Adding IBM App Connect Enterprise annotations to imported DFDL schema files

If you have imported DFDL schema files that were created outside of the IBM® App Connect Enterprise Toolkit, you must add the required DFDL annotations for use with IBM App Connect Enterprise.

Before you begin

Before you start:

Complete the following task:

About this task

If you want to use a DFDL schema file that has been created outside of the IBM App Connect Enterprise Toolkit, you must add the required IBM App Connect Enterprise annotations before you can use the DFDL schema file in the development of your message flow applications. You may encounter errors if you use a DFDL schema file that does not contain the required IBM App Connect Enterprise annotations.

To add the required IBM App Connect Enterprise annotations to your DFDL schema file:

Procedure

  1. In the Application Development view, right-click the imported DFDL schema file (file extension *.xsd) that you want to open, and select Open with > XML Editor.
    The DFDL schema file opens in the XML editor.
  2. Add the namespace xmlns:ibmSchExtn="http://www.ibm.com/schema/extensions" by completing the following steps:
    1. In the XML editor, right-click anywhere within your DFDL schema file and select Edit Namespaces....
      The Edit Schema Information window opens.
    2. In the Edit Schema Information window, click Add....
      The Add Namespace Declarations window opens.
    3. In the Add Namespace Declarations window, select Specify New Namespace.
    4. In the Prefix field, enter ibmSchExtn. In the Namespace Name field, enter http://www.ibm.com/schema/extensions, then click OK.
    5. In the Edit Schema Information window, click OK.
    The namespace is added to your DFDL schema file, and the Edit Schema Information window closes.
  3. Add the annotation, ibmSchExtn:docRoot="true" to the top-level element of your message model by completing the following steps:
    1. In the XML editor, locate the top-level element of your message model. Right-click this element and select Add Attribute > Default.
      An attribute containing default values is added to your message model.
    2. Locate the default attribute that you created in the last step. Right-click this attribute, and select Edit Attribute....
      The Edit Attribute window opens.
    3. In the Name field, enter ibmSchExtn:docRoot. In the Value field, enter true. Click OK.
    The annotation is added to your DFDL schema file, and the Edit Attribute window closes.
  4. In the Navigator view, right-click your DFDL schema file (file extension *.xsd), and select Open with > DFDL Editor.
    The DFDL schema file opens in the DFDL schema editor.

What to do next

Next:

  • You can continue to edit your DFDL schema by using the DFDL schema editor.
  • You can test your message model, see Testing a DFDL schema file.