This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
bw2:workflow_schedules_new [2020/12/15 14:22] akoehler created |
bw2:workflow_schedules_new [2024/01/08 12:08] (current) wgates [Notes Tab] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Workflow Schedules Version 2.5 and after ====== | ====== Workflow Schedules Version 2.5 and after ====== | ||
| - | When Bizweaver workflows are in active use (in production), | + | When Bizweaver workflows are active use they can be executed using a **schedule**. This means that they will execute automatically at a defined time. No user action is required. |
| A schedule is created by selecting the desired combination of options as described below. If both the schedule and the workflow are enabled, the workflow will execute automatically at the appropriate time. | A schedule is created by selecting the desired combination of options as described below. If both the schedule and the workflow are enabled, the workflow will execute automatically at the appropriate time. | ||
| Line 9: | Line 9: | ||
| To create a schedule for a workflow: | To create a schedule for a workflow: | ||
| - | * 1. Open the workflow | + | * 1. Open the workflow. |
| - | * 2. Click the // | + | * 2. Activate the workflow. |
| + | * 3. Click the // | ||
| - | {{ :bw:introimage24.png? | + | {{ :bw2:bizweaverschedules1.png |}} |
| * The Schedule information window opens. This is where the schedule for this workflow is maintained. | * The Schedule information window opens. This is where the schedule for this workflow is maintained. | ||
| - | {{ :bw:schedulermain.png? | + | {{ :bw2:scheduler.png |}} |
| - | * 3. **Status** Indicates if schedule is on or off. | + | * 3. **Status** Indicates if the schedule is on or off. |
| * **Schedule will not run if off is selected** | * **Schedule will not run if off is selected** | ||
| * 4. **Schedule Type** | * 4. **Schedule Type** | ||
| * **Recurring** - defines the occurrence of a workflow over multiple days | * **Recurring** - defines the occurrence of a workflow over multiple days | ||
| * **Single Day** - defines the occurrence of a workflow on a single day | * **Single Day** - defines the occurrence of a workflow on a single day | ||
| - | * When running a One-Time schedule the scheduler display will change, and only one date can be selected | + | * When running a One-Time schedule, the scheduler display will change, and only one date can be selected. This will be the date the schedule runs. Below are the tabs that will be displayed for modification. |
| - | * [[bw: | + | |
| - | * [[bw: | + | |
| - | * [[bw: | + | |
| * 5. **Save Schedule** | * 5. **Save Schedule** | ||
| * This will save the schedule and the workflow. | * This will save the schedule and the workflow. | ||
| * The Save workflow compiler will open once this button is clicked. | * The Save workflow compiler will open once this button is clicked. | ||
| * 6. **Close** | * 6. **Close** | ||
| - | * This will close the schedule and no changes will be saved. | + | * This will close the schedule, and no changes will be saved. |
| * 7. **Message** | * 7. **Message** | ||
| - | * This message will show the first run of the schedule based on current setting. | + | * This message will show the first run of the schedule based on the current setting. |
| - | * This message will display on the [[bw: | + | * This message will display on the **[[bw: |
| ====== Schedule Tab ====== | ====== Schedule Tab ====== | ||
| * 1. **Start Date** and **End Date** define when the schedule starts and ends. | * 1. **Start Date** and **End Date** define when the schedule starts and ends. | ||
| * Start Date will default to the current date. | * Start Date will default to the current date. | ||
| - | * When a pre-existing schedule is opened, the start date will reflect the current date. This will be the new start date when the schedule is saved (it cannot be back dated). If Cancel is selected or the scheduler window is closed, the start date will remain | + | * When a pre-existing schedule is opened, the start date will reflect the current date. This will be the new start date when the schedule is saved (it cannot be back-dated). If Cancel is selected or the scheduler window is closed, the start date will remain. |
| * No End Date option is used if you do not want the schedule to have a set end date. | * No End Date option is used if you do not want the schedule to have a set end date. | ||
| - | {{ :bw:schedulerstartend18.png? | + | {{ :bw2:bizweaverschedules3.png |}} |
| * 2. **Recurring** select the type of schedule. | * 2. **Recurring** select the type of schedule. | ||
| * Options are Daily, Weekly, Monthly. | * Options are Daily, Weekly, Monthly. | ||
| - | {{ :bw:schedulerrecurring19.png? | + | {{ :bw2:bizweaverschedules4.png |}} |
| * 3. The options in this section change depending on the type of schedule selected. | * 3. The options in this section change depending on the type of schedule selected. | ||
| - | * **Daily** \\ {{ :bw:schedulerdaily.png? | + | * **Daily** \\ {{ :bw2:daily.png|}} |
| ---- | ---- | ||
| - | * **Weekly** \\ {{ :bw:schedulerweeks.png?nolink | + | * **Weekly** \\ {{ :bw2:weekly.png? |}} |
| ---- | ---- | ||
| - | * **Monthly** \\ {{ :bw:schedulermonthly.png?nolink | + | * **Monthly** \\ {{ :bw2:monthly.png? |}} |
| * Day Option - Can select a day within a month to run for a select interval of months. | * Day Option - Can select a day within a month to run for a select interval of months. | ||
| * **Example** the 1st day of Every 1 Month will run once a month on the first day of that month. | * **Example** the 1st day of Every 1 Month will run once a month on the first day of that month. | ||
| - | * The Option - Can select the First, Second, Third, | + | * The Option - Can select the First, Second, Third, |
| - | * The Weekday selection can only be used in conjunction with First and Last options within this menu. | + | * The Weekday selection can only be used in conjunction with the First and Last options within this menu. |
| ====== Run Times Tab ====== | ====== Run Times Tab ====== | ||
| * 1. **Run At** defines a specific time a schedule should run during a day. | * 1. **Run At** defines a specific time a schedule should run during a day. | ||
| - | {{ :bw:runtimestabrunat.png?nolink | + | {{ :bw2:runat.png? |}} |
| * 2. **Run Continuously** defines a schedule running all day during the selected schedule type. | * 2. **Run Continuously** defines a schedule running all day during the selected schedule type. | ||
| - | {{ :bw:runtimestabrunevery.png?nolink | + | {{ :bw2:continuously.png? |}} |
| * 3. **Run Every** defines a schedule running during a set interval of time | * 3. **Run Every** defines a schedule running during a set interval of time | ||
| * Can run schedules from 12:00 AM to 11:59 PM | * Can run schedules from 12:00 AM to 11:59 PM | ||
| - | * Bizweaver uses the indicated interval period (ex. 5 mins, 12, mins, 20 minutes, i.e. whatever the user enters) calculated | + | * Bizweaver uses the indicated interval period (ex. 5 mins, 12 mins, 20 minutes, i.e., whatever the user enters) calculated from the selected From time to determine the actual first run of the workflow within the selected From-To range. |
| * The From and To times can only be selected within a given date and cannot span multiple dates/days | * The From and To times can only be selected within a given date and cannot span multiple dates/days | ||
| - | * **Example: | + | * **Example: |
| - | * **Important Note:** From/To ranges are inclusive of the last hour in the range. In the above example the 7 min interval will continue through the 4:00 AM hour. | + | * **Important Note:** From/To ranges are inclusive of the last hour in the range. In the above example, the 7 min interval will continue through the 4:00 AM hour. |
| * **Minutes** - Can choose from 5 to 59 minutes as an interval | * **Minutes** - Can choose from 5 to 59 minutes as an interval | ||
| - | * Note the interval period cannot be longer than the From To period | + | * Note the interval period cannot be longer than the From-To period |
| * **Hours** - Can choose from 1 to 23 hours as an interval | * **Hours** - Can choose from 1 to 23 hours as an interval | ||
| - | * Note the interval period cannot be longer than the From To period | + | * Note the interval period cannot be longer than the From-To period |
| * **Do Not Run Between** - defines a period that the workflow will not run within any given schedule. | * **Do Not Run Between** - defines a period that the workflow will not run within any given schedule. | ||
| - | {{ :bw:runtimestabrunevery1.png?nolink | + | {{ :bw2:runevery.png?|}} |
| ====== Exclusions Tab ====== | ====== Exclusions Tab ====== | ||
| Line 82: | Line 83: | ||
| * Clicking the add button adds another exclusion. | * Clicking the add button adds another exclusion. | ||
| * When the exclusion date has passed the " | * When the exclusion date has passed the " | ||
| - | {{ :bw:exclusions.png?nolink | + | {{ :bw2:exclusion.png? |}} |
| ====== Notes Tab ====== | ====== Notes Tab ====== | ||
| This tab allows notes to be entered for a schedule. | This tab allows notes to be entered for a schedule. | ||
| - | {{ :bw:schedulernotes24.png? | + | {{ :bw2:notes.png |}} |
| - | ====== Notifications Tab ====== | + | ====== Notifications Tab (2.7.8) |
| + | |||
| + | <WRAP center round tip 60%> | ||
| + | Notifications for On Start and On Completion have now been moved to the Notifications Panel starting in Bizweaver 2.7. | ||
| + | </ | ||
| Notifications can be sent to a designated email address when a workflow has started or ended. Up to 3 email addresses can be designated. | Notifications can be sent to a designated email address when a workflow has started or ended. Up to 3 email addresses can be designated. | ||
| Line 93: | Line 98: | ||
| The act of restarting the Bizweaver Service triggers these email notifications to be sent for all enabled workflows. | The act of restarting the Bizweaver Service triggers these email notifications to be sent for all enabled workflows. | ||
| </ | </ | ||
| - | {{ :bw:email.png? | + | {{ :bw2:bizweaverschedules13.png |}} |
| * 1. **Send Notifications To** | * 1. **Send Notifications To** | ||
| * Email - This checkbox enables or disables the notifications | * Email - This checkbox enables or disables the notifications | ||
| - | * If email addresses are left in the email address box and notifications are disabled the email address will be retained | + | * If email addresses are left in the email address box and notifications are disabled, the email address will be retained |
| * Send Email Using - defines the SMPT connection to be used for sending the emails. | * Send Email Using - defines the SMPT connection to be used for sending the emails. | ||
| * Email Address - defines the email that will receive the notification. | * Email Address - defines the email that will receive the notification. | ||
| * Add Another - the user can add up to 3 email addresses. | * Add Another - the user can add up to 3 email addresses. | ||
| * 2. **Send Notifications** | * 2. **Send Notifications** | ||
| - | * When workflow starts - this will send an email immediately after the workflow starts. | + | * When the workflow starts - this will send an email immediately after the workflow starts. |
| * When workflow ends - this will send an email immediately after the workflow finishes. | * When workflow ends - this will send an email immediately after the workflow finishes. | ||