Create a New B2B Schema

You can create a new B2B schema based on a standard document type and customize it to match your requirements. You can also select to use a schema created in a different project.

1. To create a schema in a project:
   1. In the navigation pane, click Projects.
   2. Click the project in which to create the schema.
   3. Click B2B .
   4. In the Schemas section, click Add.
2. To create a schema in a standalone environment:
   1. In the navigation pane, click B2B, then Schemas.
   2. On the Schemas page, click Create.
3. Enter the following details.

   Element	Description
   Name	Enter a name.
   Identifier	This field is automatically populated with the name. You can manually change this value.
   Description	Enter an optional description of the customization details for this schema.
   Use a shared schema	Click to use a shared schema. Selecting this option enables a Shared schema list to be displayed for you to select the shared schema to use. Shared schemas only available in a different project are displayed. Schemas created in a standalone environment (that is, outside a project) are not available for selection. After creation, an Override label appears below the schema name in the Schemas section to indicate that the schema is shared. To understand how shared schemas work, see What's Supported in Projects for B2B.
   Available to other projects	Select to make this schema available for use in other projects. After creation, a Shared label appears below the schema name in the Schemas section to indicate that it is available for use in other projects.
   Document standard	Select the document standard. The document standard identifies the business protocol to follow when exchanging business documents between partners. EDIFACT X12 X12HIPAA OAG Custom RosettaNet (version 2.0) FixedLength Delimited JSON cXML Note: cXML document standard is only available within projects in B2B trading partner mode. It is not supported in standalone mode.

4. If you selected EDIFACT, enter the following details:

   Element	Description
   Document version	Select the document version from the drop-down list. You cannot manually define a document version. To use a custom (overridden) document version instead of the selected standard document version, enter values in the Override version number and Override release number fields. Note: Overriding the standard document version is supported only when you create an EDIFACT schema within a project in B2B trading partner mode. It is not supported in B2B standalone mode.
   Override version number	Optional. Enter the version to use instead of the standard version. Maximum of three alphanumeric characters (for example, Ed5) is allowed.
   Override release number	Optional. Enter the release to use with the overridden version number. Maximum of three alphanumeric characters is allowed.
   Document type	Select the document type from the drop-down list. You cannot manually define a document type.
   Override document type	Optional. If you override the standard document version by entering a custom version and release value, you can also enter a custom document type to use instead of the selected standard document type. Any length of alphanumeric characters is allowed.

   Identifying an overridden EDIFACT schema

   • The headers Overridden version and Overridden type are displayed in the Schema details page.
   • In the overridden version, a colon is present as a delimiter between the schema version sub-fields - version number and release number. For example, Ed5:abs
5. If you selected X12, enter the following details:

   Element	Description
   Document version	Select the document version from the drop-down list. You cannot manually define a document version.
   Override document version	Optionally, you can override the standard document version by manually specifying an override version to support X12 extensions such as UCS or VICS. You can identify a overridden X12 schema with the Overridden version header that is displayed for it. Note: This option is available only when you create an X12 schema within a project in B2B trading partner mode. It is not supported in B2B standalone mode.
   Document type	Select the document type from the drop-down list. You cannot manually define a document type.

6. If you selected X12HIPAA, enter the following details:

   Element	Description
   Document version	Select the document version from the drop-down list. You cannot manually define a document version.
   Document type	Select the document type from the drop-down list. You cannot manually define a document type.

