getBusinessObject Step
Description:
This step retrieves a business object.
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 to configure business objects in FlowWright Business Objects to use this step. You must navigate to the Administration - Business Objects page as shown below.
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 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. This is achieved by configuring 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. Click the process step to view its properties. The step should retrieve the business object for the process.
Definition Sample:
You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into 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 the import. Then, save the definition to confirm the changes.