Register File Objects

In the CA TDM Portal, you register file objects so that you can perform various data manipulation operations (for example, data generation) on them. You register file objects in context of a project and its version.
tdm41
In the CA TDM Portal, you register file objects so that you can perform various data manipulation operations (for example, data generation) on them. You register file objects in context of a project and its version.
This procedure provides information about how to register the following file object types:
  • XSD
  • XML
  • WSDL
  • JSON
  • RR Pair
Note:
 This procedure is applicable only for the aforementioned file object types. For more information about other file object types (for example, GTExcel and CSV), see the appropriate section.
The high-level process to register different file object types remains the same; only options differ based on the type you select.
  1. Select an appropriate project and its corresponding version from the
    Project
    drop-down list in the top blue bar.
  2. Expand
    Modeling
    in the left pane and click
    Objects
    .
    The
    Objects
    page opens. This page lists all the objects that are registered to the selected version and the project. If no object is registered, nothing is listed on the page.
  3. Click the
    Register New Object(s)
     button.
    The
    Register New Object(s)
    page opens.
  4. Select the type of the file object from the
    Object Type
    drop-down list. You can select from the following file object types:
    • XSD
    • WSDL
    • XML
    • R/R PAIR
    • JSON
    Note:
     For the RRPAIR file object, you can provide RR pairs in the form of .xml, .json, and .txt files. RR pair files using .txt extension contain information in the form of HTTP headers and body, thereby providing support for REST format. For more information about the structure of .txt RR files, see the REST RR Pair Format section.
  5. Enter an appropriate name for the file object that you want to register in the 
    Name
    field.
  6. Specify the location from where you want to get the object file. Appropriate fields are displayed depending on the file object type that you select:
    • File(s) to Upload
      Lets you specify the local location where the object file is available. You can browse to the location or drag and drop the file. 
      This field is displayed for all the object types except RRPAIR.
      Note:
      For XSD and WSDL object types, you can also specify a .zip file that includes XSD or WSDL files (as appropriate). When you specify the location of a .zip file, the
      Root File Name
      field is displayed. In this field, you specify the location (relative) of the root file that you want to use for creating and registering derived objects.
    • Object URL
      (Only WSDL) Lets you specify the remote URI location where the object file is available. 
    • Request-File to Upload
      (Only RRPAIR) Lets you specify the local location where the request object file (.xml, .json, or .txt) is available. You can browse to the location or drag and drop the file. 
    • Response-File to Upload
      (Only RRPAIR) Lets you specify the local location where the response object file (.xml, .json, or .txt) is available. You can browse to the location or drag and drop the file.
      Note:
      Ensure that the request and response files are of the same type.
  7. Click the 
    Advanced Settings
     option and enter appropriate information in the following fields:
    • File Encoding
      Specifies the file encoding format that you want to use.
      Default: UTF-8
      Note:
       The CA TDM Portal supports all encoding formats that Java supports. However, it is tested and certified for these encoding formats: 
      For XML, US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE, UTF-16.
      For JSON, UTF-8, UTF-32BE, UTF-16BE, UTF-32LE, and UTF-16LE.
    • No Namespace Schema Location
      (Only for XSD and XML) Specifies the location of the schema definition file (XSD) that does not have a target namespace. This information is used for the noNamespaceSchemaLocation attribute, which references an XML schema document that does not have a target namespace. The following is an example value for this field:
      http://abx21yz.com/schemas/purchase12.xsd
      This attribute value is included in the exported XML documents (when you perform the export operation). The following example shows how this attribute is added to the exported XML document:
      xsi:noNamespaceSchemaLocation="http://abx21yz.com/schemas/purchase12.xsd"
      Note that the attribute value includes only one part, which is the location of the XML schema.
    • Schema Location
      (Only for XSD and XML) Specifies the location of the schema definition file (XSD) that has a target namespace. This information is used for the schemaLocation attribute, which references an XML schema document that has a target namespace. The following is an example value for this field:
      http://dpou123xy.com/Order
      http://dpou123xy.com/schemas/order.xsd  
      http://dpou123xy.com/schemas/Purchase 
      http://dpou123xy.com/schemas/Purchase.xsd 
      http://dpou123xy.com/schemas/Client 
      http://dpou123xy.com/schemas/Client.xsd
      This attribute is included in the exported XML documents (when you perform the export operation). The following example shows how this attribute is added to the exported XML document:
      xsi:schemaLocation=
         "http://dpou123xy.com/Order     http://dpou123xy.com/schemas/order.xsd       http://dpou123xy.com/schemas/Purchase      http://dpou123xy.com/schemas/Purchase.xsd      http://dpou123xy.com/schemas/Client      http://dpou123xy.com/schemas/Client.xsd"
      Note that the attribute value includes two parts that are separated by a space. The first part represents the namespace. The second part represents the location of the XML schema that describes the specified namespace.
    • Namespaces
      (Only for XSD and XML) Specifies the namespaces defined in the XML schema document that you want to include in the exported XML documents. Use a semicolon (;) to separate multiple values. The following is an example value for this field:
      http://www.abc90ef.com/store;http://www.abc90ef.com/location
      This attribute is included in the exported XML document (when you perform the export operation). The following example shows how this attribute is added to the exported XML document:
      xmlns:tdmns0="http://www.abc90ef.com/store" xmlns:tdmns1="http://www.abc90ef.com/location"
      Note: 
      The namespaces referred by the XML elements in the exported XML documents are added by default. Use this attribute to mention any explicit namespaces to be included in the XML document.
  8. Click the 
    Save
    button.
    The
    Objects
    page opens with the the newly registered object added to the list of registered objects.
    You have successfully registered an object. 
    Note:
     To delete a registered object, click the cross icon (X) for the required object and confirm the deletion. A delete job is created and is added to the jobs queue. You can view the jobs queue in the requests table by clicking the request ID in the message that is displayed. When the status of the job is shown as
    Completed
    , the registered object is deleted. You can also click the appropriate row to view the additional information about the job. The additional information is displayed in the
    Additional Information
    dialog.
For the XML, XSD, WSDL, JSON, and RR Pair file objects that you register, you must create and register derived objects (tables) before performing any actions on the data.
Additionally, if you want to create a data generator in context of the selected project and version, click the
Create Generator
button in the
Objects 
page and follow the steps to create a generator.