Context sensitive JSON format

Context sensitive help is imported via a JSON file. You can create a JSON file with help content in the format described in this section and import it to provide help for your customized user interface.

The JSON file contains a list of objects with the following fields:

• [{"Context_Id":"SAG_BQ_Gov_Focus_General",
• Context_View":"SAG_BQ_Gov_Focus,SAG_Governance_Focus",
• Context_ViewType":"",
• "Context_Class":"",
• "Context_Priority":"1",
• "Context_Heading":"How can this business question help me?",
• "Context_Images":"",
• "Context_Content":"<p>The business question What should we be focusing on? shows the first- and second-level business capabilities in the business capability model and indicates which ones are most critical and which are less critical to the business. Each second-level business capability displays the aggregated number of as-is applications currently supporting it and to-be applications planned to support it. The business capabilities subordinate to the second-level business capabilities are not displayed but are included in the data source and calculation of application support. The business question helps your company to decide which applications to invest in, migrate, or divest based on the relevance of the business capabilities they support.<\/p>"
• },
• {"Context_Id":"SAG_Governance_Focus_Color",
• "Context_View":"SAG_BQ_Gov_Focus,SAG_Governance_Focus",
• "Context_ViewType":"",
• "Context_Class":"",
• "Context_Priority":"2",
• "Context_Heading":"What do the colors mean?",
• "Context_Images":"Images/Buttons/purple.png,Images/Buttons/green.png",
• "Context_Content":"<p>The business capabilities are colored according to the value defined for the Business Relevance attribute of a business capability. The most critical business capabilities are shades of purple <img src=\"Images/Buttons/purple.png\" alt=\"example of purple business capability\"\/>. The less critical business capabilities are shades of green <img src=\"Images/Buttons/green.png\" alt=\"example of green business capability\"\/>.<\/p>"

• Context_Id: A unique ID to identify the help text on update. Only alpha-numeric characters, hyphens, and underscores are allowed.
• Context_View: The technical name of the view the help should be displayed for. You can list multiple views in a comma-separated format.
• Context_Priority: An integer in the range of 1 to 11 determining the position of the text in the list of context-sensitive help texts. The lower the number, the higher in the list the text is displayed. Texts with the same priority are displayed in alphabetical order.
• Context_Heading: The heading displayed when the help text is collapsed.
• Context_Images: A comma-separated list of images linked in the Context_Content field. Images must be specified with the path to the image relative to the language folder. If you use the standard documentation https://documentation.alfabet.com , the path must be define starting with the folder name after https://documentation.alfabet.com/en/Context_Links: A comma-separated list of links targeting the Alfabet web-based online help. Links to any other website must not be listed in this field. The URL defined in the Overview > Help Server in the server alias of the Alfabet Web Application is added in front of every link target listed in this field. Links to external websites should not be listed here.
• Context_Content: The help text in HTML format. The following syntax is required:
  • HTML must be JSON-compliant: All double quotes and slashes must be escaped with a backslash. Linebreaks are not allowed.
  • Image elements give the path to the image relative to the language folder. If you use the standard documentation https://documentation.alfabet.com , the path must be define starting with the folder name after https://documentation.alfabet.com/en/ . The image must be listed under the same path and name in the Context_Images field.
    • "Context_Images":"Images/Buttons/red.gif,Images/Buttons/green.gif",
    • "Context_Content":"<p>Depending on the severity, the object is displayed with a green bubble <img src=\"Images/Buttons/green.gif\" alt=\"example of green bubble\"\/> or a greenred bubble <img src=\"Images/Buttons/red.gif\" alt=\"example of red bubble\"\/>.<\/p>"
  • Links to the web-based help start page should start with the file name in the language folder or the path to the file in the language folder. During runtime, the URL will be created from the help server link from the server alias of the Alfabet Web Application amended with the specification given in the HTML link. The same link target as specified in the href attribute of the HTML link must be listed in the Context_Links field
    • "Context_Links":"GettingGS_Search.html",
    • "Context_Content":"<p>For more details, see <a href=\"GS_Search.html\">Search for Objects<\/a> in the online help.<\/p>"
  • Links to external websites should provide the complete URL to the target website and shall be defined to open in a new tab with the noopener and noreferrer security settings:
    • "Context_Content":"<p>For information about Software AG, see <a href=\"https://www.alfabet.com\" target=\"_blank\" rel=\"noopener noreferrer\">the Alfabet home page<\/a><\/p>.