Workflow Trigger Reference for SAP Business One SQL (B1WebAPI) Connector

Workflow Triggers initiate workflows and are used to define the data supplied to a workflow. Supported trigger Data Types for this connector are outlined below.

SAP Business One SQL (B1WebAPI) Connector provides several triggers including data from queries, transaction lists, or transaction data.

Trigger Source Description Version
Get a List of Financial Project Workflow Message Records Fetch a list of Financial Project workflow message records from SAP Business One. This fetches small message records whose data must be hydrated within the workflow. 7.17+
Get a List of Workflow Message Records Fetch a list of workflow message records from SAP Business One. This fetches small message records whose data must be hydrated within the workflow.

This trigger source was renamed in version 7.5.3. Older versions refer to this source as WorkFlowMessages Data.
6.4+
Get Bulk Data Query Populate local data files using the specified query. 7.7+
Get Query Results Fetch query results from a B1 query and filter results as indicated in source settings.

This trigger source was renamed in version 7.5.3. Older versions refer to this source as QueryResults.
6.0+
Get Workflow Messages (v2) Fetch a list of workflow messages generated within SAP Business One. Use filters to specify which data to include.

This trigger source was renamed in version 7.5.3. Older versions refer to this source as Workflow Messages V2.
7.1+
QueryScalar Execute a B1 Query and use the scalar result (first column and row only) as the message source. Discards all other data. 6.0+
WorkFlowMessages Fetch a list of InterConnect workflow messages to use as a message source within Integration Platform. Requires a Transaction Type and Object Type. 6.0+

Trigger Sources

Get a List of Financial Project Workflow Message Records

Trigger Source Description Version
Get a List of Financial Project Workflow Message Records Fetch a list of Financial Project workflow message records from SAP Business One. This fetches small message records whose data must be hydrated within the workflow. 7.17+

Get a List of Workflow Message Records

Trigger Source Description Version
Get a List of Workflow Message Records Fetch a list of workflow message records from SAP Business One. This fetches small message records whose data must be hydrated within the workflow.

This trigger source was renamed in version 7.5.3. Older versions refer to this source as WorkFlowMessages Data.
6.4+

This trigger supports object hydration using the workflow action Fetch object data for a triggered transaction record within a workflow. Use the workflow action with this trigger to prevent long-running triggers from timing out silently. This two-step process allows this trigger to provide a very small data set to each workflow execution, which then allows the action to hydrate (populate) data into the workflow’s “Current Message”.

This feature addresses bug 41736.

For instructions on how to convert an older workflow using triggers “WorkFlowMessages” or “WorkFlowMessages v2”, see Release Notes for version 7.4.0

Object Hydration Setup Example for Workflow Messages

To set up a workflow using this trigger with the action Fetch object data for a triggered transaction record to hydrate data, proceed as follows. The advantage of using this two-step approach is that retry logic and troubleshooting tools can be used natively within Saltbox.

  • In the manage workflows page create a new workflow.

  • Edit the workflow. Configure workflow settings as desired.

  • In the workflow trigger page:

    • Configure the trigger using the SAP Business One SQL (B1WebAPI) Connector using the source WorkFlowMessages Data.

    • Configure Source settings as required to fetch the desired data. For example, select oOrders to fetch order data, or oBusinessPartners to fetch Business Partner data.

    • Modify the schedule if desired (for example, set it to “Manual” mode).

    • Save changes.

  • In the workflow designer page:

    • Add the action Fetch object data for a triggered transaction record.

      On workflow execution, when this action is successful, it will overwrite the “Current Message” with hydrated object data, allowing subsequent actions to use “Current Message” to inspect/use that object’s data.

      When this action is unsuccessful, “Current Message” remains unchanged, with simple trigger data instead of fully hydrated object data. This allows retry logic and troubleshooting tools to access the message.

    • Edit the action. Update the “Config” to use the same one as the trigger.

    • Save changes.

    • Configure other workflow details using “Current Message” when object data is needed.

  • At this point the workflow can be run and verified.

Get Bulk Data Query

Trigger Source Description Version
Get Bulk Data Query Populate local data files using the specified query. 7.7+

Get Query Results

Trigger Source Description Version
Get Query Results Fetch query results from a B1 query and filter results as indicated in source settings.

This trigger source was renamed in version 7.5.3. Older versions refer to this source as QueryResults.
6.0+

Get Workflow Messages (v2)

Trigger Source Description Version
Get Workflow Messages (v2) Fetch a list of workflow messages generated within SAP Business One. Use filters to specify which data to include.

This trigger source was renamed in version 7.5.3. Older versions refer to this source as Workflow Messages V2.
7.1+

QueryScalar

Trigger Source Description Version
QueryScalar Execute a B1 Query and use the scalar result (first column and row only) as the message source. Discards all other data. 6.0+

WorkFlowMessages

Trigger Source Description Version
WorkFlowMessages Fetch a list of InterConnect workflow messages to use as a message source within Integration Platform. Requires a Transaction Type and Object Type. 6.0+