Configure
CA Endevor
Web Services with z/OSMF

As a domain administrator, configure the  Web Services with z/OSMF web interface. z/OSMF web interface helps you automate the configuration with the minimum mainframe expertise and also reduces the time that is required to perform the configuration tasks. You use the z/OSMF interface to register and execute the workflow to create a  Web Services configuration. The z/OSMF workflow includes the following files:
ce18
As a domain administrator, configure the 
CA Endevor
 Web Services with z/OSMF web interface. z/OSMF web interface helps you automate the configuration with the minimum mainframe expertise and also reduces the time that is required to perform the configuration tasks. You use the z/OSMF interface to register and execute the workflow to create a 
CA Endevor
 Web Services configuration. The z/OSMF workflow includes the following files:
  •  
    Workflow variables input file
    Includes the list of variables with default values that you need to modify to meet the 
    CA Endevor
     Web Services configuration requirements.
  •  
    Workflow file
     
    Defines the steps that you execute to create a 
    CA Endevor
     Web Services configuration.
    After you register the workflow in z/OSMF and execute the steps, the Apache Tomcat server is ready to start. 
Prerequisites
Ensure that you have the following z/OSMF requirements to deploy and create a CCS Apache Tomcat instance using z/OSMF:
 Systems programmers and security administrators can perform the prerequisite tasks simultaneously.
(Optional) Assign Values for Variables 
The workflow variable input file
ENDEVORAPI.properties
 
that is located in the USS directory contains the default configuration values for variables. Edit the values of variables to meet your requirements. You can reuse the modified workflow variable input file to configure multiple 
CA Endevor
 Web Services configurations, which reduces the time for any subsequent configuration. For more information about the list of variables that you require to edit, see Assign Values for Variables to Auto-populate in z/OSMF UI
 You can also edit and review the values for variables in the web interface when you execute the steps to create a configuration.
Register the Workflow
After you define the values for variables, the next step is to register and execute the workflow to make the solution ready to start. 
 
Follow these steps:
 
  1. Log in to the z/OSMF web interface.
  2. Select 
    Workflows
     from the navigation tree.
  3. Select 
    Create Workflow
     from the 
    Actions
     menu.
    The 
    Create Workflow
     panel appears.
  4. Select or enter the name of the file that resides on the z/OS system where z/OSMF is running.
  5. Enter the files or DSN path in the following fields:
    •  
      Workflow Definition File
      Specifies the complete path to 
      EndevorWS-workflow.xml
       file that resides in a z/OS UNIX directory. This file is located in the 
      CA Endevor
       USS file directory
      /tpv/
    •  
      Workflow Variable Input File
      Specifies the complete path to 
      EndevorWS-workflow.properties
       that is in the USS directory. This file is located in the 
      CA Endevor
       USS file directory 
      /tpv/
       Ensure that you specify the path to the properties file that you modified to assign the values for variables in advance to auto-populate in the z/OSMF web interface. For more information about assigning values for variables in the workflow variable input file, see Assign Values for Variables to Auto-populate in z/OSMF UI.
  6. Select the 
    System
     where you want to execute the workflow.
  7. Select 
    Next
    .
  8. Specify a unique 
    Workflow name.
     
  9. Select or type an 
    Owner user ID
    , and select 
    Assign all steps to Owner 
     
    User ID
    .
  10. Select 
    Finish
    .
    z/OSMF displays the following list of steps that you need to execute to create an instance: 
    • Step 1: Define or update values for the basic variables needed to deploy the Web Services .war file.
    • Step 2: Define or update values for variables needed to enable the discovery service for the 
      CA Endevor
       API.
    • Step 3: Verify the path where 
      CA Endevor
       has been installed.
    • Step 4: Verify the Apache Tomcat path location where Web Services will be deployed.
    • Step 5: Deploy the Web Services .war file from the source folder to the destination Apache Tomcat instance.
    • Step 6: Generate the configuration file for your Web Services instance according to the workflow variables.
    • Step 7: Modifies the post-installation configuration file for STC.
    • Step 8: Modifies the post-installation environment file for the started task command (STC).
    • Step 9: Modifies the post-installation STC.
    • Step 10: Starts the Apache Tomcat STC.
The workflow is registered in z/OSMF for the z/OS system. 
Execute the Workflow
Execute the steps for the registered workflow to create a configuration. Execute the step 
Define or Update Values for Variables 
manually to verify and update the values for variables. The remaining steps are automated. After you complete the execution of all the steps, the 
CA Endevor
 configuration is ready to start.
 Before you execute the workflow steps, you must provide a valid JOB statement that includes your ACCOUNTINFO and MSGCLASS information. Do not use the default MSGCLASS value. For more information about customizing the JOB statement for z/OSMF workflows, see the IBM documentation.
 
Follow these steps:
 
  1. Log in to the z/OSMF web interface.
  2. Select 
    Workflows
     from the navigation tree.
  3. Select the workflow that you registered from the workflow list.
  4. Execute the first step in the workflow with a state of 
    Ready
    1. Double-click the title of the step 
      Define or Update Values for Variables
      .
      These settings are used to customize the 
      CA Endevor
       Web Services behavior and establish operational settings that are processed when the product is started. 
      The 
      Properties for Workflow Step 1
       dialog displays. Use this dialog to verify and update the values for variables.
    2. Click the 
      Perform
       tab, review and update the values for variables as needed, and click 
      Next
      This step substitutes the values for variables based on the values that you specify.
       If you predefined these values, the variables are auto-populated with those values as supplied in the variable input file.
    3. Continue to click 
      Next
       until you get to the panel that shows the JOB statement.
    4. Verify and correct the JOB statement, and click 
      Next
      .
      The Review JCL panel appears.
    5. Click 
      Next
      , select the 
      Submit JCL
       checkbox if unchecked, and click 
      Finish
      .
      The Status panel appears.
    6. Click 
      Refresh
       until the job completes.
      A return code of zero (0) is expected.
    7. Click 
      Close
       to return to the panel showing the workflow steps.  
      The step is now marked 
      Complete
      .
    The variable values are reviewed and updated. 
  5. Execute the second step, in the workflow with a state of 
    Ready
    :
    1. Double-click the title of the step.
    2. Select the 
      Perform 
      tab and select 
      Automatically perform the selected step, and all the subsequent automated steps, according to their declared step dependencies
      .
    3. Select 
      OK
      .
    The automated steps in the workflow are executed. The status is now marked Complete for all the steps.
The 
CA Endevor
 configuration is ready.
Next Step
After you complete the configuration of
CA Endevor
Web Services with z/OSMF workflows, verify the configuration using one of the methods described in Validate Web Services.