Design

Back Next

Creating Process Objects from OpenAPI 3.0 Files

You can easily and simultaneously create multiple large and hierarchical process objects by importing one or more OpenAPI 3.0 JSON or YAML files.

Use the

New Process Objects Creation from OpenAPI 3.0 Files

wizard to create process objects from OpenAPI 3.0 files. After you specify the source, Application Integration parses the source, loads the resources, and generates XSD schemas. Based on the XSD schemas, Application Integration generates the process objects. You can specify import preferences such as the location for saving the process objects and optionally specify the tags to be used for the process objects.

In case errors occur during the process object creation, the wizard displays the errors under the

Related Logs

tab of the corresponding step. You can review the log and take corrective actions. You can also download the log. When you download the log at a particular step, the log also shows cumulative logging information for all the previous steps.

In Application Integration, click

New

The

New Asset

dialog box appears.

The following image shows the

New Asset

dialog box:

Click

Process Object

on the left pane.

On the right pane, expand the

Process Object Creation Patterns

list, click

Create from OpenAPI 3.0

, and then click

Create

The

New Process Objects Creation from OpenAPI 3.0 Files

dialog box appears.

The following image shows the

New Process Objects Creation from OpenAPI 3.0 Files

dialog box:

In the

Source

field, select one of the following values:

Option	Description
File	Select File to specify a single OpenAPI 3.0 source file with type definitions from your local system. You can also specify HTTP resources. Click Choose File to select the OpenAPI 3.0 source file. The maximum allowed file size for a single file is 5 MB. Default is File .
Zip (multiple files)	Select Zip to specify multiple OpenAPI 3.0 source files with type definitions in the form of a zip file from your local system. Click Choose File to select the zip file. The maximum allowed file size for a zip file is 3 MB.
URL	Select URL to specify a URL that contains an OpenAPI 3.0 source file with type definitions. The URL and Use Authentication fields appear. In the URL field, enter the source URL. Select the Use Authentication option to specify the user name and password to access the source URL.

Click

Application Integration parses the specified source file or URL, and displays the resource details on the

Load Resources

tab.

The following image shows the

Load Resources

tab with the resource details:

Review the resource details.

The following table describes the columns that the

Load Resources

tab displays:

Column Name	Description
File Name	The file name of the resource.
File Path	The URL or relative location of each resource within the source.
Type	The file type of the resource. Displays the value as OPENAPI .
Status	The status of the resource. Displays one of the following values: Valid . Indicates that the file type is supported and that the file content is valid. Invalid . Indicates that either the file type is not supported or the file content is not valid. For example, for a .txt file, the status shows up as Invalid because the file type is not supported.
Comments	Indicates whether the file type is supported or not.

If there are parsing errors, Application Integration displays the error details on the

Related Logs

tab. Fix the errors and try again.

Click

Application Integration converts the resources into XSD schemas based on which the process objects will be created. It displays the schema details on the

Generate Schemas

tab.

The following image shows the

Generate Schemas

tab with the schema details:

Review the schema details.

The following table describes the columns that the

Generate Schemas

tab displays:

Column Name	Description
Schema	The name of the generated XSD schema file.
Source	The source from which the XSD schema file was generated.
Complex Types	The number of complex types that will be created for each XSD schema.
Prefixes	The prefix to be used for the XSD schema. You can use a prefix to easily identify process objects that are created from a schema. For example, you might want to add the prefix Salesforce for all process objects that are created from a Salesforce schema. To specify a prefix for a schema, double-click under the Prefixes column against the row that contains the schema, and enter a prefix. All the process objects that are created from the schema will use the same prefix that you specify in this field.
Tags	The tags to be used for the XSD schema. You can use a tag to group related schemas together. For example, you might want to group all schemas containing financial resources under the tag Finance . To specify a tag for a schema, double-click under the Tags column against the row that contains the schema, and enter a tag. All the process objects that are created from the schema will use the same prefix that you specify in this field.

If there are schema generation errors, Application Integration displays the error details on the

Related Logs

tab. Fix the errors and try again.

Click

Application Integration applies the prefixes and tags that you specified for the XSD schemas, and generates the process objects based on the XSD schemas. It displays the process object details on the

Generate Objects

tab.

The following image shows the

Generate Objects

tab with the process object details:

Review the process object details.

The following table describes the columns that the

Generate Objects

tab displays:

Column Name	Description
Name	The name of the process object that was generated from the schema.
Description	The schema from which the process object was generated. You can edit the description.
No. of Fields	The number of complex types that the process object contains.
Tags	The tags to be used for the process object. By default, the process object tags are derived from the tags that you specified for the XSD schema. You can edit the tags if you want to specify different tags at the process object level. To edit the tags for a process object, double-click under the Tags column against the row that contains the process object, and update the tags.