|
Next revision
|
Previous revision
|
bw:workflow_schedules [2019/09/10 09:36]
runger created |
bw:workflow_schedules [2020/12/14 17:19] (current)
akoehler |
| ====== Workflow Schedules ====== | ====== Workflow Schedules Version 2.4 and prior ====== |
| |
| When Bizweaver workflows are in active use (in production), they are many times executed using a **schedule**. This means that they will execute automatically at a defined time. No user action is required. | When Bizweaver workflows are in active use (in production), they are at times 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. |
| To create a schedule for a workflow: | To create a schedule for a workflow: |
| |
| - Open the workflow so that it is currently active. | * 1. Open the workflow so that it is currently active. |
| - Click the //Schedule// link. The link will show when the next execution of the associated schedule is due to occur. | * 2. Click the //Schedule// link. The link will show when the next execution of the associated schedule is due to occur. |
| |
| {{:bw:introimage24.png?244x32}} | {{ :bw:introimage24.png?244x32 }} |
| |
| 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:introimage25.png?318x401}} | {{ :bw:schedulescreen.png? |}} |
| |
| - Enter a **Schedule Name** for the schedule. | * 3. **Schedule Name** Enter a name for the schedule. |
| - This is not mandatory and is only seen in this page. | * This is not mandatory and is only seen on this page. |
| - Enter a **Note** (description) of the schedule as needed. | {{ :bw:schedulename.png? |}} |
| - This is not mandatory but can be helpful in documenting why a particular schedule is being used. | * 4. **Note** A description of the schedule as needed. |
| - Select/enter the **Start Date** and **Start Time** the schedule becomes active. | * This is not mandatory but can be helpful in documenting why a particular schedule is being used. |
| - Select the **Type** of schedule. | {{ :bw:schedulenote.png? |}} |
| - Options are Daily, Weekly, Monthly, and One Time Only. | * 5. **Start Date** and **Start Time** The date and time, the schedule becomes active. |
| - The options in this section change depending on the type of schedule selected. | * {{ :bw:schedulestartend.png? |}} |
| - Daily \\ {{:bw:introimage26.png?209x142}} | * 6. **Type** select the type of schedule. |
| - Weekly \\ {{:bw:introimage27.png?209x265}} | * Options are Daily, Weekly, Monthly, and One Time Only. |
| - Monthly \\ {{:bw:introimage28.png?209x264}} | {{ :bw:scheduletype.png?nolink |}} |
| - **Recurrence** defines how often a workflow should run within a day. | * 7. **Type Menu** The options in this section change depending on the type of schedule selected. |
| - Options are number of hours or minutes. | * Daily \\ {{ :bw:introimage26.png?209x142 }} |
| - If no recurrence is defined, the workflow will execute once at the scheduled time, and then not be executed again until the next scheduled day. | |
| - Expire \\ \\ **Expiration Date** \\ \\ Specify the date this schedule expires. The workflow will automatically stop executing on this this date, based on the time or duration specified. \\ In most cases the expiration year should be set to something in the future, like 2099. Otherwise, the schedule may not be executed as Bizweaver will see it as expired. \\ \\ **Expiration Time** \\ \\ Expiration time is used to define a specific time at which the schedule should end on the specified date. \\ \\ **Expiration Duration** \\ \\ Expiration duration is a different way to define the expiration time. Rather than a specific time, the duration values define the number of hours & minutes past midnight on the ending date that the schedule should be active. \\ \\ For example, assume that the schedule is set run hourly. The expiration date is set to end on 1/31/2017. If the duration is set to 10 hours & 1 minute, the workflow will be executed ten times. This will bring the time to 10:00a. At 10:01a, the schedule will expire and no longer automatically execute. \\ \\ | ---- |
| - Enable | |
| - Select the checkbox to make the schedule active. | * Weekly \\ {{ :bw:introimage27.png?209x265 }} |
| - Clear the checkbox to make the schedule inactive. | |
| - The schedule is ignored if it is not active. | ---- |
| | |
| | * Monthly \\ {{ :bw:introimage28.png?209x264 }} |
| | |
| | ---- |
| | |
| | * 8. **Recurrence** defines how often a workflow should run within a day. |
| | * Options are number of hours or minutes. |
| | * If no recurrence is defined, the workflow will execute once at the scheduled time, and then not be executed again until the next scheduled day. |
| | {{ :bw:schedulerecurrence.png?nolink |}} |
| | * 9. **Expire** The date the schedule expires. There are two different ways you can set a schedule expires. |
| | * **Expiration Date** Specify the date this schedule expires. The workflow will automatically stop executing on this this date, based on the time or duration specified. |
| | * In most cases the expiration year should be set to something in the future, like 2099. Otherwise, the schedule may not be executed as Bizweaver will see it as expired. |
| | * **Expiration Time** Expiration time is used to define a specific time at which the schedule should end on the specified date. |
| | * **Expiration Duration** Expiration duration is a different way to define the expiration time. Rather than a specific time, the duration values define the number of hours & minutes past midnight on the ending date that the schedule should be active. |
| | * For example, assume that the schedule is set to run hourly. The expiration date is set to end on 1/31/2017. If the duration is set to 10 hours & 1 minute, the workflow will be executed ten times. This will bring the time to 10:00 am. At 10:01 am, the schedule will expire and no longer automatically execute. |
| | |
| | {{ :bw:scheduleexpire.png?nolink |}} |
| | |
| | * 10. **Enable** |
| | {{ :bw:scheduleenable.png?nolink |}} |
| | * Select the checkbox to make the schedule active. |
| | * Clear the checkbox to make the schedule inactive. |
| | * **The schedule is ignored if it is not active.** |
| ===== Using VBScript and Decisions to Control Schedule ===== | ===== Using VBScript and Decisions to Control Schedule ===== |
| |
| To accommodate this requirement, we can use VBScript and a Decision in the workflow. | To accommodate this requirement, we can use VBScript and a Decision in the workflow. |
| |
| {{:bw:introimage29.png?576x116}} | {{ :bw:introimage29.png?576x116 }} |
| |
| The VBScript to check the hour is: | The VBScript to check the hour is: |
| The definition of the decision step is shown below. | The definition of the decision step is shown below. |
| |
| {{:bw:introimage30.png?576x99}} | {{ :bw:introimage30.png?576x99 }} |
| |
| Now, if the value = “Y”, the processing will continue. Otherwise, the cycle will end. | Now, if the value = “Y”, the processing will continue. Otherwise, the cycle will end. |
