The delivered data source configuration file, ENDEVOR.cfg, file contains the recommended parameters for running web services. The following list describes each of these parameters, as well as additional, optional and reserved parameters:
Specifies a 1- to 20-character alphanumeric name that identifies the CA Endevor SCM data source that this configuration file applies to.
Note: To be a valid configuration file, the name of the .cfg file must match the Name= value specified within the file. To connect a user-written client to a data source, the DataSource parameter specified in the client request is matched to the name of the configuration file.
Specifies whether the service is active. Valid values are 1- to 15-character text strings. Recommended values are Available or Unavailable. This text appears where the data source is listed as a valid data source by the client application.
Specifies any 1- to 100-character message you want for this data source, such as "Welcome to CA Endevor SCM Web Services. Service is open." This text appears where the data source is listed as a valid data source by the client application.
Specifies any 1- to 100-character description you want for this data source, such as "CA Endevor SCM Web Service" This text appears where the data source is listed as a valid data source by the client application.
Specifies the one- to eight-character CAICCI hostname associated with the data source. Use the value of SYSID in the CCIPARM file, which is the SYSID of the system where CA Endevor SCM is installed.
Specifies the one- to eight-character CAICCI host application or process name used to start the CA Endevor SCM API server. Use the CA Endevor SCM mainframe started task procedure specified in the WSEWSCCI file. The jobname supplied as an example is: WSEWSSTC
Specifies the one- to eight-character name of the program started by Jobname, which is BC1PAPI0. This is the only valid value.
Specifies the one- to eight-character user ID used to spawn STCs for the STC pool. Any ID used here must be defined following the instruction in “How to Enable Security Access to Web Services”. This value overrides the user ID used to spawn STCs. The default user ID that is used to start the Web Services with a password of NOTREQED.
Specifies a one- to eight- character string. The value is either the password for the ID supplied in UserID or NOTREQED if that ID does not have a password. This value or EncryptedPassword must be coded if UserId is coded.
Specifies a 64-bit encoded string of the Password value. For a Password of NOTREQED this value is Tk9UUkVRRUQ=. This value or Password must be coded if UserId is coded.
Specifies a 1- to 100-character string that helps identify the data source to users.
Specifies the number of initial (permanent) STC in the STC pool. The permanent STCs are created when Web Services is initiated. Each STC in the pool can transmit API requests from different clients to CA Endevor SCM on the mainframe.
Valid values are: 0 through 20
Default: 0
Note: The sum of PoolInitSize and PoolIncrSize cannot exceed the value of PoolMaxSize.
Specifies the number of incremental STCs that the pool maintenance thread can create in addition to the permanent pool when a shortage of STC is detected. If PoolInitSize is set to 0, all STC connections are allocated from the incremental Pool. After the workload decreases, the thread releases the extra STC connections from the incremental pool. STCs will be started one at a time as needed.
Valid values are: 0 through 5
Default: 1
Note: The sum of PoolInitSize and PoolIncrSize cannot exceed the value of PoolMaxSize.
Specifies the maximum number of live permanent and incremental STCs in the pool. The STC pool maintenance thread maintains up to this number of STCs in the pool. If the maximum numbers of STCs are fully utilized, incoming web service calls are rejected.
Valid values are: 0 through 40
Default: 0
Specifies the interval, in seconds, between runs of the STC pool maintenance monitoring thread. For example, if this value is set to 180 (the default), the monitor thread runs every 180 seconds. Consider the following criteria when setting the PoolreapTime value:
Valid values, in seconds, are: 0 through 600
Default: 180
Specifies how long an STC connection can remain idle, before the monitor thread discards the connection. The accuracy of this timeout and performance are affected by the PoolreapTime value.
Set the Unused Timeout value higher than the PoolreapTime value for optimal performance. For example, if the unused timeout value is set to 120 and the STC monitoring thread is enabled with a PoolreapTime of 60, any unused STC remains active for at most 60 seconds before being shut down.
Valid values, in seconds, are: 0 through 3600
Default: 0
Specifies how long an STC connection can remain active, before the monitor thread discards the connection. The accuracy of this timeout and performance are affected by the PoolreapTime value.
Set the Aged Timeout value higher than the PoolreapTime value for optimal performance. For example, if the Aged Timeout value is set to 1200 and the PoolreapTime value is 60, any STC remains in existence for at most 1140 seconds (19 minutes) before being shut down.
Setting Aged Timeout to 0 allows active STCs to remain in the pool indefinitely, unless shut down is based on other parameter values.
Valid values, in seconds, are: 0 through 1200
Default: 1200
This parameter is for future use. The only valid value is 0.
Default: 0
This parameter is for future use. The only valid value is 0.
Default: 0
This parameter is for future use. The only valid value is 0.
Default: 0
This parameter is for future use. The only valid value is 0.
Default: 0
This parameter is for future use. The only valid value is 0.
Default: 0
Important: These values are superseded if values are passed with the submitSCL() call.
Specifies a two-character language code for the CodePage.
Default: EN.
Specifies the time zone where the data source is located, expressed as a positive or negative offset from GMT+0, for example GMT-6.0. Web Services uses this value to determine the correct time on the z/OS mainframe where the data source resides, for use in messages.
Specifies the code page, defined in the mainframe operating system that CA Endevor SCM is using. The code page is a variation of the Extended Binary Coded Decimal Interchange Code (EBCDIC) that defines how text files are coded on the mainframe.
The CodePage and CharacterSet parameters enable Web Services to translate the plain text information exchanged between the client computer and the API. Plain text information includes SCL commands sent to the API and reports and CSV files extracted from the API.
For information about supported encodings, see: http://download.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html
Default: cp01140
Specifies the character set used by the client application, for example latin1 or iso8859-1. The CharacterSet value specifies how Web Services is to convert the mainframe code page to and from the alphabet used by the client application. This value is used for conversion of plain text information only. For more information, see the CodePage parameter defined in this topic.
Specifies the encoding scheme for CA Endevor SCM elements stored in the client local file system. This value specifies the name of the character set that the Web Services Java Virtual Machine uses for text character conversion. This value applies to the exchange of files between the client application and the API. In CA Endevor SCM, these files are associated with an element Type defined with DATA FORMAT=Text.
Default: ISO-8859-1
Important! When you Add or Update an element to a file Type defined in CA Endevor SCM as DATA FORMAT=Text, Web Services attempts to translate this file from the code page on the local workstation to the mainframe code page using the character sets defined in the LFS.Encoding and CodePage parameters. All characters in the local code page may not have an appropriate mapping in the host code page. The same consideration applies when retrieving a text element. For files that do not require character set conversion, the Type definition must specify DATA FORMAT=Binary.
Specifies the encoding scheme for CA Endevor SCM element. This value is usually the same value as the CodePage.
Specifies how CA Endevor SCM reports and queries are exchanged with the Web Services client computer. The default is Text.
Specifies what to trace. Valid values include a trace level or string value. The default is 0.
Specifies the user name to be traced. Valid values include:
user-name – Specifies a one- to eight-character user name.
ALL – Specifies all users.
|
Copyright © 2013 CA.
All rights reserved.
|
|