Calendar Management - Calendar Deployment

Introduction

The JOC Cockpit Resources / Calendars view has import and export functions to allow reliable Calendar deployment, for example, from an Integrations System (Int.) to a Production System (Prod.).

In general, such a deployment will involve 3 steps:

1. Export of the Calendar from the Int. JOC Cockpit to the Int. file system, where the Calendar will be saved as a JSON file.
2. Transfer of the JSON calendar file to the Production file system.
3. Import of the JSON calendar file to the Production JOC Cockpit with automatic integration into the Production JOC Cockpit Daily Plan.

Details of the deployment procedure will depend on two factors:

1. Whether a Calendar is to be deployed on the Prod. system for the first time or whether an existing Calendar on the Prod system is to be updated.
2. Whether a Calendar is to be deployed on its own or whether it is to be deployed with information from the Int. system about the Orders or stand-alone Jobs which have been configured to use the Calender.

Note that Calendars are always exported with usage and folder information - i.e.:

• With information about the Orders or stand-alone Jobs which the Calender has been assigned to and the Run-time information (Period and Restrictions).
• With the Calendar Path parameter ... ADD SUMMARY

"New" Deployment of a Calendar

Consider the situation where a new Calendar has been tested and is now to be deployed to a production environment.

• The new Calendar can have ... TO COMPLETE
• on the Int. system has the same Path parameter as will be required on the Prod. system.

Export Procedure

Calendar Export is carried out from the Resources / Calendars view of the JOC  Cockpit:

• The Calendar or Calendars to be exported are selected using the select boxes shown either in the Calendar Cards or at the left of the list of Calenders (as shown in the screenshot below).
  
• Selecting a first Calendar will cause the default Import Calendar button (shown in the screenshot above) to be replaced with the Export Calendar button as shown in the next screenshot.
  
• Clicking the the Export Calendar button will open a standard browser file-saving menu that is then followed to save the Calendar(s) selected as a single .json file to the Int. file system. This file can now be transferred to the Prod. file system.
• In the configuration used for the screenshots the impexp_cal_sat Calender is assigned to two Orders on the Int. system and the impexp_cal_sun Calender is not assigned to any Order. Both Calenders are none-the-less exported in the .json file.

The exported .json file is shown in the listing below:

{
  "calendars": [
    {
      "path": "/demo/calendar/import-export/cal_mo-fr",
      "type": "WORKING_DAYS",
      "category": "e2e",
      "title": "Cal Mon-Fri",
      "from": "2017-12-16",
      "to": "2017-12-31",
      "includes": {
        "weekdays": [
          {
            "days": [
              1,
              2,
              3,
              4,
              5
            ]
          }
        ]
      },
      "usedBy": {
        "jobs": [],
        "orders": [],
        "schedules": []
      }
    },
    {
      "path": "/demo/calendar/import-export/cal_sat",
      "type": "WORKING_DAYS",
      "category": "e2e",
      "title": "Cal Sat",
      "from": "2017-12-16",
      "to": "2017-12-30",
      "includes": {
        "weekdays": [
          {
            "days": [
              6
            ]
          }
        ]
      },
      "usedBy": {
        "jobs": [],
        "orders": [
          "/demo/calendar/import-export/job_chain1,impexp_1",
          "/demo/calendar/import-export/job_chain1,impexp_2"
        ],
        "schedules": []
      }
    },
    {
      "path": "/demo/calendar/import-export/job_chain1,impexp_1",
      "basedOn": "/demo/calendar/import-export/cal_sat",
      "type": "ORDER",
      "periods": [
        {
          "singleStart": "12:00:00",
          "whenHoliday": "suppress"
        }
      ],
      "includes": {}
    },
    {
      "path": "/demo/calendar/import-export/job_chain1,impexp_2",
      "basedOn": "/demo/calendar/import-export/cal_sat",
      "type": "ORDER",
      "periods": [
        {
          "singleStart": "21:00:00",
          "whenHoliday": "suppress"
        }
      ],
      "includes": {}
    }
  ],
  "deliveryDate": "2017-12-16T12:16:36.922Z"
}

Import Procedure

The Import procedure is started in the Resources / Calendars view of the target system by simply clicking the Import Calendar button (any folder can be selected in the Folder Tree) as shown in the screenshot below.

Deployment of a Calendar Update

Consider the situation where a Calendar is already in use in a production environment and requires to be updated.

A typical scenario would be where the Calender is to be extended for a further year and the holidays for that year added.