Differences

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

--- bizweaver:wf_var [2024/09/19 15:50]
dlee
+++ bizweaver:wf_var [2024/09/24 13:54] (current)
dlee [String Manipulation]
@@ Line 3: / Line 3: @@
 Variables are data values that are held in memory during the execution of a workflow. There are two types of variables in Bizweaver: **User Variables** and **Step Variables**.
-To access these variables while in any workflow tool, press F4. This will display the variables menu flyout in the tool window. Workflow steps will be displayed on the right, appearing in the order they are in the workflow. Workflow variables will be displayed under the tool name once the tool is clicked on in the flyout alphabetical order.
+**User Variables** are defined by the user. These values can be defined in the Variables tool or they can be created using the VBScript tool.
-<WRAP center round info 80%>
+**Step Variables** are special references created by the Bizweaver application. Most Bizweaver workflow tools create these variables as the step is executed. An example of this would be a reference to an output column from a SQL/HANA Tool or File Reader step. Bizweaver variables are available to other workflow steps that follow the step where they are created.
-In Bizweaver 2.6.10 and before, the variables selector will be a separate window, but the functionality remains when selecting workflow steps and then associated variables.
+To access these variables while in any workflow tool, click the Variables icon on the toolbar. This will display the Variable Explorer window. Workflow steps will be displayed in the order they are in the workflow. Workflow variables will be displayed under the tool name in alphabetical order.
+  * Use the refresh icon to update the variable in the Variable Explorer as changes are made in the workflow design
+  * Use drag & drop to place variable in your tool configuration.
+{{ :bizweaver:wf_var01.png?300 |}}
+===== Variables Tool =====
+The **Variables** tool can establish constant/static values to be used in the following workflow steps.
+{{ :bw2:bizweavervartool1.png?600 |}}
+  * “Name” is the name of the variable.  This is how it is referenced in the workflow.
+  * "Value" is the actual value represented by a variable. Click on the gray area near the end of a row to open an editing window for the “Value” field.
+  * A variable cannot be deleted if it is used in any workflow.
+Following are examples of using variables.
+====Example 1=====
+In this example, the workflow is being called via the Bizweaver API.  The __name__ expected to come from the calling application is expected to be "vgoRecNum".
+  * **The name is case sensitive**.
+  * The __value__ field is blank because the value to be used will be sent in the API call to Bizweaver.
+{{ :bw2:bizweavervartool2.png?600 |}}
+The variable is then referenced in a subsequent SQL: Reader step.
+  * Any time a variable is referenced using <F4> in a SQL step, the string must be enclosed in single quotes as shown.
+{{ :bw2:bizweavervartool3.png?600 |}}
+====Example 2=====
+In this example, variables are defined for login credentials used at various points throughout the workflow.
+  * In this case, the __values__ are static.  They represent login information used to access the SAP HANA Service Layer API.
+{{ :bw2:bizweavervartool4.png?600 |}}
+The variables are then referenced in a subsequent WebService2 tool step as shown.
+{{ :bw2:bizweavervartool5.png?600 |}}
+====Example 3=====
+<WRAP center round tip 80%>
+Arithmetic calculations can be applied to a numeric variable during workflow execution.
+A calculation using a variable is done by using the “EVAL{}” function in the “Value” of the variable. The calculation can be done against both user and step variables. The calculation is placed within the braces {} as shown in the examples.
 </WRAP>
