This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
bw:bizweaver_application_overview [2020/12/14 17:15] akoehler [Icon Bar] |
bw:bizweaver_application_overview [2020/12/15 14:14] (current) akoehler [Related Pages] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Introduction (Bizweaver) ====== | ||
| + | |||
| + | This set of pages provides an overview of the Bizweaver data integration application. | ||
| + | ====== Audience ====== | ||
| + | |||
| + | This document is intended for developers of Bizweaver workflows. | ||
| + | ====== Related Pages====== | ||
| + | |||
| + | The following pages contain additional information about the specific components used to construct Bizweaver workflows. | ||
| + | |||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | * **[[bw: | ||
| + | ====== General Overview ====== | ||
| + | |||
| + | The Bizweaver application is set of tools used to automate data acquisition, | ||
| + | |||
| ======Bizweaver Application Overview====== | ======Bizweaver Application Overview====== | ||
| The Bizweaver application home screen consists of six areas. | The Bizweaver application home screen consists of six areas. | ||
| {{bw: | {{bw: | ||
| - | - **//[[bw:application_introduction#Icon Bar|Icon Bar]]//** | + | - **//[[bw:bizweaver_application_overview#Icon Bar|Icon Bar]]//** |
| - | - **//[[bw:application_introduction#Explorer Area|Workflow folders pane/ | + | - **//[[bw:bizweaver_application_overview#Explorer Area|Workflow folders pane/ |
| - | - **//[[bw:application_introduction#Workflow list pane|Workflow list pane]]// | + | - **//[[bw:bizweaver_application_overview#Workflow list pane|Workflow list pane]]// |
| - | - **//[[bw:application_introduction#Bizweaver tools pane|Bizweaver tools pane]]// | + | - **//[[bw:bizweaver_application_overview#Bizweaver tools pane|Bizweaver tools pane]]// |
| - | - **//[[bw:application_introduction#Workflow design pane|Workflow design pane]]// | + | - **//[[bw:bizweaver_application_overview#Workflow design pane|Workflow design pane]]// |
| - | - **//[[bw:application_introduction#Task Counter|Active task counter]]// | + | - **//[[bw:bizweaver_application_overview#Task Counter|Active task counter]]// |
| ====== Icon Bar ====== | ====== Icon Bar ====== | ||
| Line 90: | Line 118: | ||
| The Workflow List pane displays a list of workflows in the folder selected in the Folders pane. | The Workflow List pane displays a list of workflows in the folder selected in the Folders pane. | ||
| - | {{bw: | + | {{ bw: |
| * Workflow Enabled/ | * Workflow Enabled/ | ||
| Line 107: | Line 135: | ||
| * Schedule | * Schedule | ||
| * Name of the schedule associated with this workflow. | * Name of the schedule associated with this workflow. | ||
| - | * See // | + | * See // |
| * Next Schedule | * Next Schedule | ||
| * Date & time this workflow is next scheduled to execute. | * Date & time this workflow is next scheduled to execute. | ||
| Line 124: | Line 152: | ||
| ===== Workflow Design Pane ===== | ===== Workflow Design Pane ===== | ||
| - | This area is the “design area” where a workflow is constructed. See the following sections of this document form more information. Click **// | + | This area is the “design area” where a workflow is constructed. See the following sections of this document form more information. |
| <WRAP center round tip 60%> | <WRAP center round tip 60%> | ||
| Line 135: | Line 163: | ||
| As noted earlier, your license controls the number of active (enabled) tasks you may have. The right-hand number indicates the number of licensed workflows. The left-hand number indicates the number of workflows that are currently enabled. | As noted earlier, your license controls the number of active (enabled) tasks you may have. The right-hand number indicates the number of licensed workflows. The left-hand number indicates the number of workflows that are currently enabled. | ||
| + | |||
| + | ====== Building a Workflow ====== | ||
| + | |||
| + | It is strongly recommended that prior to constructing a workflow you spend some time reviewing your requirements, | ||
| + | |||
| + | Details for building a workflow are found **// | ||
| + | |||
| + | ====== Execute a Workflow ====== | ||
| + | |||
| + | There are three methods to execute a Bizweaver workflow: test/debug mode, “run now,” and scheduled. The results are the same for all methods. | ||
| + | |||
| + | ===== Test/Debug Mode ===== | ||
| + | |||
| + | The Bizweaver **Test Run Tool** allows a developer to execute a workflow in a step-by-step manner. Variable values can be examined at each step to confirm that they are what is expected. More information on this tool is found **// | ||
| + | |||
| + | ===== Run Now ===== | ||
| + | |||
| + | The “Run Now” option is used to execute a workflow while in Bizweaver. There are two ways to use this option. | ||
| + | |||
| + | First, the currently active workflow can be executed by clicking the “Run now” link as shown below. | ||
| + | |||
| + | {{ : | ||
| + | |||
| + | Second, right-click on any workflow in the Workflow List area, and select the “Run now” option. | ||
| + | |||
| + | In both cases, the workflow is executed immediately. No feedback is provided while the workflow is executing (as seen in the Test Run tool). | ||
| + | |||
| + | ==== Run Now Log ==== | ||
| + | |||
| + | At the end of the execution a “Task Execution Status” window is automatically displayed showing the log information for the workflow. | ||
| + | |||
| + | {{ : | ||
| + | |||
| + | In general, you will only need to scan the log records for information in the “Message” column. These will typically be error messages that may need attention. | ||
| + | |||
| + | Click on the //Open Log File// link to open a text file of log information. This file will have more technical information and can be saved for further review. | ||
| + | |||
| + | Click the [**Close & Delete Log Records**] button to delete the log information from the Bizweaver logging table, and close the window. | ||
| + | |||
| + | Click the [**Close**] button to close the window. An additional dialog will allow you to delete the log records here as well. | ||
| + | |||
| + | Note that the log records can be retained if desired. This can be helpful if you are doing reporting from the Bizweaver log table. See **// | ||
| + | |||
| + | ===== Scheduled Execution ===== | ||
| + | |||
| + | Bizweaver workflows can be automatically executed based on a schedule. This is the most common, and most efficient, way to execute workflows. See **// | ||
| + | |||
| + | ====== Workflow 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**. | ||
| + | |||
| + | **User Variables** are defined by the user. These values can be defined in the Variables tool or they can be created using the **// | ||
| + | |||
| + | **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 Command: Reader step. | ||
| + | |||
| + | Bizweaver variables are available to other workflow steps that follow the step where they are created. | ||
| + | |||
| + | More information is found on the **// | ||
| + | |||
| + | ====== Bizweaver Activity Logging ====== | ||
| + | |||
| + | As noted earlier in this document, actions from the Test Run tool are logged in text files. However, when a schedule executes a workflow, or using the “Run now” option, step information is logged to the SQL database used by Bizweaver. | ||
| + | |||
| + | Transaction logging data is found in the table **VGO_SYNC_PROC_LOG**. An entry is made for each workflow step that is executed. In addition to workflow and step information, | ||
| + | |||
| + | The log table can be accessed via SQL Management Studio or from a report in Versago. Following is a SQL Select statement to access this information. | ||
| + | |||
| + | <code sql> | ||
| + | select | ||
| + | |||
| + | t0.JobID, t0.TaskID, t1.TaskName, | ||
| + | |||
| + | from vgo_sync_proc_log t0 | ||
| + | |||
| + | inner join VGO_SYNC_TASKS t1 on t0.TaskID = t1.TaskID | ||
| + | </ | ||
| + | The log information for a specific workflow can also be accessed using the “View Job Log” function described in the “Icon Bar” section of this document. | ||