Planning

The Planning module allows users to create, manage, and monitor plans for the automatic one-time or repeated execution of processes. This module provides essential functionality for defining processes, setting schedules, assigning owners, and tracking the execution of processes according to the defined plans.

The module is accessible to users with the $Administrator role, who have the authority to define and manage plans.

Key Features

  • Process Definition: Specify which process should be executed.
  • Scheduling: Define the time frame and frequency for process execution.
  • Ownership Assignment: Assign an owner (initiator) for the executed cases.
  • Monitoring: Track the execution of processes based on the defined plans.

Plan Management

Plans can be managed through the "Planning" in left-menu, which provides an overview of all plans and their attributes.

Attributes of a Plan

Each plan contains the following attributes:

  • Case Template: The template from which the case will be executed.
  • Plan Guarantor: The user responsible for the correct definition of the plan.
  • Plan Name: A user-defined name for the plan.
  • Start Date/Time: The date and time when the plan should be executed for the first time.
  • Status: The current status of the plan:
    • Active: The plan is initially set up. After the first execution, the status changes to "Running."
    • Inactive: The plan is not active.
    • Running: The plan is running according to the defined schedule.
    • Not Running: Retained for historical reasons; currently equivalent to the "Inactive" status.
    • Completed: The plan has been completed based on the defined repetition settings.
  • Repetition Type:
    • Never: The plan is executed once.
    • Daily: The plan can be executed every X day of the month or every working day.
    • Weekly: The plan is executed every X week on a specific day of the week (Monday...Sunday).
    • Monthly: The plan is executed every X day of every X month or on the 1st, 2nd, 3rd, 4th, or last specified day of the week (Monday...Sunday) in every month.
    • Yearly: The plan is executed every X year, on a selected date, or on the 1st, 2nd, 3rd, 4th, or last specified day of the week (Monday...Sunday) in a selected month (January...December).
  • Additional Repetition Parameters (Not available for the "Never" repetition type):
    • End: Define the end condition as "after X occurrences," "by a selected date," or "Unlimited."

Plan History

Each plan includes a history section where users can view previously executed plans. The history provides details about the executed cases, with the option to navigate to the specific case initiated by the plan.

Plan Operations

Creating a New Plan

  1. Click the Add button in the top-right corner of the screen.
  2. Fill in the values for each field according to the plan attributes.
  3. Confirm the settings by selecting Save in the specific menu. To cancel, select Close.

Editing a Plan

  1. Select the plan you want to edit.
  2. Open the Edit Plan form by clicking the Edit icon.
  3. Modify the values of the fields according to the plan attributes.
  4. Confirm the changes by selecting Save in the specific menu. To cancel, select Close.

Deleting a Plan

  1. Select the plan you want to delete.
  2. Click the Delete icon.
  3. Confirm or cancel the deletion in the pop-up window.

Export Functionality

All tables in the Planning module can be exported to Excel or CSV format using the Export icon located in the bottom-right corner of the screen.

Roles and Permissions

  • $Administrator: Has full permissions to define, edit, delete, and monitor plans.

Notes

  • Plans can be set to run automatically based on the defined schedules.
  • The status of a plan is updated automatically after each execution.
  • Historical data is retained for reference and auditing purposes.

Anna Gernát Updated by Anna Gernát

Users

Contact

Syca (opens in a new tab)

Powered by HelpDocs (opens in a new tab)