Skip to main content

HS.IHE.XDSb.Repository.Process

persistent class HS.IHE.XDSb.Repository.Process extends Ens.BusinessProcess, HS.HC.Util.Trace.Helper

SQL Table Name: HS_IHE_XDSb_Repository.Process

Property Inventory

Method Inventory

Parameters

parameter HSDEPLOY = 1;
parameter SETTINGS = RepositoryOperations,RegistryOperations,ProvidePostProcessor,XDSbRetrieveConsentTarget,ProvidePreProcessor,ValidateSizeAndHash,ProvideAndRegisterToRegisterTransform,RegisterResponseTransform,TextToRetrieveDocumentResponseTransform,RemoveDocumentsTransform,RemoveDocumentsTarget;
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 Errors as HS.Types.IHE.Errors;
Property to hold errors generated while processing the message
Property methods: ErrorsGet(), ErrorsGetObject(), ErrorsGetObjectId(), ErrorsGetStored(), ErrorsGetSwizzled(), ErrorsIsEmpty(), ErrorsIsValid(), ErrorsNewObject(), ErrorsSet(), ErrorsSetObject(), ErrorsSetObjectId(), ErrorsUnSwizzle()
property IHEVersion as %Integer [ InitialExpression = 1 ];
Property methods: IHEVersionDisplayToLogical(), IHEVersionGet(), IHEVersionGetStored(), IHEVersionIsValid(), IHEVersionLogicalToDisplay(), IHEVersionNormalize(), IHEVersionSet()
property ProvideAndRegisterToRegisterTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/ProvideAndRegisterToRegister.xsl" ];
Stylesheet used to generate the Registry request
Property methods: ProvideAndRegisterToRegisterTransformDisplayToLogical(), ProvideAndRegisterToRegisterTransformGet(), ProvideAndRegisterToRegisterTransformGetStored(), ProvideAndRegisterToRegisterTransformIsValid(), ProvideAndRegisterToRegisterTransformLogicalToDisplay(), ProvideAndRegisterToRegisterTransformLogicalToOdbc(), ProvideAndRegisterToRegisterTransformNormalize(), ProvideAndRegisterToRegisterTransformSet()
property ProvidePostProcessor as %String);
Additional processing for documents with a given format code after document registration/store. Will not execute if registration or store failed. Failure of the post processor will not rollback document store.

The value is a delimeted list: formatCode^^formatScheme^^targetHost||formatCode^^formatScheme^^targetHost...

For example: urn:nhin:names:acp:XACML^^1.3.6.1.4.1.19376.1.2.3^^HS.Consent.XACML.Importer

