Skip to main content

Customize risk instructions

Write your own guidance for people entering risk data. The text appears in the Instructions panel on the Data tab of an Internal Control System (ICS) risk or a Business Impact Analysis (BIA) risk — opened with View Instructions. For ICS risks, the risk's category decides which text appears, so each category can carry its own instructions. All BIA risks share one set of instructions, whatever their category.

Prerequisites​

  • Administrator access to Admin → Customization.
  • Instructions display only on ICS and BIA risks, so the matching Early Access feature must be enabled for users to see them: ICS Style Risks for ICS risks — see ICS risks — and BIA Risk Data Type, available on iGrafx Cloud, for BIA risks — see BIA risks.
  • For ICS instructions, the ID of the risk category the instructions are for. Find it in the Repository area under Risks → Risk Categories — for example FINANCIAL.

Steps​

  1. Go to Admin → Customization and select the Localization Properties tab.
  2. Select Add New Property.
  3. Enter the property name:
    • For ICS risks, igrafx.risks.instructions. followed by the risk category ID — for example igrafx.risks.instructions.FINANCIAL.
    • For BIA risks, igrafx.risks.instructions.business_impact_analysis. This one property applies to every BIA risk.
  4. Enter a placeholder string in the selected language and save. The property turns into a text area.
  5. Type the instructions into the text area, as plain text or markdown (CommonMark — headings, bold, italic, links, lists, blockquotes, horizontal rules, and code). Resize the text area to see more of the text.
  6. Click outside the text area to save your changes.

The Localization Properties tab with a risk instructions property and its markdown content in the text area.

To translate the instructions, switch the language selector above the property list and enter the text again for that language.

Verify​

Open an ICS risk whose category matches the property, or any BIA risk, select the Data tab, and select View Instructions. The panel shows your text with the markdown rendered. A risk with no matching instructions property shows "Nothing added yet" instead.

The Instructions panel on an ICS risk's Data tab rendering the customized markdown instructions.