Version 9.6
 —  Importing Objects Using the API  —

Invoking an Importer From the Command Line

Each importer includes a command, which allows it to be executed from the command prompt on Windows or a terminal on any UNIX flavor.

In both cases, the command is followed by a list of appropriate input parameters and options. The parameters are key-value pairs, where the key starts with a hyphen. An option is a switch that modifies the behavior of the command and is preceded by a hyphen. Using the -usage option lists all available command parameters and options with a short description.

The input parameters and options for each importer are described in the following sections:


Importing a Web Service

To import a Web service, run the utility with the following input parameters:

Command Line under Windows

Use the following procedure to import a Web service under Windows:

  1. Open ImportWSDL.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportWSDL.cmd -user <USERNAME> -password <PASSWORD> [-dburl <CENTRASITE-URL> | [[-h <HOSTNAME>] [-p <PORT>]]] -o <ORGANIZATION> -w <WSDL-FILE-PATH>

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import a Web service under Linux:

  1. Open ImportWSDL.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportWSDL.sh -user <USERNAME> -password <PASSWORD> [-dburl <CENTRASITE-URL> | [[-h <HOSTNAME>] [-p <PORT>]]] -o <ORGANIZATION> -w <WSDL-FILE-PATH>

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters

The following table describes the complete set of input parameters that you can use with the Web Service importer:

Parameter Description
USERNAME Required. Your CentraSite user ID.
PASSWORD Required. The password for your CentraSite user account.
CENTRASITE-URL The fully qualified URL for the CentraSite registry/repository.

If you omit this parameter, the importer assumes that the registry/repository resides at http://localhost:53307/CentraSite/CentraSite.

Note:
If the registry/repository is running on a different machine and port number, you can use this parameter to specify its location instead of using the individual -h and -p parameters. (If you specify the -dburl parameter with the -h and/or -p parameters, the -h and -p parameters will be ignored.)

HOSTNAME The host name or IP address of the computer where the CentraSite registry/repository component is running.

If you omit this parameter, the importer assumes that the registry/repository is running on localhost.

PORT The port number on which the CentraSite registry/repository is configured to listen for incoming requests.

If you omit this parameter, the importer assumes that the registry/repository is listening on the default port, 53307.

ORGANIZATION Required. The name of the organization into which you want to import the Web service. If the organization name contains a space, enclose the name in double-quotes.
WSDL-FILE-PATH Required. The fully qualified name of the WSDL file that you want to import.

Note:
You can also obtain the complete list of input parameters for the Web Service importer by invoking the importer with no input parameters.

Top of page

Importing an XML Schema

To import an XML Schema, run the utility with the following input parameters and options:

Command Line under Windows

Use the following procedure to import an XML Schema under Windows:

  1. Open ImportSchema.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportSchema.cmd -user <USERNAME> -password <PASSWORD> [-dburl <CENTRASITE-URL> | [[-h <HOSTNAME>] [-p <PORT>]]] -s <XSD-FILE> [-noover]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import an XML Schema under Linux:

  1. Open ImportSchema.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportSchema.sh -user <USERNAME> -password <PASSWORD> [-dburl <CENTRASITE-URL> | [[-h <HOSTNAME>] [-p <PORT>]]] -s <XSD-FILE> [-noover]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraDESTINATIONSite folder under <SuiteInstallDir>.

Input Parameters and Options

The following tables describe the complete set of input parameters and options that you can use with the XML schema importer:

Parameter Description
USERNAME Required. Your CentraSite user ID.
PASSWORD Required. The password for your CentraSite user account.
CENTRASITE-URL The fully qualified URL for the CentraSite registry/repository.

If you omit this parameter, the importer assumes that the registry/repository resides at http://localhost:53307/CentraSite/CentraSite.

Note:
If the registry/repository is running on a different machine and port number, you can use this parameter to specify its location instead of using the individual -h and -p parameters. (If you specify the -dburl parameter with the -h and/or -p parameters, the -h and -p parameters will be ignored.)

HOSTNAME The host name or IP address of the computer where the CentraSite registry/repository component is running.

If you omit this parameter, the importer assumes that the registry/repository is running on localhost.

PORT The port number on which the CentraSite registry/repository is configured to listen for incoming requests.

If you omit this parameter, the importer assumes that the registry/repository is listening on the default port, 53307.

XSD-FILE Required. The fully qualified name of the XML Schema file that you want to import.
Option Description
-noover Prevents the importer from overwriting an XML schema if it is already present in the registry.

