getBusinessObject Step

Use this step to fetch a business object within the process.

Last published at: August 29th, 2023

Description:

This step gets a business object within the process.

Inputs

  • boProps – business object properties to get the object
  • ttl – Time to live amount
  • ttltype – Time to live type
  • loadOnDemand – Load properties on demand
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
 

 

Usage:

 

To use this step, we need business objects in FlowWright Business objects configuration.

We must define the configured Business object in the Process Definition. In process designer page, select Actions - Manage Business Objects - Add menu option.

 

Example:

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

  • Create a new definition called “getBusinessObjectDef” 
  • Select the definition and click the “design” button
  • Drag a “getBusinessObject” step from the toolbox
  • Connect the dots between the start and “getBusinessObject” step 
  • Click on the “getBusinessObject” step to configure its “Settings” properties. Provide a name to the step. Click on the button to configure the params to the business object. 
  • Click on the button to configure the params to the business object. Select the business object from the drop down list. Provide the name and value. 
  • Click on the “getBusinessObject” step to configure its “Advanced” properties. Select “On” to load properties on demand. Provide the value for the “time to live” as seconds type. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. Render the process instance. Click on the process step to view the properties. The step should get the business object for the process.