Configuration File Modification

When you install the CA SDM web interface, a sample web engine configuration file (web.cfg) is installed that you can modify to suit your needs. The web.cfg file itself contains helpful comments that you can read by viewing the file. You can open the web.cfg file from the appropriate directory:
casm173
When you install the CA SDM web interface, a sample web engine configuration file (
web.cfg
) is installed that you can modify to suit your needs. The
web.cfg
file itself contains helpful comments that you can read by viewing the file. You can open the
web.cfg
file from the appropriate directory:
  • (Windows) %NX_ROOT%\bopcfg\www\
  • (UNIX) $NX_ROOT/bopcfg/www/
Some additional configuration variables, such as charset, are also available in Options Manager. These are accessible using the Administration tab in the web interface.
AllowInactiveSrelEntry
Specifies whether a record can be saved when it references inactive records in a reference table.
  • When this property is omitted or set to zero, inactive reference table entries (such as request status or change category) are not included in drop-down selects, and cannot be specified for lookup or hierarchical search fields.
  • When this property is set to 1, the inactive flag is ignored in reference table entries.
Regardless of the setting of this flag, records already containing a reference to an inactive reference table entry can be saved without changing the reference; the flag affects only new field values.
AnnouncementLength
Specifies the maximum number of announcements to display on the opening screen for both customer and analyst interfaces. CA SDM begins the display with the most recent announcement, continuing for the number of announcements specified by this parameter. Users of the analyst interface can view additional announcements by selecting Announcements from the Search menu.
Default:
10, meaning that the ten most recent announcements display.
AnonymousPrio
Specifies valid priorities for tickets created by guest users. Such users can specify only one of the priorities in the AnonymousPrio list for their tickets. Entries in the list of priorities are separated by spaces. Each entry must be either a number between 1 and 5 or the word “none” (without quotes). The default priority for tickets created by guest users should be specified first, and can be repeated in the list.
The values valid for AnonymousPrio correspond to the symbolic names of the priorities as distributed. You can use the java client to modify these symbolic names; however, this does not affect the specification for AnonymousPrio, which must continue to reference priorities by their default names, where 1 corresponds to the highest priority.
Default:
None, meaning that all requests created by a guest user have a priority of none.
Autofill
Specifies that the web interface should auto-fill lookup fields when a user keys data into them and presses Tab to exit the field. When a user does this and the Autofill option is selected, the browser asks the server to confirm that the update is correct. This results either in the full name filling in the field (if the user provided a partial name), or a pop-up search window appearing (if the user’s selection was incorrect or ambiguous).
This property is optional. Autofill is enabled by default so if this property ID is omitted or set to Yes, tabbing out of a lookup field automatically searches the database. If this property is set to No, no auto-fill occurs, and lookup fields are not verified until the record is saved.
CAisd
Specifies the path (including a leading slash) to the alias or virtual directory in your HTTP server that contains the files needed by the CA SDM web server. This property typically has a value of /CAisd in both UNIX and Windows installations. For Apache servers, it should be defined in an Alias statement in a configuration file. For IIS, it should match an Alias field in the Directory Properties Window.
CGI
Specifies the name of the CGI executable program supplied with the web interface (without the .exe suffix).
Default:
pdmweb
If you rename this program, you must update this property.
CgiReport
Specifies the name of the CGI executable program for web reports supplied with the web interface (without the .exe suffix).
Default:
pdm_cgireport
If you rename this program, you must update this property.
ContactAutoDesc
Specifies whether the contact’s name should be inserted into the description of new issues and requests created in the customer and employee interfaces. If this property is omitted or specified as 0, no automatic information is added to the description of new issues and requests. If this property is specified as 1, the contact’s name is automatically inserted into the description of issues and requests created in the customer and employee interfaces. This property has no effect on the analyst interface.
ContactAutoDescWithIP
Specifies whether the contact’s IP address should be inserted into the description of new issues and requests created in the customer and employee interfaces. If this property is omitted or specified as 0, no IP address information is added to the description of new issues and requests. If this property and the ContactAutoDesc property are both specified as 1, the contact’s name and IP address are automatically inserted into the description of issues and requests created in the customer and employee interfaces. This property has no effect on the analyst interface. It is ignored unless ContactAutoDesc is 1.
CstPrio
Valid priorities for issues created with the customer web interface. Users of the customer interface can only specify one of the priorities in the CstPrio list for their issues and cannot update the priority of an issue if an analyst has altered it to a value that is not in the list.
Entries in the list of priorities are separated by spaces. Each entry must be either a number between 1 and 5 or the word “none” (without quotes). The default priority for issues created with the customer interface should be specified first (and can be repeated in the list).
Default:
none, 3, 4, 5
The values valid for CstPrio correspond to the symbolic names of the priorities as distributed. You can use the java client to modify these symbolic names; however, this does not affect the specification for CstPrio, which must continue to reference priorities by their default names, where 1 corresponds to the highest priority.
DateFormat
Defines the order of elements in dates.
Default:
MM/DD/YYYY hh:mm a(am,pm)
Symbol
Description
M
Print 1 or 2 digits of month
MM
Print 2 digits of month
D
Print 1 or 2 digits of date
DD
Print 2 digits of date
YY
Print 2 digits of year
YYYY
Print 4 digits of year
H
Print 1 or 2 digits of hours on 24 hour clock
HH
Print 2 digits of hours on 24 hour clock
H
Print 1 or 2 digits of hours on 12 hour clock
hh
Print 2 digits of hours on 12 hour clock
M
Print 1 or 2 digits of minutes
mm
Print 2 digits of minutes
S
Print 1 or 2 digits of seconds
ss
Print 2 digits of seconds
a(am, pm)
Print am and pm as a string
DateFormatNoTime
Specifies the same definition as DateFormat, but without specifying the time portion.
DebugSource
Enables the standard browser right-click menu on CA SDM forms. When this property is not set, you can right-click a form to display a CA SDM menu. You should use caution when setting this property, because some of the options on the standard browser right-click menu can cause execution errors (this is the reason why it is usually disabled). On Internet Explorer, you can display the standard browser right-click menu although the DebugSource property is not set by pressing the Ctrl key when you right-click.
DebugTrace
Causes the web engine to write trace information to the stdlog file.
This property should
not
be set for typical use. It should only be used when requested by CA Support.
EmpPrio
Valid priorities for requests created with the employee web interface. Users of the employee interface can only specify one of the priorities in the EmpPrio list for their requests and cannot update the priority of a request if an analyst has altered it to a value not in the list.
Entries in the list of priorities are separated by spaces. Each entry must be either a number between 1 and 5 or the word “none” (without quotes). The default priority for requests created with the employee interface should be specified first (and can be repeated in the list).
Default:
none, 3, 4, 5
The values valid for EmpPrio correspond to the symbolic names of the priorities as distributed. You can use the java client to modify these symbolic names; however, this does not affect the specification for EmpPrio, which must continue to reference priorities by their default names, where 1 corresponds to the highest priority.
ExclLockSeconds
Specifies the maximum number of seconds that a user is given an exclusive lock on a record after clicking Edit. After this period elapses, the web engine releases the lock, allowing other users to update the record. The web engine attempts to retake the lock if a user asks to save after ExclLockSeconds has expired. This attempt succeeds only if no other user has updated the record while the lock was available. If the attempt to retake the lock fails, the user must re-enter the updates.
Default:
120 (two minutes)
This argument is optional. If omitted, the default value is assumed.
The ExclLockSeconds setting must be shorter than the Timeout setting. ExclLockSeconds is specified in seconds and Timeout is specified in minutes.
FormCacheMax
Specifies the maximum number of forms to be retained in web engine memory for each user. The web engine always retains the last FormCacheMax forms used by each user. Forms beyond this number are eligible to be timed out. Timed out forms cannot be accessed by the Back or Forward buttons on the main page, and can no longer be submitted on a pop-up form.
Default:
10
Timed out forms save memory in the web engine, but they occasionally require users to manually refresh them. You can set FormCacheMax to - 1 to disable the FormTimeout feature.
FormTimeout
Specifies the minimum number of seconds that a form is retained in the web engine before it is eligible for removal from the cache. Users always have at least the number of seconds specified in this parameter to work on a form before submitting it. In addition, the web engine always retains the most recently used FormCacheMax forms for each user.
You can use the StayCacheList property to prevent specified forms from timing out.
Default:
180 (3 minutes)
FormTitle
Specifies a string to be included in the title bar of a web browser displaying a CA SDM web form. The value of FormTitle supplements the title of the specific form displayed.
Default:
CA SDM
For example, if the default value is retained, and Microsoft Internet Explorer is used to display the Announcement Detail form, the title bar displays the following:
Announcement Detail -- CA SDM -- Microsoft Internet Explorer
This property is optional. If omitted, the analyst web interface does not use a constant value in the title. The customer and PDA web interfaces revert to the default value.
HitTrackFile
Specifies the full path to a file that receives a log of all web pages used. One line is written to this file each time a user requests a page. The file can grow indefinitely, so be cautious when specifying this property.
Records containing a time stamp, user ID, database record ID, and HTMPL form name are appended to this file. The format of the records may change. You must periodically maintain this file so that it does not get too large.
This property is optional. If omitted, no hit tracking file is written.
HtmplCacheSize
Specifies the size of the HTMPL cache. When this size is exceeded, the least used form is removed from the cache.
Default:
1000.
ListAllMaximum
Specifies the maximum number of records that can be displayed in a list before a request to display the entire list produces a pop-up warning message advising the user that the request adversely impacts performance and is not allowed.
Default:
2500
ListAllWarn
Specifies the maximum number of records that can be displayed in a list before a request to display the entire list produces a pop-up warning message advising the user that the request may adversely impact performance, and asking for confirmation.
Default:
1000
ListBottomMaximum
Specifies the maximum number of records that can be displayed in a list before a request to scroll to the bottom produces a pop-up warning message advising the user that the request adversely impacts performance and is not allowed.
Default:
2500
ListBottomWarn
Specifies the maximum number of records that can be displayed in a list before a request to scroll to the bottom produces a pop-up warning message advising the user that the request may adversely impact performance, and asking for confirmation.
Default:
1000
ListPageLength
Specifies the maximum number of found records to be shown on a list page after performing a search.
Default:
10
LogoutURL
Specifies the complete URL of a web page to be displayed after a user logs out of CA SDM. This property is optional. If it is not specified, logging out returns the login form.
Lr_Refresh
Specifies the log reader refresh interval in seconds. If this property is non-zero, the Notification Log Reader automatically refreshes itself at the specified interval (with a minimum of thirty seconds).
This property is optional. If omitted, the log reader refreshes itself every 5 minutes (a default value of 300 seconds). If this property is specified as zero, the log reader does not automatically refresh at all.
MacroPath
Specifies a list of directory paths that the web engine searches to find files requested by the PDM_MACRO tag. You can specify multiple directories separated by spaces. You can include environment variables in the directory names by prefixing them with a dollar sign (for example, $NX_ROOT). For both Windows and UNIX, separate path components with a forward slash (/), not a backslash (\). This property is required. It is typically set as follows:
$NX_ROOT/site/mods/macro $NX_ROOT/bopcfg/www/macro
MatchesFound
Specifies the text of the message to display under a field when a user’s key for a lookup field is ambiguous and the edit form must be redisplayed with a drop-down select list. This property is optional; if omitted, it defaults to Multiple Matches.
MaxRecordsAutoSuggest
Specifies the number of records that autosuggest displays when search as you type or autosuggest displays suggestions below a lookup.
Default:
25
MaxSelectList
Specifies the maximum number of matches to display in the drop-down select list shown when a user’s key for a lookup field is ambiguous and the edit form must be redisplayed. If more than this many matches are found, the message specified for Too Many Matches is displayed.
MinCharsAutoSuggest
Specifies the minimum number of characters to enter in the lookup fields before search as you type or autosuggest displays suggestions.
Default:
3
MouseoverPreviewDelayTime
Specifies the delay time (in milliseconds) between hovering the mouse pointer over a link and the display of the mouseover preview.
If the mouse moves away from the link before the delay time expires, the preview does not appear.
Default:
1000
NoMatchesFound
Specifies the text of the message to display under a field when a user’s key for a lookup field is incorrect and the edit form must be redisplayed. This property is optional; if omitted, it defaults to No Matches Found.
PreLogin Timeout
Specifies the maximum number of minutes the web engine keeps a session active before login. The web engine automatically starts a session when a user requests a login form, in anticipation of the user completing the login. If the user does not login within the time period specified, the web engine destroys the session. If the user subsequently logs in, the web engine creates a session that is transparent to the user.
This property has no end-user impact. Its sole purpose is performance -- balancing web engine memory usage versus the overhead of destroying and recreating a session. This property is optional; if omitted, it defaults to one minute.
RedirectingURL
Specifies the URL the WebDirector should use to send requests to this web engine. This property specifies the full URL of the web engine, including http. This property is required if you are using WebDirector. It is ignored if you are not.
SchedExpMaximum
Specifies the limit of the number of schedule events that can be exported at a time.
Default:
1000
The default is the maximum exports that CA SDM can handle at a time. Increasing this default could cause system instability. If you attempt to export more than the value specified in SchedExpMaximum, a message appears refusing your exporting request.
SelListCacheExclude
Specifies the names of the factories (objects) to be excluded from caching for <PDM_SELECT> lists. To improve performance, the web engine usually caches in its own memory of the contents of small tables used in <PDM_SELECT> (drop-down) lists and hierarchical search lists. You may want to suppress caching for a table if you are using data partition constraints to specify that different users should receive different views of the table. In addition, including tables in the value of this property eliminates the need for the web engine to query their record count at startup, slightly improving startup performance. This property is optional. If specified, it should contain one or more object names separated by spaces.
SelListCacheMax
Defines the maximum number of records in a table that can be cached in the web engine. The web engine keeps the entire contents of tables at or below its cache size in its own memory, improving its performance in building <PDM_SELECT> lists using these tables. Specifying a higher value for this property improves performance at the expense of memory usage.
Default:
10
SelListCacheMax is ignored for tables used in hierarchical search lists, such as category on requests, issues, and change orders. The web engine always stores the entire contents of tables used in hierarchical search lists in its own memory. If you have a large number of values in any of these tables, you may want to specify the SelListCachePreload property.
SelListCachePreload
Specifies one or more tables to be loaded into the web engine’s select cache at startup time. Tables not specified in this property are loaded the first time they are used. If SelListCacheMax is large, or if you have a large number of records in a hierarchical search list (such as category), you may want to specify the table in SelListCachePreload. This avoids a response time delay the first time a user accesses a form using the table.
The specification for the SelListCachePreload property is a blank-separated list of object names. Each object name can be followed by an optional list of attribute names in parentheses. The attributes specified in the list are loaded into the web engine. If no attributes are specified, only the common name and rel attr value of the object are loaded. This is sufficient for drop-down selects, but may not be sufficient for hierarchical searches. If you modify the hierarchical search forms (hiersel_xx.htmpl, where xx is an object name), be sure that the SelListCachePreload property specifies every attribute used in the form. If you omit an attribute, the cache is reloaded when the form is used.
The SelListCachePreload property is optional. If it is omitted, nothing is loaded into the select cache until a user requests a form using a drop-down select or a hierarchical search.
chgcat(description owning_contract) chgstat crs isscat(description owning_contract) issstat pcat(description cr_flag in_flag pr_flag owning_contract) pri tskstat urg pcat_cr(description cr_flag in_flag pr_flag owning_contract) pcat_pr(description cr_flag in_flag pr_flag owning_contract) pcat_in(description cr_flag in_flag pr_flag owning_contract)
StayCacheList
Specifies the names of forms that are never removed from the forms cache, regardless of the length of time they have been displayed. This property ensures that the fixed frames on a frame display remain for the lifetime of a session. It can be used with caution to cause other forms to be permanently cached. The default is as follows:
scoreboard.htmpl top_splash.htmpl buttons.htmp hiersel_admin_tree.htmpl
SuppressHtmplCache
Specifies that the web engine should reread all files defining the contents of a page each time the page is requested. Parsing an HTMPL file takes a significant amount of web engine processing time, and usually involves reading several physical files (because most pages use PDM_INCLUDE tags). The web engine normally saves parsed files in its own memory so that future requests for the same page can be satisfied immediately. This markedly improves performance, but can be inconvenient for users in the process of developing new or updated pages, as the web engine must be recycled for changes to take effect.
This property is optional and requires no value. If it is specified, the web engine does not cache parsed files, and changes to HTMPL files take effect immediately. Because of its impact on performance, this property should not be specified in a production environment.
SuppressLoginAndLogoutMsg
Specifies that the web engine should not log a message to the CA SDM log file each time a user logs in or logs out of the web interface.
This property is optional. If it is not specified, the web engine logs a message each time a user logs in or logs out.
SuppressMacroCache
Specifies that the web engine should discard all saved macros each time a new page is requested. The web engine normally saves parsed macros in its own memory so that future requests for the macro can be satisfied immediately. This improves performance, but can be inconvenient for users in the process of developing new or updated macros, as the web engine must be recycled for changes to take effect.
This property is optional. If it is specified, the web engine does not cache parsed macros, and changes to macros take effect immediately. Because of its impact on performance, this property should not be specified in a production environment.
Timeout
Specifies the number of minutes that a user’s session can be idle before it is automatically terminated, freeing up all server resources.
The Timeout setting must be longer than the ExclLockSeconds setting. ExclLockSeconds is specified in seconds and Timeout is specified in minutes.
TooManyMatches
Specifies the text of the message to display under a field when a user’s key for a lookup field is ambiguous and the number of matches for the key exceeds the value of MaxSelectList. This property is optional; if omitted, it defaults to Too Many Matches.
UpdatedAnnouncementsPopup
The interval that browser checks for a new announcement. When a new announcement is found, it automatically shows the announcement in a popup window. The interval value is in minutes. To reduce the impact to the browser performance, it’s recommended to set this variable to the value greater than 5 (minutes).
UseDirector
Specifies when the WebDirector is controlling this web engine. The following table defines possible values:
Value
Description
No
The web engine is independent of the WebDirector. This is the default value.
Yes
The WebDirector must initiate all sessions, including the login form. If a user attempts to make a direct connection to the web engine, the web engine asks the WebDirector for a referral.
AfterLogin
The web engine refers a session to the WebDirector after authenticating a user. A web engine configured with UseDirector AfterLogin is responsible solely for authentication, and is thereby a candidate for the use of secure sockets (SSL) for maximum security.
BeforeLogin
The web engine refers a session to the WebDirector before authenticating a user. A web engine configured with UseDirectory BeforeLogin never displays a login page, and never accepts a login password.
This property is optional. If omitted, the web engine does not use the WebDirector.
UseNestedTabs
Specifies whether to display the nested tab control on detail forms.
Default:
Enabled
WebDirectorSlumpName
Specifies the name of the WebDirector servicing this web engine. This property is needed only if you are running more than one WebDirector, or if you have configured your WebDirector to use a slump name other than its default of web:director.
This property is optional if you are using WebDirector. It is ignored if you are not.
WillingnessValue
Specifies the willingness of this web engine to accept sessions, based on a scale of 0 to 10. This property is used only if you are using WebDirector. This value is meaningful only in comparison with the willingness of other web engines associated with the same WebDirector. The WebDirector transfers sessions to web engines in proportion to their willingness values. A web engine with a willingness value of twice that of another web engine’s, on average, services twice the number of sessions.
A WillingnessValue of zero means that the web engine does not accept any sessions. This value can be useful when UseDirector is AfterLogin.
This property is optional if you are using WebDirector. It is ignored if you are not. If omitted, the web engine sets its willingness to 5.
WorkFrameTimeout
Specifies the maximum number of seconds the web engine waits for a response to an internal server request before concluding the request has failed. The workframe is used for CA SDM web interface features requiring server data other than normal web pages. This includes such features as autofill, loading category properties, and updating scoreboard counts. Workframe requests to the CA SDM are unlikely to fail. However, workframe requests to other servers (such as integrated products, such as Knowledge Management) may fail if the targeted server is not running, or if a network problem prevents access to it. The WorkFrameTimeout property specifies a length of time before the request is considered to have failed, and the workframe is available for other requests.
WorkFrameTimeout is not checked unless a workframe is needed and all workframes are in use. Therefore, it is quite likely that a remote server is going to have more time than that specified for WorkFrameTimeout to respond. The value of WorkFrameTimeout is a minimum.
This property is optional. If omitted, the web engine uses a 30 second work frame timeout.