Best Practice when doing Changes to NX.ENV: using the 'pdm_options_mgr' command

Products

• CA Service Management - Service Desk Manager
• CA Service Desk Manager

Issue/Introduction

The purpose of this document is to demonstrate the basic usage of the 'pdm_options_mgr' command.

Environment

Service Desk Manager 17.x
All Supported Operating Systems

Resolution

'PDM_OPTIONS_MGR' is a command-line utility provided within Service Desk Manager (SDM) with the purpose to add or change content within the NX.ENV configuration file.

It is a best practice to use this command-line utility to avoid the NX.ENV from becoming corrupted by a text editor.

The main situations where its usage is needed are:

1.  When the variable to be added/changed already exists in NX.ENV file and is not available in the Options Manager tab in the SDM interface.

The following example was taken from NX.ENV:

2.  When a Test Fix or Cumulative Patch provided for SDM introduces a new variable. The following example was taken from USRD_CMN_FixList.HTML file in RO86155 (which is one of the packages from CF2 for SDM 14.1):

For example :

3.  When you need to deinstall an option which is not in the Options Manager tab in the SDM interface.

The command is issued two times:

• One affects NX.ENV file.
• The second one changes the NX.env_nt.TPL file, which will ensure the changes will not be overwritten when running pdm_configure.

Adding or Updating a NX.ENV variable

pdm_options_mgr -c -s LDAP_NESTED_GROUPS -v NO -a pdm_option.inst

pdm_options_mgr -c -s LDAP_NESTED_GROUPS -v NO -a pdm_option.inst -t

Removing a NX.ENV variable

pdm_options_mgr -c -s LDAP_NESTED_GROUPS -v NO -a pdm_option.deinst

pdm_options_mgr -c -s LDAP_NESTED_GROUPS -v NO -a pdm_option.deinst -t

Additional Information

A common error that occurs when using this method is to include the "NX" character string in a given command.  The "NX" string is unnecessary and is included automatically when using pdm_options_mgr.

An example of such a command (incorrect content highlighted in yellow):

pdm_options_mgr -c -s NX_LDAP_NESTED_GROUPS -v NO -a pdm_option.inst

The above will place an entry in the NX.env that reads as "NX_NX_LDAP_NESTED_GROUPS" and will not work as a result.