Property methods: ProvidePostProcessorDisplayToLogical(), ProvidePostProcessorGet(), ProvidePostProcessorGetStored(), ProvidePostProcessorIsValid(), ProvidePostProcessorLogicalToDisplay(), ProvidePostProcessorLogicalToOdbc(), ProvidePostProcessorNormalize(), ProvidePostProcessorSet()
property ProvidePreProcessor as Ens.DataType.ConfigName;
Pre Processor for XDSb_ProvideAndRegisterDocumentSet
Property methods: ProvidePreProcessorDisplayToLogical(), ProvidePreProcessorGet(), ProvidePreProcessorGetStored(), ProvidePreProcessorIsValid(), ProvidePreProcessorLogicalToDisplay(), ProvidePreProcessorLogicalToOdbc(), ProvidePreProcessorNormalize(), ProvidePreProcessorParseConfigNameSpec(), ProvidePreProcessorSet()
property RegisterResponseTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/RegisterResponse.xsl" ];
Stylesheet used to generate the Provide And Register response
Property methods: RegisterResponseTransformDisplayToLogical(), RegisterResponseTransformGet(), RegisterResponseTransformGetStored(), RegisterResponseTransformIsValid(), RegisterResponseTransformLogicalToDisplay(), RegisterResponseTransformLogicalToOdbc(), RegisterResponseTransformNormalize(), RegisterResponseTransformSet()
property RegistryOperations as Ens.DataType.ConfigName [ InitialExpression = "HS.IHE.XDSb.Repository.Operations" ];
Host which will handle the Registration of the document. Typically the HS.IHE.XDSb.Repository.Operations host. In a situation where the Repository and Registry were in the same production this value would be the HS.IHE.XDSb.Registry.Operations
Property methods: RegistryOperationsDisplayToLogical(), RegistryOperationsGet(), RegistryOperationsGetStored(), RegistryOperationsIsValid(), RegistryOperationsLogicalToDisplay(), RegistryOperationsLogicalToOdbc(), RegistryOperationsNormalize(), RegistryOperationsParseConfigNameSpec(), RegistryOperationsSet()
property RemoveDocumentsTarget as Ens.DataType.ConfigName [ InitialExpression = "HS.IHE.XDSb.Repository.Operations" ];
Host which will handle the RemoveDocument request. Typically the HS.IHE.XDSb.Repository.Operations host.
Property methods: RemoveDocumentsTargetDisplayToLogical(), RemoveDocumentsTargetGet(), RemoveDocumentsTargetGetStored(), RemoveDocumentsTargetIsValid(), RemoveDocumentsTargetLogicalToDisplay(), RemoveDocumentsTargetLogicalToOdbc(), RemoveDocumentsTargetNormalize(), RemoveDocumentsTargetParseConfigNameSpec(), RemoveDocumentsTargetSet()
property RemoveDocumentsTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/RMDRequestToRequest.xsl" ];
Stylesheet used to build the DeleteDocumentSetRequest
Property methods: RemoveDocumentsTransformDisplayToLogical(), RemoveDocumentsTransformGet(), RemoveDocumentsTransformGetStored(), RemoveDocumentsTransformIsValid(), RemoveDocumentsTransformLogicalToDisplay(), RemoveDocumentsTransformLogicalToOdbc(), RemoveDocumentsTransformNormalize(), RemoveDocumentsTransformSet()
property RepositoryOID as %String (MAXLEN = 64);
Internal value while processing for this repository, obtained at startup
Property methods: RepositoryOIDDisplayToLogical(), RepositoryOIDGet(), RepositoryOIDGetStored(), RepositoryOIDIsValid(), RepositoryOIDLogicalToDisplay(), RepositoryOIDLogicalToOdbc(), RepositoryOIDNormalize(), RepositoryOIDSet()
property RepositoryOperations as Ens.DataType.ConfigName [ InitialExpression = "HS.IHE.XDSb.Repository.Operations" ];
Host which will handle the Storage of the document. Typically the HS.IHE.XDSb.Repository.Operations host.
Property methods: RepositoryOperationsDisplayToLogical(), RepositoryOperationsGet(), RepositoryOperationsGetStored(), RepositoryOperationsIsValid(), RepositoryOperationsLogicalToDisplay(), RepositoryOperationsLogicalToOdbc(), RepositoryOperationsNormalize(), RepositoryOperationsParseConfigNameSpec(), RepositoryOperationsSet()
property TextToRetrieveDocumentResponseTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/TextToRetrieveDocumentResponse.xsl" ];
Stylesheet used to build the Retrieve Response
Property methods: TextToRetrieveDocumentResponseTransformDisplayToLogical(), TextToRetrieveDocumentResponseTransformGet(), TextToRetrieveDocumentResponseTransformGetStored(), TextToRetrieveDocumentResponseTransformIsValid(), TextToRetrieveDocumentResponseTransformLogicalToDisplay(), TextToRetrieveDocumentResponseTransformLogicalToOdbc(), TextToRetrieveDocumentResponseTransformNormalize(), TextToRetrieveDocumentResponseTransformSet()
property Transformer as HS.Util.XSLTTransformer;
Property methods: TransformerGet(), TransformerGetStored(), TransformerGetSwizzled(), TransformerIsValid(), TransformerNewObject(), TransformerSet()
property ValidateSizeAndHash as %Boolean [ InitialExpression = 1 ];
Checks the size and hash values provided against calculated values and alerts the user to discrepancies. Disabling this option silences the alert. Whether this option is enabled or disabled, the calculated values are used for registration.
Property methods: ValidateSizeAndHashDisplayToLogical(), ValidateSizeAndHashGet(), ValidateSizeAndHashGetStored(), ValidateSizeAndHashIsValid(), ValidateSizeAndHashLogicalToDisplay(), ValidateSizeAndHashNormalize(), ValidateSizeAndHashSet()
property XDSbRetrieveConsentTarget as Ens.DataType.ConfigName;
ConfigName of the business host for consent evaluation for retrieve responses. By default, consent is not evaluated for retrieve.
Property methods: XDSbRetrieveConsentTargetDisplayToLogical(), XDSbRetrieveConsentTargetGet(), XDSbRetrieveConsentTargetGetStored(), XDSbRetrieveConsentTargetIsValid(), XDSbRetrieveConsentTargetLogicalToDisplay(), XDSbRetrieveConsentTargetLogicalToOdbc(), XDSbRetrieveConsentTargetNormalize(), XDSbRetrieveConsentTargetParseConfigNameSpec(), XDSbRetrieveConsentTargetSet()

