Description:

The Link Business Data workflow step lets you associate business objects with the workflow instance while the process runs.

The step provides a mapping interface for specifying the Items to link to the instance. The configured business objects can then be associated with the current process instance for use in the workflow's business-data context.

The step supports:

• Selecting business objects to link to the current process instance.
• Mapping the items through the Items to link to the instance property.
• Associating business data with a workflow instance during execution.
• Using linked business data as part of subsequent workflow processing.
• Returning a True or False result for subsequent workflow processing.

Usage:

The Link Business Data step is typically placed after the workflow identifies or obtains the business objects to associate with the current process instance.

Configure the business objects through Items to link them to the instance, and use the resulting association in subsequent workflow activities.

A typical workflow pattern is:

Identify Business Data → Link Business Data → Continue Process

For example:

Start
  ↓
Identify Business Objects
  ↓
Link Business Data
  ├── True → Continue Process
  └── False → Handle Error

The step can be used when a workflow needs to:

• Associate business objects with a process instance.
• Establish business-data context during workflow execution.
• Link objects identified by an earlier workflow activity.
• Make business-object associations available for subsequent processing.
• Maintain business context while processing a request.
• Support workflows that operate on one or more business objects.

The Items to link to the instance property uses a dedicated mapping control, making linked-object configuration an explicit part of the step.

Typical Workflow Suggestions:

Link Business Data After a Request Is Received

Use the step after a workflow receives or identifies the business data associated with a request.

Example:

Receive Request → Identify Business Objects → Link Business Data → Process Request

This establishes the business-object association before the remaining request-processing activities execute.

Link Objects Before Business Processing

Use this step at the beginning of a workflow when subsequent activities need the business-data association established first.

Example:

Start → Link Business Data → Validate Request → Process Request

Configure Items to link to the instance with the business objects associated with the workflow.

Link Business Data from Form Processing

A workflow can use information from a form to determine which business objects to link.

Example:

Form Submission → Determine Business Objects → Link Business Data → Continue Processing

This can be useful when the form identifies the business object or objects relevant to the submitted request.

Link Business Objects to an Approval Workflow

Use the step to establish the business-data context before an approval process begins.

Example:

Create Request → Identify Business Objects → Link Business Data → Approval → Complete

This allows the workflow to establish the relevant business objects as part of the process before the approval activities execute.

Link Data Before Notifications

Use the step before notification activities when the workflow needs to establish its business-object context before generating or sending notifications.

Example:

Process Request → Link Business Data → Prepare Notification → Send Notification

The linked business data can form part of the context used by subsequent workflow activities, depending on those activities' capabilities.

Link Multiple Business Objects

The dedicated ClsEnterLinkObjects property type maps link objects, allowing the step to configure the items to link to the process instance.

Example:

Retrieve Business Data → Link Business Data → Continue Processing

The mapping can contain the business objects that the current process instance needs to associate with.

When you need multiple objects, organize the mapping carefully so the intended relationships are clear.

Link Business Data Before Document Processing

Use the step when a workflow processes documents in the context of one or more business objects.

Example:

Identify Business Object → Link Business Data → Retrieve Document → Process Document

This provides a workflow structure in which the business-data association is established before document-processing activities.

Link Business Data for a Service Request

A service-request workflow can link the business objects associated with the request before performing the requested work.

Example:

Service Request → Identify Related Objects → Link Business Data → Process Service Request

This can be useful when the workflow needs to maintain the relationship between the request and its associated business data.

Establish Business Context at the Start of a Workflow

For workflows that consistently operate on known business objects, you can place this step near the beginning of the process.

Example:

Start
  ↓
Identify Business Context
  ↓
Link Business Data
  ↓
Validate
  ↓
Process
  ↓
Complete

Route Processing Based on the Result

The step provides both True and False outputs, allowing the workflow to provide separate downstream paths.

Example:

             ┌── True → Continue Process
             │
