Creating a Schema for a System Service

This section explains how to create an XML schema for a system service.

In the Schema Editor, select the Schemas/Create/Service menu option. The 'Generate Schema for a Service' Dialog Box appears. Fill in the following fields:

Service Name Enter the name of the service to be created in the service name text box. This is the name of the first element under the Body element in the XML document. Clicking on the selection button at the right of this text box displays a selection list of available services in the system. The selection list is built out of the metadata tables in the system.

MetaInfo Directory/File The product uses XML MetaInfo files internally to describe a service. The Schema Editor uses this file to convert it to a valid XML Schema. Enter the name of the XML file defining the service. This file is used to generate the XML schema for the service.

Transaction Type Select the transaction type performed by the service. The available values are Read, Add, Change, Update, Delete, List and Search.

Note: The difference between Change and Update is that for Change, all field values must be passed in with the request. Field values that are not passed in to the request are set to null. For Update, you need only pass the primary key field values and the values of the fields to be updated. All other fields retain their existing values.

To generate the Schema, click OK.