Class EnsLib.File.PassthroughOperation

class EnsLib.File.PassthroughOperation extends Ens.BusinessOperation

Accepts objects of type Ens.StreamContainer and saves the encapsulated stream data to a file using the File OutboundAdapter.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	3	4

Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.File.OutboundAdapter.

Request	Response
Ens.StreamContainer	%Persistent

Properties
%AlertStartTime	%ConfigName	%ConfigQueueName	%LastActionTime
%LastHandledTime	%LastReportedError	%QuitTask	%RequestHeader
%SessionId	%SuperSession	%WarnedLatest	%isShadow
Adapter	AlertGroups	AlertOnError	AlertRetryGracePeriod
ArchiveIO	BusinessPartner	CharacterSetToRemove	DeferResponse
FailureTimeout	Filename	IOLogEntry	InactivityTimeout
NoFailWhileDisconnected	QueueCountAlert	QueueWaitAlert	ReplyCodeActions
Retry	RetryCount	RetryInterval	SendSuperSession
SuspendMessage	ThrottleDelay

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	DeferResponse	EnumerateSettingsClose
EnumerateSettingsExecute	EnumerateSettingsFetch	GenerateSuperSession	GetDeferredResponseToken
GetMessageList	GetMsgHdrRequestKey	GetProductionSettingValue	GetProductionSettings
GetPropertyConnections	GetSettings	GetShadowInstance	IncludeSuperSession
NewIOLogEntry	OnError	OnFailureTimeout	OnGenerateSuperSession
OnGetConnections	OnGetReplyAction	OnInit	OnKeepalive
OnMessage	OnMonitor	OnProductionStart	OnProductionStop
OnTearDown	QueueName	SaveIOLogEntry	SendAlert
SendDeferredResponse	SendRequestAsync	SendRequestSync

Parameters

• parameter ADAPTER = "EnsLib.File.OutboundAdapter";

The type of adapter used to communicate with external systems

• parameter SETTINGS = "Filename:Basic,CharacterSetToRemove:Basic";

List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property CharacterSetToRemove as %String(DISPLAYLIST=",IRIS Default,None,Unix,Windows,Detect Unix or Windows",VALUELIST=",IRIS,None,Unix,Windows,OSDetect") [ InitialExpression = "IRIS" ];

Ens.Util.File::CreateTimestamp() will remove certain characters from the source filename before applying the new name specifier. By default CreateTimestamp removes the following characters:
|?\/:[]<>&,; and ASCII control characters 0,7,9,10 and 13.
Set to IRIS Default to use the CreateTimestamp default.
Set to None to have CreateTimestamp() not strip any characters from the original filename.
Set to Unix to have CreateTimestamp strip / and ASCII control character 0 characters.
Set to Windows to have CreateTimestamp strip <>:/\|?* and ASCII control characters 0 through 31 and 34.
Set to Detect Unix or Windows to detect at startup if Unix or Windows and use the appropriate set as given above.

Note: After CreateTimestamp() has removed any specified characters it will carry out the date time modification based on the filename specificiation and then the final output string, spaces (' ') are replaced by underbars ('_'), slashes ('/') replaced by hyphens ('-') and colons (':') replaced by dots ('.'), except on VMS where both slashes ('/') and colons (':') are instead replaced by hyphens ('-').
This means if characters are to be removed and the original filename contains / or : or spaces and are not considered removable characters they are still modified to _,/,-,. as stated. However if None is chosen as the character set to remove and the filename spec is just %f then no modifications will be applied to space, slashes or colons. This can be used when it is necessary to use exactly the same name as the source.

• property Filename as %String(MAXLEN=1000,MINLEN=1) [ InitialExpression = "%f_%Q%!+(_a)",Required ];

Name of file to output the document(s) to. May include timestamp specifiers. The %f specifier if present will be replaced with the name of the document's original source filename (stripped of certain characters in target filenames - see CharacterSetToRemove).
See the method Ens.Util.File::CreateTimestamp() for documentation of timestamping options.

Methods

• classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)

Return an array of connections for drawing lines on the config diagram

• method OnInit() as %Status

This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()

• method OnMessage(pRequest As Ens.StreamContainer, Output pResponse As %Persistent) as %Status

This is the default message handler. All request types not declared in the message map are delivered here

Class Reference IRIS for UNIX 2024.1.2
Documentation Search