Previous Topic: Configure IBM Content CollectorNext Topic: Properties: CA DataMinder Import Analyze Request Metadata


Add User-Defined Metadata for Web Service Requests and Responses

You must add user-defined metadata for all data sent in CA DataMinder web service requests and returned in web service responses.

To add 'Analyze Request' metadata

  1. Launch the IBM Content Collector Configuration Manager
  2. In the Metadata and Lists tab, click ‘User-Defined Metadata’.
  3. In the Configured User-defined Metadata pane, click the Add Metadata button Add button.

    This creates a User-defined Metadata pane, comprising two sections: General and Metadata Properties.

  4. In the General section, type the name of the metadata entity in the Display Name field:
    CA DataMinder Import Analyze Request Metadata 
    

    Important! Enter the name exactly as shown above. This name will be used to define the JSON used in the web service request and response.

  5. In the Metadata Properties section, click the Import Metadata Properties button Import Metadata Properties button.

    The Import Metadata Properties dialog appears.

    1. In the File Name field, click the browse button browse button and select this file:
      CA DataMinder Import Analyze Request Metadata.xml 
      

      Find this file in the \CA\CA DataMinder\ICC subfolder below the 64-bit CA DataMinder installation folder.

    2. Click OK to import the required properties for this metadata.
  6. In the General section, change the system-defined GUID in the ID field:

    Change GUID button

    To do this, click the square Edit button (1) to right of the ID field. Then replace the default GUID with:

    ca.dataminder.metadata.import.analyze.request
    

    Important: Enter the new GUID exactly as shown above. Content Collector uses this ID value to map the response returned from the CA DataMinder web service.

  7. Click File, Save to save the new metadata.

    Now add the Commit Request metadata.

To add 'Commit Request' metadata

  1. Launch the IBM Content Collector Configuration Manager
  2. In the Metadata and Lists tab, click ‘User-Defined Metadata’.
  3. In the Configured User-defined Metadata pane, click the Add Metadata button Add button.
  4. In the General section of the User-defined Metadata pane, type the following name in the Display Name field:
    CA DataMinder Import Commit Request Metadata 
    

    Important! Enter the name exactly as shown above.

  5. In the Metadata Properties section, click the Import Metadata Properties button Import Metadata Properties button.

    The Import Metadata Properties dialog appears.

    1. In the File Name field, click the browse button browse button and select this file:
      CA DataMinder Import Commit Request Metadata.xml 
      

      Find this file in the \CA\CA DataMinder\ICC subfolder below the 64-bit CA DataMinder installation folder.

    2. Click OK to import the required properties for this metadata.
  6. In the General section, change the system-defined GUID in the ID field. To do this, click the square Edit button to right of the ID field. Then replace the default GUID with:
    ca.dataminder.metadata.import.commit.request
    

    Important: Enter the new GUID exactly as shown above.

  7. Click File, Save to save the new metadata.

    Now add the Response metadata.

To add 'Response' metadata

  1. Launch the IBM Content Collector Configuration Manager
  2. In the Metadata and Lists tab, click ‘User-Defined Metadata’.
  3. In the Configured User-defined Metadata pane, click the Add Metadata button Add button.
  4. In the General section of the User-defined Metadata pane, Type the following name in the Display Name field:
    CA DataMinder Import Metadata Response
    

    Important! Enter the name exactly as shown above.

  5. In the Metadata Properties section, click the Import Metadata Properties button Import Metadata Properties button.

    The Import Metadata Properties dialog appears.

    1. In the File Name field, click the browse button browse button and select this file:
      CA DataMinder Import Metadata Response.xml 
      

      Find this file in the \CA\CA DataMinder\ICC subfolder below the 64-bit CA DataMinder installation folder.

    2. Click OK to import the required default properties for this metadata.

    Note: When you define your CA DataMinder smart tags, you must add corresponding properties for each smart tags to this list in the Metadata Properties section.

  6. In the General section, change the system-defined GUID in the ID field. To do this, click the square Edit button to right of the ID field. Then replace the default GUID with:
    ca.dataminder.import.response
    

    Important: Enter the new GUID exactly as shown above.

  7. Click File, Save to save the new metadata.

More information:

Properties: CA DataMinder Import Analyze Request Metadata

Properties: CA DataMinder Import Commit Request Metadata

Properties: CA DataMinder Import Metadata Response