GET_PARENT_NR

Use the GET_PARENT_NR script function to retrieve the RunID of the processor or activator of a task. The script function returns the session ID if the task is activated manually by a user. The task can be any type of executable object. For more information about processors and activators, see Superordinate Tasks (Parents).

Tip: Use SYS_ACT_PARENT_NR to retrieve the RunID of the processor or activator of the current task (the task that contains the script function). For more information, see SYS_ACT_PARENT_NR.

Syntax

GET_PARENT_NR (RunID [, ACT|PRC])

GET_PARENT_NR ([ACT|PRC])

Parameters

Parameter Description Format Allowed Values Default Value
RunID

(Optional) Defines the RunID of the activated task.

Note: If you do not specify a RunID, the script function returns the parent of the task that contains the script.

Script literal or script variable n.a. n.a.
ACT|PRC

(Optional) Specifies the type of activation.

Note: If you do not specify an activation type, the script function retrieves the processor (default).

Script literal
  • ACT
    Activator. Parent task that activates the specified child task, or user who manually activates the task.
  • PRC
    Processor (default). Other means of activating the task.
PRC

Return Codes

The GET_PARENT_NR script function has the following return codes:

  • RunID of the activator or processor

  • Session ID

    (ACT only) Task was activated manually by a user. For more information, see Last session in Users (USER).

  • Empty value

    No parent task exists

Examples

The following script retrieves and uses the RunID of a task to return information about the activator of the task.

:SET &RunID# = GET_UC_OBJECT_NR(MAWI.END.PROCESSING)

:SET &RET# = GET_PARENT_NR(&RunID#, ACT)

:PRINT "The task was activated by &RET#"

If the task was activated by a parent task such as a Workflow, the output in the activation report would look as follows:

2018-11-06 15:26:01 - U00020408 The task was activated by 0001004059

If a user manually executed the task, the output would show the session ID of the user:

2018-11-06 15:26:01 - U00020408 The task was activated by 0001000081

See also: