Configuring a Web Service

You must add a Web services data connection to import data from a data system by using a Web service.
  1. To configure a Web service data connection
  2. Go to
    Manage > External Data Integration
    .
  3. From the External Data Systems list, select the data system and then do one of the following:
    • From the taskbar, select
      System Tasks > Add Data Connection
      .
    • Right-click the data system and then select
      Add Data Connection
      .
  4. In the
    Specify the External Data System
    panel, do the following and then click
    Next
    :
    System name
    Enter a name for the external data system that you want to add.
    Description
    Add a brief description on the external data system.
    This step is optional.
  5. In the
    Specify Data Connection Parameters
    panel, do the following and then click
    Next
    :
    Connection name
    Enter the name of the external data connection that you want to create.
    Data import site
    Select a site to route the job to the CCS Managers that are present in it.
    Connection type
    Select
    Web service
    .
    Data Location
    To specify a new data location, click
    New
    .
  6. In the
    Add Data Location
    dialog box, provide the following information and then click
    OK
    :
    Name
    Enter a name for the data location that you want to create.
    Description
    Enter a brief description about the data location that you want to create.
    Discovery URL
    Enter the metadata (WSDL) URL of the service.
    Click Discover to auto-populate the
    Service URL
    drop-down list with the available endpoints.
    Service URL
    Displays the available endpoints that are available at the specified location.
    Enter the endpoint URL or select the appropriate endpoint from the list.
    Binding Type
    Select
    Basic HTTP
    ,
    WSHTTP, or
    Basic HTTP(SSL)
    from the drop-down list.
    User name
    Provide the user name to connect to the service.
    Password
    Provide the password to authenticate the user account that you have specified.
    Confirm password
    Re-type the password.
    Test Connection
    Click to test the connection to the Web service.
  7. After specifying the data location, the parameters for scoping the data are displayed in the Parameters grid. This information is fetched from the GetParameterInformation method implemented in the Web service. In the Parameters grid, for each parameter, in the Values column, click the (...) button to add the parameter value.
  8. In the
    Web Service Parameter
    dialog box, from the
    Values to add
    drop-down list, enter the parameter value or select the appropriate value from the list, and click
    Add
    .
    You cannot set multiple values for a parameter.
  9. Click
    OK
    and then click
    Next
    .
  10. In the
    Select Data Fields
    panel, select the data fields that you want to include when you import the external data and then click
    Next
    .
    You must select minimum two fields to import data.
  11. In the
    Select Data Schema
    panel, select one of the following options and then click
    Next
    :
    Create new schema
    Schema is a representation of external data in CCS.
    Enter the following information:
    • In the
      Schema name
      text box, enter a name for the new schema that you want to create.
    • In the
      Description
      field, enter a brief description of the new schema.
    If you click
    Create new schema
    , then go to Step 12.
    Existing schema
    From the
    Select CCS schema
    drop-down list select the matching CCS schema to the external data.
    If you click
    Existing schema
    , then go to Step 11.
  12. The
    Map Data Fields to CCS Schema Fields
    panel displays the data fields that you specified in the
    Select Data Fields
    panel.
    Do the following and then click
    Next
    :
    • Drag the data fields from the
      Field Name
      column in the left-hand box to the
      Mapped Field Name
      column against the corresponding CCS field in the right-hand box. To identify unique fields in the external data, you must map the external data fields with key fields in the schema. The
      Is a Key Field
      column in the existing schema displays the key fields in the schema. If all the external data fields are mapped to CCS schema, go to Step 16.
    • Check
      Extend CCS Schema to import unmapped fields
      if you want to extend the selected CCS schema to import the fields that are unmapped, and click
      Next
      .
  13. The
    Associate imported data with CCS
    panel displays the data fields that you specified in the
    Select Data Fields
    panel or the fields that were unmapped in the
    Map Data Fields to CCS Schema Fields
    panel.
    Enter the following information in the
    CCS fields
    list box and then click
    Next
    :
    CCS Field
    Displays the fields that you selected in the
    Select Data Fields
    panel.
    Click the CCS field name to edit the name.
    CCS data type
    Select the data type from the drop-down list.
    For Incremental Data Import select the data type of one of the fields as DateTime.
    This field is used for incremental data collection as evaluation date time field. In incremental data import, the records only beyond the maximum date in the evaluation date time field, are fetched in subsequent imports.
    Description
    Add some description text for the field.
    Attribute of
    Select the CCS attribute to which you want to map the specified external data field. For example, Asset, Assessment, or Status.
    Is a key field
    Check to specify if the selected field is a key field. Key field is a mandatory field in CCS schema.
    You must specify minimum one field as a key field for asset and assessment.
  14. Perform this step only if you have selected a data type as DateTime, in Step 12
    In the
    Format and Date Time
    panel, provide the following information and then click
    Next
    :
    Evaluation date field
    This field is used for incremental data collection. In incremental data import, the records only beyond the maximum date in the evaluation date time field, are fetched in subsequent imports.
    Select the evaluate date field from the
    Evaluation date field
    drop-down list.
    Date-time format
    Specify the date time format that you want to apply for all DateTime fields in the schema.
    To specify the date time format for a particular field, select the date time format in Date Time Format column for that field, in the schema.
    Check
    Apply to all fields
    if you want your selection to be applied to all the DateTime data fields.
    Refer to the Date-time formats supported in Control Compliance Suite section to view the datetime formats supported while importing external data.
    Time zone
    Select the time zone.
    To specify the time zone for a particular field, select the time zone in Time Zone column for that field, in the schema.
    Check
    Apply to all fields
    if you want your selection to be applied to all the Time Zone data fields.
  15. In the
    Data Import Schedule
    panel, select one of the following schedule options and then click
    Next
    :
    • Run now
      Select this option to run the job immediately after you click
      Finish
      .
    • Run periodically
      Select this option to run the job on a specified date and time.
      Provide the following information:
      Start on
      Select the date and time to execute the data import.
      Run once
      Select this option to execute the data import one time on the specified date and time.
      Run every <number of days>
      Select this option to specify how often (in days) you want to schedule the data import execution.
  16. In the
    Email Notification
    panel, check
    Send Notification
    if you want to send a notification upon the success or failure of the data import execution. Both the tabs in the
    Email Notification
    panel contain the same options. Enter the following information and then click
    Next
    :
    Subject
    Enter the subject of the notification mail.
    Message
    Enter the message of the notification mail.
    From (Email ID)
    Enter the sender's email ID.
    To (Email IDs)
    Enter the receiver's email ID.
    Notification can be sent to multiple recipients. Separate each email ID with a comma.
  17. In the
    Summary
    panel, view the summary and then click
    Finish
    .