Difference between revisions of "GVHL7ListenerManager"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "==Description== =={{VULCON}} / {{GVCONSOLE}} Configuration== The GVHL7ListenerManager Element is used by '''GVAdapters'''. The following table show the element's attributes GV...")
 
(→‎GVCoreApplication)
 
(7 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
The GVHL7ListenerManager Element is used by '''GVAdapters'''.
 
The GVHL7ListenerManager Element is used by '''GVAdapters'''.
  
−
The following table show the element's attributes GVHL7ListenerManager:
+
The following table shows the element's attributes GVHL7ListenerManager:
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
Line 16: Line 16:
 
|}
 
|}
  
−
Its subelements are:
+
Its sub-elements are:
−
* Description
+
* [[Description]]
−
* HL7Listeners containing one or more '''HL7Listener''' elements.
+
* HL7Listeners containing one or more [[#HL7Listener|HL7Listener]] elements.
  
 
===HL7Listener===
 
===HL7Listener===
Line 24: Line 24:
 
The HL7Listener Element is used by: HL7Listeners.
 
The HL7Listener Element is used by: HL7Listeners.
  
−
The following table show the element's attributes HL7Listener:
+
The following table shows the element's attributes HL7Listener:
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
Line 35: Line 35:
 
|-
 
|-
 
| port || required || The attribute's value can't be null.
 
| port || required || The attribute's value can't be null.
 +
|-
 +
| autoStart || optional || Automatically starts listening for connection. Default to true.
 +
|}
 +
 +
<div class="version_ge3.4/3.3.4">
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| receivingApplication || optional || Force the Receiving Application MSH field value on automatic response generation.
 +
|-
 +
| receivingFacility || optional || Force the Receiving Facility MSH field value on automatic response generation. Used only if '''receivingApplication''' is set.
 
|}
 
|}
 +
</div>
  
−
Its subelements are:
+
Its sub-elements are:
−
* Description
+
* [[Description]]
−
* HL7Applications
+
* [[#HL7Applications|HL7Applications]]
  
 
====HL7Applications====
 
====HL7Applications====
Line 45: Line 57:
 
The HL7Applications Element is used by '''HL7Listener'''.
 
The HL7Applications Element is used by '''HL7Listener'''.
  
−
Its subelements are:
+
Its sub-elements are:
−
* GVCoreApplication
+
* [[#GVCoreApplication|GVCoreApplication]]
 +
 
 +
====GVCoreApplication====
 +
 
 +
The GVCoreApplication Element is used by [[#HL7Applications|HL7Applications]].
 +
 
 +
The following table shows the GVCoreApplication element's attributes :
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || Unmodifiable. Used by {{GVESB}} factory framework. This attribute must assume the value '''hl7application'''.
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.gvhl7.listener.handler.GVCoreApplication'''.
 +
|-
 +
| name || required || The attribute's value can't be null.
 +
|-
 +
| gv-system || required || ID system with which to perform the invocation of {{GVESB}}.
 +
|-
 +
| gv-service || required || ID service with which to perform the invocation of {{GVESB}}.
 +
|-
 +
| gv-operation || required || {{GVESB}} operation to invoke.
 +
|-
 +
| transacted || optional || Indicates whether the invocation to be performed in GreenVulcano is transactional or not. Default: false
 +
 
 +
A transaction is rolled back if:
 +
      - the service ends with exception
 +
      - the output GVBuffer contains the property HL7_FORCE_TX_ROLLBACK=Y
 +
|-
 +
| tx-timeout || optional || Transaction timeout in seconds. Default: 30s
 +
|}
 +
 
 +
Its sub-elements are:
 +
* [[Description]]
 +
* HL7Activations containing [[#HL7Activation|HL7Activation]] elements
 +
 
 +
<div class="version_ge3.4/3.3.4">
 +
Sets the following properties in input to GV workflow:
 +
{|class="gvtable"
 +
! Property !! Description
 +
|-
 +
| HL7_REMOTE_ADDR || Remote address of the invoking client
 +
|-
 +
| HL7_LISTENER || HL7 Listener's name receiving the client request
 +
|-
 +
| HL7_APPLICATION || HL7 Application's name processing the client request
 +
|-
 +
| HL7_REC_APPLICATION || Configured HL7 Listener @receivingApplication value
 +
|-
 +
| HL7_REC_FACILITY || Configured HL7 Listener @receivingFacility value
 +
|}
 +
</div>
 +
 
 +
====HL7Activation====
 +
 
 +
The HL7Activation Element is used by '''HL7Activations'''.
 +
 
 +
The following table shows the HL7Activation element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| messageType || required || The attribute's value cannot be null.
 +
|-
 +
| triggerEvent || required || The attribute's value cannot be null.
 +
|}

Latest revision as of 10:54, 31 December 2014

Description

VulCon / GV Console Configuration

The GVHL7ListenerManager Element is used by GVAdapters.

The following table shows the element's attributes GVHL7ListenerManager:

Attribute Type Description
version fixed This attribute must assume the value 1.0.
type fixed Element type module.
name fixed Module id always set to EXCEL_REPO. This attribute must assume the value HL7_LISTENERS.

Its sub-elements are:

HL7Listener

The HL7Listener Element is used by: HL7Listeners.

The following table shows the element's attributes HL7Listener:

Attribute Type Description
type fixed This attribute must assume the value hl7listener.
class fixed This attribute must assume the value it.greenvulcano.gvesb.gvhl7.listener.HL7Listener.
name required The attribute's value can't be null.
port required The attribute's value can't be null.
autoStart optional Automatically starts listening for connection. Default to true.
Attribute Type Description
receivingApplication optional Force the Receiving Application MSH field value on automatic response generation.
receivingFacility optional Force the Receiving Facility MSH field value on automatic response generation. Used only if receivingApplication is set.

Its sub-elements are:

HL7Applications

The HL7Applications Element is used by HL7Listener.

Its sub-elements are:

GVCoreApplication

The GVCoreApplication Element is used by HL7Applications.

The following table shows the GVCoreApplication element's attributes :

Attribute Type Description
type fixed Unmodifiable. Used by GreenVulcano® ESB factory framework. This attribute must assume the value hl7application.
class fixed This attribute must assume the value it.greenvulcano.gvesb.gvhl7.listener.handler.GVCoreApplication.
name required The attribute's value can't be null.
gv-system required ID system with which to perform the invocation of GreenVulcano® ESB.
gv-service required ID service with which to perform the invocation of GreenVulcano® ESB.
gv-operation required GreenVulcano® ESB operation to invoke.
transacted optional Indicates whether the invocation to be performed in GreenVulcano is transactional or not. Default: false

A transaction is rolled back if: 

     - the service ends with exception
     - the output GVBuffer contains the property HL7_FORCE_TX_ROLLBACK=Y
tx-timeout optional Transaction timeout in seconds. Default: 30s

Its sub-elements are:

Sets the following properties in input to GV workflow:

Property Description
HL7_REMOTE_ADDR Remote address of the invoking client
HL7_LISTENER HL7 Listener's name receiving the client request
HL7_APPLICATION HL7 Application's name processing the client request
HL7_REC_APPLICATION Configured HL7 Listener @receivingApplication value
HL7_REC_FACILITY Configured HL7 Listener @receivingFacility value

HL7Activation

The HL7Activation Element is used by HL7Activations.

The following table shows the HL7Activation element's attributes:

Attribute Type Description
messageType required The attribute's value cannot be null.
triggerEvent required The attribute's value cannot be null.
Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVHL7ListenerManager&oldid=4275"