Skip to content
CA Service Management - 14.1
Documentation powered by DocOps

Options Manager

Last update October 4, 2018


Contents


The Options Manager lets you modify the functionality of your system. You can easily install and uninstall specific modified options.

Note: In advanced availability configuration, you can install or uninstall an option only from the background server. You can view the options and the descriptions from the application server.

The Options Manager pages list the applications that can be modified, the options that apply to those applications, and the values that are associated with the options, if any. They also provide descriptions of each option and indicate the status of each option (installed or uninstalled).

You can install these customization options when you install the rest of the product, or you can install any or all the options later. (Some options are automatically installed when you install the application that uses them.) You can also change the values of installed options at any time.

Important! Depending on your role, you may not have access to all the options.

Important! Installing or uninstalling an option requires you to restart the CA SDM services and CA xFlow Analyst Interface service. For advanced availability configuration, not all options require you to restart all the servers. Ensure that you read the Server Restart List before restarting any server.

Archive and Purge Options

Option Description
busy_agent_threshold Controls the threshold for processing the archive and purge background requests.
For efficiency, requests in the background process queue should be processed during low system utilization ("non-busy" times). The Option Value field allows you to specify the number of the busy agents in a percentage. For example, if the Option Value is set to 70, the system starts processing requests in the background process queue when the percentage of busy agents is lower than 70 percent of the total agents in the system. 
The Option Value field sets the NX_BUSY_AGENT_THRESHOLD variable, which is located in the NX.env file.
default_schedule The Option Value specifies the default schedule (workshift entry) used by the archive and purge rules. If the Option Value is set to an invalid workshift entry name or empty string, the rule does not execute the rule with the schedule value.
The Option Value field sets the NX_DEFAULT_SCHEDULE variable, which is located in the NX.env file.
rule_history_length

The Option Value specifies the maximum number of rule history records saved in the database.
The Option Value field is retrieved by archive and purge process at the startup. The default value for this variable is 50, which means 50 of the most recent rule history records are saved.
The Option Value field sets the NX_RULE_HISTORY_LENGTH variable, which is located in the NX.env file.

Asset Information Service Options

Option Description
allow_exceed An asset/item contains an Inventory Count field. The number of parents an asset/item can have cannot exceed the inventory count. Installing this option allows the number of parents to exceed the inventory count.
allow_unrestricted_asset_upd

If installed, users can fully modify assets/configuration items owned by CA Asset Portfolio Management. If this option is not installed (the default), only a limited number of fields of the asset/item record can be updated.

Audit Log Options

These options control the logging of activities on the data partitions, change orders/issues, and requests. If these options are installed, an audit log entry is created for each field update and insert operation. The operation to be monitored is determined using the following options:

Option Description
audit_ins Monitors insertion.
audit_upd

Monitors field updates.

CA CMDB Options

Option Description
allow_updates_to_inactive_ci Specifies whether to permit inactive CIs to be updated. Default is NO (new installation) or YES (product upgrade). To uninstall this option, click Edit, Deinstall, Refresh. Then stop and restart the CA SDM server.
allow_updates_to_superseded_ci Specifies whether to permit superseded CIs to be updated. Default is NO. To uninstall this option, click Edit, Deinstall, Refresh. Then stop and restart the CA SDM server.
ci_filter Specifies whether to search for CIs in the CI List page. Default is YES. If the option is not installed, the CI search filter has no initial value. To uninstall this option, click Edit, Deinstall, Refresh. Then stop and restart the CA SDM server.
ci_hierarchy_levels

Specifies the number for levels (depth) to search for dependent services for CIs. Valid values are integers 0 (zero) through 9 (nine).

cmdb_model_class_inconsistency Specifies to prevent, warn, or allow a CI class from being inconsistent with the class that a user specified in the optional CI model.
  • Prevent
    Stops the CI save from occurring and displays an error message.
  • Allow
    Allows the class and the class of the model to remain inconsistent.
    Note: Use this option for compatibility with earlier releases of the product, such as CA SDM r12.6.
  • Warn
    Updates the standard log (stdlog) with a warning and lets the save occur. For example, use this option if you want to transition from Allow to Prevent.
Default: Prevent
cmdb_versioning_maxrows Specifies the maximum number of audit log and Change Order history entries that displays in the Versioning tab.
Default: 400
critical_service_relationship

Specifies a relationship type to identify dependent services for CIs. You can specify multiple relationships separated by a comma. For example, supports, is managed by.

CA Process Automation Workflow Options

Option Description
caextwf_eem_hostname

Specifies the name of the CA EEM server. For example, http://<workflow_hostname> identifies the authentication hostYou install caextwf_eem_hostname only if you configured CA Process Automation to use CA EEM as an authentication server. CA SDM uses this value to transform a user name and password into a CA EEM token. Then, the user name and password do not pass in plain text over HTTP.

Note: If the CA Process Automation installation is not using CA EEM, do not place a value in the caextwf_eem_hostname option, and do not install the caextwf_eem_hostname. Placing a false value or installing caextwf_eem_hostname when it is not necessary causes the integration to fail.
caextwf_endpoint Specifies the URL that points to the CA Process Automation web services by including the CA Process Automation host name, port, and the mandatory /itpam/soap path. 
For example, http://<workflow_hostname>:<workflow_tomcat_port>/itpam/soap identifies the endpoint. If your implementation uses CA EEM, installing the caextwf_eem_hostname option is required for the integration between CA Process Automation and CA SDM to operate properly.
caextwf_log_categories

Specifies a comma separated list of CA Process Automation process instance log category names to appear on the CA SDM Request, Change Order, and Issue Workflow Tasks tab. For example, Operator,Response,MyOwnCategory supplies three log categories.
You install caextwf_log_categories based on business decisions from the CA SDM and CA Process Automation process design personnel. This option adjusts the default data that appears on the Workflow Tasks tab for requests, change orders, and issues.
When you install the caextwf_log_categories option, all CA Process Automation process instance log messages from the Process category and the categories that you specify appear on the Workflow Tasks tab. When you do not install caextwf_log_categories, only the CA Process Automation process instance log messages from the Process category appear on the Workflow Tasks tab.

Note: For information about the CA Process Automation predefined log message categories, and defining custom message categories, see the CA Process Automation reference documentation.
caextwf_processdisplay_url Specifies how to launch a graphical snapshot of a CA Process Automation process instance by supplying the host name and the mandatory /itpam/Web.jsp?page=runtimeeditor&ROID= path.
For example, http://<workflow_hostname>:<workflow_tomcat_port>/itpam/Web.jsp?page=runtimeeditor&ROID= launches a snapshot of a process instance. On the Workflow Tasks tab of a request, change order or issue, the user selects View Process to see the snapshot. 
Installing the caextwf_processdisplay_url option is required for the integration between CA Process Automation and CA SDM to operate appropriately.
caextwf_retry_count Specifies the number of times the CA PAM attached Workflow Events can be re-triggered to retry the Unknown status events. Default retry count value is 3 and range [1-20].
caextwf_retry_interval Specifies the retry interval duration in minutes to re-trigger each unknown CA PAM Workflow events.Default retry interval duration is 10 and range [10-999].
caextwf_worklist_url Specifies the process instance path by supplying the host name and the mandatory /itpam?page=tasklist path. For example, http://<workflow_hostname>:<workflow_tomcat_port>/itpam?page=tasklist enables CA SDM users to see a list of CA Process Automation process instances that require attention. The list appears in CA Process Automation when the CA SDM user selects a link associated with any listed task in the request, change order, or issue Workflow Tasks tab.
Installing the caextwf_worklist_url option is required for the integration between CA Process Automation and CA SDM to operate properly.
caextwf_ws_password Specifies the administrative password associated with the CA Process Automation user name from the caextwf_ws_user option. CA SDM uses the user name and password to access the CA Process Automation web service functions to perform integration activities such as selecting start request forms, process definition information, and process instance information. 
Installing the caextwf_ws_password option is required for the integration between CA Process Automation and CA SDM. The password and user name that you specify requires the appropriate access to CA Process Automation. However, it is not necessary for CA SDM to use the user name and password for authentication.
caextwf_ws_user

