EnsLib.XML.Object.Service.Standard
abstract class EnsLib.XML.Object.Service.Standard extends Ens.BusinessService
EnsLib.XML.Object.Service.Standard is the base service class for services which read an XML document and then use %XML.Reader to convert the document to a set of persistent classes.Property Inventory
Method Inventory
Parameters
parameter SETTINGS = TargetConfigNames:Basic:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId},ClassName:Basic:selector?context={%ZEN.Portal.ContextSearch/Classes?super=%XML.Adaptor&classtype=persistent&system=0&internal=0},ElementName:Basic,Format:Basic,IgnoreNull:Basic;
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 ClassName as %String;
The name of the class to correlate to the entire XML document or element in the XML document.
Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize(), ClassNameSet()
property ElementName as %String;
The name of the element to correlate in the XML document.
The element must correspond to the specified ClassName.
If there are multiple occurences of this element, then a separate message will be sent to the target for each matching element.
If no element name is specified, then the root element will be correlated to the class.
Property methods: ElementNameDisplayToLogical(), ElementNameGet(), ElementNameIsValid(), ElementNameLogicalToDisplay(), ElementNameLogicalToOdbc(), ElementNameNormalize(), ElementNameSet()
property Format as %String (VALUELIST = ",literal,encoded,encoded12") [ InitialExpression = "literal" ];
The format of the XML document: "literal", "encoded" or "encoded12".
This parameter may be overriden by the Open... format parameter.
Property methods: FormatDisplayToLogical(), FormatGet(), FormatIsValid(), FormatLogicalToDisplay(), FormatLogicalToOdbc(), FormatNormalize(), FormatSet()
property IgnoreNull as %Boolean [ InitialExpression = 0 ];
The runtime specification of the XMLIGNORENULL parameter to %XML.Adaptor.
IgnoreNull specifies the value of
XMLIGNORENULL at runtime as either 0 or 1.
Property methods: IgnoreNullDisplayToLogical(), IgnoreNullGet(), IgnoreNullIsValid(), IgnoreNullLogicalToDisplay(), IgnoreNullNormalize(), IgnoreNullSet()
property TargetConfigNames as %String (MAXLEN = 1000);
Configuration items to which to send Documents
Property methods: TargetConfigNamesDisplayToLogical(), TargetConfigNamesGet(), TargetConfigNamesIsValid(), TargetConfigNamesLogicalToDisplay(), TargetConfigNamesLogicalToOdbc(), TargetConfigNamesNormalize(), TargetConfigNamesSet()
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
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method SetProperties(pReader As %XML.Reader)
Set the needed %XML.Reader properties.
This method may be overridden to add or change which proeprties are to be set.
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()
- OnError()
- OnGenerateSuperSession()
- OnKeepalive()
- OnMonitor()
- OnProcessInput()
- OnProductionStart()
- OnProductionStop()
- OnTearDown()
- PopulateSuperSession()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()