Import Custom Screen Definitions

Use this activity to import custom screen definitions from a JSON or XML file.

Screen definitions can be exported and customised, or exported from another instance, and imported using this activity.

  • A customised application screen refers to an imported application screen whose xml is modified from a core application screen, or newly developed.

  • A personalised application screen is one that is modified using the Open Personalisation functionality.

When a custom screen is imported, the custom screen's Scope is set to User and Scope Value is set to the code of the current user. If such a record already exists, it is replaced (without warning). This allows Search and Detail personalised/customised screens to be individually and separately imported.

For example, if a Search screen is already personalised for Scope = User, ScopeValue = USER1, then:

  • A Detail screen can be imported with Scope = User, and ScopeValue = USER1
  • A Search screen can be imported with Scope = User, and ScopeValue = USER2 or Scope = Lab or Scope = System

with no issues arising from the import.

Tip: It is suggested that a non-production environment is created with test data for testing customised screens before they are put into production.

Activity Steps

  1. Zip customised XML files.
  2. Access the custom CCCSD—Personalisation application from the main menu or quick launch to display the CCCSD—Search Personalisation screen.
  3. From the custom CCCSD—Search Custom Screen Definitions screen, run a trace to access the logs and track the activity associated with the customised application.
  4. Click Import.

    The Import dialog box displays.

  5. Browse for the JSON or ZIP file previously exported using the Export Personalised Screen Definitions activity or customised.
  6. Click OK.

    Note: Any content that fails validation generates error messages and are excluded from the import. The screen must be refreshed to see the imported application screens.

    A JSON file is already in the JSON format, and XML files within the ZIP file are internally transformed to JSON format.

    The customised screens are validated against the same XSD's used to develop the application screen. A difference is detected where:

    • An attribute is changed
    • A new element is added
    • An existing element is removed
    • An existing element is moved into a different existing parent
    • An existing element is moved into a newly-added parent
    • An existing element is moved out of a removed parent
    • An element is moved to a different parent AND its attribute is changed
    • Existing elements are rearranged within the same parent.

    Valid content is imported and the customised screen definition displays in the custom CCCSD—Custom Screen Definitions application under the scope as defined in the screen definition file.

    A resource with a resource type of Application and a resource name matching the new application name is created for each imported screen definition, as displayed in the MSEREA—Resource Authorisation. This resource can be assigned to rights to secure its use.