Specifies the CA Process Automation administrative user name associated with the CA Process Automation user name from the caextwf_ws_password option. CA SDM uses the user name and password to access the CA Process Automation web service functions to perform integration activities. Integration activities include selecting start request forms, selecting process definition information, selecting process instance information, or launching process instances.

Note: Installing the caextwf_ws_user option is required for the integration between CA Process Automation and CA SDM to operate. The user name and password that you specify requires the appropriate access to CA Process Automation. However, it is not necessary for CA SDM to use the user name and password for authentication.

How to Configure SLAs

CA Service Catalog Options

To enable the self-service integration, install the following options:

Option Description
casc_aty_sync

Specifies the type of activity logs to be synchronized from CA SDM to CA Service Catalog. If this field is left blank, Log Comment activity logs are synchronized.

To synchronize other activity log types, (such as, Escalate, Update Status) enter the respective log type codes, separated by comma.

casc_endpoint Specifies the CA Service Catalog Web Services URL.
Format: http://<CA_Service_ Catalog_hostname>:<CA_Service_Catalog_portnum>/usm/services
casc_session_timeout (Optional) Specifies the time in minutes for which the CA Service Catalog web services session will be cached.
Range: 20 to 60 mins.
casc_user

Specifies the CA Service Catalog administrator username that is responsible for making the web service calls to CA Service Catalog.

This user must exist in CA EEM against which CA SDM is configured.

casc_user_password Specifies the password of the CA Service Catalog user as entered in the casc_user option.
casc_ws_retry

(Optional) Specifies the number of retries to synchronize a CA SDM ticket update (activity logs/ attachments/status) with CA Service Catalog, if there is a failure.

Enter -1 to try indefinitely, until the synchronization succeeds. As a system administrator you can define the time interval after which you want the failed ticket update to be retried again.

Run the following command to define the time interval:

pdm_options_mgr -c -a pdm_option.inst -a option.inst -s NX_CASC_RETRY_INTERVAL -v [time interval in minutes]

By default this time interval is set to 15 minutes. If you do not set any value or provide a non-numeric value to this variable, the failed update is retried according to the default time interval (15 mins.).

Range: -1 to 50

casc_integrated Enables the self-service integration.

Call Service Desk Options

Option Description

call_service_desk_default_phone_number

Install this option and specify the value as a phone number for the mobile users to call the Service Desk using this specified number from their mobile.

call_service_desk_mobile_enable

(Installed by default) Enables the mobile users to call the Service Desk number from their mobile. The Service Desk number can be specified using the call_service_desk_default_phone_number or call_service_desk_tenant_phone_number_field (in case of multi-tenancy) option.

call_service_desk_tenant_phone_number_field

(Applicable if multi-tenancy is enabled) Install this option and set the value as phone_number or alt_phone, as specified in the tenant detail page. This option enables the tenant mobile users to call Service Desk using this specified number from their mobile.

Note: For more information, CA SDM Mobile application users can see the Call Service Desk from your Mobile Device.

Change Order Mgr Options

Option Description
asset_only_one_chg Restricts Assets from being attached to more than one active change order.
Category_Defaults

Automatically fills certain fields on a change order detail page when the user selects a category.

A category can have a default type, assignee, group, and organization/business. When this option is activated, the corresponding fields on the change order detail page are populated with category defaults if they have not been manually filled by the user. If the values are entered by the user, the default rule does not apply.

chg_allow_sla_downgrade Alters the behavior of the chg_sla option by allowing the system to automatically downgrade a change order's Service Type.
The chg_sla option selects the best Service Type from among several change order attributes, but cannot replace the change order's current Service Type with one of lesser rank. If this option is installed, the Service Types for all affected attributes are evaluated whenever one of the attributes changes. The change order's Service Type is set to highest ranked Type found, even if the new Service Type is lesser in rank to the change order's current Service Type.
The Service Type with the smallest Rank value is considered the best service. If all the Service Types considered are equal in Rank (including Service Types with empty Rank values), the Service Type created first in the database is selected.
The chg_sla option must be installed for this option to function correctly.
Auto Events Automatically attaches events to newly created change orders. This attachment is specified using the following options:
  • chg_auto_events -- Installs or uninstalls the option itself.
  • chg_auto_events_name -- Specifies the format of a name for the attached events.
  • chg_auto_events_count -- Specifies the number of events attached.
Event names to be attached are constructed by joining the chg_auto_events_name to a number ranging from 1 to chg_auto_events_count. For example:
  • chg_auto_events_name is "Auto Event"
  • chg_auto_events_count is "3"
With these settings, installing the chg_auto_events option would cause the following events to be attached to all new change orders:
  • Auto Event 1
  • Auto Event 2
  • Auto Event 3
To complete the implementation of this option, you must define an event with these names. For more information, see create an event from How to Configure SLAs topic.
chg_calendar_start_day_of_week Specifies the start day of the week in the Change Calender.
Default: Friday
chg_sla
Installs the rule for defaulting the Service Type field of a change order. The rule is as follows:
  • The best service among the priority, requester, affected contact, and category is applied to the change order.
  • The service type with the smallest rank value is considered the best service. If all the service types considered are equal in rank (including service types with empty rank values), the service type created first in the database is selected.
Note: This option is only available if the Classic SLA Processing Option is installed.
conflict_added Generates Activity Log entries when conflicts are added.
conflict_updated Generates Activity Log entries when conflicts are updated.
force_closure_code Modifies the closure code value of children to be identical to the parent. The following values are valid:
  • Empty - (Default) Forces the closure code value of the parent to the children when the child does not have a value for the closure code. It does not overwrite an existing closure code.
  • All - Forces the closure code value of the parent to all children even if they already have a closure code value.
impact_explorer_exclude_hier

Used when building a list of child CIs for a CI in the Impact Explorer tree. If this option is installed and set to Yes, child CIs that are related through the CMDB Relationships tab of a CI Detail page are not displayed in the Impact Explorer tree or in the CI Descendants List. 

Note: Child CIs that are related through CA CMDB are displayed.

require_change_assignee Prohibits change orders with no value in the Assignee field from being saved.
require_change_group Prohibits change orders with no value in the Group field from being saved.
require_closure_code Requires a closure code value prior to closing or resolving a change order.

Change-Issue Options

  • edit_completed_tasks
    When this option is installed with a value of Yes, you are allowed to set both the "Allow Task Update" and the "Task Completed" flags on a Change Order or Issue Task Status detail. However, if you set both the "Allow Task Update" and the "Task Completed" flags, you can only update the Workflow Task Description. The default behavior is to not allow setting of both the "Allow Task Update" and the "Task Completed" flags on a Task Status detail.

Email Options

The email interface sends email notifications and lets users create tickets from an email.

Option Description
mail_from_address Specifies the mail notification From: address. The address is in the format Displayname<user@company.com>.
mail_login_password Specifies the SMTP server login password.
mail_login_userid Specifies the SMTP server login userid.
mail_max_threads Specifies the maximum number of concurrent SMTP connections that can attempt to communicate with the server.
mail_reply_to_address Defines the reply to address for email notifications. This option is useful if emails are sent from one user account, but you want replies sent to another email address. The default value is the same as the from address.
mail_smtp_domain_name Defines the domain name of the SMTP server. You can clear the domain name by setting the value to NONE.
mail_smtp_hosts

Specifies a space-separated list of SMTP server host names for email notifications.

