Skip to main content


class EnsLib.ITK.DTS.Framework.Operation.DTSTransferFile extends Ens.BusinessOperation

This Ensemble Business Operation is responsible for creating the data and control files for the DTS data transfer and could either receive an ITK or DTS Canonical Message. The location of the files and Installation specific configurations required for the control file can be configured through this component.

Property Inventory

Method Inventory


parameter ADAPTER = EnsLib.File.OutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter SETTINGS = Version,AddressType,MessageType,Compress,Encrypt,FromDTS,Subject,TransferType,WorkflowId,SequenceIdentifier;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property Adapter as EnsLib.File.OutboundAdapter;
Inherited description: The adapter instance
Property methods: AdapterGet(), AdapterGetSwizzled(), AdapterIsValid(), AdapterNewObject(), AdapterSet()
property AddressType as %String [ InitialExpression = "DTS" ];
Identifies the type of address. Can be SMTP - SMTP Address, DTS - DTSname addressing and ALL - Used by DTS Server when sending to DTS client.
Property methods: AddressTypeDisplayToLogical(), AddressTypeGet(), AddressTypeIsValid(), AddressTypeLogicalToDisplay(), AddressTypeLogicalToOdbc(), AddressTypeNormalize(), AddressTypeSet()
property Compress as %String [ InitialExpression = "Y" ];
Should be set to Y unless there are good business reasons
Property methods: CompressDisplayToLogical(), CompressGet(), CompressIsValid(), CompressLogicalToDisplay(), CompressLogicalToOdbc(), CompressNormalize(), CompressSet()
property Encrypt as %String [ InitialExpression = "N" ];
DTS transmissions are encrypted on-the-wire and hence the encrypt setting SHOULD NOT be used
Property methods: EncryptDisplayToLogical(), EncryptGet(), EncryptIsValid(), EncryptLogicalToDisplay(), EncryptLogicalToOdbc(), EncryptNormalize(), EncryptSet()
property FromDTS as %String;
Identifies the originator of data transfer. DTS name as given in site configuration file14 'ClientIdentity' element Needs to be the source application name as per ITK subscription rules
Property methods: FromDTSDisplayToLogical(), FromDTSGet(), FromDTSIsValid(), FromDTSLogicalToDisplay(), FromDTSLogicalToOdbc(), FromDTSNormalize(), FromDTSSet()
property MessageType as %String [ InitialExpression = "Data" ];
Identifies the type of transfer. Can be Data - Will have a data file and control file, Report - Will have a control file only.
Property methods: MessageTypeDisplayToLogical(), MessageTypeGet(), MessageTypeIsValid(), MessageTypeLogicalToDisplay(), MessageTypeLogicalToOdbc(), MessageTypeNormalize(), MessageTypeSet()
property SequenceIdentifier as %String (VALUELIST = ",Host,DTSClient") [ InitialExpression = "DTSClient" , Required ];
The transaction sequence identifier, SequenceIdentifier, will be incorporated into the file names used in the transaction between the host application and the DTS Client. Transactions initiated by the host application will have the sequence identifier applied by the host application. Tansactions initiated by the DTS Client will have the sequence identifier applied by the DTS Client.
Property methods: SequenceIdentifierDisplayToLogical(), SequenceIdentifierGet(), SequenceIdentifierIsValid(), SequenceIdentifierLogicalToDisplay(), SequenceIdentifierLogicalToOdbc(), SequenceIdentifierNormalize(), SequenceIdentifierSet()
property Subject as %String [ InitialExpression = "Discharge Summary Report" ];
Subject of the DTS Transfer Data.
Property methods: SubjectDisplayToLogical(), SubjectGet(), SubjectIsValid(), SubjectLogicalToDisplay(), SubjectLogicalToOdbc(), SubjectNormalize(), SubjectSet()
property TransferType as %String (VALUELIST = ",ITK,Payload") [ InitialExpression = "ITK" , Required ];
Value to indicate whether entire Distribution envelope or just the CDA needs to be part of the data file.
Property methods: TransferTypeDisplayToLogical(), TransferTypeGet(), TransferTypeIsValid(), TransferTypeLogicalToDisplay(), TransferTypeLogicalToOdbc(), TransferTypeNormalize(), TransferTypeSet()
property Version as %String [ InitialExpression = "1.0" ];
Version of Control File
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
property WorkflowId as %String (MAXLEN = 250);
Identifier for the workflow that the data transfer is part of.
Property methods: WorkflowIdDisplayToLogical(), WorkflowIdGet(), WorkflowIdIsValid(), WorkflowIdLogicalToDisplay(), WorkflowIdLogicalToOdbc(), WorkflowIdNormalize(), WorkflowIdSet()


method CreateDTSClientFile(pRequest As EnsLib.ITK.DTS.Framework.Message, Output pResponse As Ens.Response) as %Status
method CreateDTSClientFileFromITK(pRequest As EnsLib.ITK.Framework.RequestData, Output pResponse As Ens.Response) as %Status
classmethod CreateSequenceNumber() as %String
Create the 8 digit sequence number

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab