versago:invoke_bizweaver_using_post

Differences

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

Link to this comparison view

Next revision
Previous revision
versago:invoke_bizweaver_using_post [2019/07/26 08:04]
runger created
versago:invoke_bizweaver_using_post [2020/04/02 14:58] (current)
runger [Bizweaver Action Target String and Action Parameters]
Line 11: Line 11:
     - **Action Type** is //**Service**//.     - **Action Type** is //**Service**//.
     - **Action Sequence**     - **Action Sequence**
-      - **1** if the invocation is from a custom button +      - **1** if the invocation is from a custom button. 
-      - **2** if the invocation is from a standard button.+      - **2** if the invocation is (Save & Close or Save & New) from a standard button.
     - **Service Type** is //**POST**//.     - **Service Type** is //**POST**//.
-    - **Action Target** as described below.+    - **Action Target String** and **Action Parameters** are described below.
     - **Action Trigger**     - **Action Trigger**
       - //Primary Action// if the invocation is from a custom button.       - //Primary Action// if the invocation is from a custom button.
-      - //Action Success// if the invocation is from a standard (Save, Save & Close, etc.) button.+      - //Action Success// if the invocation is from a standard (Save & Close or Save & New) button.
     - **Validate True Value** is //**SUCCESS**//.     - **Validate True Value** is //**SUCCESS**//.
     - **Validate Error Message** is //**0**//.     - **Validate Error Message** is //**0**//.
Line 27: Line 27:
   - Click the [**Add/Update**] button to save the action changes.   - Click the [**Add/Update**] button to save the action changes.
   - Click the [**Save**] button to save the button 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.+=====Bizweaver Action Target String and Action Parameters=====
  
-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 **Action String** to invoke a Bizweaver workflow using **POST** is shown below.
  
-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.+  http://YourURL:YourPort/BWService/api/workflow/InvokeWorkFlow 
 +  https://YourURL:443/BWService/api/workflow/InvokeWorkFlow
  
-  - The server where Bizweaver is installed +  - "YourURL" is the URL used by Versago. 
-  - The port assigned to the Bizweaver web service when the application was installed+  - "YourPort 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 =====+"YourURL" and "YourPort" are specific to your installation.  An example of this string is:
  
-  - 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>'}** \\ \\ +  https://portal.acmecorp.com:443/BWService/api/workflow/InvokeWorkFlow
-  - 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**+The **Action Parameters** define the Bizweaver workflow to be invoked, and any parameters to be passed.
  
-{{::versago:formv2image102.png?576x32}}+Select the **Bizweaver** checkbox.
  
-**Configuration in Versago form button**+Enter the Bizweaver workflow (task ID) to be invoked.
  
-This configuration can be applied on the [Save & New] and [Save & Close] buttonsIt 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 recordAlso note that if you have both the [Save & New] and [Save & Close] buttons active, the configuration needs to be applied on both buttons.+A row is created for each variable to be passed to Bizweaver. 
 +  * Select the **Type** of variable to be used.  Options are //Dynamic// and //Static//. 
 +    * Dynamic refers to fields on the form and is the most common. 
 +    * Static is used when a value is the same each time Bizweaver is invoked from this form.
  
-{{::versago:formv2image103.png?384x415}}+  * Enter the name of the variable expected by Bizweaver.  This value is case sensitive and must match the value defined in Bizweaver exactly.
  
-**Configuration in Bizweaver**+  Set the variable value to be passed. 
 +      If the Type is Dynamic, select the form field to be used "Form Field" from the drop-down list. 
 +      * If the Type is Static, enter the value to be passed in the "Form Field."
  
-The values from Versago are captured in a Variables step at the beginning of the Bizweaver workflow.+{{:versago:formv2image106.png?600|}}
  
-{{::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_post.1564142668.txt.gz · Last modified: 2019/07/26 08:04 by runger