Home > Class Reference > ENSLIB namespace > EnsLib.ITK.DTS.Framework.Service.DTSConfigFile
Private  Storage   

EnsLib.ITK.DTS.Framework.Service.DTSConfigFile


class EnsLib.ITK.DTS.Framework.Service.DTSConfigFile extends
Ens.BusinessService

This Ensemble Business Service is responsible for creating the DTS client directory structure, client configuration file and managing the DTS Client executable.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 21 3


Summary


This is an Ensemble Business Service class.

The associated Adapter class is Ens.InboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
ArchiveIO BusinessPartner CertificatePath
ClientLogLevel CollectReport DTSCredentials
DTSExeLocation DelayReport FilePoll
GenerateSuperSessionID IOLogEntry InactivityTimeout
InterfaceRoot LogPath MaxMessages
MaxMessagesDown MaxMessagesUp PollMode
PollPeriod PollReport PrimaryURL
SaveSent ServerPoll ServerRetry
ThrottleDelay TransferReport WorkPath

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetProductionSettingValue GetProductionSettings GetPropertyConnections GetSettings
GetShadowInstance NewIOLogEntry OnError OnGenerateSuperSession
OnGetConnections OnInit OnKeepalive OnMonitor
OnProcessInput OnProductionStart OnProductionStop OnTearDown
PopulateSuperSession QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync


Parameters


• parameter ADAPTER = "Ens.InboundAdapter";
The type of adapter used to communicate with external systems
• parameter SETTINGS = "DTSCredentials,InterfaceRoot,CertificatePath,PrimaryURL,PollMode,PollPeriod,DTSExeLocation";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property CertificatePath as %String(MAXLEN=250) [ InitialExpression = "c:\dtsv4\certs\Class 3 Primary Certificate Authority.cer",Required ];
The specified location of the certificate.
• property ClientLogLevel as %String [ InitialExpression = "1" ];
Parameter controlling the level of logging. 1 is default. Range is 0 to 3. 0 is debug.
• property CollectReport as %String [ InitialExpression = "N" ];
Parameter controlling the generation of reports by the DTS Client, indicating that it has taken responsibility for the Data Transfer files.
• property DTSCredentials as %String [ InitialExpression = "1",Required ];
Site specific Credentials for the DTS Client.
• property DTSExeLocation as %String [ InitialExpression = "C:\dtsv4\WIN32\DTSClient" ];
Location of DTS Client exe.
• property DelayReport as %String [ InitialExpression = "N" ];
Parameter controlling the generation of reports from the DTS Client indicating that the transfer is delayed if it fails to transfer the Data Files to the DTS Server but the Client is configured to retry.
• property FilePoll as %String [ InitialExpression = "120" ];
• property InterfaceRoot as %String [ InitialExpression = "C:\dtsv4",Required ];
The file system path to the root of the DTS Client File Interface.
• property LogPath as %String [ InitialExpression = "c:\dtsv4\log",Required ];
The location where the client log files dtsclient.log and dts_ssl.log will be created
• property MaxMessages as %String [ InitialExpression = "500" ];
The number of messages that can be upload/downloaded per poll period.
• property MaxMessagesDown as %String [ InitialExpression = "500" ];
An individual MaxMessages down tag have been introduced to give the administrator more control over message flow to the DTS Server.
• property MaxMessagesUp as %String [ InitialExpression = "500" ];
An individual MaxMessages up tag have been introduced to give the administrator more control over message flow to the DTS Server.
• property PollMode as %String(VALUELIST=",Upload,Download,Reverse") [ InitialExpression = "Reverse",Required ];
The poll mode option offers 3 distinct ways of running the client.
• property PollPeriod as %String [ InitialExpression = "10" ];
PollPeriod is defined in minutes and is the period of time the client waits between sending and receiving messages to and from the DTS Server.
• property PollReport as %String [ InitialExpression = "Y" ];
Parameter controlling the generation of reports indicating that the poll to the DTS Server to check for received transfers has succeeded or failed.
• property PrimaryURL as %String [ InitialExpression = "dts.nhs.uk",Required ];
The name of the DTS Server to which the DTS Client will connect.
• property SaveSent as %String [ InitialExpression = "Y" ];
Parameter controlling the copying of sent Data Transfer files into the SENT folder on successful Transfer to the DTS Server.
• property ServerPoll as %String [ InitialExpression = "15" ];
• property ServerRetry as %String [ InitialExpression = "3" ];
The number of retries allowed for a message if the DTS Server is unavailable (but not busy).
• property TransferReport as %String [ InitialExpression = "Y" ];
Parameter controlling the generation of reports indicating that the transfer of the Data Files to the DTS Server has succeeded.
• property WorkPath as %String [ InitialExpression = "c:\dtsv4\work",Required ];
This is the location used by the client for managing working files, such as sequence id file and log rollover timestamp file.

Methods


• method OnInit() as %Status
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
• method OnProcessInput(pInput As %RegisteredObject, pOutput As %RegisteredObject) as %Status
Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).
• method OnTearDown() as %Status
This user callback method is called from %OnClose()