Create a Custom Card in Lenel Console


 
Create a Custom Card in Lenel® Console
 

  • Procedure Steps
     
    Use the following procedures to create a custom card on Lenel Console for a third-party module or app. This card can launch a URL in the browser.
     
    Important: Only the attributes and options described below are supported for user-created cards.
     

    Basic Configuration of the Card, including the English language text

    1. On the OnGuard Server, go to C:\ProgramData\Lnl\Console\modules.
    2. Inside the modules folder, create a new sub-folder and name it using the name of the module or app being added to Lenel Console.
      Note: The folder name must be all lowercase and cannot contain any spaces or special characters.
    3. In the new sub-folder, use a text editor to create a config.json file.
    4. In the new config.json file, add the following text and modify as needed:
      {
      ...."url": "/mymodule",
      ...."weight": 100,
      }
    5. Modify the attributes as needed:
      Attribute Type Required/Optional Description
      url   string Required Enter the relative or absolute URL path for the module/app.
      weight integer Optional This attribute controls the default order in which cards appear on Lenel Console. Cards with higher weight values appear first until and unless cards are rearranged in the browser.
    6. In the sub-folder, add a new sub-folder called locales.
    7. In the locales sub-folder:
      1. Create a sub-folder called en for the default language of English.
      2. Create a translation.json text file. This file contains the actual file name.
    8. In the translation.json file, add the following text and modify as needed:
      {
      ...."name": "My Module",
      }
      Note: To ensure any special characters (for example, ® or Ô) appear correctly on Lenel Console, save the translation.json file with UTF-8 encoding. Do not save the file using ANSI/ASCII encoding.
    9. To see the custom card on Lenel Console, refresh the page or go to https://:8080 ("hostname" = address of the OnGuard OpenAccess server). If the card does not appear on Lenel Console, make sure the LS Module Manager service is running.
    Note: If necessary, clear the browser cache on each client workstation to see the new card on Lenel Console.
     

    Create Locale-specific Translation of the Card Text

    1. In the locales folder, create additional sub-folders, one for each language, as needed.

    2. Name the sub-folders using the supported language codes:Arabic: ar-SA

      • Chinese Simplified: zh-CN
      • Chinese Traditional: zh-CHT
      • Croatian: hr
      • Czech: cs-CZ
      • Dutch: nl-NL
      • Finnish: fi-FI
      • French: fr-FR
      • German: de-DE
      • Hebrew: he
      • Italian: it-IT
      • Japanese: ja-JP
      • Korean: ko-KR
      • Lithuanian: lt
      • Polish: pl
      • Portuguese: pt-BR
      • Romanian: ro
      • Russian: ru-RU
      • Spanish: es
      • Swedish: sv-SE
      • Turkish: tr
    1. Inside each sub-folder, add a translation.json file and modify it as needed:
      {
      ...."name": "My Module",
      }
      Note: Do not change the name of the translation.json file.
    2. To see the custom card on Lenel Console, refresh the page or go to https://:8080 ("hostname" = address of the OnGuard OpenAccess server). If the card does not appear on Lenel Console, make sure the LS Module Manager service is running.

    Note: If necessary, clear the browser cache on each client workstation to see the new card on Lenel Console. 


  • Applies To
     
    OnGuard 7.3 and OnGuard 7.4
    Lenel Console
     
    Note: In OnGuard 7.5 and later, this functionality is available within the Lenel Console. For more information, refer to the Lenel Console online help.
     
     

  • Additional Information
     
    None