Automation Engine Script Guide > Ordered by Function > Activation Data > SYS_ACT_PTTYP

SYS_ACT_PTTYP

Script Function: It returns the partner type of the userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management..

Syntax

SYS_ACT_PTTYP()

Return codes

"D" - Activation through UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."]
"C" - Activation through CallAPIA programming interface that processes a script in the Automation Engine system. It can be called directly from within the program itself or from a different program.
"A" - Activation through Java Application Interface / Deployment Descriptor

Comments

This scriptA particular Automation Engine object type. functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… determines how a taskAn executable object that is running. Tasks are also referred to as activities. is activated.

When you use this function in post processing or when the option "Generate at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start)." is set, the system will supply an empty return codeThe value that represents the result of tasks and script functions..

Example

This example shows the line that is written to the activation reportA report provides more detailed information about a task's execution or a component. if a task has been activated by a CallAPI.

:SET &PTTYP# = SYS_ACT_PTTYP()
:
IF &PTTYP#  = "C"
:   
PRINT "Task was activated through CallAPI."
:
ENDIF

 

See also:

Script Elements - Activation Data

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH