11.1 Customizing Identity Governance

Use the following information to customize Identity Governance for your environment.

11.1.1 Customizing the Name in the Identity Governance Application

You can change the name that the authorized users see when they access the Identity Governance application through a web browser. The default name is NetIQ. You can change this name during the installation. You can change the name during the installation of Identity Governance or you can change it after the installation using the Identity Governance Configuration utility.

  1. Access the installation directory for the utility from a command prompt as a user with root access on a Linux server or administrative privileges on a Windows server. The default installation directory is:

    • Linux: /opt/netiq/idm/apps/idgov/bin

    • Windows: c:\netiq\idm\apps\idgov/bin

  2. From the command line, enter:

    • Linux: ./configutil.sh -password database_password

    • Windows: configutil.bat -password database_password

  3. Click the IG Server Details tab.

  4. In the Product Name field, add the name you want to appear.

  5. Click Save to save the changes.

11.1.2 Localizing the Preferred Language of the User

Identity Governance localizes the attributes and email text according to the preferred language of the user. The following is a list of the languages Identity Governance automatically localizes:

  • Chinese Simplified

  • Chinese Traditional

  • Czech

  • Danish

  • Dutch

  • English

  • French

  • German

  • Hebrew

  • Italian

  • Japanese

  • Norwegian

  • Polish

  • Portuguese

  • Russian

  • Spanish

  • Swedish

Identity Governance cannot always reconcile the differences in language that occur when different users collect data and run reports on that collection. For example, a user in Spain runs a collection for a set of data. Then a user in Russia runs a report against that collection. The fields in the report appear in Russian since that is the report user’s default language. However, the reported data is in Spanish because the collection occurred on a computer with Spanish as the default language.

You can customize the content in the provided languages. Alternatively, you can apply a new language to Identity Governance and OSP.

11.1.3 Customizing the User Interface

Identity Governance and OSP automatically display content in the user interface according to your preferred language. You can customize content such as attribute names and informational messages using a text editor.

You might customize the content if your organization requires special terminology for some or all attributes. For example, you might refer to user ID as account name. You can change all instances of user ID in the catalog.

For more information about translating the content to a new language instead of customizing it, see Section 11.1.4, Translation Content for Identity Governance and One SSO Provider.

Customizing the Labels in the Identity Governance Interface

Some organizations might want to customize the default names for the attributes, risk levels, and navigation items in Identity Governance. The .properties file for customizing this content is available from the Identity Governance interface, rather than a .jar file.

To customize the labels:

  1. Log in to Identity Governance as a Global Administrator.

  2. Select Configuration > Localization Import and Export.

    Identity Governance lists the .properties files by language.

  3. For the language that you want to customize, select Download.

    Depending on your browser settings, you might be prompted for the download path.

    NOTE:If prompted, do not rename the .properties file. Identity Governance cannot upload a file that does not match the expected name.

  4. In a text editor, customize the displayed text for the attributes that you want to change.

    For example, you want to change all instances of user ID to account name. When you search for user ID, you will find the following type of string:

    com.netiq.iac.persistence.ops.AttributeDefinition.USER.userID=User ID from source

    Change User ID from Source to Account Name from Source.

    WARNING:Do not modify any text in the code string before the = sign. For example, com.netiq.iac.persistence.ops.AttributeDefinition.USER.userID=. Identity Governance might not function appropriately if you change the code string incorrectly.

  5. Save and close the file.

  6. To submit the modified file, select Upload for the language that you customized.

  7. Refresh the browser window to view the changes.

    NOTE:Depending on the browser settings, you could need to sign out of Identity Governance, clear the cache in the browser, and then log in again.

Customizing Strings in the Properties Files

By editing the various .properties files in the Identity Governance and OSP .jar files, you can customize the content displayed in the Identity Governance Configuration utility, as well as most of the Identity Governance and OSP interface.

Customizing Strings for the Configuration Utility

If you want to use different terminology in the Identity Governance Configuration utility, you can do so by editing .properties files.

To customize strings for the Configuration utility:

  1. Log in to the server where you installed Identity Governance.

  2. Navigate to the /opt/netiq/idm/apps/idgov/localization directory.

  3. Copy the iac-configutil-strings.jar to a temporary directory.

    For example: opt/netiq/idm/apps/work

  4. Extract the iac-configutil-strings.jar, making sure to maintain folder structure.

    For example: /opt/netiq/idm/apps/work/com/netiq/iac/config/util/

  5. Navigate to the com/netiq/iac/config/util directory.

  6. Perform the following steps to create a new .properties file:

    1. Rename the existing IacConfigUIstringsRsrc_en.properties file to org-IacConfigUIstringsRsrc_en.properties.

    2. Create a new, empty IacConfigUIstringsRsrc_en.properties file.

  7. Perform the following steps to modify specific strings:

    1. Use a text editor to open the org-IacConfigUIstringsRsrc_en.properties file.

    2. Find the properties that you want to modify.

      For example, the labels Bootstrap Admin and Bootstrap File Details, which appear on the Authentication Server Details tab in the Configuration utility:

      FILE_DETAILS_TITLE=Bootstrap File Details

      BOOTSTRAP_ADMIN_TITLE=Bootstrap Admin

    3. Copy the properties into the empty IacConfigUIstringsRsrc_en.properties file.

    4. Modify the string values, which appear after the equal sign.

      For example:

      FILE_DETAILS_TITLE=Default Admin File Details

      BOOTSTRAP_ADMIN_TITLE=Default Admin

    5. Save and close the file.

  8. (Optional) Repeat Step 6 through Step 7 for each language you want to modify.

  9. Navigate to the folder from which you extracted the iac-configutil-strings.jar file.

    For example: /opt/netiq/idm/apps/work

  10. Create a custom .jar file that contains only the .properties files you modified.

    For example: jar -cMf my-configutil-strings.jar com/netiq/iac/config/util/IacConfigUIstringsRsrc_en.properties

  11. Copy the custom .jar file to the /opt/netiq/idm/apps/idgov/lib directory.

    NOTE:Be sure to set the correct permissions and ownership of the .jar file.

  12. Navigate to the /opt/netiq/idm/apps/idgov/bin directory, and perform the following steps:

    1. Use a text editor to open the configupdate.sh file.

    2. Scroll to the bottom of the file, then add the custom .jar file you created in Step 10 to the -cp section.

      For example: -cp "${app_home}/lib/ig-configutil.jar":"${app_home}/lib/${_db_jdbc_jar}":"${app_home}/lib/my-configutil-strings.jar"

    3. Save and close the file.

  13. Launch the Configuration utility in GUI mode to view the changes.

Customizing Strings for Identity Governance

If you want to use different terminology in Identity Governance and Access Request, you can do so by editing .properties files.

To customize strings for Identity Governance and Access Request:

  1. Log in to the server where you installed Identity Governance.

  2. Navigate to the /opt/netiq/idm/apps/idgov/localization directory.

  3. Copy the client-strings.jar file and the cx-client-strings.jar file to a temporary directory.

    For example: /opt/netiq/idm/apps/work

  4. Extract the client-strings.jar file and the cx-client-strings.jar file, making sure to maintain folder structure.

    For example:

    /opt/netiq/idm/apps/work/com/netiq/iac/client and

    /opt/netiq/idm/apps/work/com/netiq/cx/client/

  5. Navigate to the /com/netiq/iac/client directory.

  6. Perform the following steps to create a new .properties file for Identity Governance:

    1. Rename the ArRsrc_en.properties file to org-ArRsrc_en.properties.

    2. Create a new, empty file named ArRsrc_en.properties.

  7. Perform the following steps to modify specific strings:

    1. Use a text editor to open the org-ArRsrc_en.properties file.

    2. Find the properties that you want to modify.

      For example, the Legend and About labels that appear when you click your user name in the title bar:

      legend=Legend

      about=About

    3. Copy the properties you want to modify into the empty ArRsrc_en.properties file.

    4. Modify the string values, which appear after the equal sign.

      For example:

      legend=Key

      about=Info

    5. Save and close the file.

  8. (Optional) Repeat Step 6 through Step 7 for each language you want to modify.

  9. Navigate to the /com/netiq/cx/client directory.

  10. Perform the following steps to create a new .properties file for Access Request:

    1. Rename the CxRsrc_en.properties file to org-CxRsrc_en.properties.

    2. Create a new, empty CxRsrc_en.properties file.

  11. Perform the following steps to modify specific strings:

    1. Use a text editor to open the org-CxRsrc_en.properties file.

    2. Find the properties that you want to modify.

      For example, the Legend and About labels that appear when you click your user name in the title bar:

      legend=Legend

      about=About

    3. Copy the properties into the empty CxRsrc_en.properties file.

    4. Modify the string values, which appear after the equal sign.

      For example:

      legend=Key

      about=Info

    5. Save and close the file.

  12. (Optional) Repeat Step 10 through Step 11 for each language for which you want to modify strings.

  13. Navigate to the folder from which you extracted the .jar files.

    For example: /opt/netiq/idm/apps/work

  14. Create a custom .jar file that contains only the .properties files you modified.

    For example: jar -cMf my-ui-strings.jar com/netiq/iac/client/ArRsrc_en.properties com/netiq/cx/client/CxRsrc_en.properties

  15. Copy the custom .jar file to the tomcat/lib directory.

    For example: /opt/netiq/idm/apps/tomcat/lib

    NOTE:Be sure to set the correct permissions and ownership of the .jar file.

  16. Stop Apache Tomcat. For more information, see Section 3.4.3, Starting and Stopping Apache Tomcat.

  17. Delete all files and folders in the following temporary directories:

    /opt/netiq/idm/apps/tomcat/temp

    /opt/netiq/idm/apps/tomcat/work/Catalina/localhost

  18. Delete all log files from the logs directory for Apache Tomcat.

    /opt/netiq/idm/apps/tomcat/logs

  19. Start Apache Tomcat. For more information, see Section 3.4.3, Starting and Stopping Apache Tomcat.

If you want to verify your changes, clear your browser cache, then log in to Identity Governance and view the pages that should contain your changes.

For example, to verify changes for the examples used in the procedure:

  1. Log in to Identity Governance as a user who can access both Identity Governance and Access Request.

  2. Within Governance Administration, select your name in the Navigation to view the changes.

  3. Within Access Request, select your name in the Navigation to view the changes.

11.1.4 Translation Content for Identity Governance and One SSO Provider

If the default languages for Identity Governance and OSP do not meet the needs of your organization, you can translate the strings and user interface content to a different language. For example, you might want to interact with Identity Governance in Norwegian (language code=nb). To use a non-default language, you need to translate the .properties files of an existing language.

For more information about customizing the content for a current new language instead of adding a language, see Section 11.1.3, Customizing the User Interface.

Preparing Files for Translation

This procedure assumes that you will translate English .properties files to the new language, rather than starting from another language such as French. Most of the .properties files are located in .jar files.

  • Linux: Default location:

    • Identity Governance: /opt/netiq/idm/apps/idgov/localization

    • OSP: /opt/netiq/idm/apps/osp/osp-extras/l10n-resources

  • Windows: Default location:

    • Identity Governance: c:\netiq\idm\apps\idgov\localization

    • OSP: c:\netiq\idm\apps\osp\osp-extras\l10n-resources

WARNING:Do not change the directory structure of the .jar files or modify any text in the code strings before the = sign. Identity Governance might not function if you make inappropriate alterations.

