Recipe Exchange API

Export

This method returns an Exportdata instance containing an XML stream of the specified item from the DeltaV database and information on the result of the export. The method signature is:

ExportData Export(
   ExportInfo exportInfo,
   bool bCheckOut,
   bool bRecursive
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

exportInfo

Instance of ExportInfo data contract

ExportInfo

ExportInfo instance

bCheckOut

Check out the recipe item from the VCAT database.

Boolean

True = Check out the recipe

False = Do not check out the recipe

bRecursive

Check out recursively from the VCAT database.

Boolean

True = Check out recursively

False = Do not check out recursively

Web Service Properties Affecting Exports

The default values of the Recipe Exchange web service should allow for exporting anything in a typical configuration. However, if your configuration is unusually large or complex, you may have to change some of the default property values for the web service. If an export fails, try changing the following service property values and the corresponding values in the client program configuration file to the values shown:

  • OpenTimeout = 01:01:00

  • ReceiveTimeout = 01:10:00

  • SendTimeout = 01:01:00

  • MaxBytesPerRead = 4096

  • InactivityTimeout = 7.00:00:00