Maintaining Customised and Personalised Screens

• Maintaining Customised and Personalised Screens
  • Naming a Personalised Screen
  • Changing the Scope of a Personalised or Customised Screen
  • Setting an Alias for a Personalised or Customised Screen Definition
  • Copy a Personalised or Customised screens
  • Activate or Deactivate a Personalised or Customised Screen
  • Exporting and Importing Screen Definitions
  • Deployment Effects on Personalised or Customised Screen Definitions
  • Upgrading Personalised or Customised Screen Definitions
  • Delete Personalised or Customised Screen Definitions
  • Maintenance of Personalised and Customised Screen Layouts
    • Troubleshooting
    • Datamine Support Level

Screens are personalised using the screen personalisation tool or customised to conform work practices with business rules, to supply screen defaults, and to give or limit access to particular functionality.

The CCCSD—Custom Screen Definitions application supercedes, and is a system-scope personalisation of, the MSECSD—Custom Screen Definitions application, supplied in the CCLAS package as it contains improvedservices compared to the MSECSD application, additional search criteria is available to allow the search to return only search or detail pages, and the Change Status dialog has improved usability. The improved services include:

• search—Much faster than the MSECSD application's search as it uses a more efficient approach to determine whether a screen can be upgraded or not (does this during CCLAS deployment and persists the upgradable status), and allows wildcards in the Application Name, Alias and Scope Value search criteria.

• upgrade—Runs an enhanced algorithm to upgrade personalised screens

• upgradeAll—Runs similarly to the MSECSD Upgrade All, except that it upgrades every single personalised page)

• import—Runs a different import to establish correct differences between personalised screens.

  Important: The Upgrade, Upgrade All or Import flows in the MSECSD application SHOULD NOT BE USED as they could corrupt personalised or customised screens, thus rendering them unusable. Instead, use the Upgrade, Upgrade All and Import flows in the CCCSD application to perform all personalised or customised screen upgrades and imports.

  The MSECSD ALL core right is adjusted such that the CUSTOMISATION:UPGRADE, CUSTOMISATION:UPGRADEALL and CUSTOMISATION:IMPORTCUSTOMISATION resources are removed so that the out-dated services are not inadvertently run, and the CCSCREENCUSTOMISATION:SEARCH, CCSCREENCUSTOMISATION:UPGRADE, CCSCREENCUSTOMISATION:UPGRADEALL and CCSCREENCUSTOMISATION:IMPORTDEFINITION resources are added so that the new services can be run.

Important: It is recommended that the custom CCCSD—Custom Screen Definitions application IS NOT MODIFIED because the VEAM installer is coded to overwrite it as part of installation. If modifications are required, a copy of the CCCSD application can be made in another scope and the modifications be made there. Also, be aware that the system-scope CCCSD application should NOT BE UPGRADED in case a future release installation contains a newer version of this personalised screen. This is due to the fact that the custom CCCSD application itself is a customisation of the MSECSD application, so any attempts to upgrade CCCSD application (regardless of scope) is going to be compared against the core MSECSD application instead.

The permission to personalise screens is controlled by the MSECSD ALL core right.

Naming a Personalised Screen

Personalised and customised screens are given a custom name so they can be easily identified. For example, if you have multiple personalisations or customisations of a specific screen, the screens can be given a single custom name so all users can readily identify the screen.

Note: When personalising a search or detail screen, ensure the screens have the same Custom Name.

Changing the Scope of a Personalised or Customised Screen

Personalised or customised screen definitions are applied to all users of a system, or laboratory, or for an individual user. This is referred to as the Scope. The following list is in the order of hierarchy for the scope:

• User—The specified user sees the personalised or customised screen as their default screen.
• Laboratory—Users logged into this laboratory see the personalised or customised screen as their default screen.
• System—users using this system see the personalised or customised screen as their default screen and the original screen cannot be accessed by anyone other than the System Administrator.

Setting an Alias for a Personalised or Customised Screen Definition

You can set an alias (custom name) for a screen definition so that it can be identified easily. For example, there may be multiple personalisations for a specific screen, therefore the screens are each given an alias so that users can readily identify the screens.

Note: When personalising a search or detail screen, ensure the screens have the same Custom Name.

Copy a Personalised or Customised screens

A personalised or customised screen can be copied to create a new screen similar to the existing screen. This can be used to save time and avoid reapplying all personalisations or customisations.

Activate or Deactivate a Personalised or Customised Screen

A personalised or customised screen can be set to active or inactive. If the screen is set to active, the user group within the scope of the personalised or customised application sees this screen as their default screen. If it is set to inactive, the original screen is seen when it is accessed.

Exporting and Importing Screen Definitions

Screen definitions are exported and imported as JSON files where there is a requirement to move the application screen from one CCLAS instance to another, for example, moving personalised/customised application screens from a setup to a test environment. This can be to CCLAS instances that are of the same or higher version. Imported JSON files maintain the screen type of the application, for example personalised or customised.

Screen definitions are exported as XML files in a ZIP file where there is a requirement to customise the screen. Customising screen definitions manually involves modifying the XML file. Refer to Customising Screen Definitions using an XML Editor.

Customised screen definitions are imported from XML files in a ZIP file where there is a requirement to replace or copy an CCLAS existing screen definition, or create a new screen definition. All imported application screens are given a screen type of Customised.

Validation is carried out as part of the pre-import process. If application validation fails, an error message is returned. If the application screen is imported, validation determines if the application screen requires an upgrade.

Core applications cannot be imported.

Deployment Effects on Personalised or Customised Screen Definitions

When deploying a new release to an environment, if there are some underlying changes to the default screens within applications, then these screen changes can potentially be applied to personalised or customised screens by the system administrators.

During CCLAS installation or a personalised screen upgrade, changes in default screen definitions are tracked by the release version. This allows for custom screens to be maintained across upgrades.

When a custom screen definition is upgraded, then:

• The system uses the known differences between core screen definitions across consecutive versions of the core CCLAS screen definition to determine the set of differences that need to be applied to a screen.
• Where a core screen was previously personalised, the known differences between the core screen definition is applied and merged with the personalised screen components.

For example, where a customer is upgrading from 6.6.0.3 to 6.7.1, in total there are four upgrade runs which comprise 6.6.0.3 -> 6.6.0.4, 6.6.0.4 -> 6.7, 6.7 -> 6.7.0.1-HF, and 6.7.0.1-HF -> 6.7.1.

The following tables contain details regarding custom screen definitions, so that differences are identifiable to assist with the custom screen upgrade process:

• MSFCSD—Only contains customised screens, and not the core CCLAS screens, and is updated when a screen is customised.

  Field	Type
  APPLICATION_NAME	String (20)
  SCREEN_NAME	String (7)
  CUSTOM_NAME	String (20)
  SCOPE_TYPE	String (8)
  SCOPE_VALUE	String (255)
  ACTIVE_FLAG	Boolean
  CUSTOM_DATA	CLOB
  LAST_MOD_DATE	Date
  LAST_MOD_TIME	Time
  MODELLED_SCREEN_DATA	CLOB
  LAST_MOD_EMP	String (254)
  LAST_MOD_USER	String (254)
  SCREEN_TYPE	String (1)

• CCCSD—1:1 relationship with the MSFCSD table, but only exists when a screen is upgraded, effectively, an extension of custom screen definitions.

  Field	Type
  APPLICATION_NAME	String (20)
  SCREEN_NAME	String (7)
  CUSTOM_NAME	String (20)
  SCOPE_TYPE	String (8)
  SCOPE_VALUE	String (255)
  PREVIOUS_CUSTOM_SCREEN	CLOB
  VERSION	String (55)
  IS_UPGRADABLE	Boolean

• CCCSDDIFF—Contains the differences between screens from one version to the next.

  Field	Type
  APPLICATION_NAME	String (20)
  SCREEN_NAME	String (7)
  FROM_VERSION	String (50)
  DIFF_CONTEXT	CLOB

• CCVERSION—Contains information about the current installed CCLAS.

  Field	Type
  CCLAS_VERSION	String (20)
  JI_VERSION	String (50)
  RELEASE_DATE	Date-time

A CCLAS deployment updates the following details:

• CCCSD.IS_UPGRADABLE is updated to Y—This process uses a smart search operation that makes use of the new Version strings, for a an efficient search.
• CCVERSION. CCLAS_VERSION is updated to contain the deployed CCLAS version, for example, 6.7.0.1-HF.20499
• CCVERSION.JI_VERSION is updated to contain the deployed JI version, for example, 5.10.0.0_ga_1033
• CCVERSION.RELEASE_DATE is updated to contain the time-stamp of deployment

Upgrading Personalised or Customised Screen Definitions

When a new CCLAS patch or release is deployed, if the application screen definitions have changed, the personalisation or customisation may need to be upgraded to pick up changes from the patch or release.

System administrators can search for screens that require upgrade, and upgrade their custom screens with the core screen changes.

A custom screen upgrade updates the following details:

• CCCSD.PREVIOUS_CUSTOM_SCREEN is updated when a screen is upgraded

The CCCSD—Custom Screen Definitions application is used to search for custom screens to view those that require an upgrade. The upgrade can be applied to all or selected custom screens that require upgrade, to make them compatible with the latest CCLAS release.

Delete Personalised or Customised Screen Definitions

Personalised or customised screens can be deleted if they are no longer used.

Maintenance of Personalised and Customised Screen Layouts

CCLAS screen definitions for personalised or customised CC and MSE screens are maintained using the CCCSD—Custom Screen Definitions application.

Initial personalisation occurs at a user level but can be changed using the CCCSD—Custom Screen Definitions application.

If you have permissions to personalise a screen, the personalisation applies to you only. No other user can view or access the personalised screen unless the System Administrator applies the personalisation to users at district or system level.

The CCCSD—Custom Screen Definitions application can only be accessed and managed by the System Administrator or an employee who is given security access to manage personalisations.

Application screen definitions are exported in either JSON or XML.

JSON files take on the filename MSECSD-export.json

XML files take on the filename MSECSD-customised-screens.zip.

All imported applications are imported with the scope user and the user's scope value.

If a personalised or customised application already exists in the system, neither application can be reimported.

Troubleshooting

Customised applications screens are not supported, but xml developers can use CCLAS trace functionality to capture a trace and download a zip file containing the various logs and the monitoring.csv file. These files provide the developer with the same functionality that is used by CCLAS developers when developing application screens.

Note: Only original core and personalised screens are supported. If a support call is raised on a customised screen, all customisations must be removed to confirm if the defect still exists without the customisation.

Datamine Support Level

The following are not supported by Datamine:

• Customised applications development is not supported. While this information is provided by Datamine, there is no phone, email or other related support supplied for developers.
• Customised applications are not supported. While customised applications can be developed and imported into CCLAS environments the customised application screens are not supported.

There is no guarantee that customised application screens work in future releases. While they may work, there may also be a requirement for changes to the application screen for it to work in other releases of CCLAS.