To prepare files for translation:

  1. To prepare the file that Identity Governance uses for labels in the user interface, complete the following steps:

    1. To download a file to use as the template for translation, complete Step 1 through Step 3 in Customizing the Labels in the Identity Governance Interface.

    2. Change the locale code in the file name to represent the language that you want to add.

      For example, to add Norwegian, change

      localizedLabels_en.properties

      to

      localizedLabels_nb.properties

  2. To prepare the content in the .jar files, complete the following steps:

    1. Create backup copies of the .jar files that you want to translate. Store the backups in a safe location.

    2. Copy the .jar files that you want to translate to a temporary directory.

      You will need these files again after the translations are complete.

    3. For each .jar file in the temporary directory, extract the English .properties files that you want to translate.

      For example, extract iac-ConfigUIstringsRsrc_en.properties from the iac-configutil-strings.jar file for Identity Governance.

    4. For each extracted .properties file, change the locale code in the file name to represent the language that you want to add.

      For example, to add Norwegian, change

      iac-ConfigUIstringsRsrc_en.properties

      to

      iac-ConfigUIstringsRsrc_nb.properties

    5. (Conditional) If a string that you want to translate and use in the .properties file has a comment, you must un-comment it.

      For example, change

      #OIDPENDUSER.50048=Next

      to

      OIDPENDUSER.50048=Next

    6. Create .jar files to contain the .properties files that you want to translate.

      For example, for the Norwegian translator, you might create nb-iac-configutil-strings.jar.

      The new .jar files must mimic the directory structure of the original files.

    7. Add the .properties files that are ready for translating to the new language in the new, appropriate .jar files.

      For example, add the iac-ConfigUIstringsRsrc_nb.properties file to the nb-iac-configutil-strings.jar file.

  3. Provide the .jar files and the localizedLabels_xx.properties file to your translator.

    WARNING:Ensure that the translator maintains the file names and directory structure of the .jar files. Also, do not modify any text in the code string before the = sign. For example, com.netiq.iac.persistence.ops.AttributeDefinition.USER.guid=. Identity Governance might not function if you make inappropriate alterations.

Ensuring that Identity Governance Recognizes the New Language

The Identity Governance Configuration utility controls which languages appear in Identity Governance and sets the default language. When you integrate with Identity Manager, the RBPM Configuration utility performs this duty.

Perform this procedure when you are ready to add new translations to Identity Governance.

  1. In a terminal, navigate to the following directory:

    • Linux: Default location of /opt/netiq/idm/apps/idgov/bin

    • Windows: Default location of c:\netiq\idm\apps\idgov\bin

  2. Run the Identity Governance Configuration utility:

    • Linux: Enter the following command:

      • Console mode: ./configutil.sh -password db_password -console

      • Guided mode: ./configutil.sh -password db_password

    • Windows: Enter the following command:

      • Console mode: configutil.bat -password db_password -console

      • Guided mode: configutil.bat -password db_password

  3. Select Miscellaneous.

  4. For Supported Locales, add the locale code that represents the language(s) that you want to include. Use a pipe sign to separate entries.

    For example, enter nb for Norwegian and it|ru for Italian or Russian.

  5. For Default Locale, specify the language that you want to use.

    For example, enter nb for Norwegian.

  6. Save your changes and close the utility.

Adding the Translated Labels to the Identity Governance Interface

  1. Complete the steps in Ensuring that Identity Governance Recognizes the New Language.

  2. Log in to Identity Governance as a Global Administrator.

  3. Select Configuration > Localization Import and Export.

    Identity Governance lists the .properties files by language.

  4. For the language that you added to Identity Governance, select Upload.

    For example, if you added the locale code for Norwegian to the Identity Governance Configuration utility, upload the localizedLabels_nb.properties file.

  5. Refresh the browser window to view the changes.

    NOTE:Depending on the browser settings, you might need to sign out of Identity Governance, clear the cache in the browser, then log in again.

Adding Translated Content to Identity Governance and OSP

To add the new content to Identity Governance and OSP, you need to place the translated .properties files in their appropriate locations in the .jar files in the temporary directory. The updated .jar files belong in the lib directory for Apache Tomcat.

  • Linux: Default directory of /opt/netiq/idm/apps/tomcat/lib

  • Windows: Default directory of c:\netiq\idm\apps\tomcat\lib

