Wiki

Scale Your Enterprise

User Tools

Site Tools


versago:invoke_bizweaver_using_get

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
versago:invoke_bizweaver_using_get [2019/07/26 08:05]
runger [Invoking a Bizweaver Workflow Using GET]
— (current)
Line 1: Line 1:
-====== Invoking a Bizweaver Workflow Using GET ====== 
  
-<WRAP center round info> 
-Each standard button is a unique control. If a Bizweaver workflow needs to be invoked from the Save & Close and Save & New buttons, each button must be configured separately; even if the exact same call is being made. 
-</WRAP> 
- 
-  - To begin, open the Control Properties for the button. 
-  - Click on the [Action] button to open the Action Properties page. 
-  - To create a new button action: 
-    - Enter an **Action Name**. This is used for reference only. 
-    - **Action Type** is //**Service**//. 
-    - **Action Sequence** 
-      - **1** if the invocation is from a custom button 
-      - **2** if the invocation is from a standard button. 
-    - **Service Type** is //**Get**//. 
-    - **Action Target** as described below. 
-    - **Action Trigger** 
-      - //Primary Action// if the invocation is from a custom button. 
-      - //Action Success// if the invocation is from a standard (Save, Save & Close, etc.) button. 
-    - **Validate True Value** is //**SUCCESS**//. 
-    - **Validate Error Message** is //**0**//. 
-    - **Validate Success Message** is //**1**//. 
-  - To modify an existing button action: 
-    - Click on the desired **Action Name**. 
-    - The existing information is displayed 
-    - Make whatever changes are desired 
-  - Click the [**Add/Update**] button to save the action changes. 
-  - Click the [**Save**] button to save the button changes. 
-===== Bizweaver Action Target String ===== 
- 
-The Action String to invoke a Bizweaver workflow is shown below. 
- 
-http:%%//%%<color #ed1c24>1</color>:<color #ed1c24>2</color>/BWService/api/workflow/InvokeWorkFlow?pTaskID=<color #ed1c24>3</color>&pStartAfter=0&pArguments={<color #ed1c24>4</color>:'~<color #ed1c24>5</color>~'} 
- 
-The elements in <color #ed1c24>red</color> 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:%%//%%<color #ed1c24>TWBSTestserver.demo.com</color>:<color #ed1c24>8082</color>/BWService/api/workflow/InvokeWorkFlow?pTaskID=<color #ed1c24>10</color>&pStartAfter=0&pArguments={<color #ed1c24>vgoRecNum</color>:'<color #ed1c24>~5~</color>'}** \\ \\ 
-  - 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:%%//%%<color #ed1c24>TWBSTestserver.demo.com</color>:<color #ed1c24>443</color>/BWService/api/workflow/InvokeWorkFlow?pTaskID=<color #ed1c24>10</color>&pStartAfter=0&pArguments={<color #ed1c24>vgoRecNum</color>:'<color #ed1c24>~5~</color>'}** \\ \\ 
-  - 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:%%//%%<color #ed1c24>TWBSTestserver.demo.com</color>:<color #ed1c24>8082</color>/BWService/api/workflow/InvokeWorkFlow?pTaskID=<color #ed1c24>10</color>&pStartAfter=0&pArguments={<color #ed1c24>vgoRecNum</color>:'<color #ed1c24>~5~</color>',vgoText: 'TextString'}** 
-===== Versago and Bizweaver Complete Example ===== 
- 
-**Information captured on Versago Form** 
- 
-{{::versago:formv2image102.png?576x32}} 
- 
-**Configuration in Versago form button** 
- 
-This configuration can be applied on the [Save & New] and [Save & Close] buttons. It should not be applied on the [Save] button since you probably don’t want Bizweaver processing to occur until the user is finished with the input record. Also note that if you have both the [Save & New] and [Save & Close] buttons active, the configuration needs to be applied on both buttons. 
- 
-{{::versago:formv2image103.png?384x415}} 
- 
-**Configuration in Bizweaver** 
- 
-The values from Versago are captured in a Variables step at the beginning of the Bizweaver workflow. 
- 
-{{::versago:formv2image104.png?247x159}} 
- 
-{{::versago:formv2image105.png?384x285}} 
- 
-<WRAP center round info> 
-Note that the variable names in Bizweaver are the same, including case, as those being sent from Versago. 
-</WRAP> 
versago/invoke_bizweaver_using_get.1564142708.txt.gz · Last modified: 2019/07/26 08:05 by runger