Component Process Utility Steps

Several utility steps are provided for component processes.

Process Sleep

The Process Sleep step enables you to enter time in seconds for a process to wait until continuing with the next steps in the process. The following table describes the property for this step.
Property Description
Sleep Time Default: 30

Acquire Lock and Release Lock

The Acquire Lock and Release Lock steps enable you to lock and release a process for a designated resource.

Locks are typically used to prevent specific processes from modifying the same resource at the same time, such as when a database is being updated.

In an Acquire Lock step, the process tries to acquire a lock with the specified name. If there is no other lock with that exact name, the process acquires the lock with that name and continues. If another process is using a lock with that exact name, the process waits until the lock is released by the other process. Any processes that access the resource without a lock or with a lock of a different name do not wait on this lock.

Locks are released automatically when the process completes, but you can also release the lock using the Release Lock step if you need to release it explicitly before continuing later steps in a process. Administrators can also release locks. See Managing Locks.

The following table describes the property for these steps.

Property Description
Lock Name Specify the lock name. The default setting is as follows: ${p:component.name}-${p:componentProcess.name}-${p:resource.name}
Tip: The default lock name setting is set using a default variable. Therefore, to make the lock names exactly the same for different objects and processes, you can enter a static string for the name or use variables that will resolve to the same in both processes. For example, if you want to lock a resource against concurrent use for two processes in different components that are mapped to the same resource, you could use ${p:resource.name} as the lock name for both.

Set Status

The Set Status step enables you to explicitly set the status of a process. The following table describes the property for this step.
Property Description
Status Values: Success or Failed

Set Property

The Set Property step enables you to set a value of a property. The following table describes the properties for this step.
Property Description
Name Enter a name for the step.
Property Name Enter a name for the property.
Property Value Enter a value for the property.

Switch

The Switch step enables you to define a conditional step. The outbound connections for this step are set to check for values to determine the ongoing path of the process. See Using Conditions and Switch Steps in Processes. The following table describes the properties for this step.
Property Description
Name Enter a name for the step.
Property Name Enter a name for the property to be checked for values in the outgoing connections.

Join

The Join step enables you to join steps in a process. There are no properties for this step.

For the Join step to continue processing on to its outboard connections, all its inbound connection paths must be valid. To be valid, all that should evaluate to success do so, all that should evaluate to failure do so, all that should evaluate to any value do so, and all that should evaluate to a specific switch value do so.

You can do an implicit join without the Join step by having multiple inbound connections for another step. Regardless of whether it is an implicit or explicit join, all incoming connections must be valid for the joining step to be executed.

One reason you should choose an explicit Join step is when your process has multiple steps that must all complete to a certain outcome and then should continue on to multiple outbound steps without additional processing between them.

Manual Task

The Manual Task step enables you to interrupt a process until some manual intervention is performed according to a pre-configured component task. Component tasks must be set for an component before you can select them for this step. See Component Tasks.

The following table describes the properties for this step.

Field Description
Name Enter a descriptive name for the step.
Task Definition Used to select a previously-defined user-defined task. See Application Tasks.
Environment Role Select the role expected to respond. The user mapped to this role must respond to the generated work item before the process can continue.
Component Role Select the role expected to respond. The user mapped to this role must respond to the generated work item before the process can continue.
Resource Role Select the role expected to respond. The user mapped to this role must respond to the generated work item before the process can continue.

All roles are required, so all affected users must respond before the process can continue.

Add Inventory Status and Remove Inventory Status

The Add Inventory Status and Remove Inventory Status steps enable you to add an inventory status as part of your process. See Using Inventory Statuses.

The following table describes the property for these steps.

Property Description
Status Select the status to add or remove.

Run Component Process

The Run Component Process step enables you to run a component process as part of the current process. The following table describes the properties for this step.
Property Description
Name Enter a name for the step.
Component Process Select the component process name.

Run Global Process

The Run Global Process step enables you to run a global process as part of the current process. The following table describes the properties for this step.
Property Description
Name Enter a name for the step.
Process Select the global process name.
Resource Name Enter the resource name. The default value is as follows:

${p:resource.name}

Related Topics

Application Process Utility Steps

Global Process Utility Steps

Deployment Package Process Utility Steps

Component Tasks

Using Conditions and Switch Steps in Processes

Configuring Email Notifications