Configure
CA Endevor
for Web Services

As the  administrator you can configure  to support the Web Services component. Web Services is a prerequisite for the Eclipse-based UI.
ce18
As the
CA Endevor
administrator you can configure
CA Endevor
to support the Web Services component. Web Services is a prerequisite for the Eclipse-based UI.
How to Configure
CA Endevor
for Web Services
How to Configure CA Endevor for Web Services
Follow these steps:
  1. Review the prerequisite information. For more information, see How to Enable Web Services.
  2. Configure Type definitions for Text and Binary Files and review Support for Element Types. Then define Type definitions as appropriate for your site as described in the following articles:
  3. (Optional) To optimize the use of your Master Control File (MCF) and Package data set, we strongly recommend that you implement IBM VSAM Record Level Sharing Support (RLS).
Configure Defaults Table for Web Services
To enable
CA Endevor
to use Web Services, customize the TYPE=MAIN section of the C1DEFLTS table (Defaults table).
Follow these steps:
  1. Set the BATCHID parameter in the TYPE=MAIN section of the C1DEFLTS table to 1. The BATCHID parameter specifies that the
    CA Endevor
    user ID associated with a batch job is determined by the USER parameter that is specified on the JOB statement instead of the JOBNAME.
  2. Specify a value for MODHLI, if your site uses RACF with the RACF PROTECTALL enabled. When using the Eclipse-Based UI, CA CMEW, or any other client program under RACF with the RACF PROTECTALL option activated, security violations are issued, unless MODHLI is coded. These violations occur where the ID used to allocate the temporary files that are required by Web Services is different than the ID used to open the files. Specifically, the data sets are allocated under the context of the user ID provided on the CA Common Services Common Communications Interface (CAICCI) request to spawn the pool STCs. The open and write requests are issued under the context of the user ID signed on to the client program that is issuing requests through Web Services.
    MODHLI affects security. For more information, see Determine the Web Services Security Requirements for MODHLI.
  3. Assemble and link-edit the table. You can use an SMP/E USERMOD to assemble and link-edit C1DEFLTS after it has been customized. Alternatively, you can edit the sample JCL BC1JTABL to assemble and link source module C1DEFLTS outside of SMP/E. BC1JTABL is supplied in the installation library iprfx.iqual.CSIQJCL. The iprfx.iqual.CSIQJCL library stores the defaults table in iprfx.iqual.CSIQAUTU as member C1DEFLTS, enabling
    CA Endevor
    to use Web Services.
Determine the Web Services Security Requirements for MODHLI Data Sets
To enable client programs to access the API, your security administrator may need to enable user access to MODHLI data sets. The
CA Endevor
administrator must determine the security requirements for MODHLI data sets.
Follow these steps:
  1. View your C1DEFLTS table, to see if a MODHLI value is coded in the TYPE=MAIN section of the table.
    • If the MODHLI value is coded, your security administrator must grant all user IDs access to all data sets with the MODHLI high-level qualifier (HLQ). This requirement applies to access under all security products including RACF, CA Top Secret, or CA ACF2.
      This action is required because, for a client program to access the API, the user ID sent to CAICCI to spawn the pool STCs and the user IDs that issue requests to Web Services must have read/write access to these data sets. The MODHLI parameter therefore causes the data set names to be built with the following format:
      modhli.Dyyddd.Thhmmss.STCnnnnn.ddname
      • STCnnnnn, ddname
        The job ID and ddname that is the unique qualifier for one of the nine API-related files (APIMSGS, C1MSGS1, and so on).
    • If a MODLHI value is not coded, security is unaffected because the temporary data sets names are built by the operating system with the standard temporary data set HLQ in the following format: SYSyyddd.Thhmmss.RA000.jobname.nnnnnn
  2. Request your security administrator to grant all user IDs access to all data sets with the MODHLI high-level qualifier (HLQ), if the MODHLI value is coded in C1DEFLTS, ensuring that the client programs can access the API.
