EnsLib.EDI.XML.Service.Standard
abstract class EnsLib.EDI.XML.Service.Standard extends Ens.BusinessService, EnsLib.EDI.ServiceInterface
Property Inventory
Method Inventory
- GetRequestClassList()
- GetResponseClassList()
- IOLogDiscard()
- OnGetConnections()
- OnInit()
- OnResolveDocType()
- OnValidate()
- SendReply()
- reportReply()
- resolveAndIndex()
- resolveDocType()
- standardOnProcessInput()
Parameters
parameter DOCCLASS = EnsLib.EDI.XML.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.XML.Service.Standard},ReplyMode,DocSchemaCategory:Basic:selector?context={Ens.ContextSearch/SchemaCategories?host=EnsLib.EDI.XML.Service.Standard},Validation;
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 DocSchemaCategory as %String (MAXLEN = 1000);
Category to apply to incoming XML document root node 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='Qv3NL,QURX_IN990001NL=QURX_IN990001NL';
Note that a DocType assignment is be needed for Transformation, Validation or SearchTableClass indexing.
A trailing asterisk (*) at the end of a given partial type Name will match any types with that beginning part. An example: DocSchemaCategory='Qv3NL,QURX_IN990001NL=QURX_IN990001NL';
Note that a DocType assignment is be needed for Transformation, Validation or SearchTableClass indexing.
Property methods: DocSchemaCategoryDisplayToLogical(), DocSchemaCategoryGet(), DocSchemaCategoryIsValid(), DocSchemaCategoryLogicalToDisplay(), DocSchemaCategoryLogicalToOdbc(), DocSchemaCategoryNormalize(), DocSchemaCategorySet()
property ReplyMode as %String (DISPLAYLIST = ",Never,Application", VALUELIST = ",Never,App") [ InitialExpression = "Never" ];
This is 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
- 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.XML.SearchTable" ];
Store a set of searchable properties associated with each XML Document processed.
These records will be stored in the named SearchTable class, if any.
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;
Specifies types of Validation to perform
Set to 1 to reject documents that don't pass DocType schema validation.
Property methods: ValidationDisplayToLogical(), ValidationGet(), ValidationIsValid(), ValidationLogicalToDisplay(), ValidationLogicalToOdbc(), ValidationNormalize(), ValidationSet()
Methods
classmethod GetRequestClassList() as %String
method IOLogDiscard(pSC As %Status, pNote As %String, pDiscard As %GlobalCharacterStream)
Add discarded characters to IO Archive
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 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 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 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.XML.Document) as %String
Return the DocType that this service will assign to this document
method standardOnProcessInput(pDocIn As EnsLib.EDI.XML.Document, Output pDocOut As EnsLib.EDI.XML.Document) as %Status
Inherited Members
Inherited Properties
- %AlertStartTime
- %ConfigName
- %ConfigQueueName
- %LastActionTime
- %LastHandledTime
- %LastReportedError
- %OutsideCreated
- %PreserveSession
- %ProcessInputCalled
- %QuitTask
- %RequestHeader
- %SessionId
- %SuperSession
- %SuperSessionCreatedBeforeSession
- %WaitForNextCallInterval
- %WarnedLatest
- %isShadow
- Adapter
- AlertGracePeriod
- AlertGroups
- AlertOnError
- ArchiveIO
- BusinessPartner
- GenerateSuperSessionID
- IOLogEntry
- InactivityTimeout
- ThrottleDelay
Inherited 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()
- GetMsgHdrRequestKey()
- GetProductionSettingValue()
- GetProductionSettings()
- GetPropertyConnections()
- GetSettings()
- GetShadowInstance()
- NewIOLogEntry()
- OnDocumentEnd()
- OnDocumentStart()
- OnError()
- OnGenerateSuperSession()
- OnKeepalive()
- OnMonitor()
- OnParsingError()
- OnPostDocument()
- OnPreDocument()
- OnProcessInput()
- OnProductionStart()
- OnProductionStop()
- OnTearDown()
- PopulateSuperSession()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()