Integration Configuration for Microsoft Dynamics GP (RIS PD164)

Integration Configuration for Microsoft Dynamics GP (RIS_PD164) v1.2

Integration Configuration forMicrosoft Dynamics GP

This document intends to describe the above module / functionality of the CRIS System.

Author:Steve Jennings

Version:v1.2

Issue Date:1st August 2014

These materials are or comprise restricted and proprietary confidential information of Healthcare Software Systems. Disclosure to or use by the recipient shall not convey any intellectual property rights in these materials. The right to use these materials by the recipient is subject to restrictions and limitations contained in the Provision of Integrated Care Record System and Associated Services Agreement and related agreements.

Document Control

Title / Integration Configuration for Microsoft Dynamics GP
Author / Steve Jennings / Date 21/12/2011
File Ref. / RIS_PD164_20910_MSGP_Integration Configuration.doc
Approval Sign-off (For formal issue)
Owner / Role / Signature / Date / Issue
Steven Verdon / Integration Services Manager / 13/04/13
Approver / Role / Signature / Date / Issue
Dr Julia Paul / Software Developer / 13/04/13
Review Panel
Name / Role
Nick Woods / Integration Specialist
Change History
Issue / Date / Author / Editor / Details of Change
0.1 / 21/12/2011 / Steve Jennings / First Draft
1.0 / 01/05/2012 / Steve Verdon / Erik Simonsen / Standardised document control and contents. Approved for release
1.1 / 13/04/2013 / Steven Verdon / Document review
1.2 / 01/08/2014 / Steven Verdon / Document review

Contents

1Document Information

1.1Scope

2Configuration

2.1Introduction

2.2Installation

2.2.1Required Hostname

2.2.2Jar Files

2.2.2.1Java 6

2.2.2.2Java 5

2.2.3Service.xml file

2.2.3.1Available attributes

2.2.3.2Example service.xml file

2.2.3.3Example messages in xml format

2.2.3.3.1Create Sales Invoice

2.2.3.3.2Create Sales Return

2.2.3.3.3Create Payables Invoice

2.2.3.3.4Create Payables Credit Memo

3Related Documents

4Glossary

1Document Information

1.1Scope

This document contains the information required for configuring and maintaining the integration between CRIS and Microsoft Dynamics GP.

2Configuration

2.1Introduction

Aninterface between CRIS and Microsoft Dynamics GP has been developed, such that contractual information, including costings for items such as examinations, consumables, fees and commissions can be managed from within CRIS, and passed to GP each time the contract is invoiced.

2.2Installation

The communication between the CRIS and MSGP systems takes place on the application server using JBoss, therefore all configuration is required to take place on the application server.

2.2.1Required Hostname

The jar required for the integration has been packaged up with IMSDEV as the hostname of the webservice box.

Therefore IMSDEV needs to be added to the hosts file of the CRIS server, or be available on the DNS.

If there are ever any issues with IMSDEV as a hostname, the gplegacy.jar will need to be repackaged for a different name. Instructions on how to do this are

Compile the wsdl as follows

pathtometrobin\wsimport.sh -d destinationdirectory

Then package up the contents of the destination directory in the jar file gplegacy.jar

2.2.2Jar Files

2.2.2.1Java 6

If the server is running under Java 6, the following jar will need to be in the 05-hsslibs directory within the JBoss deploy directory.

gplegacy.jar

In addition the following jars

stax-api.jar

webservices-api.jar

webservices-extra-api.jar

webservices-extra.jar

webservices-rt.jar

webservices-tools.jar

wstx-services.war

should be placed in the endorsed directory, which can be found using the command

find / -type d -name "endorsed" 2> /dev/null

2.2.2.2Java 5

If the server is running under Java 5, the following jars will need to be in the 05-hsslibs directory.

gplegacy.jar

stax-api.jar

webservices-api.jar

webservices-extra-api.jar

webservices-extra.jar

webservices-rt.jar

webservices-tools.jar

wstx-services.war

In addition, the following jars need to be removed from the default/lib directory of JBoss (You may just want to move them to a backup location).

jboss-jaxrpc.jar

jboss-saaj.jar

2.2.3Service.xml file

A new service.xml file needs to be installed into the deploy directory of the JBoss running on the application server, in order to start listening and acting on SEND_INVOICE messages posted by the CRIS clients. These triggers are fired from the client whenever a new invoice is created or the user requests the trigger to be resent, which is an option in the IMS module.

