Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • B1 Messages • Preparation • Called from SAP Business One (Trigger) • Workflow Schedules Version 2.5 and after
bw2:bizweaver_api

Differences

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

Link to this comparison view

Next revision 		Previous revision
bw2:bizweaver_api [2020/12/15 12:32]
akoehler created 		bw2:bizweaver_api [2021/02/05 11:58] (current)
akoehler
Line 2: Line 2:
 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. 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 **//[[versago:form_configuration#invoking_a_bizweaver_workflow|Invoking a Bizweaver Workflow]]//** Versago page for information about using this process from Versago.+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 **//[[versago:form_configuration#invoking_a_bizweaver_workflow|Invoking a Bizweaver Workflow]]//** Versago page for information about using this process from Versago.
  
-To initiate another workflow within Bizweaver, use a **//[[bw:web_service_tool|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.+To initiate another workflow within Bizweaver, use a **//[[bw2:web_service_tool|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.
  
 <WRAP center round tip 80%> <WRAP center round tip 80%>
Line 10: Line 10:
 </WRAP> </WRAP>
 <WRAP center round important 80%> <WRAP center round important 80%>
-A token must be generated in order to use the POST processes described below.  Information on configuring a token is found **//[[bw:bizweaver_general_settings#bizweaver_webservice|here]]//**.+A token must be generated in order to use the POST processes described below.  Information on configuring a token is found **//[[bw2:bizweaver_general_settings#bizweaver_webservice|here]]//**.
 </WRAP> </WRAP>
 <WRAP center round important 80%> <WRAP center round important 80%>
-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.+Use caution when connecting multiple workflows in a sequence.  You may need to adjust the timeout value on the earlier steps to ensure the processing doesn't continue before the called step(s) have completed their work.
 </WRAP> </WRAP>
  
Line 20: Line 20:
 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. 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.
  
-{{ :bw:webservice_bizweaverpost.png?400  |}}+{{ :bw2:bwapiws.png |}}
  
  
  
   * Change the **YourServer:YourPort** values as needed by your installation.  The URI might look something like https://MyPortal.MyCompany.com:443   * 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. +    * 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.+    * The rest of the URI, __/BWService/API/workflow/InvokeWorkFlow__, will always be the same.
   * Select POST from the "Method" drop-down list.   * Select POST from the "Method" drop-down list.
   * Enter "application/json" in the "Content Type" field.   * Enter "application/json" in the "Content Type" field.
Line 34: Line 34:
  
 <WRAP center round tip 60%> <WRAP center round tip 60%>
-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.+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.
 </WRAP> </WRAP>
  
Line 56: Line 56:
   * **NN** is the ID of the workflow being called.   * **NN** is the ID of the workflow being called.
   * **Arguments** (parameters) are any values being passed to 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.+    * Arguments are always sent in pairs.  Each pair is separated by a colon **:** as shown.
     * The argument (Arg1, Arg2, etc.) is the variable name expected by the workflow being called.     * The argument (Arg1, Arg2, etc.) is the variable name expected by the workflow being called.
       * Variable names are case-sensitive.       * Variable names are case-sensitive.
Line 62: Line 62:
       * Text and dates are enclosed in double-quotes.       * Text and dates are enclosed in double-quotes.
       * Numeric values do not require 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.+    * "pArguments" is required even if no values are being passed.  In this case, the "pArguments" section will look like this.
  
 <code json> <code json>
bw2/bizweaver_api.1608053543.txt.gz · Last modified: 2020/12/15 12:32 by akoehler

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Valid HTML5 Valid CSS Driven by DokuWiki