Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

EnsLib.EDI.ASTM.Service.Standard

abstract class EnsLib.EDI.ASTM.Service.Standard extends Ens.BusinessService, EnsLib.EDI.ServiceInterface

Property Inventory

Method Inventory

Parameters

parameter DOCCLASS = EnsLib.EDI.ASTM.Document;
parameter IndexReplies = 0;
If SearchTableClass is set, use it to index any reply documents
parameter SETTINGS = TargetConfigNames:Basic:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId},SearchTableClass::selector?context={Ens.ContextSearch/SearchTableClasses?host=EnsLib.EDI.ASTM.Service.Standard},LocalApplicationID,ReplyMode,DocSchemaCategory:Basic:selector?context={Ens.ContextSearch/SchemaCategories?host=EnsLib.EDI.ASTM.Service.Standard};
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property %Parser as EnsLib.EDI.ASTM.Parser;
Property methods: %ParserGet(), %ParserGetSwizzled(), %ParserIsValid(), %ParserNewObject(), %ParserSet()
property DocSchemaCategory as %String (MAXLEN = 1000) [ InitialExpression = "E1394" ];
Category to apply to incoming ASTM document type names to produce a complete DocType specification.

Combines with the document type name to produce a DocType assignment.

This setting may also contain multiple comma-separated type names followed by = and then a DocTypeCategory or full DocType value to apply to documents declared as that type.

A trailing asterisk (*) at the end of a given partial type Name will match any types with that beginning part.

An example: DocSchemaCategory='E1394, Q=E1394_Custom, M-*=PVT'
Note that a DocType assignment may be needed for Validation or SearchTableClass indexing.

Property methods: DocSchemaCategoryDisplayToLogical(), DocSchemaCategoryGet(), DocSchemaCategoryIsValid(), DocSchemaCategoryLogicalToDisplay(), DocSchemaCategoryLogicalToOdbc(), DocSchemaCategoryNormalize(), DocSchemaCategorySet()
property LocalApplicationID as %String (MAXLEN = 1000) [ InitialExpression = "ASTMService:ENS" ];
Colon-separated Local ID:Qualifier codes representing this (receiving) facility and application.

These are used in constructing reply document headers.

The '@' symbol represents using the corresponding field from the incoming message.

If your ID must contain a literal @ symbol, escape it with backslash: '\@'

Property methods: LocalApplicationIDDisplayToLogical(), LocalApplicationIDGet(), LocalApplicationIDIsValid(), LocalApplicationIDLogicalToDisplay(), LocalApplicationIDLogicalToOdbc(), LocalApplicationIDNormalize(), LocalApplicationIDSet()
property ReplyMode as %String (DISPLAYLIST = ",Never,Application", VALUELIST = ",Never,App") [ InitialExpression = "Never" ];
This is a 2-way interface; you can send outbound on it using a partner Business Operation. However if your target config item wishes to return an immediate response you can enable this by selecting ReplyMode='Application'.
- Never : Do not send back any reply
- Application : Wait for response from target config item and forward it back when it arrives
Property methods: ReplyModeDisplayToLogical(), ReplyModeGet(), ReplyModeIsValid(), ReplyModeLogicalToDisplay(), ReplyModeLogicalToOdbc(), ReplyModeNormalize(), ReplyModeSet()
property SearchTableClass as %String [ InitialExpression = "EnsLib.EDI.ASTM.SearchTable" ];
Store a set of searchable properties associated with each ASTM document processed.

These records will be stored in the named SearchTable class, if any.

Property methods: SearchTableClassDisplayToLogical(), SearchTableClassGet(), SearchTableClassIsValid(), SearchTableClassLogicalToDisplay(), SearchTableClassLogicalToOdbc(), SearchTableClassNormalize(), SearchTableClassSet()
property TargetConfigNames as %String (MAXLEN = 1000);
Configuration items to which to send Documents
Property methods: TargetConfigNamesDisplayToLogical(), TargetConfigNamesGet(), TargetConfigNamesIsValid(), TargetConfigNamesLogicalToDisplay(), TargetConfigNamesLogicalToOdbc(), TargetConfigNamesNormalize(), TargetConfigNamesSet()
property Validation as %String;
Comma-separated string specifying types of Validation to perform; make it a Setting in your subclass if you override OnValidate() and need to provide options
Property methods: ValidationDisplayToLogical(), ValidationGet(), ValidationIsValid(), ValidationLogicalToDisplay(), ValidationLogicalToOdbc(), ValidationNormalize(), ValidationSet()

Methods

classmethod GetRequestClassList() as %String
classmethod GetResponseClassList(pRequest As %String = "") as %String
method IOLogDiscard(pSC As %Status, pNote As %String, pDiscard As %GlobalCharacterStream)
Add discarded characters to IO Archive
method OnDocumentEnd(pDocument As EnsLib.EDI.Document, pSource As %String, pStatus As %Status) as %Status
Called by the Parser at the end of a document
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
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pDocIn As %Library.RegisteredObject, Output pDocOut As %Library.RegisteredObject, ByRef pHint As %Library.String) as %Status
Note: pDocIn is not declared as EnsLib.EDI.ASTM.Document so that subclasses can handle other types and transform them before calling ##super().
method OnResolveDocType(pDoc As EnsLib.EDI.Document, ByRef pDocType As %String) as %Boolean
Override this method to implement your own custom method for resolving the DocType of an incoming Message Returning nonzero means you are overriding the framework's standard DocType resolution.
method OnValidate(pDoc As EnsLib.EDI.Document, pValSpec As %String, Output pStatus As %Status) as %Boolean
Override this method to implement your own custom method for validating of an incoming Document Return non-zero to prevent default validation of the message (if any);
method SendReply(pReplyDocument As EnsLib.EDI.Document, pOriginalDoc As EnsLib.EDI.Document = $$$NULLOREF) as %Status
method getReplyCode(pMSH As EnsLib.EDI.ASTM.Segment, pSC As %Status, pSCVal As %Status, pAppACK As %Boolean) as %String
method reportReply(pOriginalDoc As EnsLib.EDI.Document, pReplyCode As %String = "", ByRef pSC As %Status) as EnsLib.EDI.Document
method resolveAndIndex(pDoc As EnsLib.EDI.Document) as %Status
Accept only specified document names; resolve DocType and perform requested validation if any
method resolveDocType(pDoc As EnsLib.EDI.ASTM.Document, pMSH As EnsLib.EDI.ASTM.Segment = $$$NULLOREF) as %String
Return the DocType that this service will assign to this document
method standardOnProcessInput(pDocIn As EnsLib.EDI.ASTM.Document, Output pDocOut As EnsLib.EDI.ASTM.Document) as %Status

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab