| Back | Main view

Product:	IMiS/wClient
Release:	1.7.2110
Date:	12/17/2021

Case:

IMiS/wClient - Changing the display of metadata

Description:

This example demonstrates changing the display of metadata in "Details" tab on the IMiS/wClient.

Changing the display of metadata in the "Details" tab is possible in the settings of the file settings.json, where the user can define which metadata will be displayed and which hidden, and the display order, which matches the order in the configuration.

Below is a description of settings.json configuration for changing the display of metadata in "Details" tab.

settings.json

details
- profiles: Collection of display profile items.
- display: Collection of display items.

details.profiles item
- id: Profile identifier.
- filter_type: Type of attribute filter. The set of values:
  - Include: certain attributes will be displayed.
  - Exclude: certain attributes will not be displayed.
- attributes: Collection of attributes. If filter_type = Include, the order applies.
- sections: Collection of displayed sections. If this element has not been defined, all sections are displayed. The set of values:
  - more,
  - retention,
  - versions,
  - references.

details.display item
- profile: Profile identifier from details.profiles.id.
- templates: Collection of templates to which the profile applies. If this element has not been defined or is empty, it applies to all templates.
- members: Collection of directory entities of type user or group. The "subject" or "alias" is defined for the user. If a group has been defined, the setting applies to all members.
- archives: Collection of archives. If this element has not been defined or is empty, it applies to all archives.


Example of changing the display of metadata in settings.json

settings.json configuration has 2 details profiles:
- display_profile_1 includes attributes "sys:SecurityClass", "sys:Description", "sys:Title" and section "more",
- display_profile_2 excludes attribute "sys:Description" and displays all sections.

settings.json configuration has 2 details display items:
- kclay has defined "display_profile_1", on templates "Class" and "Case", on archive "iarc102s",
- admin has defined "display_profile_2", on templates "Class" and "Case", on archive "iarc102s".

settings.json
{
  "url": "<IMiS/Storage Connector Services REST - URL>",
  "request_timeout": 240000,
  "details": {
    "profiles": [
      {
        "id": "display_profile_1",
        "filter_type": "Include",
        "attributes": [
          "sys:SecurityClass",
          "sys:Description",
          "sys:Title"
        ],
        "sections": [
          "more"
        ]
      },
      {
        "id": "display_profile_2",
        "filter_type": "Exclude",
        "attributes": [
          "sys:Description"
        ]
      }
    ],
    "display": [
      {
        "profile": "display_profile_1",
        "templates": [
          "Class",
          "Case"
        ],
        "members": [
          "kclay"
        ],
        "archives": [
          "iarc102s"
        ]
      },
      {
        "profile": "display_profile_2",
        "members": [
          "admin"
        ],
        "templates": [
          "Class",
          "Case"
        ],
        "archives": [
          "iarc102s"
        ]
      }
    ]
  }
}

Keira Clay (kclay) "Details" tab

Keira Clay uses "display_profile_1", which includes attributes "sys:SecurityClass", "sys:Description", "sys:Title" and section "more" for entity template "Class".



Administrator (admin) "Details" tab

Administrator uses "display_profile_2", which excludes attribute "sys:Description" and displays all sections for entity template "Class".






Related Documents:

 IMiS/wClient 1.7.2110

| Back | Main view