This is an old revision of the document!
Table of Contents
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 use the API within a Bizweaver workflow, simply use a WebService2 step. The body of the step will contain an action string as described below. 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.
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.
The Bizweaver API can be used with any tool that can send a URL. For example, you might create a small VBScript for a specific user to let them execute a workflow on demand. Or you could call the URL from a Versago Action link in a report.
Bizweaver Action Target String
The Action String to invoke a Bizweaver workflow is shown below.
http://1:2/BWService/api/workflow/InvokeWorkFlow?pTaskID=3&pStartAfter=0&pArguments={4:'~5~'}
The elements in red are specific to your installation. The other items (included variable names used by Bizweaver) are case sensitive, so the easiest way to create the Action Target is to copy this string and paste it into Versago, then make the needed changes. You might also update the Bizweaver server information so that you will only need to change a few items.
- The server where Bizweaver is installed
- The port assigned to the Bizweaver web service when the application was installed.
- The Bizweaver workflow ID to be invoked. This can be found in Bizweaver and will always be numeric.
- The name of the variable in Bizweaver that will receive a value from Versago.
- Value(s) to be passed to Bizweaver.
- If value(s) are not being passed to Bizweaver, the space between the curly braces is left blank.
- If the value is a value from the form, use the Column Name from the form enclosed in tilde symbols (~) as shown.
- If the value is static the tildes are not used.
- In both cases the value being passed is enclosed in single quotes.
- If multiple values need to be sent to Bizweaver, separate each pair of values (steps 5 and 6) by a comma. See sample 3 in the next section.
Bizweaver Action Target String Samples
- Example using HTTP to port 8082 on server “TWBSTestserver.demo.com”, invoking workflow ID 10, and sending a value from form control name “vgoRecNum” to a Bizweaver variable named “vgoRecNum.”
http://TWBSTestserver.demo.com:8082/BWService/api/workflow/InvokeWorkFlow?pTaskID=10&pStartAfter=0&pArguments={vgoRecNum:'~5~'}
- Example using HTTPS to port 443 on server “TWBSTestserver.demo.com”, invoking workflow ID 10, and sending a value from form control name “vgoRecNum” to a Bizweaver variable named “vgoRecNum.” Note that the only difference is the “HTTPS” and port number.
https://TWBSTestserver.demo.com:443/BWService/api/workflow/InvokeWorkFlow?pTaskID=10&pStartAfter=0&pArguments={vgoRecNum:'~5~'}
- Example using HTTP to port 8082 on server “TWBSTestserver.demo.com,” invoking workflow ID 10, and sending two values; one from form control name “vgoRecNum” to a Bizweaver variable named “vgoRecNum” and a static value “TextString” to a Bizweaver variable name “vgoText.”
http://TWBSTestserver.demo.com:8082/BWService/api/workflow/InvokeWorkFlow?pTaskID=10&pStartAfter=0&pArguments={vgoRecNum:'~5~',vgoText: 'TextString'}