-To select variables, select the desired tool, click the tool name. This will expand the list and show all available variables from that tool in alphabetical order. Double click on the variable, and it will automatically be inserted into the last place the cursor was in the tool. To close the variable flyout, press the collapse button to the top right of the panel.
+Following is a simple example of how a “counter” calculation is defined. We want to know how many records were passed into a loop from an SQLCommand step in this case. For this example, we will use a simple statement.
+{{ :bw2:bizweavervartool6.png |}}
+The “counter” variable is first defined in the “Variables_Init” step. In this case, the variable is named “ActionCount,” and the initial value is set to zero (0).
+{{ :bw2:bizweavervartool7.png |}}
+The “SQLCommand” step reads a list of data records. This list feeds into a loop.
+<code>
+SELECT
+     [recordNumber] -- This will be a record number from your table that you are using
+FROM
+    [yourTable] -- table you are pulling the recordNumber from
+</code>
+The “counter” variable defined initially is incremented by 1 for each record passed into the loop.
+{{ :bw2:bizweavervartool8.png |}}
+In this process, we are taking whatever value is in “ActionCount” and adding 1 to it. The initial value was zero, so when the first record is processed, “ActionCount” = 0 + 1, so now “ActionCount” = 1. This process continues for each record that is passed into the loop.
+When all records have been read, the loop ends. At this point, the “ActionCount” variable will contain the number of records that were passed into the loop.
+The final step of the workflow writes out a file with the record count information. Below is the file writer step information to write the information to a text file.
+{{ :bw2:bizweavervartool9.png |}}
+===== Step Variables =====
+Step variables are created by Bizweaver and do not require any user action. These variables are available as soon as a step has been executed.
+===== Special Note for Step Variables and Loops =====
+As noted, step variables are created when a step executes. When the step that makes the variable feeds a Bizweaver loop, the same variable's value will change for each loop cycle. Following is an example of this using the workflow shown above. For this example, we will focus on the “CardCode” value.
+The step named “SQL Command_getData” uses the SQL statement:
+<code sql>SELECT CardCode,
+   CardName,
+   CardType
+FROM OCRD
+</code>
+This produces a list of records that feeds into the loop “Loop_ProcessRecords.” The step variable created for “CardCode” is:
+<code>WorkFlow(SQLCommand).Get({FIELD_CardCode})</code>
+This step variable is used in the FileWriter_VariableTest step.
+The list contains the values C1, C2, and C3.
+The first time the file writer sees the step variable, the value will be the first record in the list or C1. Then, when the end of the loop processing is reached, the next record from the list is read.
+When the file writer step sees the same step variable, the next record will be returned from the SQL select statement or C2 received from the loop processing. This cycle continues for each record read into the loop processing.
+==== Example 4 ====
+In this example, we are writing the output of the SQL step to a file.
+Below is the workflow we are using for the example.
+{{ :bw2:bizweavervartool17.png |}}
+Note the fields in the SQL statement that will be referenced later.
-{{ :bw2:bizweavervarmanager1.png |}}
+{{ :bw2:bizweavervartool14.png |}}
-**User Variables** are defined by the user. These values can be defined in the **//[[bw2:using_variables|Variables tool]]//**  or they can be created using the **//[[bw2:vbscript_tool|VBScript]]//** tool.
+Next, you will press [F4] and select the SQL step variables when going to the file writer step.
-**Step Variables** are special references created by the Bizweaver application. Most Bizweaver workflow tools create these variables as the step is executed. An example of this would be a reference to an output column from a SQL/HANA Tool or File Reader step.
+{{ :bizweaver:wf_var02.png |}}
-Bizweaver variables are available to other workflow steps that follow the step where they are created.
+You can see each step variable in the "Body" section of the FileWriter Tool.
-More information is found on the **//[[bw2:using_variables|Using Variables]]//** page.
+{{ :bw2:bizweavervartool16.png |}}
 =====String Manipulation=====
-Starting in Bizweaver 2.7.2, the functionality to modify variables was introduced. This allows a user to manipulate all variables that are inserted in a specific step.
+This allows a user to manipulate all variables that are inserted in a specific step and is accessed by pressing F4
-{{ :bw2:bizweavervarmanager1.png |}}
+{{ :bizweaver:wf_var03.png |}}
   * **Escape:** Selecting this checkbox will enable or disable the escaping functionality.

Wiki

User Tools

Site Tools

Differences

Page Tools