Recipe Exchange API

Import

This method imports a recipe configured as an XML file from the client to the DeltaV database as a string. The method signature is:

string Import(
   string xmlConfig,
   bool bNoToAll,
   bool bPreDownloadStatus,
   bool bAutoCheckOut,
   bool bAutoCheckIn
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

xmlConfig

The XML to import

String

XML data that conforms to the DeltaV recipe schema

bNoToAll

Answers the question about updating existing objects in the database with objects from this file.

Boolean

True = Import with the No To All option

False = Import with the Yes To All option

bPreDownloadStatus

Sets if the import is made with the Preserve Download Status option

Boolean

True = Import with the Preserve Download Status option

False = Import without the Preserve Download Status option

bAutoCheckOut

Turn on the Auto CheckOut VCAT preference.

Boolean

True = Turn on Auto CheckOut

False = Do not turn on Auto CheckOut

bAutoCheckIn

Turn on the Auto Checkin VCAT preference.

Boolean

True = Turn on Auto Checkin

False = Do not turn on Auto Checkin