Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace:
bw:databuilder_tool

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
bw:databuilder_tool [2020/05/07 10:50]
runger [Introduction (DataBuilder)] 		bw:databuilder_tool [2022/08/02 15:33] (current)
akoehler
Line 7: Line 7:
 The following documents contain additional information that may be helpful with the development of Bizweaver workflows. The following documents contain additional information that may be helpful with the development of Bizweaver workflows.
  
-  * [[bw:web_service_tool|WebService Tool]]+  * **[[bw2:web_service_tool|WebService Tool]]**
  
 ====== Before You Begin ====== ====== Before You Begin ======
Line 13: Line 13:
 You will need to know, or have examples of , the data structures the API is expecting. This includes element (field names) and child objects within the structure. Keep in mind that names will generally require an exact match, including case. You will need to know, or have examples of , the data structures the API is expecting. This includes element (field names) and child objects within the structure. Keep in mind that names will generally require an exact match, including case.
  
 +=====For SAP Business One Service Layer=====
 +An easy way to view the data structures used for SAP Business One is to create a small workflow that executes a GET on the object in question.  The workflow will have two WebService2 steps: a login step and a GET step.  The GET step references the target object (e.g. SalesOrders). The GET step will return the data structure for the object in the "Output String."  This is also an easy way to create a template file for the object in your environment as it will include any user-defined fields as well.
 +
 +More information dealing with SAP Service Layer can be found **[[bw2:sap_business_one_integration_using_service_layer|here]]**
 ====== General Notes ====== ====== General Notes ======
  
Line 30: Line 34:
 This workflow builds two sections of a JSON structure for an SAP Business One sales order.  The sections are the header and the rows.  Each section consists of a SQL statement to gather the needed information and the DataBuilder to format the information.  Once the pieces are constructed, the output is sent to the SAP Service Layer API in the WebService step.  Other APIs will work in a similar manner. This workflow builds two sections of a JSON structure for an SAP Business One sales order.  The sections are the header and the rows.  Each section consists of a SQL statement to gather the needed information and the DataBuilder to format the information.  Once the pieces are constructed, the output is sent to the SAP Service Layer API in the WebService step.  Other APIs will work in a similar manner.
  
-{{:bw:databuilder1.png?600|}}+{{  :bw:databuilder1.png?600  |}}
  
 ===== Create Main DataBuilder Step ===== ===== Create Main DataBuilder Step =====
  
-{{:bw:databuilder2.png?600|}}+{{  :bw:databuilder2.png?600  |}}
  
 This should always contain the first items of the data structure. This should always contain the first items of the data structure.
Line 62: Line 66:
 ===== Create the Lower-Level DataBuilder Step(s) ===== ===== Create the Lower-Level DataBuilder Step(s) =====
  
-{{:bw:databuilder3.png?600|}}+{{  :bw:databuilder3.png?600  |}}
  
 This will be the next section in the expected data structure. The process is the same as described in the “Main DataBuilder” step. This will be the next section in the expected data structure. The process is the same as described in the “Main DataBuilder” step.
Line 68: Line 72:
 For objects such as a set of rows, the display will only display a single entry. However, all data received as input will be included when the workflow executes. For objects such as a set of rows, the display will only display a single entry. However, all data received as input will be included when the workflow executes.
  
-<WRAP center round tip 60%>+<WRAP center round tip 80%>
 In most cases the lower-level sections will need to be marked as an **array**. The “Add as an array” checkbox should be selected. However, always check your API documentation to verify this.  **At the same time**, the "Top-level Element" checkbox should remain cleared. In most cases the lower-level sections will need to be marked as an **array**. The “Add as an array” checkbox should be selected. However, always check your API documentation to verify this.  **At the same time**, the "Top-level Element" checkbox should remain cleared.
 </WRAP> </WRAP>
 +
 +<WRAP center round important 80%>
 +When creating lower-level section that __may__ have more than one entry (i.e. an array), be sure to put the DataBuilder tool within a **Loop**.  As each record is read from the input it is added to the bottom of the array being constructed.  Not using a loop will result in an incorrect data structure.
 +</WRAP>
 +
  
  
Line 84: Line 93:
     - The lower-level object is displayed in the left-side data structure.     - The lower-level object is displayed in the left-side data structure.
  
-{{:bw:databuilder5.png?600|}}+{{  :bw:databuilder5.png?600  |}}
  
 Here is the resulting JSON that is sent in the API call. Here is the resulting JSON that is sent in the API call.
Line 115: Line 124:
 The output of the main DataBuilder step is used in the API call. This is done by using the “**CumulativeData**” variable from the Main DataBuilder step. An example is shown in the image below. The output of the main DataBuilder step is used in the API call. This is done by using the “**CumulativeData**” variable from the Main DataBuilder step. An example is shown in the image below.
  
-{{:bw:databuilder6.png?600|}}+{{  :bw:databuilder6.png?600  |}} 
 + 
 +====Databuilder Variables==== 
 +^Name         ^ Description          
 +|AddAsArry|True or False if the add as array checkbox is selected| 
 +|CumulativeData|This is the collection of all data that was built in the databuilder| 
 +|Data|This is the last run of data that was entered into the databuilder| 
 +|DataSourceName|This indicates the name of the tool that is being used for the source data for the databuilder| 
 +|DataType|This indicates the type of data your are building XML or JSON| 
 +|ObjectName|Is the name of the top level of your JSON or XML| 
 +|TopLevelElement|True or False if the top level element checkbox is selected| 
 +| StepMessage|During a failure the reason for failure will be populated here | 
 +| StepStatus        |True or False|
  
bw/databuilder_tool.1588863057.txt.gz · Last modified: 2020/05/07 10:50 by runger

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