Methods

method BuildAttachments(pRequest As HS.Message.XMLMessage, pDocument, Output pDocumentArray) as %Status
Move any inline documents to attachments and build DocumentArray
method BuildResponse(pResponse As HS.Message.XMLMessage, pStatusString, ByRef pStream) as %Status
method ExecuteProvidePostProcessor(pRequest As HS.Message.XMLMessage, ByRef pDocArray As %String) as %Status
Execute post-processing on a document set submission
classmethod OnGetConnections(Output pArray As %String, item As Ens.Config.Item)
Inherited description: This method is called when Portal is drawing the production diagram pArray contains the config names the scanner found. Users can remove or add new names
method OnRequest(pRequest As %Persistent, Output pResponse As %Persistent) as %Status
Inherited description: Handle a 'Request'
method OnResponse(pRequest As Ens.Request, ByRef pResponse As Ens.Response, pCallrequest As Ens.Request, pCallresponse As Ens.Response, pCompletionKey As %String) as %Status
OnResponse must be overridden here to avoid error upon response from async request.
method ParseProcessor(pValues As %String) as %ArrayOfDataTypes
Returns array(code^^scheme)=host from given string: code^^scheme^^host||code^^scheme^^host...
method ParseRegistrationHeader(pDocument As %XML.XPATH.Document, ByRef pResults As %String) as %Status
method PrepareAndSendAsync(pRequest As HS.Message.XMLMessage, ByRef pResponse As HS.Message.XMLMessage, Output pWebServiceResponse) as %Status
method ProvideAndRegisterDocumentSetb(pRequest As HS.Message.XMLMessage, pResponse As HS.Message.XMLMessage) as %Status
method RemoveDocuments(pRequest As HS.Message.XMLMessage, pResponse As HS.Message.XMLMessage) as %Status
take external IHE message and turn it into internal DeleteDocumentSetRequest
method RetrieveDocumentSet(pRequest As HS.Message.XMLMessage, pResponse As HS.Message.XMLMessage) as %Status
method RollbackProvideAndRegisterDocumentSetb(ByRef pDocumentArray As %String = "", pRequest As HS.Message.XMLMessage) as %Status

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"received",n)
=
%MessagesReceived(n)

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"sent",n)
=
%MessagesSent(n)

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID)
=
%%CLASSNAME
%ConfigQueueName
%IsCompleted
%MasterPendingResponsesOld
%PrimaryRequestHeader
%PrimaryResponseHeader
%RepliedStatus
%responseId
Adapter
%SessionId
%TimeCompleted
%TimeCreated
%ConfigName
%QuitTask
AlertOnError
%responseClassName
%IsTimerInterrupted
%IsTerminated
%StatusCode
%MessagesReceivedOld
%MessagesSentOld
ReplyCodeActions
RetryInterval
AlertRetryGracePeriod
FailureTimeout
Retry
SuspendMessage
QueueCountAlert
QueueWaitAlert
InactivityTimeout
BusinessPartner
AlertGroups
%SuperSession

Storage Model: Storage (HS.IHE.XDSb.Repository.Process)

^Ens.BusinessProcessD(ID,"Process")
=
MPIOperations
TraceOperations
IHEVersion
IHEExtension
Transformer
ECRTarget
RegistryOperations
XSLForCreatingSDA
RepositoryOID
RepositoryOperations
ProvidePreProcessor
ProvidePostProcessor
XDSbRetrieveConsentTarget
Errors
Pipeline
PipelineMode
PnRPreProcessor
ValidateSizeAndHash
ProvideAndRegisterToRegisterTransform
RegisterResponseTransform
TextToRetrieveDocumentResponseTransform
RemoveDocumentsTarget
RemoveDocumentsTransform
FeedbackOpens in a new tab