Ensure that you complete the steps in Ensuring that Identity Governance Recognizes the New Language before starting this procedure.

  1. Navigate to the temporary directory where you had copied the original .jar files in Step 2.b.

  2. Add the translated .jar files to the temporary directory.

  3. For each translated .jar file, extract the translated .properties file(s).

  4. Copy the translated .properties file(s) to their appropriate locations in the original .jar files in the temporary directory.

    • Linux: For example, place the iac-ConfigUIstringsRsrc_nb.properties file in the /com/netiq/iac/config/util directory of the iac-configutil-strings.jar file.

    • Windows: For example, place the iac-ConfigUIstringsRsrc_nb.properties file in the c:\netiq\com\iac\config\util directory of the iac-configutil-strings.jar file.

  5. Delete the translated .jar file(s) from the temporary directory.

  6. Copy the .jar file(s) with the added translations to the lib directory for Apache Tomcat.

    • Linux: Default directory of /opt/netiq/idm/apps/tomcat/lib

    • Windows: Default directory of c:\netiq\idm\apps\tomcat\lib

  7. Stop Apache Tomcat. For more information, see Section 3.4.3, Starting and Stopping Apache Tomcat.

  8. Delete all files and folders in the following Apache Tomcat directories:

    • Linux: Default locations of

      • / opt/netiq/idm/apps/tomcat/temp

      • /opt/netiq/idm/apps/tomcat/work/Catalina

    • Windows: Default locations of:

      • c:\netiq\idm\apps\tomcat\temp

      • c:\netiq\idm\apps\tomcat\work\Catalina

  9. Delete all log files from the Apache Tomcat logs directory.

    • Linux: Default location of /opt/netiq/idm/apps/tomcat/logs

    • Windows: Default location of c:\netiq\idm\apps\tomcat\logs

  10. Start Apache Tomcat. For more information, see Section 3.4.3, Starting and Stopping Apache Tomcat.

  11. Before logging in to Identity Governance, clear the browser cache to ensure that the browser displays your new language.

Verifying the New Translations

  1. In a browser, clear the browser cache.

  2. Change the browser language to the language that you added to Identity Governance.

  3. Enter the URL for Identity Governance.

    If you did not translate the content in the OSP .jar files, the login page continues to appear in the default language.

  4. Log in to Identity Governance.

  5. Observe the translated content.

11.1.5 Customizing the Identity Governance Style Sheet

You can modify the stylesheet (CSS file) that Identity Governance uses to display enterprise-specific branding. Identity Governance defaults to the NetIQ template.

  1. Log in as the Apache Tomcat server administrator to the Apache Tomcat server that hosts Identity Governance.

  2. In the home directory of the Apache Tomcat server administrator, create a directory named netiq_custom_css. For example:

    • Linux: /home/SmithJ/netiq_custom_css

    • Windows: C:\Windows\System32\config\systemprofile\netiq_custom_css

    NOTE:For Windows environments, you might need to create the directory in a different location. To determine the correct location, you can use the Process Monitor tool from Microsoft. For more information, see Process Monitor in the Windows Sysinternals documentation.

  3. (Optional) If you are using Process Monitor, include the following steps:

    1. Create a filter including the following:

      • Process name is java.exe

      • Operation is QueryOpen

      • Result contains PATH NOT FOUND

      • PATH contains custom.css

    2. Log in to Identity Governance.

    3. When the product loads in your browser, look back at Process Monitor to see the path for your Windows environment.

  4. Create a file named custom.css.

  5. Edit the custom.css file to include your branding and other custom style settings that you want Identity Governance to use.

  6. (Conditional) To use custom images, add the images to the netiq_custom_css directory.

  7. To preview your changes, log in to Identity Governance.

    You might need to refresh the page in the browser. You do not need to restart the Apache Tomcat server.