Creating an XML Layout

Owned by Akash Kumar Jaiswal (Unlicensed)
Last updated: Jan 23, 2020Version comment
4 min read

The XML layout defines the procedure to read data from and write data to an XML file. You can do that by specifying the layout definition location.

Steps to create an XML Layout:

  1. Go to Account and click Manage Objects.



  2. Click LAYOUTS > XML.



  3. Click CREATE XML Layout.



  4. On the Create Layout window, type the name and description of the new XML layout in the Name and Description fields respectively.



  5. Select the Validate XML checkbox to validate the XML against an XSD file during execution. 

    It works when you use an XSD file to create an XML layout activity. Also, this layout activity must be used in the process flow (which is generally not required in case of XML format). This option validates the entire XML at runtime. On selecting the checkbox, you need to provide the validator name (Native or Saxonica) to validate the file in the XML Validator field. If you don't provide the value in this field, then your file will be validated by the default Native parser. 

    However, you can also configure the validator parser (Native or Saxonica) globally for all the XML layout activities created in Adeptia Connect in the abpm.xml.validator.engine property (…<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc\server-configure.properties file). You can update the abpm.xml.validator.engine property in server-configure.properties file based on the configuration (Native or Saxonica).

  6. Select one of the following Definition Modes - Import File, Web Service Consumer, Web Service Provider.

  7. Depending on the option chosen in the Definition modes, the further steps differ.

    1. If you have selected Import File option then,

      1. If your XSD file is referring to another XSD file then you can either choose an existing file reference activity from the File References drop-down list or create a new file reference activity by clicking . You can update an existing file reference activity by clicking . Click here to know how to create a new file reference activity.
      2. Browse to and select the XSD file in the File Path. 
      3. Click Validate XSD to validate the path of the file in the File Path. You can validate all XML, XSD, or DTD files with this validator. If it is not an XSD file then the layout will convert it to an XSD file format and then validate.
    2. If you have selected Web Service Consumer option then,
      1. Select the pre-defined Web Service Consumer activity from the Consumer ID field.
      2. Select the following options from the XSD Type field - Input, Output, and Header.

    3. If you have selected Web Service Provider option then,

      1. Select the pre-defined Web Service Provider activity from the Provider field.
      2. Select the following options from the WsProvider XSD Type field - Input and Output.

  8. Expand Advanced Properties to view the advanced properties of XML layout.



  9. Type the XML validator name to parse the XML file in the XML Validator. The value can be Native or Saxonica.

    The XML file will be validated using the parser if specified in this field.

  10. Define the Character Set Encoding for the XML layout. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1.

  11. Select the Convert XML/DTD to XSD checkbox to instruct the layout to convert the entire XML/DTD to XSD.

    To know more details about conversion of XML/DTD to XSD Constructs, click .

  12. Select the Project from the drop-down list of Project.

  13. Click Save to save the XML layout.

 

Updating Existing XML Layout Using Easy Schema Parser

When you upgrade your existing XML layout activity by using the new parser (Easy Schema Parser), then your mapping may be lost during the process. For example, if you have an XSD file that has namespaces, then the namespace prefix may change when you update the existing XML layout activity by using the new parser. In this case, the mapping can be lost, and you may have to repeat the mapping process.

You need to follow these steps to ensure that there are no structural changes in your mapping:

  1. Create a new XML layout activity using the same XSD file.
  2. Load both the XML layout activities (exiting and new) into web mapper.
  3. Verify the hierarchy.

If you want to update your existing XML layout activity by using the new parser (Easy Schema Parser) then follow the below steps:

  1. Go to Accounts > Manage Objects > Layouts > XML.
  2. Select an existing XML layout that you want to parse using Easy Schema parser and click the more icon.
  3. Click Edit from the list.
  4. On Edit layout screen, expand Advanced Properties to view the advanced properties of XML layout.

  5. Click XML Schema Version 2.0 checkbox. To get the additional information about the parse, click .

     

  6. Click Save.