Note:
You can also obtain the complete list of input parameters for the XML schema importer by invoking the importer with no input parameters.

Top of page

Importing an XML Service

To import an XML Service, run the utility with the following input parameters and options:

Command Line under Windows

Use the following procedure to import an XML Service under Windows:

  1. Open ImportXMLService.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportXMLService.cmd -dbuser <USERNAME> -dbpassword <PASSWORD> [[-h <HOSTNAME>] [-p <PORT>]] -s <XML-FILE> -n <SERVICE-NAME> -e <ENDPOINT-URL> -m <HTTP-METHODS> [[-suser <XML-FILE-USER>] [-spassword <XML-FILE-PASSWORD>]] [-noover] [-desc <DESCRIPTION>] [-ver <VERSION-ID>] [-porg <PROVIDING-ORG>] [-sorg <SUBMITTING-ORG>]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import an XML Service under Linux:

  1. Open ImportXMLService.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportXMLService.sh -dbuser <USERNAME> -dbpassword <PASSWORD> [[-h <HOSTNAME>] [-p <PORT>]] -s <XML-FILE> -n <SERVICE-NAME> -e <ENDPOINT-URL> -m <HTTP-METHODS> [[-suser <XML-FILE-USER>] [-spassword <XML-FILE-PASSWORD>]] [-noover] [-desc <DESCRIPTION>] [-ver <VERSION-ID>] [-porg <PROVIDING-ORG>] [-sorg <SUBMITTING-ORG>]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters and Options

The following tables describe the complete set of input parameters and options that you can use with the XML Service importer:

Parameter Description
XML-FILE Required. The URI (file: or http:) of the XML Schema file from which the XML service is created.
SERVICE-NAME Required. The name that is to be assigned to the service.
ENDPOINT-URL Required. The URL where the service is deployed. (The access point for the service.)
HTTP-METHODS Required. The HTTP access methods that the service supports. Valid values are: GET, POST, PUT, DELETE. If the service supports multiple methods, list the methods separated by spaces (e.g., -m GET PUT DELETE).
USERNAME Required. Your CentraSite user ID. (This user account must have permission to create assets in the organization to which the service will be added.)
PASSWORD Required. The password for your CentraSite user account.
HOSTNAME

The host name or IP address of the computer where the CentraSite registry/repository component is running.

If you omit this parameter, the importer assumes that the registry/repository is running on localhost.

PORT

The port number on which the CentraSite registry/repository is configured to listen for incoming requests.

If you omit this parameter, the importer assumes that the registry/repository is listening on the default port, 53307.

XML-FILE-USER The user ID that is to be used if the XML file (specified in the -s parameter) resides on a secure server and the importer is required to provide a user ID and password to access it.
XML-FILE-PASSWORD The password for the user account in -suser.
DESCRIPTION

The description that is to be assigned to the XML Service.

If you omit this parameter, the service description will be empty.

VERSION-ID

The version identifier that is to be assigned to the XML Service. (This is the user-defined identifier, not the system-assigned version number.)

If you omit this parameter, the version identifier will be set to 1.0.

PROVIDING-ORG

The name of the organization that is to be designated as the providing organization for this service.

If you omit this parameter, the providing organization will be set to the Default Organization.

SUBMITTING-ORG

The name of the organization to which this service is to be added.

If you omit this parameter, the service will be added to the Default Organization.

Option Description
-noover Prevents the importer from overwriting an XML service if it is already present in the registry.

Note:
You can also obtain the complete list of input parameters for the XML Service importer by invoking the importer with no input parameters.

Top of page

Importing a REST Service

To import a REST Service, run the utility with the following input parameters and options:

Command Line under Windows

Use the following procedure to import a REST Service under Windows:

  1. Open ImportRESTService.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportRESTService.cmd -dbuser <USERNAME> -dbpassword <PASSWORD> [[-h <HOSTNAME>] [-p <PORT>]] -s <REST-FILE> -n <SERVICE-NAME> -e <ENDPOINT-URL> -m <HTTP-METHODS> [[-suser <REST-FILE-USER>] [-spassword <REST-FILE-PASSWORD>]] [-noover] [-desc <DESCRIPTION>] [-ver <VERSION-ID>] [-porg <PROVIDING-ORG>] [-sorg <SUBMITTING-ORG>]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import a REST Service under Linux:

  1. Open ImportRESTService.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportRESTService.sh -dbuser <USERNAME> -dbpassword <PASSWORD> [[-h <HOSTNAME>] [-p <PORT>]] -s <REST-FILE> -n <SERVICE-NAME> -e <ENDPOINT-URL> -m <HTTP-METHODS> [[-suser <REST-FILE-USER>] [-spassword <REST-FILE-PASSWORD>]] [-noover] [-desc <DESCRIPTION>] [-ver <VERSION-ID>] [-porg <PROVIDING-ORG>] [-sorg <SUBMITTING-ORG>]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters and Options

