Process properties

The process properties uniquely define a process within a module. Properties include how the process is exposed, selecting a custom icon, and setting keywords. The information in the process properties is used when searching on processes, when using processes in rules or schedules, and when exporting modules.

When you create a new process in the BMC Atrium Orchestrator Development Studio application, the process properties window is displayed automatically. To view the properties for existing processes you can double-click on the process canvas when the process is displayed, or with the process displayed, right-click on the process canvas and select process properties from the list.

Field

Description

Process Name

(required) Specifies the name of the process. The name must be unique within the process directory. Process names are not case sensitive; Process1 and process1 are considered to be duplicates.
The process name should not contain any extensions. Process names can consist of alphanumeric characters, spaces, parentheses and underscores.

Process ID

Specifies the process ID generated by BMC Atrium Orchestrator Development Studio

Icon

Specifies the icon to use for the process. If you do not select a customized icon, the default icon is used.

Expose Process

Check box that indicates whether a process is exposed

  • In Schedules - Specifies that the process is used to determine frequency of execution.
  • In Rules - Specifies that the process is used to control process execution.
  • In Operator Control Panel - specifies if the process will run in the Operator Control panel

    Note

    Workflows exposed to the Operator Control Panel have a size limit of 2880 pixels horizontally and vertically. Workflows exceeding this size limit will not display properly. 

  • As SOAP - Indicates if the process will be exposed as a web service via SOAP when activated on the grid.

Author

Specifies the name of the person who created the process.

Category

Specifies the grouping for the process.

Last Modified

Indicates the date and time when the process was changed. This is a system generated date.

Last Modified By

Specifies the name of the person who last modified the process.

Process Timeout (ms)

Specifies the length of time (in milliseconds) this process is allowed to run before the compensation is called due to a timeout event.
Note: 1000 milliseconds = 1 second.

Status

Specifies the state of the process.

Peer Location

Specifies the peer on which the process should run.

  • any - specifies that the process can run on any peer in the grid. The master job processor will distributethe process to the next available peer.
  • this - specifies that the process runs on the peer that has the master job processor
  • best - specifies that the grid must determine on the best peer to run the process
  • peer - you specify the peer on which the process will run

Note

This setting is ignored.

Peer Name

Specifies the name of the peer. This field is required when you select 'peer' in the peer location option. The peer name must match a peer on the grid on which the module is activated.

Note

This setting is ignored.

Process Version

Indicates the version of the process. This is a value you enter and maintain.

Record Metrics

Specifies whether to record process metrics when the process executes. When set to true, this option causes standard process metrics to be recorded each time this process executes on a grid, provided the grid and database are properly configured. All process metrics written to the metric table have a category of foundation. For more information about configuring the grid and database for metrics, see Managing metrics and audit records.

Note

 If Value Reports are using process metrics for reporting and you turn off record metrics, the reports will stop working. For more information about Value Reports, see Setting up the Value Dashboard and reports and Value Dashboard.

Supported Systems

Specifies the systems that support the process. This is a value you enter and maintain.

Keywords

Specifies specific words to use for a search

Description

Specifies the description of the process. This can be a helpful reference to provide a summary of the process function.

Enable Logging

Specifies whether custom logging is enabled on this workflow. This field is unselected by default.

Log File Name

Specifies the custom log file name for log entries. If Enable Logging is selected, this field has a default value created using the values in the Process Name and Process ID values.

The log file is created in the AO_HOME/tomcat/logs directory for the CDP, HA-CDP, or AP. In Development Studio, the log file is created in the AO_HOME/logs directory.

Note

A process must be a root job to use a custom log file. Even if you enable logging and specify a log file name for a sub-process (call-process) in a parent process (root job), the log file will not be created.

Was this page helpful? Yes No Submitting... Thank you

Comments