The documents listed in the related documents section detail how and when this is done by CRIS.

2.2.3.1Available attributes

Attribute Name / Attribute Description / Mandatory
GPURL / The URL of the MSGP webservices installation / Yes
GPUserName / The user name for the MSGP webservices user / Yes
GPPassword / The password for the MSGP webservices user / Yes
Sites / The list of sites that should have the intregration to MSGP applies to. Leave blank if all sites should be affected. / No
DefaultModality / The default modality to use when no modality can be obtained for a billed item. This may be a generic modality code and does not have to be in line with a CRIS modality, it just makes up part 5 of the distribution code for each SalesLineItem in MSGP. / No
SalesBatchKeyPrefix / The prefix to use for the SalesDocument created within MSGP.
This can be left blank, in which case the sales batch key will be a date format in the form ddMMyy–dd. / No
PayablesBatchKeyPrefix / The prefix to use for the PayablesDocument created within MSGP.
This can be left blank, in which case the payables batch key will be a date format in the form ddMMyy–dd. / No
FeeNominalCode / The nominal code (3rd part of the distribution code) to use for all fees. This is mandatory as if not present, the distribution code for the fees with not be created. / Yes
CommissionNormalCode / The nominal code (3rd part of the distribution code) to use for all commissions. This is mandatory as if not present, the distribution code for the commissions with not be created. / Yes
SalesTaxScheduleKey / The key of the tax schedule to be used for normal SalesLineItems / No
SalesTaxExemptScheduleKey / The key of the tax exempt schedule to be used for SalesLineItems with a zero tax value / No
PayablesTaxScheduleKey / The key of the tax schedule to be used for a normal PayablesDocument / No
PayablesTaxExemptScheduleKey / The key of the tax exempt schedule to be used for a PayablesDocument with a zero tax value / No

2.2.3.2Example service.xml file

server

mbeancode="org.jboss.mq.server.jmx.Queue"name="cris3.interfaces.greatplains:service=Queue,name=GPTestToCris"

dependsoptional-attribute-name="DestinationManager"</depends

</mbean

mbeancode="org.jboss.mq.server.jmx.Queue"name="cris3.interfaces.greatplains:service=Queue,name=GPTestFromCris"

dependsoptional-attribute-name="DestinationManager"</depends

</mbean

mbeancode="org.jboss.mq.server.jmx.Queue"name="cris3.interfaces.greatplains:service=Queue,name=GPTestErrors"

dependsoptional-attribute-name="DestinationManager"> </depends

</mbean

mbeancode="hss.interfaces.greatplains.OutgoingMessageProcessor"name="cris3.interfaces.greatplains:service=GP Outbound"

attributename="ErrorQueue"GPErrors</attribute

attributename="QueueName"GPFromCris</attribute

attributename="GPURL"

attributename="GPUserName"HSS User</attribute

attributename="GPPassword"HSS Password</attribute

attributename="Name"GPOUT</attribute

attributename="DataSource"java:/LiveDBDS</attribute

attributename="Sites"HSS01</attribute

attributename="DefaultModality"GM</attribute

attributename="SalesBatchKeyPrefix"SIMP</attribute

attributename="PayablesBatchKeyPrefix"PMIM</attribute

attributename="FeeNominalCode"70403</attribute

attributename="CommissionNominalCode"70401</attribute

</mbean

</server

2.2.3.3Example messages in xml format

2.2.3.3.1Create Sales Invoice

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesInvoice>

<lines>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesInvoiceLine>

<key>

</salesDocumentKey>

</key>

</unitPrice>

</totalAmount>

</quantity>

</taxAmount>

</taxScheduleKey>

<isEncrypted>false</isEncrypted>

</inventoryGLAccountKey>

</itemKey>

<id>SALES</id>

</shippingMethodKey>

<taxes>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesLineTax>

<key>

</taxDetailKey>

</key>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesLineTax>

</salesLineTax>

</taxes>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesInvoiceLine>

</salesInvoiceLine>

</lines>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</glAccountKey>

</creditAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</glAccountKey>

</creditAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</companyKey>

</glAccountKey>

</debitAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</salesDistribution>

</distributions>

</date>

</taxAmount>

<customerName>UAT CUST 3 - INSURANCE</customerName>

<comment>Abdomen,Ankle</comment>

<type>INVOICE</type>

</documentTypeKey>

</companyKey>

</customerKey>

</batchKey>

<contactPerson>Uat - Harry Uat - Test Patient 1</contactPerson>

