Loading configuration settings

Loading templates allows new configuration data to be added and existing configuration to be updated, if required, using an XML template file.

Templates containing partial data are validated using a combination of the template and existing SCP configuration.

Templates containing data which already exists in the SCP configuration are overwritten (exception elements are excluded).

Exception to overwrite data is based on the predefined entities and the entity properties in the template. This allows the user to modify certain data without reverting the existing data when a template is loaded. However, you can use these options to update the values of exception elements from the template:

  • Reset Display Name
  • Reset Enabled
  • Reset Cycle

Certain entities and elements contain override values. These values are stored in a separate entity and must be loaded after the main template is loaded.

These entities and elements contain override values:

  • Worksheet parameter
  • Plansheet parameter
  • Measure calculation
  • Measure format
  • Multipanel Worksheet panels and panel links
  • Multipanel Plansheet panels and panel links
  • Application Variables
  • Cycle Tags
  • Macro condition

To load configuration settings:

  1. Select Configuration > Maintenance > Load Template.
  2. Specify this information in the Load Template page:
    Select a Template to Import
    The XML file that can be used for configuration settings. Use the File icon to browse and select the required file.
    Note: 
    • The template can be a single XML file or zip file containing XML files.
    • The zip file can include the content.properties file which has the major version and build number information.
    • The import process automatically detects the file type being imported.
    • When the zip template is loaded with the content.properties file, the major version, build number and the zip name from the load template audit log message are added to the Audit log.
    Reset Display Names
    Update the display name with the values in the loaded template. If this option is set to On, the values of these entities are updated:
    Entity Name Field Name
    Measure Display Name
    Standard Worksheet and Plansheets Display Name
    Multiple Worksheets and Plansheets Display Name
    Note: By default, this value is set to Off.
    Reset Enabled
    If this option is set to On, the values of the Enabled option are updated with the values in the loaded template. The values of these entities are updated:
    Entity Name Field Name
    Planning Hierarchies Enabled
    Macros Enabled
    Standard Worksheets and Plansheets Enabled
    Multiple Worksheets and Plansheets Enabled
    Notes Type Enabled
    Note: By default, this value is set to Off.
    Reset Cycle
    If this option is set to On, the values of certain elements in the Cycle are updated with the values in the loaded template., The values of these entities are updated:
    Configuration Screen Field Name
    Cycle - Cycle Details Base Currency
    Cycle - Calendar History Horizon
    Cycle - Calendar Future Horizon
    Cycle - Cycle Process Next Period
    Cycle - Archive Settings Number of cycle periods to retain
    Cycle - Archive Setting Number of Archived cycle periods to retain
    Cycle - Planning Hierarchy Item Hierarchy
    Cycle - Planning Hierarchy Item Hierarchy level for storing Scenario Values
    Cycle - Planning Hierarchy Finance Hierarchy
    Cycle - Planning Hierarchy Demand Hierarchy
    Cycle - Planning Hierarchy Supply Hierarchy
    Cycle - Planning Hierarchy Integrated Hierarchy
    Cycle - Generate Scenario History Generate History for scenario changes
    Cycle - Generate Scenario History Generate History for business metric updates
    Note: By default, this value is set to Off.
    Content Language
    The language in which the file display name can be translated.
    Note: 
    • By default, the value is set to the user's default language if defined in the user settings. Else, the value is set to ‘English’.
    • If the English display name does not exist for a record in the template, the name of the record is displayed as display name.
    • Only one content language is supported for the configuration entities.
    • When translation is not available, the English display name is used.
    • If you reload the existing records with a different content language, the existing display name of all the appropriate records are replaced with the selected language.
    • You must load the configuration files with the required language to change the language of the content used in SCP. Ensure that the Reset Display Names option is set to ON.
  3. Click Import. In the Job Manager window the template loading task is displayed.
    Note: 
    • If there are errors in the template content or in the xml file format, the related error message is displayed.
    • When you submit a template with minor configuration issues, appropriate warning message is logged in the Audit log.
      • Data Source configurations may be loaded without the password or access key fields populated, this will be recorded within the Audit log.
    • On completion of the import of all configuration details available in the template, a successful message is logged in the Audit log.
Related topics