| Back | Main view

IMiS/wClient - Changing the help view

Product:IMiS/wClient
Release:1.7.2110
Date:06/13/2022

Case: IMiS/wClient - Changing the help view

Description:

This example demonstrates changing the help view on the IMiS/wClient.

The help view settings are defined in the settings.json, where they can be defined in the element help.

Below is a description of settings.json configuration for changing the help view.

settings.json

help
- links: Collection of help links.

help.links item
- label: The link label.
- url: The link URL.
- archives: Collection of archive identifiers.
- members: Collection of directory entities.
- context: Link context (optional). The set of values:
  - ARCHIVE,
  - MY_ENTITIES,
  - DRAFTS,
  - DIRECTORY,
  - REVIEWS,
  - EXPORT,
  - IMPORT,
  - DELETED,
  - DISPOSED,
  - QUEUE,
  - LOGIN,
  - PROFILE,
  - REPORTS.
- type: Link display type. Default value: TAB. The set of values:
  - TAB,
  - DIALOG,
  - CURRENT.

help.link item.label
If only one language is defined, the link will be displayed only for specified language.
- en: English link label.
- sl: Slovenian link label.


Example of changing the help view

settings.json configuration has 2 help links:
- Knowledge base link is displayed in dialog, for context "ARCHIVE", for all archives and all members.
- imis.si link is displayed in new tab, for all contexts, all archives, all members.
- Contact us link opens email application to send new email, for all contexts, iarc102 archive and all members.

settings.json
{
  "url": "<IMiS/Storage Connector Services REST - URL>",
  "request_timeout": 240000,
  "help": {
    "links": [
      {
        "label": [
          "en": "Knowledge base",
          "sl": "Baza znanja"
        },
        "url": "http://d2.imis.eu/imaging4notes.com/imiskb.nsf/All?OpenView&Start=1",
        "type": "DIALOG",
        "context": ["ARCHIVE"]
      },
      {
        "label": [
          "en": "imis.si",
          "sl": "imis.si"
        },
        "url": "https://www.imis.si"
      },
      {
        "label": [
          "en": "Contact us",
          "sl": "Kontakt"
        },
        "url": "mailto:support@acme.com",
        "archives": ["iarc102"]
      }
    ]
  }
}


Help menu preview

Help menu preview with context ARCHIVE.



Help menu login preview

Help menu preview with context LOGIN.


Help dialog preview

Knowledge base link is displayed in dialog.




Related Documents:

Database 'IMiS Knowledge database', View 'All Documents', Document 'IMiS/wClient 1.7.2110' IMiS/wClient 1.7.2110

| Back | Main view