<line1>CLAREWOOD HOUSE</line1>

<line2>CLAREWOOD DRIVE</line2>

<city>CAMBERLEY</city>

<state>SURREY</state>

</shipToAddress>

</date01>

</date02>

<list01>MILTON KEYNES DIAGNOSTIC CENTRE</list01>

<list02>Mike - INSURANCE</list02>

<text01>Uat - Harry Uat - Test Patient 1</text01>

<text03>BAIRD-SMITH SV</text03>

</userDefined>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesInvoice>

2.2.3.3.2Create Sales Return

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesReturn>

<lines>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesReturnLine>

<key>

</salesDocumentKey>

</key>

</unitPrice>

</totalAmount>

</quantity>

</taxAmount>

</taxScheduleKey>

<isEncrypted>false</isEncrypted>

</inventoryGLAccountKey>

</itemKey>

<id>SALES</id>

</shippingMethodKey>

<taxes>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesLineTax>

<key>

</taxDetailKey>

</key>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesLineTax>

</salesLineTax>

</taxes>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesReturnLine>

</salesReturnLine>

</lines>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</glAccountKey>

</debitAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</glAccountKey>

</debitAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</companyKey>

</glAccountKey>

</creditAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesDistribution>

</salesDistribution>

</distributions>

</date>

</taxAmount>

<customerName>UAT CUST 3 - INSURANCE</customerName>

<comment>Abdomen,Ankle</comment>

<type>INVOICE</type>

</documentTypeKey>

</companyKey>

</customerKey>

</batchKey>

<contactPerson>Uat - Harry Uat - Test Patient 1</contactPerson>

<line1>CLAREWOOD HOUSE</line1>

<line2>CLAREWOOD DRIVE</line2>

<city>CAMBERLEY</city>

<state>SURREY</state>

</shipToAddress>

</date01>

</date02>

<list01>MILTON KEYNES DIAGNOSTIC CENTRE</list01>

<list02>Mike - INSURANCE</list02>

<text01>Uat - Harry Uat - Test Patient 1</text01>

<text03>BAIRD-SMITH SV</text03>

</userDefined>

</com.microsoft.schemas.dynamics.gp.__2006.__01.SalesReturn>

2.2.3.3.3Create Payables Invoice

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesInvoice>

<key>

</key>

</date>

</purchasesAmount>

<description>Reporting Fee</description>

<vendorName>2 B Direct</vendorName>

</batchKey>

</companyKey>

</vendorKey>

</taxScheduleKey>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</distributionTypeKey>

<reference>24/10/2011 Uat - Mary Uat - Test Patient 5</reference>

<isEncrypted>false</isEncrypted>

</glAccountKey>

</debitAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</companyKey>

</glAccountKey>

</debitAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</companyKey>

</glAccountKey>

</creditAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</payablesDistribution>

</distributions>

<taxes>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesTax>

<key>

</taxDetailKey>

</key>

</taxAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesTax>

</payablesTax>

</taxes>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesInvoice>

2.2.3.3.4Create Payables Credit Memo

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesCreditMemo>

<key>

</key>

</date>

</purchasesAmount>

<description>Reporting Fee</description>

<vendorName>2 B Direct</vendorName>

</batchKey>

</companyKey>

</vendorKey>

</taxScheduleKey>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</distributionTypeKey>

<reference>24/10/2011 Uat - Mary Uat - Test Patient 5</reference>

<isEncrypted>false</isEncrypted>

</glAccountKey>

</creditAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</companyKey>

</glAccountKey>

</creditAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</distributionTypeKey>

<isEncrypted>false</isEncrypted>

</companyKey>

</glAccountKey>

</debitAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesDistribution>

</payablesDistribution>

</distributions>

<taxes>

<com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesTax>

<key>

</taxDetailKey>

</key>

</taxAmount>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesTax>

</payablesTax>

</taxes>

</com.microsoft.schemas.dynamics.gp.__2006.__01.PayablesCreditMemo>

3Related Documents

RIS_CRIB299l_02.09.10i_IMS_v1.0

RIS_CRIB299m_02 09 10i_Invoice_Management_System_User_Guide_v1.0

4Glossary

CRIS / The HSS RIS client interface application
GP / MSGP / Microsoft Dynamics Great Plains finance system.
IMS / The invoice management module of the HSS RIS Client interface application.

 Healthcare Software Systems 2014Commercial in ConfidencePage 1 of 18