getBusinessObject Step
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:
We need business objects in FlowWright Business objects configuration to use this step.
We must define the configured Business object in the Process Definition. Select the Actions—Manage Business Objects—Add menu on the process designer page. Provide the BO name and choose the type of the drop-down list. Click the Add button to consider this business object in the workflow.
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 the “getBusinessObject” step to configure its “Settings” properties. Provide a name to the step. Click on the button to configure the parameters for the business object.
- Click on the button to configure the parameters for 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 “time to live” value as a second type.
- The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is achieved 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.
Definition Sample:
You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.