Support for Element Types
You can add files accessible on a client machine to
CA Endevor
and retrieve elements from
CA Endevor
. Web Services transfers files to and from the client application using SOAP attachments. To enable the translation of transferred data, a
CA Endevor
Type record must be properly defined for each type of data to be managed. The characteristics of binary and text files are described next:
  • Text files
    CA Endevor
    defines a text file as one that has line delimiters and requires character translation. You can store text files on the mainframe and can browse them in
    CA Endevor
    . Detailed change history is stored for text files.
    Browsing an element in
    CA Endevor
    invokes the EBCDIC-to-ASCII conversion function of
    CA Endevor
    ; the EBCDIC-to-local file system encoding is not used. However, when you retrieve a text file from
    CA Endevor
    , the Web Services server converts EBCDIC from the mainframe. The
    CA Endevor
    administrator must work with the web services administrator to properly define the element Type for text files. The CodePage Web Services parameter in the Web Services configuration file defines the character sets for the mainframe and Web Services. The configuration file is customized by your Web Services administrator. A description of this parameter follows:
  • CodePage
    Specifies the code page, which is defined in the mainframe operating system, that
    CA Endevor
    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 that is exchanged between the client computer and the API. Plain text information includes SCL commands that are sent to the API and reports and CSV files that are extracted from the API.
    For information about supported encodings, see Supported Encodings.
    Default:
    cp01140
  • Binary files
    CA Endevor
    defines a binary file as one that does not have line delimiters or require character translation. Examples of binary files are Microsoft Word documents or Excel spreadsheets. Long names are typically used for naming binary files. Specific file versions can be retrieved through Web Services. You can browse binary files whose content type is recognized by your browser when using Web Services. Detailed change history is stored for binary files, except for file Types defined with log delta format.
Define an Element Type for Text Files
To enable Web Services to transfer text files using attachments, Type definitions for text files must be properly configured in
CA Endevor
.
CA Endevor
defines a text file as one that has line delimiters and requires character translation. You can store text files on the mainframe and can browse them in
CA Endevor
. To define a text Type, complete the following steps:
  1. Define the base and delta libraries using
    CA Endevor
    rules for the specific file type.
  2. Set TYPE DEFINITION panel fields to the following values to define a
    CA Endevor
    Type record for text data.
    1. Set the FWD/REV/IMG DELTA field to F for forward or R for reverse to specify the delta storage format.
    2. Set the COMPRESS BASE/ENCRYPT NAME field to N for element names that do not exceed eight characters and are uppercase. For other element names, set this field to Y. If set to Y, the base library must be UNIX System Services (USS).
    3. Set the COMPARE FROM field to a value appropriate for the type of data. For example, COBOL can be 7.
    4. Set the SOURCE LENGTH and COMPARE TO fields to values appropriate for the type of data. For example, the fields for COBOL SOURCE LENGTH can be 80, and the field for COMPARE TO can be 72.
    5. Set the UNIX System Services (USS) RECFM field to CRLF. This field specifies the line feed character for Microsoft Windows files. If you do not specify CRLF for text types that are accessed using local file system support, you get unexpected results in Windows-based editors.
    6. Set the DATA FORMAT field to T for text. This triggers conversion from EBCDIC to local file system encoding.
    7. Set the FILE EXT field to the file name extension that you want the file type to have on the local machine (cob, jcl, and so on). You can also leave it blank. FILE EXT is used when you are adding files from, or retrieving files to a local directory using Web Services.