7. If you selected OAG, Custom, or RosettaNet, enter the following details:

   Element	Description
   Schema location	Click Browse to select the schema to use. If you select RosettaNet, note that RosettaNet PIPs are not preseeded in B2B for Oracle Integration. You can download the RosettaNet schema to use from this site. Expand the Specification list to find the schema you want to download and use in B2B for Oracle Integration. Prepare the schema for upload into B2B for Oracle Integration: Download the schema from RosettaNet and place it in a new folder. Unzip the downloaded schema. Navigate to the XML directory inside the unzipped folder. Find and delete all non-XSD files in this directory. $ find . -type f | grep -v xsd | xargs rm Note: If you are using a UI-based explorer, some hidden files/folders may exist that also need to be removed. In which case, the above command must be modified. For example, the __MACOX__ folder on macOS or the Thumbs.db file on Windows. Create a new zip file from current XML directory onwards. zip -r pip4b2-v11-01-00-notifyofshipmentreceipt.zip ./ Upload this new zip file to define a new schema. After you upload a RosettaNet schema to use, the name of the PIP is displayed in the Root element field (for example, Pip3A4PurchaseOrderRequest.)
   Document version	For Custom or RosettaNet, manually enter a new value or select an existing value from the drop-down list. For OAG, select an existing value from the drop-down list. You cannot manually define a document version.
   Document type	For Custom or RosettaNet, manually enter a new value or select an existing value from the drop-down list. For OAG, select an existing value from the drop-down list. You cannot manually define a document type.

8. If you selected FixedLength, enter the following details:

   Element	Description
   Segment identifier start position	Enter the start position of the segment identifier (default is 1). This is the position where the segment identifier appears in each record. For example, if this value is 9, the system will start checking for the segment identifier at the 9th character of each record in the payload.
   Scan for character	Enter an integer between 1 and 32 to identify the number of characters to scan to identify the segments in the payload. For example, enter 3 to identify the schema segments from the first three characters in each row where the segment identifier start position is 1. See Fixed Length Payload Support.
   Drag and Drop	Drag a sample payload file with a fixed-length content. UTF-8 is the supported character encoding. After creating the schema, you can add child elements, as necessary. See Add Child Elements to a Fixed-Length Schema.
   Character Encoding	Select the character encoding to use.
   Document version	Manually enter a new value or select an existing value from the drop-down list.
   Document type	Manually enter a new value or select an existing value from the drop-down list.

9. If you selected Delimited, enter the following details:

   Element	Description
   Drag and Drop	Drag and drop the delimited payload file.
   Character encoding	Select the character encoding to use.
   Segment delimiter	Select the delimiter used to separate segments in the payload. See Delimited Payload Support.
   Segment name delimiter	Select the delimiter used to separate segment names in the payload.
   Element delimiter	Select the delimiter used to separate elements in the payload.
   Composite element delimiter	Select the delimiter used to separate composite elements in the payload.
   Document version	Manually enter a new value or select an existing value from the drop-down list.
   Document type	Manually enter a new value or select an existing value from the drop-down list.

10. If you selected JSON, enter the following details:

    Element	Description
    Drag and Drop	Drag and drop a sample JSON payload. Ensure that the sample file has the same fields and structure as the expected payload.
    Document version	Manually enter a new value or select an existing value from the drop-down list.
    Document type	Manually enter a new value or select an existing value from the drop-down list.

11. If you selected cXML, enter the following details:

    Element	Description
    Schema location	Select Choose file and then browse and select either an XSD file or a zip file with XSDs (with namespace). After you upload a cXML schema to use, the schema will be parsed and you can select the root element in the Root element field.
    Document version	Manually enter a new value or select an existing value from the drop-down list.
    Document type	Manually enter a new value or select an existing value from the drop-down list.

    Note the following for cXML schemas:

    • The overall cXML structure (envelope) is automatically generated and managed by B2B for Oracle Integration. Users are only required to provide the schema (XSD) for the business payload.
    • If a single XSD file is used to define the schema, it must not include a targetNamespace.
    • If a ZIP file containing multiple XSDs (zipxsd) is used, a targetNamespace must be defined and the entire payload must be in the same namespace.
    • B2B for Oracle Integration does not support attributes or elements from the default xml namespace, such as xml:lang. Schema definition should be modified to define them locally.
12. Click Create.
13. Customize the schema to match your business requirements.

    For example customizations, see Customize or Edit a B2B Schema.

    After completing the customization, you can select the custom schema while creating a new B2B document as described in Create a Custom B2B Document Definition.