The following tables describe the complete set of input parameters and options that you can use with the REST Service importer:

Parameter Description
REST-FILE Required. The URI (file: or http:) of the XML Schema file from which the REST service is created.
SERVICE-NAME Required. The name that is to be assigned to the service.
ENDPOINT-URL Required. The URL where the service is deployed. (The access point for the service.)
HTTP-METHODS Required. The HTTP access methods that the service supports. Valid values are: GET, POST, PUT, DELETE. If the service supports multiple methods, list the methods separated by spaces (e.g., -m GET PUT DELETE).
USERNAME Required. Your CentraSite user ID. (This user account must have permission to create assets in the organization to which the service will be added.)
PASSWORD Required. The password for your CentraSite user account.
HOSTNAME

The host name or IP address of the computer where the CentraSite registry/repository component is running.

If you omit this parameter, the importer assumes that the registry/repository is running on localhost.

PORT

The port number on which the CentraSite registry/repository is configured to listen for incoming requests.

If you omit this parameter, the importer assumes that the registry/repository is listening on the default port, 53307.

REST-FILE-USER The user ID that is to be used if the REST file (specified in the -s parameter) resides on a secure server and the importer is required to provide a user ID and password to access it.
REST-FILE-PASSWORD The password for the user account in -suser.
DESCRIPTION

The description that is to be assigned to the REST Service.

If you omit this parameter, the service description will be empty.

VERSION-ID

The version identifier that is to be assigned to the REST Service. (This is the user-defined identifier, not the system-assigned version number.)

If you omit this parameter, the version identifier will be set to 1.0.

PROVIDING-ORG

The name of the organization that is to be designated as the providing organization for this service.

If you omit this parameter, the providing organization will be set to the Default Organization.

SUBMITTING-ORG

The name of the organization to which this service is to be added.

If you omit this parameter, the service will be added to the Default Organization.

Option Description
-noover Prevents the importer from overwriting a REST service if it is already present in the registry.

Note:
You can also obtain the complete list of input parameters for the REST Service importer by invoking the importer with no input parameters.

Top of page

Importing a BPEL Process

To import a BPEL process, run the utility with the following input parameters and options:

Command Line under Windows

Use the following procedure to import a BPEL process under Windows:

  1. Open ImportBPEL.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportBPEL.cmd -user <USERNAME> -password <PASSWORD> [[-dburl CENTRASITE-URL]|[[-h <HOSTNAME>] [-p <PORT>]]] -file <BPEL-FILE> [-nowarning]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import a BPEL process under Linux:

  1. Open ImportBPEL.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportBPEL.sh -user <USERNAME> -password <PASSWORD> [[-dburl CENTRASITE-URL]|[[-h <HOSTNAME>] [-p <PORT>]]] -file <BPEL-FILE> [-nowarning]

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters and Options

The following tables describe the complete set of input parameters and options that you can use with the BPEL Process importer:

Parameter Description
BPEL-FILE Required. The fully qualified name of the BPEL process file that you want to import.
USERNAME Required. Your CentraSite user ID.
PASSWORD Required. The password for your CentraSite user account.
HOSTNAME Optional. The host name or IP address of the computer where the CentraSite registry/repository component is running.

If you omit this parameter, the importer assumes that the registry/repository is running on localhost.

PORT The port number on which the CentraSite registry/repository is configured to listen for incoming requests.

If you omit this parameter, the importer assumes that the registry/repository is listening on the default port, 53307.

CENTRASITE-URL The fully qualified URL for the CentraSite registry/repository.

If you omit this parameter, the importer assumes that the registry/repository resides at http://localhost:53307/CentraSite/CentraSite.

Note:
If the registry/repository is running on a different machine and port number, you can use this parameter to specify its location instead of using the individual -h and -p parameters. (If you specify the -dburl parameter with the -h and/or -p parameters, the -h and -p parameters will be ignored.)