Link Business Data
             │
             └── False → Error Handling

Example:

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

• Create a new process definition named “linkBusinessDataDef” and open it in designer mode. 
• Drag a “linkBusinessData” step to the canvas. 
• Connect the dots between the “Start” and the “linkBusinessData” 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. 
• Define a few variables or globals to store the data items.
• Click the “linkBusinessData” step to configure its “Required” properties. Provide a name for the step. Click the button to link Items to the instance, then click Save. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the button to link Items to the instance. A configuration pop-up window appears. Click the Add Row (+) button to insert an empty row. Enter the Item value and the Item Type. Click the Save button. You may add multiple item values by using the Add Row button. 

• Save the process definition, create a new instance, and execute it. Render the process instance and click the Link Business Data step to view its properties. When the workflow reaches the step, FlowWright processes the configured Items to link to the instance mapping. The step then returns True or False to guide subsequent workflow processing. Verify that:
  • The mapping includes the intended business objects.
  • The mapping is configured correctly.
  • The process instance reaches the Link Business Data step.
  • The expected downstream path is followed.
  • Subsequent workflow activities operate with the intended business-data context.

• On the Process Instance page, select the process instance from the table above and choose the Execute - With Params menu option.  Enter the variable values, then click Execute. 

• The process instance completes successfully. Select the instance to render, then click Items - Business Data. 

• The step should link the business objects used within the process instance.

• To view the business objects in FlowWright, you need to navigate to the Administration - Business Objects page, as shown below. 

Tips:

• Configure Items to link to the instance before executing the step because the property is required. 
• Review the mapped business objects carefully before saving the step.
• Use business objects that are relevant to the current workflow instance.
• When the business objects are determined dynamically, validate the source information before passing it to the mapping.
• Place the step before activities that depend on the business-data association.
• Keep the business-data mapping organized when multiple objects need linking.
• Use meaningful workflow logic to clarify why particular business objects are being linked.
• Test the workflow with representative business-data configurations before deploying it.
• Verify the process instance after execution to confirm that the intended business-data association has been established.
• Consider connecting the False return path to appropriate error handling or an alternative workflow path.
• Do not assume that the step creates, modifies, or deletes the underlying business objects. The XML describes the step as linking business objects used within the process instance to the instance. 
• Do not assume how downstream workflow steps consume linked business data unless that behavior is documented by those steps.
• Keep environment-specific business-object configuration in mind when moving workflow definitions between environments.
• If multiple workflows require the same business-data relationship, use a consistent mapping approach so workflow designs remain maintainable.
• Avoid linking unrelated business objects to a process instance unnecessarily.
• When troubleshooting, verify the Items-to-link-to-instance mapping before investigating downstream activities.
• Do not assume the exact UI behavior of the ClsEnterLinkObjects mapping control from the XML alone. The XML identifies it as a “Map link objects” data type but does not describe the complete configuration interface. 
• Do not assume additional semantics for the True and False returns beyond the behavior confirmed in the FlowWright implementation.

Notes:

• The Link Business Data step is defined in the Business Objects category with the internal name linkbusinessdata, label “Links business objects used within the process instance to the instance”, and display name “Link Business Data.”
• The step is implemented by FlowWright.Workflow.LinkBusinessDataStep in FlowWright.Workflow.dll and is defined as a Process step with 2 incoming connections and 2 outgoing connections.
• The step defines one required property:
  • itemsToLink – Items to link to the instance. 
• The property uses the ClsEnterLinkObjects data type, implemented by FlowWright.DataTypes.ClsEnterLinkObjects. Its data-type description is “Map link objects.”
• The step provides two return values:
  • False
  • True

Definition Sample:

You may download the sample definition from the link provided and later import it into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

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

• Items to link to the instance.
• Business-object mapping.
• Workflow Variable references used to identify the business data.
• Environment-specific business-data configuration.
• Downstream True and False workflow paths.
• Logging configuration.

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

Click here to download the sample file.