Web Services can now transfer text files using attachments set to the specified file name extension.
Define an Element Type for Binary Files
To define an element Type for binary files (for example, WAR, EAR, JAR DOC, PPT, and XLS), use the following steps:
  1. Define the Base library
    Values:
    PDS, PDSE, ELIB, CA Panvalet, or CA Librarian
  2. Define the Delta library
    Values:
    The delta library can be PDS, PDSE, or ELIB.
    1. Define the delta library as follows:
      • The delta PDS, PDSE, or ELIB record format must be variable blocked.
      • The delta library record length and the Type definition source length can be any value (for example, 259, 6024 or 27984). However, define the maximum delta record length about twice the source length. We recommend an LRECL value of 27,984. For example:
        DCB=(DSORG=PO,RECFM=VB,LRECL=27984,BLKSIZE=0)
  3. Type definition -- Set the TYPE DEFINITION to the following values to define the
    CA Endevor
    Type record for the binary element data.
    • Set the Fwd/Rev/Img/Log Delta field to one of the following formats:
      • I
        -- Image delta format. The image delta format stores the full image of the file, and suppresses the comparison logic. Each update causes the entire file to be added as a new level.
        Using the full image delta can cause the delta file to run out of space if you have very large binary files and set a high consolidation level.
      • L
        -- Log delta format. The log delta format stores only the last level of the element and stores it as a full image of the element. Delta files contain only change activity information by level. Source changes by level are not kept. Consequently, you cannot view prior source levels or display source change or history.
        Before deciding which delta format to use, consider the benefits and limitations of both. The image delta format can use much space, but prior levels are retained. Whereas, the log delta format only keeps the current element, but does not keep prior levels. For more information about delta formats, see Element Storage Formats.
    • Set the COMPARE FROM field to 1. This option specifies the position within each statement at which
      CA Endevor
      begins comparing to identify changed statements (5 digits in the range 1-32,000).
    • Set the SOURCE LENGTH field to 13992. This option specifies the logical record length in the source statements. Although the maximum allowable value is 32000, the value must not exceed the maximum physical record length in the delta library definition.
    • Set the COMPARE TO field to 13992. This option specifies the position within each statement at which
      CA Endevor
      stops comparing to identify changed statements.
    • Set the UNIX System Services (USS) RECFM field to F to specify the fixed length. This option specifies the record delimiter. A record delimiter is necessary due to the nature of UNIX System Services (USS) files. USS files contain one large data stream. Therefore, a delimiter is used to identify individual records within that data stream. This is also true for elements associated with a Type defined as Data Format=Text when the element is transferred between
      CA Endevor
      and Web Services. Web Services recognizes and appends the delimiter for the exchanged records.
    • Set the DATA FORMAT field to B for binary. (
      Default
      option: B). This option deactivates compression and prevents text character conversion from being invoked.
    • Set the FILE EXT field to a valid file extension. The file extension identifies the file type when you are adding from or retrieving to a local file directory using CA CMEW, the Eclipse-Based UI, or a Web Services user-written client program.
      • Values:
        • doc
        • ppt
        • xls
        • jar
        • ear, (....and so on)
        • blank.
    • Set the COMPRESS BASE/ENCRYPT NAME field to Y or N. This option specifies whether to encrypt and compress the base form of elements stored in reverse delta format.
Resize a zFS Linear Data Set
Web Services is installed as a linear VSAM file,
iprfx.iqual
.CSIQUSSM, which contains a file system that is mounted to a user-defined mount point on the Z/OS UNIX file system.
A user can receive the error message “EDC5133I No space left on device”, which indicates that there is no free space left in the z/OS UNIX file system. As a Web Services administrator, you can allocate additional space for the file system.
A sample batch JCL job, WSZFSRSZ, is delivered in iprfx.iqual.CSIQJCL. This job, in summary, does the following:
  1. Deletes work files
  2. Produces details of the original zFS linear data set into the job output
  3. Unmounts the original zFS linear data set from the z/OS UNIX file system
  4. Allocates a new zFS linear data set with your allocation values
  5. Creates a backup data set with the data from the original zFS data set
  6. Alters the name of the original zFS linear data set to ‘zFSFile.OLD’
  7. Alters the name of the new zFS linear data set to the original zFS linear data set name
  8. Restores the data from the backup data set into the resized zFS linear data set
  9. Produces details of the resized zFS linear data set into the job output
  10. Mounts the resized zFS linear data set to the z/OS UNIX file system
After the successful execution of the batch JCL job, WSZFSRSZ, you can view the job output or view the VSAM attributes to verify the data set was resized correctly.