Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Building a Workflow • downloads • contact • Introduction (GraphqL)
bw2:building_a_workflow

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
bw2:building_a_workflow [2021/03/03 14:14]
akoehler [Workflow Variables] 		bw2:building_a_workflow [2024/01/05 10:28] (current)
wgates [Workflow Design]
Line 10: Line 10:
 The following pages contain additional information about the specific components used to construct Bizweaver workflows. The following pages contain additional information about the specific components used to construct Bizweaver workflows.
  
-    * **[[bw2:bizweaver_general_settings|General Settings]]**+  * **[[bw2:bizweaver_general_settings|General Settings]]**
   * **[[bw2:workflow_tools|Workflow Tools]]**   * **[[bw2:workflow_tools|Workflow Tools]]**
   * **[[bw2:crystal_reports_tool|Crystal Reports Tool]]**   * **[[bw2:crystal_reports_tool|Crystal Reports Tool]]**
Line 27: Line 27:
 ===== General Workflow Rules ===== ===== General Workflow Rules =====
  
 +  * Each workflow should have a unique name.
 +    * The application will assign a default name, "Untitled," but we recommend that you change the name to something that helps you understand the step's purpose.
   * Each workflow step must have a unique name.   * Each workflow step must have a unique name.
-    * The application will assign a default name "Untitled", but we recommend that you change the name to something that helps you understand the step's purpose. 
  
 ===== Basic Information ===== ===== Basic Information =====
 +====2.6====
  
 {{ :bw2:bizweaverbuildingaworkflow2.png |}} {{ :bw2:bizweaverbuildingaworkflow2.png |}}
  
   * See the General Workflow Rules above.   * See the General Workflow Rules above.
-  * It is not necessary to have the workflow-enabled initially. The workflow can be executed in test mode during the development process. However, it will need to be enabled to use the “Run now” or scheduled options.+  * It is not necessary to have the workflow-enabled initially. The workflow can be executed in test mode during the development process. However, it will need to be enabled to use the “Run” or scheduled options.
   * Enter any Notes about the workflow. This information can be updated at any time.   * Enter any Notes about the workflow. This information can be updated at any time.
-  * Click the “Save” button {{ :bw2:bizweaverbuildingaworkflow3.png |}} at the bottom of the workflow designer+  * Click the “Save” button {{:bw2:bizweaverbuildingaworkflow3.png|}} at the bottom of the workflow designer
  
-===== Build a New Workflow =====+====2.7====
  
 +{{ :bw2:bizweavernewribbon0.png |}}
 +
 +====2.9====
 +
 +{{ :bw2:2_9_bizweavernewribbon.png |}}
 +
 + * See the General Workflow Rules above.
 +  * It is not necessary to have the workflow-enabled initially. The workflow can be executed in test mode during the. development process. However, it will need to be enabled to use the “Run” or scheduled options.
 +  * Enter any Notes about the workflow by clicking {{:bw2:bizweavernewribbon2.png|}}. Will open a new window, clicking "X" will close the window and save all options. Clicking cancel will discard all changes.
 +    *  {{ :bw2:bizweavernewribbon3.png |}}
 +      * 1. **Workflow Name:** The name of the workflow, can be modified on the ribbon or in this window.
 +      * 2. **Notes:** Workflow notes.
 +      * 3. **Folder:** The folder a workflow is saved in, double click on the folder to select it. 
 +      * 4. **+ Folder:** Creates a new folder
 +  * Click the “Save” button {{:bw2:bizweavernewribbon1.png|}} at the bottom of the workflow designer.
 +
 +===== Build a New Workflow =====
 <WRAP center round info 80%> <WRAP center round info 80%>
 Workflows are constructed using drag-and-drop functionality. Click and hold the left mouse button on the tool icon you want to place on the design pane. Drag the icon to the point where you want it and release the mouse button to “drop” it in place. This same process is used to re-order icons in a workflow on the canvas. Workflows are constructed using drag-and-drop functionality. Click and hold the left mouse button on the tool icon you want to place on the design pane. Drag the icon to the point where you want it and release the mouse button to “drop” it in place. This same process is used to re-order icons in a workflow on the canvas.
 </WRAP> </WRAP>
  
- +  * Begin by dragging the next tool onto the design pane.
-  * Begin by dragging a Start point onto the canvas. +
-  * Drag the next tool onto the design pane.+
     * A connector line is automatically added to show the link between the two steps.     * A connector line is automatically added to show the link between the two steps.
   * Continue adding tools as needed.   * Continue adding tools as needed.
   * The workflow should always contain a Stop/Endpoint.   * The workflow should always contain a Stop/Endpoint.
 +    * You can no longer drag and drop to add a tool to a workflow with an End tool present.
 +    * There are two ways to add a tool to a workflow if an End tool is present
 +      * Right-click on the tool in the design canvas and select "Create Link From," and when the next tool is dropped into the design area, it will be linked from that tool.
 +      * Delete the End tool in the workflow and add it once the modifications are finished.
  
 <WRAP center round tip 60%> <WRAP center round tip 60%>
