AX1378

GetProcessInfo("ProcessDefinitionID")

If "ProcessDefinitionID" is specified as the first parameter, GetProcessInfo returns the ID of a process definition. This ID can then be used in other versions of the GetProcessInfo function to return information about that process.

Syntax

GetProcessInfo("ProcessDefinitionID", "ProcessDefinitionNameorPath", "FileGroupName")

Parameter Description

Parameter	Description
ProcessDefinitionID	Use the keyword `ProcessDefinitionID` to return the ID of a process definition.
ProcessDefinitionNameorPath	The process definition for which to return the ID. Enter one of the following: If the process definition belongs to a file group, you can enter the name of the process definition file (without the file extension). You can also optionally enter the full path to the process definition (including the file extension). The display name cannot be used. If the process definition is located in the Process Definition Library, enter the full path to the process definition (including the file extension).
FileGroupName	Optional. The name of the file group that the process belongs to. A file group alias name can also be used. If the function is used in a file that belongs to a file group, then this parameter can be omitted and the current file group is assumed. (However, in this case you should use GetFileGroupProperty("ProcessDefinitionID") instead.) You can also omit the name of the file group if you specified the full path to the process definition in the second parameter.

ProcessDefinitionID

Use the keyword ProcessDefinitionID to return the ID of a process definition.

ProcessDefinitionNameorPath

The process definition for which to return the ID. Enter one of the following:

If the process definition belongs to a file group, you can enter the name of the process definition file (without the file extension). You can also optionally enter the full path to the process definition (including the file extension). The display name cannot be used.
If the process definition is located in the Process Definition Library, enter the full path to the process definition (including the file extension).

FileGroupName

Optional. The name of the file group that the process belongs to. A file group alias name can also be used.

If the function is used in a file that belongs to a file group, then this parameter can be omitted and the current file group is assumed. (However, in this case you should use GetFileGroupProperty("ProcessDefinitionID") instead.) You can also omit the name of the file group if you specified the full path to the process definition in the second parameter.

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell.

Remarks

If a process has historical instances and you want to report against that history, you can look up the Process Definition ID for historical instances using Manage > Process Management > Current Processes. Select the check box for Show inactive processes (if necessary), then select the current process definition in the top of the dialog. You can then review the process history at the bottom of the dialog to find the Process Definition ID for a historical instance. This historical ID can be used in other GetProcessInfo functions.
GetProcessInfo is a volatile function.

Examples

=GetProcessInfo("ProcessDefinitionID","\Axiom\Process Definition Library\Rollover.axp")

This example returns the ID of a process definition that is stored in the Process Definition Library, as indicated by the full path used in the second parameter. The third parameter is not needed and is omitted.

=GetProcessInfo("ProcessDefinitionID","Budget Process","Budget 2020")

This example is for a file group-specific process, so the second parameter uses just the process name. The third parameter specifies the file group that the process belongs to. The file group name could be omitted when using this function in a file that belongs to a file group.

Alternatively, you could use the full path to the file group process in the second parameter, and then the file group name would not be necessary in any context.