Defining custom calendars

To define a custom calendar:

  1. Select Configuration > Common > Calendar .
  2. Click New and select Custom Calendar.
  3. Specify this information:
    Name
    The name of the calendar.
    Display Name
    The name to be displayed in the application.
    Status
    The status of the calendar. Possible values:
    • Ready: The calendar is created and can be used.
    • Building: Processes are executed to create the calendar.
    • Invalid: An error occurs when creating the calendar. You can view the details of the error on the Audit Log page.
    • Disabled: The calendar is disabled when the Enabled option is set to Off.
    Enabled
    Indicates whether the calendar is enabled and available for use. Enabled calendars are created. Possible values:
    • On (Active)
    • Off (Inactive)
    Note: 
    • By default, this field is set to Off.
    • If this option is enabled, the calendar is created after processing.
    • If this option is enabled, custom calendars are created whenever code lists are modified.
    Type
    Indicates the calendar type. This value is based on the calendar selected when you click New.
  4. Specify this information in the Code List Details tab:
    Code List
    The code list you defined on the Code Lists page. The code list contains a structure of attributes that can be mapped to the custom calendar. The calendar period of the custom calendar consists of the elements of the selected code list.
    Period Start Attribute
    The code list's attribute that corresponds to the period start date. The attribute Type is set to Date.
    Period End Attribute
    The code list's attribute that corresponds to the period end date. The attribute Type is set to Date.
  5. Click Add on the Level Details tab.
  6. Specify this information:
    Level ID
    A unique identifier of the period level in the calendar hierarchy.
    Attribute
    The code list's attribute that includes the data for this calendar period level.
    Same Period Previous Year Attribute
    The attribute that specifies the period label equivalent to the previous year period elements for the associated level. This value (attribute) is used to calculate the previous year and the next year attributes, for the associated level, for the same period.
    Note:  Calendar period levels must follow the calendar hierarchy. For example, years must appear above months to indicate that each specified month belongs to a particular year.
  7. Click Add. A new level is added to the custom calendar.
    Note: At least, one level must be defined in the custom calendar.
  8. Click Submit to save the calendar. .
    Note: To view the tree structure of a calendar with the status Ready, click Preview in the details pane.