This is an old revision of the document!
Table of Contents
Bizweaver API
Bizweaver has its own API that can be used in a variety of ways. This is a directly-called API and does not currently use REST as the communication mechanism. Instead, a specially formatted URL is used.
The two most common uses are to invoke a Bizweaver workflow from a Versago form or report, and to have one workflow call another workflow. See the Invoking a Bizweaver Workflow Versago page for information about using this process from Versago.
To initiate another workflow within Bizweaver, use a WebService2 step. The step is configured to use POST (preferred) or GET. When the second workflow is called, the calling workflow will wait until it receives a response from the called workflow. Once a response is received the calling workflow will continue to its next step.
Processes beginning with v2.4 should always use POST. Processes from older versions that used GET should be converted to POST as soon as possible.
A token must be generated in order to use the POST processes described below. Information on configuring a token is found here.
Use caution when connecting multiple workflows in a sequence. You may need to adjust the timeout value on the earlier steps to be sure the processing doesn't continue before the called step(s) have completed their work.
Call Another Workflow Using POST
When a Bizweaver workflow is called (initiated) using POST, the configuration of the WebService2 tool involves two sections: the URI and the Body. An example is shown below.
- Change the YourServer:YourPort values as needed by your installation. The URI might look something like https://MyPortal.MyCompany.com:443
- Remember that you will need to use HTTP or HTTPS depending on your environment.
- The rest of the URI, /BWService/api/workflow/InvokeWorkFlow, will always be the same.
- Select POST from the “Method” drop-down list.
- Enter “application/json” in the “Content Type” field.
- Select the “Calling BW Task” checkbox.
- Enter the appropriate values in the “Body Information” section in the structure shown. This structure can be copied from here, pasted into your workflow, and the values changed as needed.
Finding the proper port needed will be in your IIS Manager which can be found in Start → Windows Administrative Tools → Internet Information Services (IIS) Manager. There will be a drop down for your server, then you will see Sites drop down and then Versago click on Versago and on the right panel there will be the proper port needed to use in the API call.
Here is a sample of the full URL. Copy and paste this string as a starting point.
https://MyPortal.MyCompany.com:443/BWService/api/workflow/InvokeWorkFlow
{
"pTaskID":"NN",
"pArguments":
{
"Arg1":"Value1",
"Arg2":"Value2"
}
}
- NN is the ID of the workflow being called.
- Arguments (parameters) are any values being passed to the workflow being called.
- Arguments are always sent in pairs. Each paid is separated by a colon : as shown.
- The argument (Arg1, Arg2, etc.) is the variable name expected by the workflow being called.
- Variable names are case-sensitive.
- Values are the value being passed.
- Text and dates are enclosed in double-quotes.
- Numeric values do not require double-quotes.
- “pArguments” is required even if no values are being passed. In this case the “pArguments” section will look like this.
{
"pTaskID":"NN",
"pArguments":{}
}