mail_smtp_host_port Specifies an SMTP port to override the default SMTP port.
mail_smtp_security_level Specifies the SMTP security level. Valid settings are: 0=no security, 1=basic authentication, 2=NTLM, 3=MD5 and 4=LOGIN. If you set this option to 1, set the mail_login_password and mail_login_userid options. Most SMTP servers do not require authentication.
mail_smtp_use_tls Specifies the Transport Layer Security (TLS) usage in the email. The valid settings are Yes= Use TLS, No=Do not use TLS.
mail_ca_cert_path

Specifies the path where the trusted certificate has been deployed.

Note: For the advanced availability configuration, you must deploy the trusted certificate on the same location in all the CA SDM servers. CA SDM supports only Base-64 encoded (PEM) format for CA Certificates.
mail_show_to_cc_list

Shows all the recipients of the email notification. For manual email notification, both “To” and “Cc” list recipients are displayed and for automatic email notification, only “To” list recipients are displayed. By default, this option is installed.

Note:  Pager email notification method does not support the listing of all recipients in To or CC list.

General Options

Option Description
add_utf8_byte_order_mark Causes the default data to include an encoding signature (UTF-8 Byte Order Mark). Editors that support UTF-8 use this signature to display and maintain UTF-8 encoding.
catalog_server

