Description:

The GetBusinessObject workflow step retrieves a Business Object using the parameters supplied to the step. The retrieved Business Object can then be used by subsequent workflow activities.

The step supports:

• Supplying parameters to identify or retrieve the Business Object.
• Optionally loading Business Object properties on demand.
• Specifying a time-to-live amount.
• Specifying the time-to-live unit.
• Returning a True or False result for subsequent workflow processing.

Usage:

The GetBusinessObject step is typically placed when a workflow needs to retrieve a Business Object before performing additional processing.

A typical workflow pattern is:

Prepare Business Object Parameters → Get Object → Process Business Object

The step can be useful when a workflow needs to:

• Retrieve a Business Object using configured parameters.
• Load Business Object properties on demand.
• Control the time-to-live configuration for the retrieved object.
• Make the Business Object available to subsequent workflow activities.
• Perform additional Business Object processing.
• Route the workflow based on the result of the retrieval operation.

To use this step, configure business objects in FlowWright Business Objects. You must navigate to the Administration - Business Objects page as shown below. 

Typical Workflow Suggestions:

Retrieve a Business Object

Use the step when a workflow needs to retrieve a Business Object using configured parameters.

Example:

Start → Get Object → Process Business Object

Configure parameters for the business object with the parameters required for the desired Business Object.

Retrieve an Object Before Processing

Use GetBusinessObject as a preparation step before activities that need to work with the retrieved Business Object.

Example:

Get Business Object Parameters → Get Object → Business Object Processing

This clearly separates preparing the retrieval parameters from processing the resulting object.

Load Properties on Demand

Enable Load properties on demand when the workflow requires Business Object properties to be loaded on demand.

Example:

Get Object → Load Properties as Needed → Process Object

The XML exposes this behavior through the optional Load properties on demand checkbox.

Configure a Time-to-Live Duration

Use the TTL properties when the Business Object retrieval needs an associated time-to-live configuration.

Example:

Get Object → Process Object During TTL → Continue Workflow

Configure:

Time to live amount: 10

Time to live type: Minutes

The XML exposes the amount and type as separate optional properties.

Use Different TTL Units

You can use the Time to live type property with the TTL amount to express the required duration using the available time-unit configuration.

Example:

Get Object → Configure TTL → Continue Process

The underlying data type is named ClsSecondsMinutesDaysHours, indicating the time-unit configuration supports seconds, minutes, days, and hours.

Retrieve an Object for Subsequent Workflow Activities

Use the step when the retrieved Business Object is needed by several downstream activities.

Example:

Get Object → Business Object Data Available → Activity 1 / Activity 2 / Activity 3

This can provide a common Business Object retrieval point before additional processing.

Route the Workflow Based on Retrieval Result

Use the True and False return paths to create different workflow paths.

Example:

                         ┌── True → Process Business Object
Start → Get Object
                         └── False → Handle Retrieval Failure

Retrieve an Object with On-Demand Properties

Use the step when the workflow needs the Business Object but does not necessarily need all of its properties loaded immediately.

Example:

Prepare Parameters → Get Object → Load Properties on Demand → Continue

The Load Properties on Demand setting is optional and is represented as a checkbox in the step definition.

Use Business Object Parameters Dynamically

You can configure business object property parameters as part of a workflow that determines the required Business Object parameters during execution.

Example:

Determine Object Parameters → Get Object → Process Object

This lets you incorporate the retrieval operation into a dynamic workflow pattern.

Control Object Lifetime

Use the TTL properties when the workflow needs to configure a time-to-live value for the retrieved Business Object.

Example:

Get Object → Object Available for Configured Duration → Continue Workflow

The TTL amount and TTL type are exposed as separate optional properties.

Example:

Let’s build and execute the “getBusinessObjectDef” example.          

• Create a new process definition named “getBusinessObjectDef” and open it in designer mode.
• Drag a “getBusinessObject” step to the canvas. 
• Connect the dots between the “Start” and “getBusinessObject” steps, as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Select the Actions > Manage Business Object menu on the process designer page. Enter the BO name and select the drop-down list type. Click the Add button to include this business object in the workflow. 

• Click the “getBusinessObject” step to configure its “Required” properties. Provide a name for the step. Click the button to configure the business object’s parameters. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the button to configure the business object's parameters. A pop-up window appears for configuration. Select the business object from the drop-down list. Enter the name and value. Click the Save button. 

• Click the “getBusinessObject” step to configure its “Optional” properties. Select “On” to load properties on demand. Enter the “time to live” value in seconds. Click the Save button. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Render the process instance and click the Get object step to view its properties. When the workflow reaches the GetBusinessObject step, FlowWright uses the configured Business Object parameters to perform the retrieval operation. If configured, the step also applies the Load properties on demand, Time to live amount, and Time to live type settings. The workflow can then continue through the True path or use the False path for alternative or error-handling processing.

Tips:

• Always configure the required Parms to the business object property.
• Verify that the Business Object parameters identify the intended object.
• Test the configured parameters before deploying the workflow.
• Use meaningful workflow configuration and step names.
• Enable Load properties on demand only when it matches the requirements of the Business Object processing.
• When using TTL, configure the Time to live amount and Time to live type consistently.
• Verify that the selected TTL type corresponds to the intended duration.
• Test TTL configurations with representative workflow scenarios.
• Connect the True path to the normal Business Object processing path.
• Connect the False path to appropriate alternative or error-handling logic.
• Test the workflow when the requested Business Object can be retrieved successfully.
• Also test scenarios where the requested Business Object cannot be retrieved.
• Verify downstream processing after changing Business Object parameters.
• Verify downstream processing after changing on-demand property loading.
• Keep Business Object configuration maintainable when the same object is retrieved by multiple workflows.
• Avoid logging sensitive Business Object information unnecessarily.
• Test the workflow after changing the underlying Business Object configuration.
• Verify that downstream activities are compatible with the retrieved Business Object.
• When using TTL configuration, document the intended duration so that future workflow maintainers understand its purpose.
• Do not assume the exact internal structure of the boParams configuration unless confirmed by the FlowWright implementation.
• Do not assume the precise runtime behavior of property loading or TTL beyond what is exposed by the step configuration.
• The supplied XML identifies Load properties on demand, TTL amount, and TTL type as configuration options, but does not document their detailed runtime implementation.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page, following the same approach described in the supplied SearchAndReplaceString documentation.

Note: Verify and complete any missing configuration after importing the sample, including:

• Business Object parameters.
• Load properties on demand setting.
• Time to live amount.
• Time to live type.
• Workflow Variable references used within the Business Object parameters.
• Environment-specific Business Object configuration.
• Downstream True and False workflow paths.
• Any subsequent Business Object processing activities.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.