Option Description
-nowarning Suppresses the warning message that the importer issues if the BPEL process references a BPEL Partner Link Type that refers to a Web service that is not present in the CentraSite registry.

Note:
You can also obtain the complete list of input parameters for the BPEL importer by invoking the importer with no input parameters.

Top of page

Importing an XPDL File

To import an XPDL file, run the utility with the following input parameters:

Command Line under Windows

Use the following procedure to import an XPDL file under Windows:

  1. Open ImportXPDL.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportXPDL.cmd -user <USERNAME> -password <PASSWORD> [[-h <HOSTNAME>] [-p <PORT>]] -file <XPDL-FILE>

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import an XPDL file under Linux:

  1. Open ImportXPDL.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportXPDL.sh -user <USERNAME> -password <PASSWORD> [[-h <HOSTNAME>] [-p <PORT>]] -file <XPDL-FILE>

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters

The following table describes the complete set of input parameters that you can use with the XPDL file importer:

Parameter Description
XPDL-FILE Required. The fully qualified name of the XPDL file that you want to import.
USERNAME Required. Your CentraSite user ID.
PASSWORD Required. The password for your CentraSite user account.
HOSTNAME The host name or IP address of the computer where the CentraSite registry/repository component is running.

If you omit this parameter, the importer assumes that the registry/repository is running on localhost.

PORT The port number on which the CentraSite registry/repository is configured to listen for incoming requests.

If you omit this parameter, the importer assumes that the registry/repository is listening on the default port, 53307.

Note:
You can also obtain the complete list of input parameters for the XPDL file importer by invoking the importer with no input parameters.

Top of page

Importing an Archive

To import an archive, run the utility with the following input parameters and options:

Command Line under Windows

Use the following procedure to import an archive under Windows:

  1. Open ImportArchive.cmd in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ImportArchive.cmd [-setreplace] 
    [-importorg <ORGANIZATION-KEY>] [-keepowner] [-keeporganization] <CENTRASITE_URL> 
    <ARCHIVE_FILENAME> <USERNAME> <PASSWORD>

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Command Line under Linux

Use the following procedure to import an archive under Linux:

  1. Open ImportArchive.sh in a text editor.

  2. Add the following property statement:

    <CentraSiteInstallDir>\utilities\ ImportArchive.sh [-setreplace] 
    [-importorg <ORGANIZATION-KEY>] [-keepowner] [-keeporganization] <CENTRASITE_URL> 
    <ARCHIVE_FILENAME> <USERNAME> <PASSWORD>

    where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters and Options

The following table describes the complete set of input parameters and options that you can use with the archive importer:

Parameter Description
ARCHIVE_FILENAME Required. The fully qualified name of the export archive file. The archive file can contain an organization with its assets or can contain a set of objects that were exported from one or more organizations.
USERNAME Required. Your CentraSite user ID.
PASSWORD Required. The password for your CentraSite user account.
CENTRASITE-URL Required. The fully qualified URL for the CentraSite registry/repository.

If you omit this parameter, the importer assumes that the registry/repository resides at http://localhost:53307/CentraSite/CentraSite.

Note:
If the registry/repository is running on a different machine and port number, you can use this parameter to specify its location instead of using the individual -h and -p parameters. (If you specify the -dburl parameter with the -h and/or -p parameters, the -h and -p parameters will be ignored.)

ORGANIZATION-KEY By default, objects are imported into the current user's organization. Use this optional parameter if you want to specify a different organization into which the objects should be imported. The keyword is followed by the organization's GUID, prefixed by "uddi:", for example: "uddi:207ff1cc-25c5-544c-415c-5d98ea91060c".

Note:
This parameter has no effect if the -keeporganization option is set.

Option Description
-setreplace When an object is to be imported, the timestamp of the object in the import archive file is compared with the timestamp of the corresponding object with the same GUID in the registry, if the latter exists. If the timestamps are equal, the object is not imported. If the archive timestamp is older than the registry timestamp, the object is only imported if this optional parameter is present; otherwise it is ignored.
-keepowner

This option will maintain the original owner of the importing objects. This requires the original owner to exist with the same UDDI key on the target machine.

If the parameter is not set, the importing user will be owner of the objects.

-keeporganization

This option will maintain the original organization of the importing objects. This requires the original organization to exist with the same UDDI key on the target machine.

Note:
If an organization is imported with its assets, this option is automatically activated.

Note:
You can also obtain the complete list of input parameters for the XPDL file importer by invoking the importer with no input parameters.

Top of page