ContractExport command (Business Edition)

This command exports a contract to an XML file.

Command structure

http://host_name/path/
The fully qualified name of your WebSphere Commerce Server and the configuration path.

Diagram of the command structure: the command starts with the fully qualified name of your WebSphere Commerce Server and the configuration path, followed by the command name, ContractExport  and the ? character. End the command with a list of parameters in the form of name value pairs. Separate each name value pair with the & character. For a detailed description of the parameters and their values, refer to the list entitled Parameter values.

Parameter values

contractId
(Required) The contract ID for the contract you want to export, as found in the CONTRACT database table.
fileName
(Required) The name you want the contract XML file to have. If you do not specify the full path name for the XML file, the XML file will be written to the WC_installdir/xml/trading/xml directory.
langId
(Required) Use this parameter to specify the language of the descriptions in the contract you want exported. Descriptions in languages other than the language specified by this parameter will not be exported to the generated XML file.
xsdName
(Required) The XSD file name to use for the root element.
xmlFileEncoding
Use this parameter to specify the encoding of the generated XML file. If you do not specify this option, the generated XML file will be encoded using UTF-8 encoding. For a list of all supported international encodings that can be specified with this parameter, see the related topic below.
all
Specifies whether to include all reference numbers and timestamps when exporting the contract or not. Valid values for this parameter are true and false. Use true to include all reference numbers and timestamps. Use false to omit all reference numbers and timestamps

If this parameter is not specified, a value of true is assumed.

URL
(Required) The URL to be called when the command completes successfully.

Example

The following example exports contractID 260369 to a UTF-8 encoded XML file in the default directory called contract260369.xml:

https://myhostname/webapp/wcs/stores/servlet/ContractExport?
contractId=260369&fileName=contract260369.xml&langId=-1&xsdName=Package.xsd
&URL=ContractDisplay

Behavior

 This command creates an XML file from the information in the WebSphere Commerce database for the specified contract number.

Exception conditions