Specifies the CA Service Catalog server location (for example: http[s]://servername:8090). If a load balancer is in use, verify that this option specifies the load balancer.

default_superuser_id Specifies the default superuser ID for CA SDM, such as ServiceDesk.
Status_Policy_Violations Specifies how strictly the system enforces Status policies. This option only applies to automated system processes, such as integrations and macros. The end user is unaffected by this option.
Valid option values are:
  • Warn -- Allows the status policy violation to proceed, but a warning message is written to the log.
  • Allow -- Allows the status policy violation to proceed, but no warning message is written to the log.
  • Reject -- Rejects the status policy violation and an error message appears.
xflow_installed Enable this option if the xFlow Analyst Interface is installed.

singleton_notify_list

CA SDM sends the singleton daemon failure notification when it fails to restart a failed singleton daemon. This option controls the list of email recipients that will be notified when a singleton daemon fails to restart on the CA SDM server. Some fields in this page are self-explanatory. Following are the fields that need explanation:

Action Status

Indicates the installation status of the option.

  • Option Value
    Specifies a list of comma-separated email addresses for sending the singleton daemon failure email.
  • Action Status Message
    Specifies the message text to be included in the singleton daemon failure email.

Issue Mgr Options

Option Description
iss_allow_sla_downgrade Alters the behavior of the Iss SLA Option by allowing the system to automatically downgrade an issue's Service Type.
The Iss SLA Option selects the best Service Type from among several issue attributes, but cannot replace the issue's current Service Type with a type of lesser rank. If this option is installed, the Service Types for all affected attributes are evaluated whenever one of the attributes changes. The issue's Service Type is set to the highest ranked type found, even if the new Service Type is lesser in rank than the issue's current Service Type.
The Service Type with the smallest Rank value is considered the best service. If all the Service Types considered are equal in Rank (including Service Types with empty Rank values), the Service Type created first in the database is selected.
The Iss SLA Option must be installed for this option to function correctly.
iss_assignee_set Sets the assignee for issues to that of the logged in user, if the user is an analyst. If the option is installed, when an analyst creates a new issue, it is automatically assigned to that analyst.
Issue Auto Events
  • Automatically attach events to newly created issues. This is specified using three options:
    • iss_auto_events -- Installs or uninstalls the option itself.
    • iss_auto_events_count -- Specifies the number of events attached.
    • iss_auto_events_name -- Specifies the format of a name for the attached events.
    Event names to be attached are constructed by joining the iss_auto_events_name to a number ranging from 1 to iss_auto_events_count. For example:
  • iss_auto_events_name is "Auto Event"
    • iss_auto_events_count is "3"
    With these settings, installing the iss_auto_events option would cause the following events to be attached to all new issues:
  • Auto Event 1
    • Auto Event 2
    • Auto Event 3
    To complete the implementation of this option, you must define events with these names.
Iss_Category_Defaults Determines what happens when the category field is specified on an issue detail page.
A category can have a default assignee, group, and organization/business. When this option is activated, the corresponding fields on the issue detail page are populated with the category defaults, if they have not been manually entered by the user. If these values are filled by the user, the defaulting rule does not apply. Make sure that the default assignee is actually a member of the default group.
iss_sla

Installs the rule for defaulting the Service Type field of an issue. The rule is as follows:
The best service among the priority, requester, affected contact, and category is applied to the issue.
The service type with the smallest rank value is considered the best service. If all the service types considered are equal in rank (including service types with empty rank values), the service type created first in the database is selected.

Note: This option is only available if the Classic SLA Processing Option is installed.
require_issue_assignee Prohibits issues with no value in the Assignee field from being saved.
require_issue_group Prohibits issues with no value in the Group field from being saved.

Knowledge Options

This option controls the Knowledge functionality:

Option Description
analyst_preferred_ticket Sets the link for opening a ticket from a Knowledge Document for the analyst user interface. The analyst has a default setting of Incident, and the available options are Incident, Request, IncidentandRequest, and Issue.
kt_disallow_forums If this option is set to Yes, the Forum feature is disallowed (inactive), which means you cannot create or update forums or view any menu items.
kt_report_card_issue_status Allow issue statistics to be calculated and displayed in the Reuse section of the Knowledge Report Card. The validity of the where clause is not checked.
Example: status='CL'
kt_report_card_request_status Allow request statistics to be calculated and displayed in the Reuse section of the Knowledge Report Card. The validity of the where clause is not checked.
Example: status='CL'

KPI Options

These options control the operation of the KPI daemon:

Option Description
kpi_ticket_data_table

Enables the KPI daemon to collect data whenever CA SDM tickets are opened, closed, or certain fields are modified. Ticket data is written into the usp_kpi_ticket_data database table, and is available for generating web-based reports.

Note: Enabling this feature may result in degraded CA SDM performance.
concurrent_lic_refresh_interval Specifies the concurrent refresh time interval (in seconds) for all the concurrent KPIs (for example, webConcurrentLicenseCt KPI). If this option is installed, all the concurrent KPIs calculate the count only after the specified interval. If you do not install this option, refresh interval time is defaulted to 3600 seconds for all the concurrent KPIs.Range: 600 to 7200 seconds.

LDAP Options

You can set the domain name for LDAP Servers that was configured through Options Manager, by adding the domain name in the NX.env file variable and executing the following commands:

pdm_options_mgr -c -a pdm_option.inst -s NX_LDAP_DOMAIN -v <DEFAULT_LDAP_SERVER_DOMAIN_NAME> -t
pdm_options_mgr -c -a pdm_option.inst -s NX_LDAP_DOMAIN -v <DEFAULT_LDAP_SERVER_DOMAIN_NAME>

Note: Restart the services and login to CA SDM with domain\username credentials.

The following LDAP options are available for installation from Options Manager on the CA SDM Administration tab.

Note: The options identified as required must be installed together to enable integration with an LDAP directory. The options identified as optional are features you can add only if the required options are installed.
Option Description
default_ldap_tenant (required)

Specifies the default tenant for contacts imported from an LDAP directory into an installation that is configured for a multi-tenancy environment.

The option value must set to the UUID for that tenant. You can get the tenant UUID from a database query. For example, "SELECT * FROM ca_tenant".

Important! This option is only required if multi-tenancy is enabled. This option only takes effect if Option "multi_tenancy" is set to "on". Before you run the pdm_buildtenant utility, and if you want to retain the tenant value, you must modify NX.env by adding the NX_RETAIN_TENANT_VALUE variable manually, and set it to "yes".

If multi-tenancy is set to "on" and the variable is set to "no", missing, or not set properly, then the utility overwrites the tenant information. The variable has no effect when multi-tenancy is in "setup" mode.

ldap_dn

Specifies the LDAP distinguishedName for logging in to the LDAP server.

Example: CN=Joe, CN=Users, DC=KLAND, DC=AD, DC=com
Depending on your site's network configuration, the userid may be used instead of a distinguishedName.

Note: If the LDAP server supports anonymous binds, this value can be empty.

For example, if the LDAP directory is the CA EEM identity store, this option is not required because CA EEM allows anonymous access.

 ldap_enable

 Specifies whether LDAP integration is enabled. The default value is Yes. In addition to this option, you install all other LDAP options indicated as required.
ldap_enable_auto (optional) Specifies whether automatic creation of contacts from LDAP information is enabled. The default value is Yes. If you install this option, a contact is automatically created from LDAP information whenever a new user logs in.
ldap_enable_groups (optional)

Specifies whether CA SDM assigns a contact's Access Type based on LDAP Group membership. The default value is Yes. 
To use this feature, you associate CA SDM Access Types with LDAP Groups.

Note: This option is only applicable for Microsoft Active Directory.

ldap_enable_tls

(optional)

Specifies whether Transport Layer Security (TLS) is enabled during LDAP processing. The default option value is Yes.
ldap_group_object_class



Specifies the value of the LDAP objectClass attribute. The default value is group.

This value is always included in the where clause of the automatically generated filters used to search for LDAP groups.

ldap_host

Specifies the LDAP server hostname or IP address.

Note: If the LDAP directory is the CA EEM identity store, use the hostname of the machine where Ingres is installed.

 ldap_port

 Specifies the LDAP server port number.

Note: If the LDAP directory is the CA EEM identity store, use 1684 for the port number.

ldap_pwd

Specifies the password for the ldap_dn for logging in to the LDAP server.

Note: If the LDAP server supports anonymous binds, this value can be empty.

For example, if the LDAP directory is the CA EEM identity store, this option is not required because CA EEM allows for anonymous access.

ldap_search_base

(required)

Note: If you want to search contacts for a default LDAP server, keep the domain name field in the LDAP Directory Search page as blank or provide the exact LDAP domain name configured in CA SDM to retrieve the contacts in the specified LDAP directory.


Specifies the starting point for searches in the LDAP schema tree:

  • UNIX -- You must specify a starting container, such as: CN=Users, DC=KLAND, DC=AD, DC=com
  • Windows -- You do not have to specify a container and may start at the top of the schema tree, such as: DC=KLAND, DC=AD, DC=com
Note: If the LDAP directory is the CA EEM identity store, then use: cn=Users,cn=Entities,cn=iTechPoz This is only applicable when CA EEM is configured to use the MDB rather than an external directory.

ldap_service_type

(optional)



Install this option to establish the LDAP service type. If the LDAP type is Active Directory, specify the string “Active Directory”. If the LDAP type is not Active Directory, specify any other string, for example, “eTrust” or “Novell”.

ldap_sync_on_null

(optional)

Specifies whether existing contact attribute values are overwritten with null data if the corresponding LDAP user attribute contains a null value. The default value is Yes.
ldap_user_object_class (required)

Sets the value of the LDAP objectClass attribute. The default value is person. This value is always included in the where clause of the automatically generated filters used to search for LDAP users.

Note: If the LDAP directory is the CA EEM identity store, use pozObject. For many non-AD LDAP stores, the correct setting is inetOrgPerson.

num_ldap_agents

Specifies the number of LDAP agents. Install this option only if you have multiple LDAP agents. The default value is 2.

Multi-Tenancy Options

Option Description
max_tenant_depth Specifies a limit to the depth of the tenant hierarchy. Default is four (4) levels of tenants.
multi_tenancy
Controls the multi-tenancy features. Multi-tenancy allows organizations or groups to share a single installation. The following values are available:
  • off -- Multi-tenancy is not in use.
  • setup -- Multi-tenancy is not in use, however, administrators can view and edit the tenant-related objects and attributes on the UI.
  • on -- Multi-tenancy is fully operational. You can also add enforcement level options after the "on" setting, as follows:
    • warn -- Untenanted objects can be created or updated, but an error message are written to the log.
    • allow -- Untenanted objects can be created or updated, but a warning message is written to stdlog.

Note: Setting an enforcement level is useful during migration. It allows SLA and attached event updates to legacy untenanted data.

Notifications Options

Option Description
add_know_list Adds the "in-the-know" notify list to all future notifications regarding a change order, issue, or request. When this option is installed, the contacts listed in the notify list are added to all future notifications.
log_all_notify Logs all notifications, regardless of the method used. Logging a notification creates a notification log object that records the recipient, date/time, method of notification, and the notification text.
The administrator uses the Notification History list to view and maintain notification log objects. The notification history can also be viewed from an individual ticket.
If this option is not installed, the contact receives only the notification specified in the Contact record. No record is kept of the notification attempt.
notification_allow_temp_address Allows manual notifications to be sent to manually entered SMTP email addresses, rather than to registered contacts only.
web_cgi_url

Allows the recipient of a notification email to click a URL and view the object they were notified about. This option is also used in survey notifications.
To define a URL for a user to reach the CA SDM, a reference to the web interface is needed. The reference value is the web interface URL that is used to access the CA SDM web component.
The URL has the following syntax.

     http://hostname/CAisd/pdmweb.exe
  • hostname
    Specifies the location of your web server. 
    (Recommended) For Advanced Availability configuration, it is strongly recommended that this option points to one of the application servers and not the background or standby server. It can also point to a Web Director or a third-party load balancer.

    Note: Change the value of this option to point to:
    • The load balancer if you have more than one application servers.
    • The application server, if you have only one application server.

Request Mgr Options

Option Description
Area_Defaults Determines what happens when the Request Area field is specified on a Request Detail page.
A Request Area can have a default assignee and group. When this option is activated, the Request Detail assignee and group are populated with the Request Area defaults.
Assignee_set Sets the assignee for requests to that of the logged in user, when the user is an analyst. If the option is installed, when an analyst creates a request, it is assigned automatically to that analyst.
autoasg_ci_assign_lowest_agt Enables the CI-based auto-assignment to assign an analyst from group. The analyst must have active Status as Active and Available as Yes. The tickets assigned to all of the analysts that meet this criteria are counted but the first one encountered with the least number of tickets assigned to them is assigned to the ticket. You have to install this option to use it. After installing, this option restart the CA SDM servers.
autoasg_override Controls how Auto Assignment handles a Request that is created with an Assignee, Group, or both. Configure your system by setting this option to one of the following values:
  • Uses the existing Assignee, Group, or both. Auto Assignment processing does not occur if the Assignee, Group, or both was set during the creation of the Request.
  • Ignores the existing Assignee, Group, or both. Auto Assignment processing occurs and attempts to find an Assignee, Group, or both.
The Assignee, Group, or both can be set in various ways:
  • Manually by the Analyst
  • Area Defaults and the Assignee set options
  • Request Templates
  • Uninstalling this option causes it to operate in its default mode, which is 0.
Auto Events
  • Automatically attach events to newly created requests. This is specified using three options:
    • auto_events -- Installs or uninstalls the option itself.
    • auto_events_count -- Specifies the number of events attached.
    • auto_events_name -- Specifies the format of a name for the attached events.
    Event names to be attached are constructed by joining the auto_events_name to a number ranging from 1 to auto_events_count. For example:
  • auto_events_name is "Auto Event"
    • auto_events_count is "3"
    With these settings, installing the auto_events option causes the following events to be attached to all new requests:
  • Auto Event 1
    • Auto Event 2
    • Auto Event 3
    To complete the implementation of this option, define an event with these names. For more information, see create an event from How to Configure SLAs topic.
clear_scratch_pad Clears the Scratch Pad text is after creating a request. The default behavior is to apply the Scratch Pad text to all new requests.
cr_allow_sla_downgrade

Alters the behavior of the CR SLA Option by allowing the system to downgrade a request Service Type automatically.
The CR SLA Option selects the best Service Type from among several request attributes, but never replace the request current Service Type with a type of lesser rank. If this option is installed, the Service Types for all affected attributes are evaluated whenever one of the attributes changes. The request Service Type is set to the highest ranked type found, even if the new Service Type is lesser in rank than the request current Service Type.
The Service Type with the smallest Rank value is considered the best service. If all the Service Types considered are equal in Rank (including Service Types with empty Rank values), the Service Type created first in the database is selected.
The CR SLA Option must be installed for this option to function correctly.

cr_sla Selects the best Service Type from among several request attributes, and never replace the request current Service Type with a type of lesser rank. The Service Type with the smallest Rank value is considered the best service. If all the Service Types considered are equal in Rank (including Service Types with empty Rank values), the Service Type created first in the database is selected.
efficiency_tracking Specifies Efficiency Tracking, which lets analysts use options to track incidents. This option displays the Show Efficiency Tracking tab on the Incident Detail page.
employee_intf_incident_support
Displays the Incident, Request, or both ticket types for users logged in under the Employee interface type. You can select one of the following Option Values:
  • Incident only
  • Request only
  • Incident and Request
Note: The employee_intf_incident_support option is installed during CA SDM installation and cannot be uninstalled.
force_resolution_code

Specifies how the Resolution Code field value is handled for requests and incidents when an analyst closes a request or an incident.
When this option is installed, select one of the following values:

Empty -- The resolution code value of the parent is forced to the children only when the child does not have a value for the resolution code field. The option does not overwrite an existing resolution code value. This is the default value.

All -- The resolution code value of the parent is forced to all children even if they already have a value for the resolution code field. The option overwrites the current value with the value of the parent.


  • If this option is not installed, the resolution code values of all children remain unchanged.
  • If the option is installed, the resolution code value of the parent is propagated to its children.
force_resolution_method

Specifies how the Resolution Method field value is handled for requests and incidents when an analyst closes a request or an incident.
When this option is installed, select one of the following values:

Empty -- The resolution method value of the parent is forced to the children only when the child does not have a value for the resolution method field. The option does not overwrite an existing resolution method value. This is the default value.

All -- The resolution method value of the parent is forced to all children even if they already have a value for the resolution method field. The option overwrites the current value with the value of the parent.


  • If this option is not installed, the resolution method values of all children remain unchanged.
  • If the option is installed, the resolution method value of the parent is propagated to its children.
guest_intf_incident_support
Displays the Incident, Request, or both ticket types for users logged in under the Guest interface type. You can select one of the following Option Values:
  • Incident only
  • Request only
  • Incident and Request
Note: The guest_intf_incident_support option is installed during CA SDM installation and cannot be uninstalled.
monitor_joins

Specifies whether to monitor joined tables for updates to dynamic lists.
Updates to another table can affect the contents of a list. This effect often occurs when you use data partition view constraints containing a join. For example, a view constraint on change orders/issues where:

 assignee.organization = @root.organization

results in a join from the Change_Request table to the Contact table in all change order, issue, or both lists.
Keeping a change order or issue list containing this constraint up-to-date requires monitoring updates to the Contact table, and refreshing the list whenever a contact changes its organization/business. The result can be that a large number of lists updating simultaneously after an update to a joined table, with a possible performance degradation while the update is occurring. The monitor joins option allows the list updating (and the monitoring of the joined table) to be suppressed at sites where the up-to-date accuracy of such lists is less important than the performance degradation.

Netres_pty Escalates a request based on the associated asset. If you specify an asset with a Priority greater than the Priority on the request, the request Priority is set to match the asset. An escalation activity is not created. This option does not override a Priority that you manually specified on the Request Detail page during the same editing session.
op_Authenticate_Survey

Require authentication to respond to a survey accessed from a link in an email.

When op_Authenticate_Survey option is installed, this property requires authentication/credentials to respond to a survey accessed from a link in an email.

require_incident_assignee Prohibits incidents with no value in the Assignee field from being saved.
require_incident_group Prohibits incidents with no value in the Group field from being saved.
require_problem_assignee Prohibits problems with no value in the Assignee field from being saved.
require_problem_group Prohibits problems with no value in the Group field from being saved.
require_request_assignee Prohibits requests with no value in the Assignee field from being saved.
require_request_group Prohibits requests with no value in the Group field from being saved.
urgency_on_employee Specifies whether to show the Urgency field on Self Service incidents or requests. When the urgency_on_employee option is not installed, the Priority field appears on Self Service incidents or requests. When urgency_on employee option is installed, the Urgency field appears instead of the Priority field. The range of Urgency values are based on web.cfg settings.
use_incident_priority Specifies whether to calculate the Incident Priority field on the Incident Detail page. When the administrator uses Web Screen Painter to add the Incident Priority field, the Incident Priority field appears on the Incident Detail page. When the use_incident_priority option is not installed, the Incident Priority value calculated is zero. When the use_incident_priority option is installed the Incident Priority calculates as the sum of the Urgency and Impact values.

Request-Change Options

Option Description
edit_inactive Prevents editing change orders, issues, or requests unless their status is Active. Default behavior is to allow editing of inactive tickets.
set_sla_evt_open_date Uses the open date/time value of a change order, issue, or request as the start date/time of attached events. The attached events are triggered as soon as the ticket is saved.

Request-Change-Issue Options

Option Description
activity_log_security

Allows or prevents the Activity Log fields from being edited. The only exception to this option's setting is the Internal field. This is always editable.

Note: The activity_log_security option is installed during installation and cannot be uninstalled.
Any_Contact Some CA SDM objects restrict field values for Contacts based on Contact Type. This type of restriction is typically found on fields labeled, "Assignee" and only allow Contacts with a Contact Type Analyst. This option removes the contact type restrictions across the entire CA SDM application, allowing any type of contact to be used as an assignee.
classic_sla_processing

Enables the "classic" model of service types and SLA's. This model uses the Rank value for Service Types to determine the correct Type for a ticket. Only one Service Type can be applied to a ticket.

Note: The Chg SLA Option, CR SLA Option, and Iss SLA Option are available if the Classic SLA Processing Option is installed.
delete_null_properties Determines what happens to the properties when the Change Category, Issue Category, Request Area, Incident Area or Problem Area change and you install the keep_tasks option. A saved ticket with a specified category can have a number of properties and tasks.
If this option is not installed, the following occurs:
  • All existing properties are preserved.
  • Any new properties, if any, from the new category are added.
If this option is installed, the following occurs:
  • All existing properties that contain non-empty values are preserved.
  • All existing properties that contain empty values are deleted.
  • New properties from the new category, if any, that do not have the same label value as any of the existing kept properties are added.
When new properties are added to a ticket with existing properties, the system automatically adjusts (increases) the sequence numbers of the new properties to ensure they do not conflict with existing properties. The new properties always have greater sequence numbers than the existing ones.
filter_template_search Filter the initial template search with end user's Organization.
force_rootcause Specifies how the Root Cause field is handled for requests, change orders, and issues.
  • If this option is not installed, the root cause field values of all children are left unchanged.
  • If the option is installed, the root cause value of the parent are propagated to its children.
When this option is installed, choose one of the following values:
  • Empty -- The root cause value of the parent are forced onto the children only when the child does not have a value for the root cause field. It does not overwrite an existing root cause value. This is the default.
  • All -- The root cause value of the parent is forced onto all children even if they already have a value for the root cause field. It overwrites the current value with the value of the parent.
init_list_search Performs a search when opening the Request, Change Order, and Issue List pages to display the logged-in user's list of tickets. If this option is not installed, these list pages are blank on opening until the user performs a search.
keep_tasks
Specifies what happens if you move a ticket to a different category or area:
  • If keep_tasks is not installed, all existing properties on the ticket are removed. Any properties or tasks associated with the new category or area are added. Tasks with a status of Wait are removed. Tasks with any other status are retained.
  • If keep_tasks is installed, all existing properties and tasks on the ticket are retained. Any properties or tasks associated with the new category or area are added.
Note: When new properties or tasks are added to a ticket with existing properties or tasks, the sequence numbers are automatically adjusted to prevent conflict. New properties and tasks are always assigned greater sequence numbers than the existing ones.
leave_children_open Keeps child incidents, requests, problems, changes, or issues, open when the parent is closed.  
lex_lang Allows you to select the language to be used for spell checking. Default is US-English.
This option sets the NX_LEX_LANG variable located in the NX.env configuration file.
sla_workshift_override
Use this option to default the workshift for Service Type Events.
  • When this option is not installed, events for a Service Type always uses the workshift specified each event's template.
  • Installing this option defaults the workshift for Service Type Events to the workshift specified on the Service Type. The default occurs only when the event does not specify its own workshift. If an event template specifies a workshift, it is always used.
Tip: Set the event's workshift to the supplied '24 hour' workshift if you want the event to always start, regardless of any Service Type workshift.

Search Engine Options

The following options control Knowledge Management search performance:

Option Description
ebr_max_qps Specifies the maximum number of queries per second (QPS) that is logged in the .stdlog file. The default is 2 QPS. QPS below this number is logged in trace mode.
ebr_qps_timeout Specifies the time interval (the number of seconds) by which QPS are measured. Default is 300 seconds.

The following options control search engine integration:

Option Description
ebr_search_engine_baseport Specifies the port selected when the search engine was installed. Default is 13000.
ebr_search_engine_host Specifies the host name or IP address where the search engine is installed.
ebr_version

Defines the search engine you want Knowledge Management to use for searches. The KM Search Engine specifies the engine that is installed and configured with CA SDM.

Note: The document is not indexed when the Search Engine and all the text fields contain noise words.

Security Options

Option Description
bopauth_host (Applicable only for advanced availability configuration) Specifies the server name where bopauth_nxd is running. bopauth_nxd authenticates users accessing CA SDM through different interfaces. Select default if bopauth_nxd has to run in background server. This option cannot be uninstalled.
ldap_virtdb_host (Applicable only for advanced availability configuration) Specifies the server name where ldap_virtdb is running. Select default if ldap_virtdb has to run in background server. This option cannot be uninstalled.
eiam_hostname Specifies the hostname of the server where EEM is running. Required for EEM user name and password or artifact authentication.

force_browser_to_send_cookie_only_in_ssl_connection

(optional) Force the browser to send the Session ID (SID) cookie only if there is an SSL connection. This attribute is applicable only if you have enabled the use_encrypted_sid_and_cookie to (Yes). By default, this is turned off. If this flag is enabled, CA SDM can only be accessed through an SSL connection.
force_unique_userid

Prevents using duplicate active system login names.

Important! We recommend that you keep the force_unique_userid option enabled at all times. If this option is uninstalled, and there are multiple contact records with the same login id, you may experience problems with data partitions, multi-tenancy, security, and other functionality.
guest_user_name Specifies the Guest user login ID. Default is Anonymous. Must be a valid user ID.
ignore_security_case If installed, the user ID is not case sensitive.
Portal_Safe_List

Stores a list of machine names and port numbers where Portal is installed.
The machine name and the port are entered as follows

machine-name:8080

For multiple Portal installations, separate the machine name/port number with a comma. For example:

machine-name1:8080,machine-name2:8081,machine-name3:8080
url_etrust_password_reset

The URL for the eTrust Admin web interface. This enables the password reset link on the web interface. 
For example:

http[s]://hostname/EAOWebi/EAOLogin
use_eiam_artifact Allows EEM artifact to be used when users log in to CA SDM / Knowledge Management using URL.
use_eiam_authentication Allows use of EEM authentication when users log in to CA SDM / Knowledge Management and the access type authentication is set to OS.
use_encrypted_sid_and_cookie (optional) Use encrypted Session ID (SID) and cookie to prevent SID spoofing and Man-in-the-middle attack. By default, this attribute is disabled. If you want to have enhanced CA SDM security, this attribute can be enabled (Yes). Enabling this attribute can have some performance impact on the CA SDM Application.

Support Automation Options

Option Description
sa_domsrvr Specifies that the Support Automation main server communicates with the specified Support Automation domsrvr. If this variable is not installed, the Support Automation main server communicates with the default primary CA SDM Domsrvr named "domsrvr".
sa_primary_domsrvr Specifies whether to start the Support Automation primary domsrvr. This variable is used to determine if a dedicated object server is already configured. If this option is not installed, the domsrvr:sa runs on one of the secondary CA SDM servers and you are required to startup for domsrvr:sa.
supportautomation_url

Specifies the URL of the Support Automation web application, which CA SDM uses to communicate with the Support Automation main server. The host name and port number should correspond with the values set during configuration. We recommend that you configure the supportautomation_url with a host name because you may encounter problems when you configure the supportautomation_url with an IP address, if you use an IP address which has an existing host name mapping, the HTTP request processing resolves to this host name.

Note: The administrator installs this option after you configure the Support Automation main server on a primary or secondary CA SDM server to enable Support Automation usage in CA SDM. Do not install this option if Support Automation is not configured.

Time-to-Violation Options

These options control the process that monitors the service level agreements on all open tickets and tasks, and records the time the Service Type enters violation:

Option Description
ttv_enabled

Runs the Time to Violation daemon, which monitors the SLAs for all open tickets and tasks. This process does not set the SLA violation, but records the date the ticket or task is violated in its current state. This projection is updated when the ticket or task is updated. This option must be installed in order for the other Time to Violation options to function correctly.

Important! This option requires that the classic_sla_processing option not be installed.
ttv_evaluation_delay

Sets the delay between a request to the time-to-violation (TTV) daemon and when it actually evaluates a ticket. Whenever a ticket is updated, a request is sent to the TTV daemon to update the time-to-violation projections. Because tickets are often updated several times in quick succession, a delay in evaluation helps prevent needless evaluations and improves performance.

Important! This option is dependent on the ttv_enabled option, which must also be installed.
Note: This value may never be set below 60 seconds.
ttv_highlight

Highlights a ticket in a list if the ticket has a Time to Violation value set to start by a certain time. The default highlight color is a pale yellow.
The ticket number is highlighted only if one of its Time to Violation values is less than the date/time specified by the Timespan, "TTV_THRESHOLD". By default, this Timespan is set to show tickets with Time to Violation values less than midnight of the current day, for example, "today". You may modify this Timespan to any value. 
This option only affects ticket list forms on the web interface client. It applies to lists of Requests, Issues, Change Orders, Incidents, Problems and Tasks. It's an option because the Time to Violation value is stored in a database table separate from the ticket, and requires an extra database fetch *for each row displayed*. Given this extra DBMS activity, installing this option may increase the load on your database so that performance may be affected.

Important! This option is dependent on the ttv_enabled option, which must also be installed.

Ver Ctl Options

The ver_ctl option controls the actions that are taken by the Version Control Manager when a version discrepancy is detected. The Version Control Manager detects discrepancies by comparing version files across all CA SDM servers (client and servers). Depending upon the CA SDM configuration, the following client and servers are used:

  • Conventional:
    • Client: Secondary server
    • Server: Primary server
  • Advanced availability:
    • Client: Application and Standby servers
    • Server: Background server

Only components that are listed in the version files are controlled. When you restart the servers and if a discrepancy is detected, the client connects to the server to send a list of its controlled components. The server compares the list to its own master list. The affected components on the client are upgraded or terminated, depending on the ver_ctl option.

ver_ctl
Installing this option activates the Version Control Manager. Valid option values are:

  • Fail -- A version discrepancy terminates the secondary server's connection to the primary server. The secondary server is prevented from connecting to the primary server until it is manually updated.
  • Notify -- Default value. On Windows, a version discrepancy results in a message window asking if you want the secondary server to continue or quit. On UNIX, a version discrepancy is logged, but the secondary server always completes initialization.
  • Upgrade -- When a version discrepancy is detected, an upgrade of the affected components is attempted on the secondary server. If the upgrade is successful, the secondary server connection continues; otherwise, the secondary server connection terminates.
  • Disable -- Version discrepancies are ignored. All secondary servers are allowed to connect to the primary server.

Web Options

These options control the CA SDM web interface operation:

Option Description
auto_suggest_status

Displays matching records for the text entered in lookup fields within the Analyst interface.

Note: For this option to work correctly, the Using Screen Reader user preference must be disabled. To specify user preferences, select View, Preferences on the menu bar. Default: On
copy_inactive

Copies the inactive attributes of an object (such as the previous assignee) from the original record to the new record.

Note: By default, this option is uninstalled so that links to inactive objects are not copied. If you install this option, or if you migrated from CA SDM r12.5, links to inactive objects are copied.

charset

Defines the default HTTP character set for the web interface. You cannot uninstall this option.
The value of this option is set in the charset parameter of the HTTP content-type header and it matches the character encoding of the operating environment when CA SDM is configured.
Under normal circumstances, this option does not need updating after initial configuration.

Important: Restarting the CA SDM server is not required.
export_max_fetch_rows Determines the maximum number of rows that users can export for a list.
Default: 5000
max_files_to_upload_simultaneously Defines the maximum number of files that you can simultaneously upload during the same operation.
Valid Range: Greater than or equal to 0. Zero means unlimited.
Default: 10
max_records_auto_suggest Specifies the number of suggestions to display in matching results. For example, increase the number of suggestions if analysts in your environment request 50 suggestions.
Default: 25
min_chars_auto_suggest Specifies the minimum number of characters that a user enters in a lookup field before the field starts displaying matching results. For example, increase the number of characters if your environment contains many users that share the first three characters in their user names. T
Default: 3
mouseover_preview_delay_time Specifies the delay time, in milliseconds, between hovering the mouse cursor over an object link and the display of the mouseover preview. The preview is not generated if the mouse is moved away from the link before the delay time expires. Enter a value from 100 to 5000 in the Option Value field.
Default: 1000
pdmweb_cache_disable All regular files from bopcfg/www are cached. If this option is installed, the PDMWEB servlet does not cache the files, which means all files are retrieved from the directory each time one is needed.
pdmweb_cache_sitemods

The PDMWEB Servlet, by default, does not cache files from the $NX_ROOT/site/mods folder. If this option is installed, files are cached from the sitemods folder.

prompt_for_knowledge Enables a dialog that prompts users to search the knowledge base before creating issues from the customer web interface and requests from the employee web interface.
scoreboard_entry_limit Limit for adding new scoreboard nodes and folders. When the system reaches the limit, existing folders and nodes continue to display information. However, the user must delete unused folders or nodes before creating new ones.
suppress_web_hier_search
Suppresses the hierarchical search used on the web for request, incident, and problem areas, category, and root cause. This option is useful for tables that are not organized hierarchically, or when one or more of the hierarchical levels contains a great many records. When hierarchical search is suppressed for a table, search requests on the table are processed as lookups.
The value of this option is list of object names of the tables for which hierarchical search is suppressed. If more than one table name is specified, values are separated by spaces. Valid values are:
  • chgcat - Change order category
  • isscat - Issue category
  • pcat_cr - Request area
  • pcat_in - Incident area
  • pcat_pr - Problem area
  • rc - Request root cause
Important! To avoid errors when using autocomplete, we recommend that you use this option instead of modifying the dtlHier macro to dtlLookup in the HTMPL file.
use_nested_tabs Displays nested tabs within the current form. The analyst can expand each tab to view key details. If you want to revert to the notebook styles used in CA SDM r12.5, you can disable the nested tabs control. For example, analysts in your environment prefer to click a tab that shows only the content of that tab.
web_auto_update Requests the automatic update of scoreboard counts for analyst web users. When this option is installed, each web analyst session requests updated scoreboard counts at the interval specified in the option.
The value of this option is the number of seconds between updates, with a minimum value of 60 seconds (one minute). Web scoreboard updating occurs in the background. The analyst end user can see periodic activity on the main page. In addition, updated count values are highlighted on the scoreboard. The highlighting remains until the user either clicks on the scoreboard link to display the associated list, or presses the Update Counts button.
Activating this option affects the overall load of the system as follows:
  • Each web user can send additional requests to the server at the frequency specified in the option.
  • The web engine receives messages from the object engine each time a database update causes the count associated with a query to change.
When the web auto update option is not installed, the web engine requests counts from the object engine only when a web user explicitly requests an update.
web_wildcard_search

Installing this option enables a wildcard search for all text fields when using Search Filters. To perform a wildcard search, you add the "%" symbol after a text string. For example, entering the string "option%" retrieves all records that begin with the word "option". Installing this option eliminates the need for the "%" symbol and conducts wildcard searches by default.

Note: Installing this option enables functionality equivalent to using the "%" symbol only at the end of the search string, not at the beginning. For example, with this option installed, searching the Options Manager option list for the string "ldap" finds all options with names beginning with "ldap" but does not find the "default_ldap_tenant" option.
wsp_domsrvr Specifies the name of an object engine dedicated to the Web Screen Painter (WSP). The WSP webengine, designated by the companion option wsp_webengine, is the only client process allowed to connect to the object engine identified by wsp_domsrvr. You must install both the wsp_domsrvr option and wsp_webengine option in order to enable the WSP schema modification test feature.
The value of this option must be a string beginning with the characters "domsrvr:". It is recommended that you use domsrvr:wsp as the name of the WSP object engine.
Installing this option automatically runs the WSP object engine on the primary server.
wsp_webengine Specifies the slump name of the webengine used by Web Screen Painter users. All WSP users connect to this webengine, and use it for preview sessions.
All files saved by WSP users are stored in the site/mods directory on the server running this webengine, which must be the CA SDM primary server. Because WSP saves information on the server running its webengine, all WSP users must connect to the same webengine. If the wsp_wengine option is not installed, WSP users connect to the default webengine: web:local, sharing it with other users. 
The value of this option must be a string beginning with the characters: "web:". We recommend you use web:wsp as the name of the WSP webengine.

Web Report Options

These options control the CA Business Intelligence reporting integration with the BusinessObjects server:

Option Description
bo_server_auth
Specify which type of authentication you want to use for reporting. You can specify the following types of authentication:
  • secEnterprise. (Default) Specify Enterprise Authentication as your authentication type if you prefer to create distinct accounts and groups in BusinessObjects for use with CA Business Intelligence, or if a user hierarchy has not been set up on an LDAP server or a Windows AD server.
Note: If you choose the secEnterprise option, you need to add your CA SDM report users to the BusinessObjects Central Management Console (CMC). The CMC allows you to control users' access to Business Intelligence Launch Pad and other BusinessObjects applications. In the CMC, you must enter the same user names and passwords configured in CA SDM.


  • secLDAP. Specify LDAP Authentication as your authentication type if you have already set up an LDAP directory server and want to use your LDAP user accounts and groups in BusinessObjects for use with CA Business Intelligence. 
  • When you map LDAP accounts to BusinessObjects, users can access CA Business Intelligence with their LDAP user name and password. This eliminates the need to recreate individual user and group accounts within BusinessObjects.
  • secWinAD. Specify Windows AD Authentication as your authentication type if you are working in a Windows 2000 environment and want to use your existing AD user accounts and groups in BusinessObjects for use with CA Business Intelligence.
  • secExternal. Specify External Authentication as your authentication type if you integrate the BusinessObjects authentication solution with a third-party authentication solution (for example, using JCIFS with Tomcat). This authentication type requires setting up Trusted Authentication in BuisnessObjects to allow users to log on without providing their passwords.
Note: During the Trusted Authentication configuration, you must set the user name retrieval method to REMOTE_USER in the BusinessObjects web.xml file.
Note: For information about alternative security options, see the CA Business Intelligence.
bo_server_cms Specify the name of the Central Management Server (CMS) that is responsible for maintaining a database of information about your BusinessObjects that you use with CA Business Intelligence.
For the bo_hostname, use the hostname of the machine where CA Business Intelligence is installed. The default bo_cms_port is 6400.
bo_server_location

Specify bo_hostname by using the hostname of the machine where CA Business Intelligence is installed. CA SDM uses this URL to put together report URLs for requesting reports from the BusinessObjects server. The CMS location is specified by hostname and port.

Important! The default bo_application_server_port is 8080 (for example, this can be the Tomcat port). If you install CA SDM and CA Business Intelligence on the same server, you must specify a different port. Use the port specified when starting Business Intelligence Launch Pad.

For example, http://hostname:8180/businessobjects/enterprise115/desktoplaunch/businessintelligencelaunchpad/logon/logon.do displays that 8180 is the value to use for bo_tomcat_port.

Web Service Options

Option Description
rest_webservice_access_duration Specifies the number of hours that the REST Web Service Access Key remains active before expiration. The Access Key timeout is not based on inactivity time, but it is based on duration time since the Access Key creation. After the Access Key meets the specified duration, the Access Key ends regardless of whether it is being used.
Optionally, the REST client can also provide the Access Key duration time for the specific Access Key during the Access Key request. To provide the duration value, set it directly on the expiration_date attribute of the rest_access resource, as part of the POST request payload.
Valid Range: 1-8760 hours
Defaut: 168
rest_webservice_disable_basic_auth Disables Basic Authentication in REST Web Services.
Default: No
rest_webservice_list_max_length Specifies the maximum number of rows that a REST Web Service query returns.
Default: 500
rest_webservice_list_page_length Specifies the default number of rows that a REST Web Service query returns per page.
Valid Range: 1-500
Default: 25
rest_webservice_resources_to_expose Specifies the list of Majic factories (resources) that CA SDM exposes through REST Web Services. This option overrides the default behavior. By default, CA SDM exposes all factories through REST Web Services.
If you do not enter values in this option, the default behavior exposes any Majic factory that does not have the REST_OPERATIONS property set to NONE. By default, no Majic fatory has this property set to NONE.
Use the REST_OPERATIONS property to set the specific HTTP CRUD (CREATE, READ, UPDATE, DELETE) methods for CA SDM to expose on a given Majic factory.
Default: rest_access
Example: rest_access, cnt, grp, cr, crs, pri, alg, urg, imp, pcat, org
hmac_algorithm Specifies the algorithm that you use to compute the signature for Custom/Secret Key Auhentication in REST Web Services.
Default: HmacSHA1
string_to_sign_fields Specifies the fields that you use to compute the signature for Custom/Secret Key Authentication in REST Web Services, in addition to the default REQUEST_METHOD, REQUEST_URI, and QUERY_STRING fields.
Default: blank
webservice_domsrvr Specifies the name of the object engine that SOAP web services use. If not installed, SOAP web services use "domsrvr".
The value of the option must be a string beginning with the characters "domsrvr:"
webservice_session_timeout Sets the timeout value (in minutes) for SOAP Web Service sessions. When the time between successive web method calls is greater than the value specified, the session ID is marked expired. The session is then no longer valid.
To prevent sessions from expiring due to activity, set the value for this option to 0. Other methods, such as logoff routines, can still invalid sessions.

xMatters

xMatters is used for mass notifications and Alerts. When a CA SDM ticket (incident, request, or problem) is created or updated, the integration mechanism sends the notification along with ticket information to the xMatters agent. The notification works only with CA SDM CR objects (incident, request, or problem). The CA SDM notification feature sends notifications to users based on the rules set for notification. CA SDM sends the Notify Log Reader information automatically along with ticket information to the configured xMatters agent.

CA SDM administrators can enable or disable integration with xMatters through the Options Manager options. You must install these options as these options are not installed out of the box. Restart CA SDM services after installing or uninstalling these options. On successful installation of xMatters options, a new daemon the pdm_xmatters_sync is started and can be monitored through the task manager process list. This daemon is a singleton process and runs on the primary or background server.

The pdm_xmatters_sync daemon gathers notification records with status Pending or Error based on the xmatters_retry_count option value. It also maintains a list of newly created notification records. After the existing record list is run, the pdm_xmatters_sync runs the newly created record list. This is an ongoing process. In case of failure, when the xMatters agent is not available, the records wait for the time specified in the Options Manager xmatters_retry_interval option and re-triggers the pdm_xmatters_sync daemon till all records attain a status of either Success or Abort.

The pdm_xmatters_sync daemon runs the records in the same order in which they are created. Records having xMatters-Pending or xMatters-Error status are processed first and then, the newly created records are processed.

Based upon the set notification rules, the notification history page will have information along with the status.

Rule Information
xMatters – Error Return error code status to CA SDM. Indicates that this notification message was sent to xMatters agent but was not received by xMatters agent. This can happen due to xMatters agent not running or other issues with the agent. Notifications having this status will retry based on the Options Manager xmatters_retry_count and xmatters_retry_interval.
xMatters – Abort Return error code status to CA SDM. Indicates that CA SDM triggered the number of iterations mentioned in the Options Manager xmatters_retry_count and xmatters_retry_interval options, but the xMatters agent did not receive this message.
xMatters – Success This status indicates that xMatters agent received this notification message successfully and returned the success status code. These records can be shown from xMatters system web interface.

Install the following xMatter Options Manager Options. These options control the CA SDM and xMatters integration provides a reliable and stable mechanism to integrate notifications.

Option Description
xmatters_cr_attr The valid CR majic attribute name. Specify the request attributes for xMatters notification. This can include custom attributes.
xmatters_retry_count The default and minimum value is set as 3 in the range [1-20]. This value indicates the number of times the retry option can be triggered for failed transactions or notifications.
xmatters_retry_interval The default and minimum value is set as 15 minutes in the range of [15-999]. This value indicates the time gap between each retry and specifies the retry interval duration in minutes for each failed xMatters notification.
xmatters_URL Valid xMatters server agent and port number. Specifies the xMatters integration URL link.
Example URL: http://<xmattersagentname>:<port>/http/caservicedesk15_caservicedesk15

For more information, see Create a Notification Method. To complete the implementation of this option, you must define an event with these names. For more information, see create an event from How to Configure SLAs topic.

Was this helpful?

Please log in to post comments.

  1. Karen Matoke
    2016-06-06 06:14

    In the description of "allow_unrestricted_asset_upd", it could be helpful to mention that the list of restricted fields are the values specified in the NX_UFAM_ATTRIBUTES environment variable stored in NX.env and that the list cannot be changed.

    1. Rajashree Nair
      2016-09-26 05:27

      Thanks Karen Matoke for the suggestion. Will add description as suggested by you after discussion with Engineering. 

       

      Regards,

      DocOps Services Team

  2. J.W.
    2016-09-23 03:14

    In SDM 14.1.03, there is no option for 'guest_user_name' under Security. An issue has been opened with Support.

    J.W.

    1. Rajashree Nair
      2016-09-26 05:25

      Thanks J.W. for raising a support ticket. We will add it after Engineering confirms the same. 

      Regards,

      DocOps Services Team

  3. Pedro Ramalho
    2018-03-28 09:11

    In the 2nd "Important" note from the top there is a reference to Server Restart List that does not exist. Problem also happens for 17.0 documentation (same url to Server Restart List).

    1. Rajashree Nair
      2018-05-07 09:57

      Thanks, PEDRO RAMALHO for your feedback. Removed the said cross-reference. Apologies for the delayed response.