Line 58: Line 79:
  
 ===== Bizweaver Tools Pane ===== ===== Bizweaver Tools Pane =====
-{{ :bw2:bizweaverbuildingaworkflow21.png |}}+{{ :bw2:2_9_tool_pane.png |}} 
 The tools used to construct Bizweaver workflows are found in this area. They are added to a workflow by dragging them from the Tools area into the Design area. See the **//[[bw2:workflow_tools|Workflow Tools]]//** page for descriptions of the tools. Details on each of the tools are found in other Bizweaver documents. The tools used to construct Bizweaver workflows are found in this area. They are added to a workflow by dragging them from the Tools area into the Design area. See the **//[[bw2:workflow_tools|Workflow Tools]]//** page for descriptions of the tools. Details on each of the tools are found in other Bizweaver documents.
  
Line 73: Line 95:
 Bizweaver version 2.5 and above, the ability to click and drag within the design pane grid was added. Bizweaver version 2.5 and above, the ability to click and drag within the design pane grid was added.
 </WRAP> </WRAP>
-{{ :bw2:bizweaverbuildingaworkflow23.png |}} 
- 
-===== Description Window ===== 
- 
-The description window can be opened when right-clicking on a tool and selecting "Show Description". This will open a window with any notes associated with the step entered into the tool description box. To close, click the "X" in the right corner of the description box. This will also contain the results of a test run. If you close the test run results, you can reopen the last run by selecting the "Last Run" link next to the test run button. 
- 
-{{ :bw2:bizweaverbuildingaworkflow24.png |}} 
  
 +{{ :bw2:2_9_Desinger.png |}}
 ===== Adding Steps to an Existing Workflow ===== ===== Adding Steps to an Existing Workflow =====
  
Line 141: Line 157:
  
 In this view, the workflow steps are presented in the sequence in which they will be executed. In this view, the workflow steps are presented in the sequence in which they will be executed.
 +
 +====Continue On Error====
 +
 +Continue on error if selected will allow a workflow to process past a step that had an error.
 +
 +====Breakpoint====
 +
 +More information on Breakpoints [[bw2:test_run_tool|**here**]]
  
 ====== Workflow Variables ====== ====== Workflow Variables ======
Line 146: Line 170:
 “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**. “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. Workflow tool will be displayed on the left, appearing in the order they are in the workflow. Workflow variables will be displayed on the right in alphabetical order. +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. 
  
-To select variables, select the desired tool, select the variable in the tool then press save. It will automatically be inserted into the last place the cursor was in the tool.+<WRAP center round info 80%> 
 +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. 
 +</WRAP>
  
-{{ :bw2:bizweaverbuildingaworkflow22.png |}}+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. 
 + 
 +{{ :bw2:bizweavervarmanager1.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. **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.
Line 160: Line 188:
 More information is found on the **//[[bw2:using_variables|Using Variables]]//** page. More information is found on the **//[[bw2:using_variables|Using Variables]]//** page.
  
 +
 +======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.
 +
 +{{ :bw2:bizweavervarmanager1.png |}}
 +
 +  * **Escape:** Selecting this checkbox will enable or disable the escaping functionality.
 +    * Only one of these can be selected at once, and they only apply in the step in which they are enabled.
 +    * **JSON:** Selecting this will escape reserved characters for a JSON file. See the table below for more information.
 +      * This will generally be used in a Databuilder step 
 +    * **XML:** Selecting this will escape any reserved characters for an XML file. See the table below for more information.
 +      * This will generally be used in a Databuilder step
 +    * **SQL:** Selecting this will escape reserved characters for SQL Server see table below for more information
 +  * **Replace empty values with NULL:** This will take any empty strings or blanks ex '' and replace it with NULL
 +    * This works independently of the Escape functions.
 +
 +^**JSON Reserved Character**     ^**Explanation**                                ^**Escaped Value**^
 +|Backspace                   |A backspace in any text in a string           |\b|
 +|Form feed                   |Advanced to the next page                     |\f|
 +|Newline                     |A new line in a string                        |\n|
 +|Carriage return             |A carriage return in a string                 |\r|
 +|Tab                         |A tab in a string                             |\t|
 +|"                           |A double quote                                |\"|
 +|\                           |A backslash                                   |\\|
 +
 +^**XML Reserved Character**     ^**Explanation**                             ^**Escaped Value**^
 +|<                             |Less than sign                              |&lt;|
 +|>                             |Greater than sign                           |&gt;|
 +|&                             |Ampersand                                   |&amp;|
 +|"                             |Double quote                                |&quot;|
 +|'                             |Single quote                                |&apos;|
 +
 +^**SQL Reserved Character**     ^**Explanation**                             ^**Escaped Value**^
 +|'                             |Single quote                                |\'|
  
  
bw2/building_a_workflow.1614798853.txt.gz · Last modified: 2021/03/03 14:14 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