Process Engine Extensions

The Process Engine Extensions add classes which support process scenario definitions and simulated workflows. These classes include properties which enable you to specify a description for the scenario, configure whether events generated by the simulation are published to the Process Analyzer, and gather information about the simulated execution of the workflow.

Display Name
<Release> Process Engine Extensions
XML Script Name
ProcessEngineInstallObjects.xml
Installation Type
Recommended
Predecessors
Base Content Engine Extensions
Required By

The Process Engine Extensions provides property templates and implements custom classes, objects, and properties in the following areas throughout Enterprise Manager:

CAUTION  The Process Engine Extensions provide classes and properties which support out-of-the-box behavior for process simulation, including Simulation Console and Simulation Designer. The values for properties on object instances created by FileNet out-of-the-box applications should not be modified, as changing these values could cause application behavior issues with FileNet out-of-the-box applications and AddOn applications. In addition, the classes should not be extended or subclassed by third-parties. The descriptions included in this section are provided for informational purposes only.

Property Templates

The following property templates are added by Process Engine Extensions and implemented by various feature AddOns. These templates are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Property Templates.

Property Template Type Implementation(s) Description
Publishing Enabled Boolean
Simulation class
When this option is enabled (true), the events generated by the simulation are published to the Process Analyzer for analysis and report generation.
Scenario Definition DocID String
Simulation class

The document id of the scenario definition which this simulation is generated from. The value for this property can be specified as a GUID.

Scenario Description String
Scenario Definition class

Provides a description for the scenario, which is obtained from the user when the scenario is saved. This property is not required to be queryable and may be converted to the Text type if necessary.

Simulation Description String
Simulation class

Provides a description for the simulation, which is obtained from the user when the simulation is saved. This property is not required to be queryable and may be converted to the Text type if necessary.

Simulation GUID String
Simulation class

A text string representing the unique identifier of the simulation which consists of information pertaining to the simulation, including the host name of the simulation engine and the simulation launching timestamp.

Simulation Life Span in Hours Integer
Simulation class
The length of time the simulation data remains available for use by the Simulation Animator once the simulation completes or after the last time an animation was played. The minimum value for this property is two hours.
Simulation Status String
Simulation class

The current status of the simulation which is displayed by the Process Simulation Console.

Custom Subclasses Added to the Document Class

The following subclasses are derived from the Document Class by Process Engine Extensions. These subclasses and their respective properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Custom Subclass Name.

Subclass
Modifiable
Description
Scenario Definition
No
Defines the scenario which simulates the execution of a workflow.
Simulation
No
Provides information about the simulated execution of a scenario, including a description of the corresponding scenario and the current status of the simulation.

Scenario Definition, Subclass of Document Class

The following properties are added to the Scenario Definition subclass by Process Engine Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Scenario Definition, right-click Properties > Property Definitions.

Property Type
Modifiable
Description
Scenario Description String
No

Provides a description for the scenario, which is obtained from the user when the scenario is saved. This property is not required to be queryable and may be converted to the Text type if necessary.

Simulation, Subclass of Document Class

The following properties are added to the Simulation subclass by the Process Engine Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Document Class > Simulation, right-click Properties > Property Definitions.

Property Type
Modifiable
Description
Publishing Enabled Boolean
No
When this option is enabled (true), the events generated by the simulation are published to the Process Analyzer for analysis and report generation.
Scenario Definition DocID String
No

The document id of the scenario definition which this simulation is generated from. The value for this property can be specified as a GUID.

Simulation Description String
No

Provides a description for the simulation, which is obtained from the user when the simulation is saved. This property is not required to be queryable and may be converted to the Text type if necessary.

Simulation GUID String
No

A text string representing the unique identifier of the simulation which consists of information pertaining to the simulation, including the host name of the simulation engine and the simulation launching timestamp.

Simulation Life Span in Hours Integer
No
The length of time the simulation data remains available for use by the Simulation Animator once the simulation completes or after the last time an animation was played. The minimum value for this property is two hours.
Simulation Status String
No

The current status of the simulation which is displayed by the Process Simulation Console.