An Event Based Package Schedule allows you to run several Event Based schedules at the same time. It also allows you to determine the timing and order of execution of the Event Based schedules in the package.
How do I create Event Based Package in PBRS?
Step 1: Navigate to Event Based Package.
General Wizard
Step 2: Complete the Information on the General Wizard
- Package Name: The name of the package.
- Create In: The PBRS folder where the package is stored.
- Description (optional): You may write a short description to help other users identify exactly what this schedule is and what it is expected to do.
- Keyword (optional): Enter some keywords which can be used later by Smart Folders to identify this schedule.
Step 3: Click Next to continue to the next wizard section.
Schedule Wizard
In this section, you will decide when the report will execute. There are a variety of options.
Step 4: Complete the scheduling frequency section with the desired settings.
In this section, you will decide when the report will execute. There are a variety of options:
- Daily: Run a report every day or at a frequency of days.
- Sub options: Repeat every X Days.
Example: Run the schedule every 3 days.
- Weekly: Run a report on a weekly time frame.
- Sub options: Repeat every X weeks.
Example: Run the schedule every 2 Weeks.
- On: Select the specific days of the week the schedule will run. If only once a week,select only the day of the week it will run.
Example: Run every Monday, Wednesday, and Friday.
- Week Days: Run the schedule Monday through Friday.
- Working Day: Run the schedule starting on a specific day of the month. Indicate which day of the month the schedule will run. E.G. run the schedule on the 4th working day of the month.
- Monthly: Run the schedule on a monthly time frame.
- Use the following options: Checking this box will enable you to select frequency options such as the “last Thursday of the month.” Also you can include or exclude specific months from the schedule.
- Annual: Run the schedule every year at a specified time.
- Custom Calendar: Select the custom Calendar you wish to use. You can create a new custom calendar from the menu as well. Please see Custom Calendars for more information.
- Other: Other scheduling options.
- Run Schedule every X Minutes, hours, days, weeks, months, years.
- None: No scheduling is required for this item.
- Start Date: Enter the desired starting date for the schedule. This section can be the current date (providing schedule time has not already passed) or a date in the future.
- End Date: If the schedule is due to end after a certain date enter that here. If the schedule is to run indefinitely, then leave it blank.
- Schedule time: On the Next Run date, the package will run at this time.
- Exception Calendar: Choose a calendar that will instruct the schedule to NOT run on those specified days. Please see Custom Calendars for more information.
- Next to run on: The package will next run on this date.
- Repeat Every: Rerun the package every x minutes from the scheduled time until your specified time.
For example, you can set up a daily package to run every day at 8 am, and to run every hour until 5 pm.
- Until: After this date, there will be no automated scheduling of this package.
- Enable this Schedule: Uncheck this option to Disable the package. Disabled packages are not deleted, but they do not execute automatically. You can re-start the automatic scheduling at a later date by checking this option again. Or right-clicking this schedule from the main screen and selecting Enable.
Step 5: Click Next to continue to the Schedules section in the Wizard.
Schedules Wizard
Step 5: In this section, add as many Event Based schedules to the package as required.
Step 6: Click Add to choose one or more already existing Event Based schedules or create a new Event Based Schedule directly from here so that it can be added to the package.
New Reports
- Display a screen where you can create a new reports schedule.
- To add a new Event Based Report, click here.
Existing Schedules
- Displays a list of existing schedules in PBRS for you to choose from.
Step 7: Navigate to the folders that store the required event based schedule(s). Click on the required schedule and click OK to add it to the package. Repeat steps6 & 7 this until all the required schedules have been added to the package.
Step 8 (Optional): Once all the Schedules have been added they will execute in the order in which they appear on screen. If you want to change the order, simply click on a schedule that you would like to move and use the up and down arrows to move it up and down the list.
Step 9: Click Next to continue to the Custom Tasks Section of the wizard.
Custom Tasks Wizard
Step 10: In the section you have the option of setting up Custom Tasks. Custom tasks are business process automation tools that can be auto triggered before or after a report runs. Simply navigate to the task you would like to set up and drag & drop to the right hand side of the screen. This will automatically open the Configuration screen for the selected task.
If you have no Custom Tasks to set up you may skip this step and click Next to continue to the Execution Path section of the Wizard.
- Edit: Select a Custom Task and click Edit to change it's properties. Or simply double-click on the Custom Task.
- Delete: Select a Custom Task and click delete to remove it.
- Green Up and Down Arrows: Once your Custom Tasks have been created you may want to change the order in which they appear on the screen. Highlight the Custom Tasks you wish to move up or down the list and click on the arrows to do so until the desired list order has been achieved. The order that they appear on the screen will be the order in which they are executed.
- Import: If you already have a default Custom Task List created you may import it using this option.
- Export: If you wish to create a Default Task list from the tasks created here, simply click on the Export button, give the task list a name, when prompted and it is ready to be used again and again in other schedules.
- For more information on Custom Tasks, click here
Execution Path Wizard
Step 11: If you have schedules AND tasks being executed as part of the event based schedule you can determine the order in this section.
- For Example:
Run Schedules then the Custom Actions
OR
Run the Custom Actions first, then the schedules, the run the Custom Actions again.
Step 12: Once you have chosen the execution order, click Finish to save the information and complete the Schedule set up.
Event Based Package Schedule Context Menu
Right-Click on a schedule to see the following actions:
- Properties: Edit the schedule from here. Or you can just double click on the schedule.
- Add Schedule: You may add new reports or existing.
- Copy: Use this to copy an existing schedule. You can then paste it into another folder or the same folder. Simply open the folder you wish to paste to, right-click in the "white" space and select "Paste". Follow the on-screen instructions to complete the process.
- Paste: Paste a previously copied schedule.
- Rename: Rename a schedule.
- Enabled: Schedules are enabled when there is a check beside this option. To stop a schedule from running, or to "pause" it for a while, select this option to remove the check. Disabled schedules will not run till they are enabled again.
- Move: Use this option to move the report into an existing package.
- Open: This will open the package and show its constituent reports.
- Execute: This button will execute the schedule immediately. Note that the next run date and time is not moved on as a result of a manual execution. They only move on if the schedule is run automatically by one of the schedulers .
- Delete: Selecting this option will delete the schedule.
- Execute On: Use to option to execute the schedule to another collaboration server.
- Split Package: This will split all the constituent reports in the package.
This process will automatically delete the package once the splitting process is completed.
- Create Shortcut: Use this option to create a shortcut you can save in any location on your PC. Execute the shortcut to execute the schedule in PBRS.
Event-Based Package Properties
- To access your schedule properties, right click on a schedule and select properties.
- Similar to the schedule wizard, you adjust settings to your schedule such as timing, error handling, or custom tasks.
- General
- Schedule
- Schedules
- Tasks
- Execution Path
- Sharing: Here you can share this schedule with multiples users.
- History: Review the schedules history. Successes, failures, and other data is located here.
