Administer > Time Period Management > Time period configuration tasks > Configure time period global settings

Configure time period global settings

Administrators can configure some global settings for the Time Period Management module. This configuration includes updating or deleting existing settings and adding new settings.

To configure time period settings, follow these steps:

  1. Click Time Period Management > Administration > Settings.

    The Time Period Settings form opens, in which the Module and Area fields are auto-populated with these values: Timeperiod, and Timeperiod Configuration.

  2. Specify the settings on the form, as described in the following table.

    Attribute Description Validation
    Time period category group-by fields (comma separated) The fields by which the time period categories are grouped when users creates a new time period definition. Maximum: 4 fields
    Time period category sort-by fields (comma separated) The fields by which the time period categories are sorted when users creates a new time period definition. Maximum: 4 fields
    Link for copy The link record used to copy the fields from the current record to the target. The default link is timeperiodDefinition.copy. None
    Copy options for Rules and Occurrences

    These are the options when users copy time period definitions:

    • Do not copy Rules/Occurrences
    • Copy Rules only
    • Copy Rules/Occurrences
    None
    Lock Rules once approved

    If this option is set to true, users cannot edit or delete their rules anymore when time periods are approved and then return to the first phase of the workflow. Users can only deactivate or activate the rules.

    If this option is set to false, users can always edit or delete their rules as long as time periods are in the first phase.

    Note A time period rule reflects the recurrence of future start and end times of the time period occurrences. A time period rule stores all the recurrence patterns.

    For more information, see Time period recurrence rules.

    None
    Maximum number of occurrences before a rule expires

    The maximum allowed value for the Expires after field in which the user enters the number of recurrences within a time period rule.

    For more information, see Create a time period.

    No greater than 100
    Maximum number of months for calculating future occurrences The number of months to calculate future occurrences. Maximum: 12 months

    The default value (12) is recommended for best performance.

    Number of occurrences for initial display

    The maximum number of occurrences that are displayed when users view a time period definition.

    Maximum: 100
    Force activity entry for occurrence status changes If this option is selected, users are required to give an explanation when changing the status of an occurrence. The explanation is logged in the activity log. None
    Disable the Pop-up Window to warn time period conflicts

    If this option is set to true, the time period conflicts warning is displayed in system message.

    If this option is set to false, a window is opened to warn time period conflicts.

    None
    Send an email notification to the time period owner when the conflicting change is approved If this option is selected, an email will be sent to the time period owner of a freeze window when the conflicting change is approved. None
  3. Click Save.

To add a new time period setting, follow these steps:

  1. Click Time Period Management > Administration > Settings.

    The Time Period Settings form opens.

  2. Click More or the More Actions menu, and select Add New Setting.

    The New Setting Information wizard opens.

  3. Compete the following fields, and click Next.

    Field Name Description Example Value
    Setting Id

    Specify an ID for the setting.

    Note Once saved, the setting ID becomes non-editable.

    categoryGroupBy
    Display Label Enter a display name of the setting. Time period category sort-by fields
    Description Enter a description of the setting.  
    Setting Type

    Select a type from the list:

    • Number: a numeric field.
    • String: a String field.
    • Date/Time: a Date/Time field.
    • Boolean: a Boolean field. A check box will appear before the display label.
    • Manual List: a list of options.
    • Global List: a global list.
    • Record
    • Condition
    String
    Mandatory Indicates if this setting is mandatory. Not selected
  4. If the setting requires validation, enter a validation script; otherwise leave it empty.
  5. Click Finish.
  6. Open Time Period Settings from the navigator. The new setting now appears on the form.

To edit or remove an existing time period setting, follow these steps:

  1. Click Time Period Management > Administration > Settings.

  2. Click More or the More Actions menu, and select Edit Settings.

    A wizard opens.

  3. Click the Setting Id of the setting you want to edit or remove.
  4. Update the field values as needed, and click Finish.
  5. If you want to remove the setting, click Remove This Setting.