Home

installation documentation

1. 5 Ahome directory is created at the selected location and Figure 4 is displayed British Telecommunications plc 2012 IN CONFIDENCE Page 19 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 claps HOM Figure 4 Screen to select APPS_HOME Path 6 If you have a working EDT Client installation the installer identifies your EDTClient DATA Home and populates as shown Figure 5A Clicking on the Next button prompts you with a dialog box confirming that the directory will be overwritten Click on the YES button to continue as shown in Figure 5 Warning Figure 5 Confirmation Box to Overwrite DATA_HOME Directory British Telecommunications plc 2012 IN CONFIDENCE Page 20 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT Installation of EDT Client Issue 2 01 November 2012 og Select the DATA HOME path C DATA_HOME C WDATA_HOME F Browse ade with IzPack Greve o Cos Figure 5A Screen to select show existing DATA_HOME Path The existing data will be preserved and you can continue to use the same location to send interchanges to EDT server If this is a new installation you need to enter the path for the location of the EDT Client Data home directory and provide the root directory from where inte
2. SENDER2 SENDER3 OUTBOX i anges only Figure 27 EDT Mode Receive and Folder Mapping The four receive modes for downloading the interchanges are as follows e In Receive by ASID mode where successful all of the uploaded Interchange files for the entire applicable datasets will be downloaded into their respective senderlD folders created as follows British Telecommunications plc 2012 IN CONFIDENCE Page 47 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 4 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 lt EDT_ DATA HOME gt OUTBOX lt Dataset Name gt SENDER folder In Receive by Dataset mode where successful all of the uploaded Interchange files for the dataset name specified will be downloaded into their respective senderlD folders created as follows lt EDT_DATA HOME gt OUTBOX lt Dataset Name gt SENDER folder In Receive by Dataset Not Received mode where successful all of the interchanges which have never been downloaded will be downloaded for the mentioned dataset file into their respective senderID folders creates as shown below lt EDT_ DATA HOME gt OUTBOX lt Dataset Name gt SENDER folder 3 In Receive by File Name mode where successful all of the ctl and dat files with the specified name for the dataset name provided will be downloaded into the senderlD folder creat
3. Validation reports are produced under lt EDT DATA HOME gt REPORTS lt Dataset Name gt lt Sender Id gt directory detailing the validation errors Additionally the current sender is blocked from transmitting interchanges in future executions of the application This step ensures that the failed and subsequent interchanges are not transmitted to Spine until Validation errors are corrected and interchanges placed back in INBOX British Telecommunications plc 2012 IN CONFIDENCE Page 49 of 78 Issue 2 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 4 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Relevant sender is unblocked to resume transmissions The successfully validated interchanges are transmitted to Spine sequentially Transmissions are retried for set number of attempts as mentioned in the configuration file i e For authentication of the EDT Client retry attempts will be limited to one and for uploading the file retry attempts will be limited to two This applies if failure occurs due to internet or other problems for example slow connectivity If all the retry attempts are exhausted this and all subsequent interchanges are ignored and processing moves onto next Application Sender ID Note that interchanges are successfully transmitted are moved to lt EDT_DATA HOME gt ARCHIVE SENT lt Dataset Name gt lt Sender Id gt directory
4. British Telecommunications plc 2012 IN CONFIDENCE Page 8 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 2 1 2 1 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 Introducing EDT Purpose The EDT system is used to transmit data Commissioning Data Set CDS Mental Health Minimum Data Set MHMDS Choose and Book CAB Reference Data Management RDM Pseudonymisation P14N and De Pseudonymisation DeP14N interchanges securely to the SUS environment and downloading the files back to the client environment From Release 12 the EDT system will support CDS v6 2 It will continue to support CDS v6 1 and its subversion viz CDS v6 1 1 The EDT client will not support the CDS v6 0 To summarize the EDT system will support the below mentioned CDS schemas 1 The existing CDS V6 1 and its subversion CDS V6 1 1 schema 2 The new CDS 6 2 schema By virtue of schema s backwards compatibility any interchange compliant with the existing CDS 6 1 schema will be compliant with CDS 6 1 1 schema The new EDT Client install package will also cater to this feature This means that anybody installing EDT Client for the first time or re installing it will have CDS 6 1 and its subversion CDS 6 1 1 schema and the new CDS 6 2 schema EDT Modes 1 Validate Only This mode facilitates the user to only validate its interchanges In this mode EDT validates interchanges against locally stored schemas and does not r
5. Figure 12 Screen Displayed to Ask For Confirmation to Create APPS_HOME and DATA_HOME Directories 8 If Y is entered the installer installs the client British Telecommunications plc 2012 IN CONFIDENCE Page 27 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 3 3 3 3 1 3 3 2 12564 MSK SUS R12 User Guide EDT t Novemberi 10 25 59 72 PUTTY Installation Finished Figure 13 Screen Displayed During Client Installation If N is entered the installer quits Post Installation Installation of DATA Sets Application References and Senders For existing installations you need to use the existing Data Home For new installation creating datasets and senders refer to section 4 5 3 1 EDT Application User Setup on UNIX To make the EDTClient run on a UNIX application with privileges other than root for daily operations execute the following steps Make sure that you have a user EDTUser with group EDTUserGroup before executing the following steps chown R lt EDTUser gt lt EDTGroup gt lt ClientInstallDir gt chown R lt EDTUser gt lt EDTGroup gt lt Client Data Dir gt Note ClientInstallDir is the location you have installed APPS_HOME and Client Data Dir is the folder where you have installed Data Home British Telecommunications plc 2012 IN CONFIDENCE Page 28 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SU
6. British Telecommunications plc 2012 Contains EDT library files Contains the following log files created during the EDT execution EDTAudit Provides complete audit trail of file transmissions EDTPerformance Provides performance log entries EDTDiagnostic Provides error info debug messages useful for EDT maintenance support Contains schema files for local validation in Validate Only mode Source for all interchanges This contains further subdirectories to hold interchanges for specific Applications and Sender Ids CDS Dataset which contains sender folders with names as 15 Digit sender IDs This folder will be under CDS Value is CDSInterchangeSenderldentity tag value in the data file or Sender Identity with which you are registered for SUS MHMDS Dataset Which contains all MHMDS sender ID values This folder will be under MHMDS Value is MHMDSSourceldentification tag value in the data file or Sender Identity with which you are registered for SUS CAB Dataset which contains all CAB SenderID values This folder will be under CAB Value is SUSInterchangeSenderldentity tag value in the control file or Sender Identity with which you are registered for SUS RDM Dataset which contains all RDM SenderID values This folder will be under RDM Value is SUSInterchangeSenderldentity tag value in the control file or Sender Identity with which you are registered for SUS IN CONFIDENCE Page 30 of 78 NHS CFH National Spi
7. British Telecommunications plc 2012 IN CONFIDENCE Page 51 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 4 4 4 Issue 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 2 172 16 226 182 PuTTY H nEDT Version 3 5 0 British Telecommunicatio log4 xml puild URL to resource o pported for wnl ed Figure 30 Screen Displayed After Successful Completion of Receive Mode The application goes through following steps in response to above command First the application tries to authenticate the EDT Client with the Spine Authentication is retried for set number of attempts if failure occurs due to internet or other problems The application exits if the authentication fails or is denied by Spine For receive by ASID mode authentication takes place for the respective application type The application then performs a handshaking operation If the handshaking operation is successful interchanges are downloaded to the client sequentially Transmissions are retried for set number of attempts if failure occurs due to internet or other problems If all the retry attempts are exhausted this and all subsequent interchanges are ignored Note that interchanges are successfully downloaded to the lt EDT_DATA_HOME gt OUTBOX lt Dataset Name gt lt Sender Id gt directory Receive by Dataset Name With this receive option EDT downloads the Interchanges from the SUS environment to the Client environment for the
8. All errors are logged in locally configured text files called diagnostic logs A detailed audit trail of all authentication transmission actions performed is logged in audit log The start and end of every authentication transmission request is logged in performance log The EDT system comes with automated installation upgrade and administration utilities Pre requisites and Dependencies Following are the dependencies of the EDT Client e EDT executes schema validation against the schemas e EDT handles a maximum data file size up to 1 GB For PDS and NF extracts that have data of more than 1 GB will be stored in the split files at the file store These will be downloaded and will be merged to create a single file which will be provided to the user in the OUTBOX folder The split file will be downloaded into a hidden temporary folder British Telecommunications plc 2012 IN CONFIDENCE Page 11 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 e Internet Explorer 6 0 and 7 0 installed on the Windows box and access to the N3 network for End Point Registration EPR Process specifically for downloading the certificates e Tobe able to run EDT the host environment must have the following software environment SUN JAVA Runtime Environment 1 5 x For Windows operating System SUN JRE 1 5 x is bundled along with the EDT Client Software and for on any UN
9. 66 68 69 69 71 72 72 77 78 Page 6 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 1 1 1 2 1 3 12564 MSK SUS R12 User Guide EDT 01 November 2012 About this Document This document is the User Guide for External Data Transfer EDT Client of the NHS Spine system It describes the purpose and usage of the service and forms part of the standard Spine documentation set Scope This document is the User Guide Framework DEV110 for the EDT sub system of the NHS Spine The document forms part of the standard EDT release documentation set It details the use of the application provided by the subsystem including e How to install access and navigate around the EDT Client application e How to perform the basic operations required to maintain and monitor the application e Description of End Point Registration EPR and certificate signing and importing e Description of the EDT client installable screens both on Windows and Unix e Description of Keystores and certificate issues and resolutions e Descriptions of EDT error reports and EDT logs e Description of how to uninstall EDT client from the machine e As per BIR SUS 0274 steps to update EDT Client Schema viz CDS V6 1 to CDS V6 1 1 Audience This document is intended for members of the following teams e Systems Delivery Directorate e Training Directorate Assumptions and Constraints It is assumed that readers of this document
10. EDT Issue 2 01 November 2012 C Documents and Settings soniat Local Settings Temporary Internet Files OLK38F EDT_Report_v5BO Microsoft Internet Explorer File Edit View Favorites Tools Help a Q Back x E O JO Search she Favortes O B A w mm rel y 3 Address C Documents and Settings soniat Local Settings Temporary Internet Files OLK38F EDT_Report_v5B020_26_31052006123105 html v Go Links File y5B020_26 xml Action Validate_Send Status Passed 0 error s Size 28 KB Location C DT_DATA_HOMEANBOX CDS ProviderA Time Started 31 05 2006 12 31 03 Time Completed 31 05 2006 12 31 05 Top Done Internet Figure 346 EDT Report Details 5 2 1 EDT Error Reports Upon failure the EDT Client generates an error report lt EDT DATA HOME gt REPORTS Error Report html in HTML format as shown in Figure 357 Typically it will contain a single error Note that the diagnostic log shows these errors in text format British Telecommunications plc 2012 IN CONFIDENCE Page 68 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 5 3 5 3 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 c tmp EDT_DATA_HOME REPORTS Error_Report html Microsoft Internet Explorer D 15 xj File Edit View Favorites Tools Help A Q O t A AL san eraot Aui 4 2 2 LR a Address c tmp E
11. LoggingInitialiser configureFromFile Attempting to build URL to resource ol n the classpath LoggingInitialiser configureFromFile Successfully built URL to resource LoggingInitialiser Loading config at URL file C APPS_HOME CONFIG 1094j xml LoggingInitialiser Logging initialized EDT Sender Completed Please refer the logs for more details C APPS_HOME BIN gt Figure 28 Screen Displayed After Successful Completion of Validate_Send Mode The application goes through the following steps in response to the above command First the application tries to authenticate the EDT Client with the Spine Authentication is retried for set number of attempts if failure occurs due to internet or other problems The application exits if authentication fails or denied by Spine All the interchanges present under lt EDT DATA HOME gt INBOx directory are processed per Application and Sender Id in sequential steps These steps are repeated for all application type and senders Interchanges pertaining to an Application and Sender Id are collated in the ascending order of the file modification date All interchanges are then validated sequentially using the schemas centrally held on Spine server If a particular interchange fails to validate then all subsequent interchanges are not validated and all of them are moved to lt EDT_DATA_HOME gt ARCHIVE FAILED lt Dataset Name gt lt Sender Id gt directory
12. The interchanges that have failed to transmit remain under INBOX to be picked up by next execution of the application Validate Only With the Validate Only option EDT validates interchanges against the locally stored schemas lt EDT APPS HOME gt SCHEMA lt Application gt lt schema version gt without transmitting them to Spine The validation success failure reports are placed under relevant Application Sender Id Folders of EDT_DATA_HOME REPORTS directory Note that EDT Client does not connect to Spine as authentication transmission is not required Note In this instance senders are not blocked when interchanges fail validation This option should be run manually whenever required rather than scheduling it It functions in the same way irrespective of run mode scheduled manual and operating environment Windows UNIX Change directory to lt EDT_APPS_HOME gt BIN and execute following command at the prompt Windows runEDTClient bat Validate_Only UNIX runEDTClient sh Validate Only Note Parameter Validate_Only is not case sensitive In normal circumstances the application should exit successfully as shown in Figure 29 British Telecommunications plc 2012 IN CONFIDENCE Page 50 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 4 3 12564 MSK SUS R12 User Guide EDT di Nears WINDOWS system32 cmd exe C APPS_HOME BIN gt runEDTClient bat
13. lt filename gt is case sensitive In normal circumstances the application should exit successfully as shown in Figure 311 British Telecommunications plc 2012 IN CONFIDENCE Page 54 of 78 NHS CFH National Spine BT Approved nl IN CONFIDENCE Issue 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 2 GMT 2012 EDT Sender Version 3 5 0 British Telecommunicatio c Initialising Log4 j d filename log4 xml configureFromFile Attempting to build URL to resource o configu romFile j Su fully built URL Loading nfig at URL f EDT Client APPS Or details Figure 311 Screen Displayed After the Successful Completion of Receive By The application g First the applicati Filename Mode oes through following steps in response to above command on tries to authenticate the EDT Client with the Spine Authentication is retried for set number of attempts if failure occurs due to internet or other problems The application exits i f authentication fails or is denied by Spine The application then performs a handshaking operation If the handshaking operation is successful all the specified interchanges for the specified application are downloaded to the client sequen tially Transmissions are retried for set number of attempts if failure occurs due to internet or other problems If all the retry attempts are exhausted this and all subsequent interchanges are ignored Note that in
14. 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 e EDT Client Versions 3 2 1 Automatic user friendly full installation This is updated in R4 release Supports CDS V6 0 CDS V6 1 MHMDS3 4 CAB Control files CAB Data files RDM control files and data files P14N control file and data file DeP14N control file and data file It also supports CDS V6 1 1 if CDS V6 1 is updated to CDS V6 1 1 e EDT Client Versions 3 4 1 Automatic user friendly full installation This is updated in R6 release Supports CDS V6 0 CDS V6 1 MHMDS V3 4 CAB Control files CAB Data files RDM control files and data files P14N control file and data file DeP14N control file and data file NF_DATA_ RECON control file and data file NF_DATA_POSTRECON control file and data file NF_MANIFEST_RECON mf files NF_MANIFEST_POSTRECON mf files SUS_DATA_PDS control file and data file SUS_MANIFEST_PDS mf files It also supports CDS V6 1 1 if CDS V6 1 is updated to CDS V6 1 1 e EDT Client Versions 3 5 2 Automatic user friendly full installation This is updated in R12 release Supports CDS V6 1 and its subversion viz CDS V6 1 1 CDS V6 2 MHMDS V3 4 CAB Control files CAB Data files RDM control files and data files P14N control file and data file DeP14N control file and data file NF_DATA_ RECON control file and data file NF_DATA_POSTRECON control file and data file NF_MANIFEST_RECON mf files NF_MANIFEST_POSTRECON mf f
15. CONFIDENCE Page 4 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT 3 5 3 Load ASID 3 6 Uninstalling EDT client 3 7 Logging In 3 8 Navigating Through EDT 3 9 Logging Out 4 Application Functionality 4 1 View an Alert s Details 4 2 Business Process 4 3 Keeping Interchange Files Ready for Transmission 4 4 Application Execution 4 4 1 Validate amp Send 4 4 2 Validate Only 4 4 3 Receive by ASID 4 4 4 Receive by Dataset Name 4 4 5 Receive by File Name 4 4 6 Receive by Dataset Not Received 4 5 Administration 4 5 1 Automated Tracking 4 5 2 EDT Admin Utility 4 5 3 Unblock Senders 4 5 4 Logging Changes 4 5 5 Archiving 4 5 6 Future Upgrades 4 6 Keystore and Certificate Issues 4 6 1 Steps to Check Certificate Expiry Date British Telecommunications plc 2012 IN CONFIDENCE Issue 2 01 November 2012 41 42 43 43 43 45 45 45 46 46 48 50 51 52 54 55 57 57 58 58 60 62 62 62 62 Page 5 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT 4 6 2 Steps to renew certificate 5 Troubleshooting 5 1 Viewing Reports 5 2 Interchange Validation Reports 5 2 1 EDT Error Reports 5 3 Viewing Logs 5 3 1 Upload Audit Events 5 3 2 Download Audit Events 5 3 3 Performance Logs 5 3 4 Diagnostic Logs 6 Glossary 7 References British Telecommunications plc 2012 IN CONFIDENCE Issue 2 01 November 2012 64 66 66
16. EDT Issue 2 01 November 2012 operates more than a single instance of EDT Client it remains the responsibility of the provider to maintain the business sequence required for the correct submissions of data SUS processes interchanges in the sequence in which they are received Keeping Interchange Files Ready for Transmission Place the interchange files to be validated transmitted under the relevant Application and Sender Id folders under lt 1 EDT DATA HOMI E gt INBOX directory For example if Interchange file is for CDS application and the user is LSP1234 then the received interchange file should be kept at lt 1 The folder lt EDT_DATA_HOMI EDT DATA HOMI installation procedure mentioned in section 3 2 Application Execution E gt INBOX CDS LSP1234 folder E gt INBOX CDS LSP1234 would be created during Figure 26 depicts how the xml files are moved to directories configured on client execution CDS SENDER1 Validate _Only SENDER2 _ SENDER3 SENT DS Validate_Send REPORTS cps _ SENDER2 _ SENDER3 ARCHIVE ENDER1 SENDER2 SENDER3 Figure 26 EDT Modes Validate_Only and Validate_Send and Folder Mapping British Telecommunications plc 2012 IN CONFIDENCE Page 46 of 78 NHS CFH National Spine IN CONFI
17. LL DETAIL Application Type MHMDS Sender senderC File MHMDS 132058 26062006 5 interchanges xml Transmission request sent 08 LL DETAIL Application Type MHMDS Sender senderC File MHMD 132058 26062006 5 interchanges xml Transmission successful 9 LL DETAIL EDT Sender executed successfully 3 LL DETAIL Application Type MHMDS Authentication request sent LL DETAIL Application Type MHDS Authentication successful 5 LL DETAIL Application Type MHMDS Sender senderC File MHMDS 132058 26062006 5 interchanges xml Interchange validation successful 6 LLIDETAIL Application Type MHMDS Transmission handshake request sent LLIDETAIL Application Type MHMDS Transmission handshake successful 18 LL DETAIL Application Type MHMDS Sender senderC File MHMDS 132058 26062006 5 interchanges xml Transmission request sent 9 LLIDETAIL Application Type MHMDS Sender senderC File MHMD 132058 26062006 5 interchanges xml Transmission successful 20 LLIDETAIL EDT Sender executed successfully of EDTAudit log _ EDTDiagnostic log EDT Sender prope For Help press F1 niz0 eolas7 127 00 Pc Rec ins READ Figure 368 EDT Audit Log 53 2 Download Audit Events A detailed audit trail for interchange download is created for every execution of the EDT Client The log files are named as EDTAudit log Audit trail traces the following events Table 5 Event Description Event Description EDT Sender execution started in receive m
18. X X X X R12 1 Note When re installing the client the End Point Registration EPR process can be avoided by taking a backup of the existing CERT folder British Telecommunications plc 2012 IN CONFIDENCE Page 15 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 3 2 1 Installing the software on Windows Platform X Windows Mode on UNIX Perform the following installation steps Note When installing EDT you will input values in the screenshot shown in Figure 4 illustrating the directory paths for a Windows box When installing EDT you will input values for a Unix installation which follows Unix file system naming conventions 1 Copy the MSK_SUS_EDT_Client_ lt Version gt zip file from the CD to a local drive where the version is the specific current release version supplied for this release 2 Extract the zip file in a temporary location and change to the extracted directory 3 For Windows double click on the file EDT_Windows_Installer bat or execute the following command from the directory to where the file has been copied EDT Windows Installer bat This assumes that the Windows command prompt opens at the default Windows directory rather than a user defined directory If the command prompt has been modified to open at a different location double clicking on EDT_Windows_Installer bat will not start the installation It is then necessary t
19. administrator can perform the following functions using the EDT Admin utility e Unblock senders e Add new Application and or Sender Ids e Replace ASID e Manage Certificates Unblock Senders When an interchange fails to validate the Sender for that specific Application type is blocked from further transmissions The administrator can unblock senders after the reasons for the blockage are corrected Once unblocked interchanges for that sender will be picked up in the subsequent run of the application Perform the following steps at the command prompt 1 Navigate to lt EDT APPS HOME gt BIN 2 Type in the following command and press Enter Note that Unblock command line input is case sensitive and even the parameters application type and sender ID are also case sensitive Windows runEDTClient_admin bat Unblock lt application type gt lt sender ID gt UNIX runEDTClient_admin sh Unblock lt application type gt lt sender ID gt Repeat step 2 for unblocking various senders as required Add Application References Datatypes Sender Ids You can add a new Application and Sender Ids at any time using following command provided the necessary EPR has been completed Perform following steps to add application types from the command prompt 1 Navigate to lt EDT APPS HOME gt BIN To add a new Application Reference type in the following command and press Enter Note that paramet
20. amp Logging Interface ASID Accredited System ID CDS Commissioning Data Set Dataset Also referred to as Application Type DeP14N De pseudonymisation EDT External Data Transfer EPR End Point Registration ESW End Trust Server for the Web FQDN Fully Qualified Domain Name MHMDS Mental Health Minimum Data Set NF National Feed P14N Pseudonymisation PDS Personal Demographics Service RDM Reference Data Management SDS Spine Directory Services Source ID Also referred as Sender ID SUS Secondary Uses Service XML Extensible Mark up Language British Telecommunications plc 2012 IN CONFIDENCE Page 77 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT 7 References Ref Document Number and Title Description 1 5081 Spine Glossary of Terms and Spine Glossary Abbreviations Issue 1 British Telecommunications plc 2012 IN CONFIDENCE Issue 2 01 November 2012 Page 78 of 78
21. and SUS_DATA_PDS Receive By Dataset Name This mode facilitates the user to download all the files sent for the dataset specified This mode is not supported for NF_DATA_RECON NF_DATA_POSTRECON and SUS_DATA_PDS e Receive By Dataset which are not Received This mode is similar to the Receive By Dataset Name mode except it facilitates the download of all the files for the requested dataset which are not yet downloaded For more details on this mode refer to Table 1 e Receive By File Name This mode facilitates the download of files for a particular dataset whose name is specified The name to be specified should be the original payload file name with extension This downloads all the files whose name matches with the name provided in the request Table 1 Download Modes Dataflow ID Mode 1 Mode 2 Mode 3 Mode 4 P14N Yes Yes Yes Yes DeP14N Yes Yes Yes Yes NF_MANIFEST_ RECON Yes Yes Yes Yes NF_DATA_RECON No No Yes Yes NF_MANIFEST_POSTRECON Yes Yes Yes Yes NF_DATA_POSTRECON No No Yes Yes SUS_MANIFEST_PDS Yes Yes Yes Yes SUS _DATA_PDS No No Yes Yes Where Mode 1 Download by ASID Mode 2 Download by dataset name Mode 3 Download all files by dataflow that have not been previously downloaded British Telecommunications plc 2012 IN CONFIDENCE Page 10 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 2 2 12564 MSK SUS R12 User Guide EDT
22. by the administrators of NHS end point Message Handling systems to enter the relevant certificate codes to retrieve the corresponding signed public certificate This service does not provide the capability to generate the certificate codes these are needed as inputThe signed public certificate can be returned to your browser keystore or to the screen in PKCS7 format and subsequently installed on the end point system by your system administrator Figure 20 First Screen of ESW Interface Click the link Create Web Server Certificate from PKCS 10 Second option in Figure 20 e Enter the referencelD from the EPR Process e Enter the Authorisation code from the EPR Process e Select the first option of displayed as PEM encoding of certificate in raw DER format from the options drop down box a EditPlus C EDT_APPS_HOME CERT EDT csr E lO x Z Eile Edit View Search Document Project Tools Window Help lej xj O 2il a SMX S 4 El 4 ERA wf 4 eepTDiegnostic log gt dtsfe 10 20060629 _ CDS130 xml CDS 180 xml For Help press F1 aif 20 pc REC ins READ 4 Figure 21 Content of the EDT csr Certificate British Telecommunications plc 2012 IN CONFIDENCE Page 38 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Open the EDT csr in lt EDT APPS HOME gt CERT folder and copy the content including BEGIN CERTIFICAT
23. interchange validation transmission viz validate only mode Execute the following command Windows runEDTClient bat Validate Only UNIX runEDTClient sh Validate Only British Telecommunications plc 2012 IN CONFIDENCE Page 31 of 78 01 November 2012 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 EDT Client should run and exit successfully as shown in Figure 15 cn C WINDOWS system32 cmd exe C APPS_HOME BIN gt runEDTClient bat validate_only Fri Jul 06 16 45 47 GMT 2012 EDT Sender Version 3 5 0 r British Telecommunicatio ns ple 2012 LoggingInitialiser Initialising Log4j LoggingInitialiser configureFromFile received filename log4j xml LoggingInitialiser configureFromFile Attempting to build URL to resource o n the classpath LoggingInitialiser configureFromFile Successfully built URL to resource LoggingInitialiser Loading config at URL file C APPS_HOME CONFIG 1lo0g4j xm1 LoggingInitialiser Logging initialized EDT Sender Completed Please refer the logs for more details C APPS_HOME BIN gt Figure 15 Screen Displayed on Successful Completion of Validate_Only 4 Validate a TEST interchange a Copy a CDS type TEST interchange to directory lt EDT_DATA_HOME gt INBOX CDS lt sender gt b Run the following command Windows runEDTClient bat Validate_Only UNIX runEDTClient sh Validate
24. specified Data type This mode is not allowed for NF_DATA_RECON NF_DATA_POSTRECON and SUS_DATA_PDS datasets This section provides an example of how to run it manually whenever required It functions in the same way irrespective of run mode scheduled manual and operating environment Windows UNIX British Telecommunications plc 2012 IN CONFIDENCE Page 52 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved Issue 2 12564 MSK SUS R12 User Guide EDT di Novembersat Change directory to lt EDT_APPS_HOME gt BIN and execute following command at the prompt Windows runEDTClient bat receive lt dataset name gt UNIX runEDTClient sh receive lt dataset name gt Note Parameter receive is not case sensitive Parameter lt dataset name gt is case sensitive In normal circumstances the application should exit successfully as shown in Figure 30 British Telecormmunicatio red filename log4 xml mpting to build URL to resource o FromFile config at URL Figure 30 Screen Displayed After Successful Completion of Receive By Dataset Mode The application goes through following steps in response to the above command First the application tries to authenticate the EDT Client with the Spine Authentication is retried for set number of attempts if failure occurs due to internet or other problems The application exits if authentication fails or denied by Spine The applica
25. the parseXMLFile method Error occurred while validating the XML file with its schema The dataset is not supported for transfer The schema file on the Spine server for validating the payload file could not be located The payload file to be validated is null or empty The retry count parameter for retrying transmission is less than or equal to zero The Receiver server could not be connected The block xml file could not be created IN CONFIDENCE Issue 2 01 November 2012 Possible Solution Ensure that the ASID is valid and value of authenticatorUrl is correctly set in EDTSender properties file Check any firewall is blocking the connections from client to EDT server Ensure the file being parsed is valid Ensure the XML file is valid and the schema is present to be validated against Manually remove unsupported directories from INBOX Refer to Section 4 5 3 1 to add supported datasets source IDs Ensure the schema location attribute of the interchanges is correctly set to the URL supplied by BT Ensure the payload file to be validated is correct Ensure the retry count property is properly set in the EDT Sender properties file Enter a value which is greater than zero Ensure that the value of receiverUrl is correctly set Ensure that lt EDT_APPS_HOME gt BLOCK Directory exists Page 74 of 78 NHS CFH National Spine BT Approved Error Message Unabl
26. well formed Page 75 of 78 NHS CFH National Spine BT Approved Error Message Java lang AbstractMeth odError Exception in thread main java lang AbstractMeth odError com sun xml messagin g saaj soap ver1_1 SO AP Part1_1Impl setXmlVer sion Ljava lang String V For receive mode EDT Sender execution failed EDT Services Are Disabled British Telecommunications plc 2012 IN CONFIDENCE Issue 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Possible Cause This error occurs if a JVM later than 1 5 0_14 is installed e g 1 6 0 The parameter passed for execution is wrong The parameters are case sensitive The services for EDT are temporarily stopped Possible Solution EDT Client should be configured with the JAVA 1 5 0_14 Check the parameter passed in the receive mode Ask service people to start the service IN CONFIDENCE Page 76 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 6 Glossary The glossary entries in this section are specific to this document For a full list of Spine terms and abbreviations see the Spine Glossary of Terms and Abbreviations at this intranet location http globalservices intra bt com health programmes spine tools glossary_ index htm The glossary is also displayed in Appendix A of 5081 Spine Glossary of Terms and Abbreviations Abbreviation Definition ALI Audit
27. x at the top right hand of the screen 11 In you have performed the installation on UNIX with x windows mode you will provide the execute rights for shell scripts by executing the following command chmod R 755 lt ClientInstalltionDir gt BIN In case of failure correct the problems with your access permissions and repeat the installation procedure Installation of software on UNIX in Silent Mode Copy the MSK_SUS_EDT_Client_ lt Version gt zip file that is given on the CD toa temporary location as a root user on the UNIX box Perform the following steps to install 1 Set JAVA_HOME value to J2SDK or JRE path till JRE directory as given below export JAVA_HOME lt JRE or J2SDK location till JRE directory gt Eg export JAVA_HOME usr jdk jdk1 5 0_14 jre Note The JRE should be from SUN British Telecommunications plc 2012 IN CONFIDENCE Page 25 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 2 Extract the file in temporary location unzip lt temp location gt MSK_SUS EDT Client _ lt Version gt zip 3 Go to the extracted folder 4 cd lt temp location gt MSK_SUS_EDT_Client_ lt Version gt Execute the following command to remove the M character from EDT Unix installer script dos2unix EDT Unix _Installer sh EDT Unix _Installer sh 5 Grant the execute permission for the EDT Unix installer script chmod 755 EDT Unix_Installer sh 6
28. 01 November 2012 Only files that have a generated date which is the same as or equal to the previous day will be downloaded in this mode Mode 4 Download by filename For PDS requirements EDT supports the download modes For receiving by file name the Manifest file for PDS or NF extracts should be downloaded first and then the data files should be downloaded Three Manifest files NF_MANIFEST_RECON NF_MANIFEST_POSTRECON and SUS_MANIFEST_PDS interchanges will be created by the Data Extractor component when all National Reconciliation Post Reconciliation and PDS extracts and associated control files NF_DATA_RECON NF_DATA_POSTRECON and SUS_DATA_PDS interchanges are copied into the appropriate directory and when notification is provided to EDT The three Manifest files relate to the set of extracts for either Reconciliation Post Reconciliation or PDS available for download The manifest file identifies all data files provided The Manifest file will be created in both error or success condition for PDS extracts Other applicable modes can be used in the way it was implemented in the R4 release Refer to Table 1 for the download modes The NF and PDS extracts that have data of more than 1 GB will be stored in the split files at the file store These will be downloaded and merged to create a single file which will be provided to the user in the OUTBOX folder The split file will be downloaded into a hidden temporary folder
29. Certificates to the EDT Client Load the root certificate as follows 1 Navigate to lt EDT_APPS_HOME gt BIN 2 Type in the following command and press Enter Windows runEDTClient_admin bat Import Cert lt root certificate file name with extension gt lt alias name gt UNIX runEDTClient_admin sh Import Cert lt root certificate file name with extension gt lt alias name gt Note Certificate alias names should be unique and you should make a note of them as you may need them to delete certificates upon their expiry Alias names are not case sensitive however you must make sure these names are unique Alias names can be anything e g root etc however do not reuse an existing alias as this will lead to a failure during certificate import 3 Upon successful loading of root certificate you will load all other certificates in the order of their position in the hierarchy of the certificate chain for e g SUBCA signed EDT Cert by repeating the following step for each one of them British Telecommunications plc 2012 IN CONFIDENCE Page 40 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 3 5 3 12564 MSK SUS R12 User Guide EDT 01 November 2012 Additionally the EDT certificate s alias name is edt_alias by default If you prefer a different name you can change it using the following a Modify lt EDT_APPS_HOME gt lt CONFIG gt EDTAdmin properties to set variable edt_alias t
30. DENCE BT Approved 12564 MSK SUS R12 User Guide EDT Issue 2 01 November 2012 In Validate_Only mode in case of success failure Interchange files for sender1 will remain in lt EDT_DATA_HOME gt INBOX CDS SENDER1 folder and HTML reports will be created and kept under lt EDT DATA HOME gt REPORTS CDS SEND ER1 folder In Validate_Send mode In case of success Interchange files for sender1 will be moved from lt EDT_DATA_HOME gt INBOX CDS SENDER1 folder to the lt EDT_DATA_HOME gt ARCHIVE SENT CDS SENDER1 folder and HTML reports will be EPORTS CDS SE ND ER1 folder created and kept under the lt EDT DATA HOME gt R In Validate_Send mode In case of failure Interchange files for sender1 will be moved from lt EDT_DATA_HOME gt INBOX CDS SENDER1 folder to lt 1 RECEIVE MODE lt EDT_ DATA _HOME gt REPORTS CDS SENDER1 folder EDT DATA _HOME gt ARCHIVE FAILED CDS SENDER1 folder and HTML reports will be created and kept under Figure 27 depicts how the files are downloaded to directories configured on client execution The receive mode is applicable to P14N DeP14N NF_DATA_RECON NF_DATA_POSTRECON NF_MANIFEST_RECON NF_MANIFEST_POSTRECON SUS_DATA_PDS SUS_MANIFEST_PDS interch P14N SENDER1
31. DT_DATA_HOME REPORTS Error_Report html x Eco Links Status Time Started w Type Message Figure 357 EDT Error Report Viewing Logs The EDT Client logs audit performance and diagnostic events in locally configured text files that are created under lt EDT APPS HOME gt LOGS folder These are daily rolling log files Old log files are stored with relevant date stamp extension Upload Audit Events A detailed audit trail for interchange validation transmission is created for every execution of EDT Client The log files are named as EDTAudit log The audit trail traces the following events providing time stamp Application Sender Id retry attempt number and interchange file name separated by tabs Table 4 Event Description Event Description EDT Sender execution started in validate and send mode EDT Sender execution started in validate only mode Authentication request sent Authentication successful British Telecommunications plc 2012 IN CONFIDENCE Page 69 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Event Description Authentication failed Authentication request retry attempted Interchange validation successful Interchange validation failed Invalid file not processed Sender blocked Sender is blocked from transmissions Transmission handshake request sent Transmission handshake successful Transmission handshake failed Tr
32. E and END CERTIFICATE as shown in Figure 21 without any blank spaces Paste the content in to Text area as shown in Figure 22 Click on the Submit Request button F NHS Certificate Enrollment Service Microsoft Internet Explorer Eel File Edit View Favorites Tools Help Q X A Preah frr O 2 I a JAAS ss http 10 216 248 152 59060 cda cgijcientcgi action start Eo Links Software BTHome eT Today Directory WS Windows Marketplace Google Gly yoo D EP YF Bookmarksy E 10blocked P check 4 Autolink E Autori wb Send tow Q settings NHS Certificate Enrollment Service INHS Home a Web Server PKCS 10 Certificate Request Web Bros n i E web prowser Note here you can request a certificate for a Web Server or any client that supports PKCS 10 request O web server In the fields below enter the reference number and authorization code that you received from the Certification Authority You can choose to view the computer Device or Windows Server Certificate in raw DER format or in PKCS 7 ROOT CA and SUB CA a Certficates Reference Number 56519768 ie 3 Ca eee Authorization Code J1XH E83G TOYJ Install ROOTCA cert DER format E install ROOTCA cert PEM format Options displayed as PEM encoding of certificate in raw DER E view suBca cert PEM format Please enter your certificate request PKCS 10 request in the following field If you are requesting this cert
33. FIDENCE Page 39 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Z NHS Certificate Enrollment Service Microsoft Internet Explorer DER a Fie Edit View Favorites Tools Help Ox AAA Psat frr O 2 D a ae ss http 10 216 248 152 59060 cda c cgcientcgiaction start v i gt Go Links Software BTHome BT Today Directory WS Windows Marketplace Google G yoo D EP YF Bookmarksy Bi ioblocked Yr Check 4 Autolink E Autori wb Send tow Q Settings NHS Certificate Enrollment Service Mg Home a Web Server Certificate b Bros 3 7 CJ web Browser This is your certificate in raw DER Copy the entire certificate into your clipboard including the BEGIN CERTIFICATE and END CERTIFICATE lines For O web server instructions an how to secure your server using this certificate please consult your server documentation computer Device or Windows Server BEGIN CERTIFICATE ROOT CA and SUB CA MIIDBDCCA1SgAwIBAg IEROSXVTANBgkqhki G3vOBAQUFADArMOww0g DVOQKEwNu Certficates aHMxCzAJBgNVBAsTARNBNQ4wDAYDVQQDEwVTVUJDOTAeF wOwNzA4NTNxN j NyMDZa E view ROOTCA cert PEM format Fy vOTA4MTMxNz AyMDZaMD8xDDAKBGNVBAOTA 2SoczELMAkGA1UECRNCY2ExDj AM 5 BgNVBAMTBXN1 YnNhMRIWEAYDVQODEw 1 nYXNzZXJ 2ZX1wgZ0wDOYJKOZIhvcNAQEB Install ROOTCA cert OER format BOQADGYSAMIGHAOGBALLUGAf duEi uvKdoCGAET3 8qiw j 3pmjmkRisEX8e4R5Ts EJ install ROOTCA
34. IX flavour Operating System installation should use only SUN JAVA 1 5 x To run EDT it is recommended that the host system has a minimum of memory requirement of 2GB RAM The filenames for submission via EDT are restricted to the basic 36 character set of A to Z upper and lower case 0 to 9 hyphen and underscore with period permitted for the separation of filename and suffix The following are the prerequisites of the Client System for the EDT installation Each host installation of EDT must first go through the Spine End Point Registration Process if it intends to transmit data to Spine Some providers of data to SUS may wish to operate multiple instances of the EDT Client This does not affect submission to SUS provided the instances of the EDT Client have correctly completed the EPR process and have the correct certificates Where a provider wishes to operate two instances of the EDT Client each instance of the EDT Client must be installed on a separate machine A single machine cannot host two instances of the EDT Client British Telecommunications plc 2012 IN CONFIDENCE Page 12 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 3 1 3 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Getting Started with EDT EDT Installation This section provides detailed instructions for a fresh installation of the EDT Client on a particular server EDT Client installation is as simple as running an
35. NCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 dF Installation of EDT Client Figure 9 Screen Displaying the Progress of the Client Installation 9 The screen shown in Figure 9 displays the status of the installation using progress bars Wait until the installation is complete as shown in Figure 9 Click on the Next button or press Enter to go to the next screen as shown in Figure 9 If the user clicks on Quit button at this stage the installer screen will close but the installation of the new EDT client version won t get rolled back as the installation has completed by this stage If the user wishes to uninstall the EDT client he has to follow the steps mentioned in section 3 6 British Telecommunications plc 2012 IN CONFIDENCE Page 24 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 3 2 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Installation of EDT Client lol x A y Description T Installation has completed successfully 9 An uninstaller program has been created in C APPS_HOME Uninstaller Made with IzPack Figure 10 Screen Displayed after the Client Installation Completes Successfully 10 The screen shown in Figure 10 displays a success message for the installation and the pathway for the uninstaller Click on the Done button or press Enter to complete installation task Close the window using the
36. NFIDENCE Page 41 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 The EDT Client application is now ready for use You have fulfilled all the pre requisites to be authorised for sending the file The actual authorisation will take place when a user wants to perform a file transfer 3 Proceed for configuration and installation verification 3 6 Uninstalling EDT client 3 7 1 Uninstalling EDT client on Windows 1 Go to the folder location C WINDOWS EDTinstallationFiles 2 You can find a file name EDTClientUninstall bat 3 Please take necessary back up of the config files and the certificates before you run the un installer These files folders are present in the EDT client installation directory i e APPS_HOME folder 4 Double click on the EDTClientUninstall bat file to uninstall the EDT client from your client machine 5 On successful execution of the un installer all the contents of the EDT client installation directory i e APPS_HOME will be removed If the APPS_HOME directory or APPS_HOME BIN directory in the APPS_HOME folder is still present after uninstalling it has to be deleted manually by the user The contents of the EDT client Data directory i e DATA_HOME will not be removed 3 7 2 Uninstalling EDT client on Unix 1 Go to the folder location etc EDTInstallationFiles as show in Figure 24 2 You can find a file name EDTClientUninstall sh 3 Execut
37. NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 BTE NHS CFH National Spine Mastek 12564 MSK SUS R12 User Guide EDT DEV110 SUS Release 12 BT Approved Issue 2 01 November 2012 British Telecommunications plc 2012 IN CONFIDENCE Page 1 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Copyright British Telecommunications plc 2012 Registered Office 81 Newgate Street London EC1A 7AJ Confidentiality All information in this document is provided in confidence for the sole purpose of adjudication of the document and shall not be used for any other purpose and shall not be published or disclosed wholly or in part to any other party without BT s prior permission in writing and shall be held in safe custody These obligations shall not apply to information which is published or becomes known legitimately from some source other than BT Many of the product service and company names referred to in this document are trademarks or registered trademarks They are all hereby acknowledged Distribution Spine Programme Management Services 1 Sovereign Street Leeds LS1 4BT Information Notice This document is not a contractual deliverable therefore the information provided within it is not to be relied upon and shall in no way impact the contractual requirements placed upon BT by NHS CFH und
38. Run the EDT_Unix_Installer sh shell script as follows sh EDT Unix Installer sh If you have a previous working client it will populate the apps_home and data_home directories and it will ask for either upgrade with the same paths or new paths as given in the screen shown in Figure 11 2 10 25 59 33 PUTTY Client Application Home Directory EDT 3 4 1 A ent Data Home Directory EDT_3 4 1 DATA_HOME ing Client To Use Existing APPS HOME and DATA HOME popu Client with N APPS HOME and DATA _ HOME Enter N or n Yor N J Figure 11 Message Displayed to Upgrade Existing Client Enter Y or y to upgrade with same directories or Enter N or n to install client with new directories 7 For upgrade with new paths or where an existing client does not exist execute the following steps British Telecommunications plc 2012 IN CONFIDENCE Page 26 of 78 NHS CFH National Spine IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT Issue 2 01 November 2012 Enter Client Installation Directories lt Enter your path for apps _ home here gt Press Enter Enter Client Data Path lt Enter your Data_home path here gt and press Enter The screen shown in Figure 12 is displayed with details you have entered and you will be asked if you wish to proceed exist It will be created EDT_Client_3 5 2 DATA Client Application Home Directory EDT Client 3 5 2 2 EDT Client 3 5 2 DATA_
39. S R12 User Guide EDT 01 November 2012 3 4 Installation Verification Tests On the successful installation and creation of the Interchange folders in the inbox and outbox folders the directory structure as shown in Figure 14 will be created in the respective locations and is loaded with the EDT software O APPS_HOME O BIN BLOCKED CERT O CONFIG O jret 5 0_14 us Logs O cas cps MHMDS O P14N O Uninstaller ma a te 3 ORE L ARCHIVE O INBOX O OUTBOX C REPORTS E Figure 14 Folder Structure Table 2 Folder Details Abbreviation Definition EDT_APPS_HOME BIN Contains EDT executable BLOCKED Contains blocked senders records file CERT Contains the certificate file supplied by Spine These certificates can then be uploaded in certificate store during the first installation on a particular server or using EDT Admin utility on expiry of certificates CONFIG Contains EDT Configuration files British Telecommunications plc 2012 IN CONFIDENCE Page 29 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Abbreviation Definition LIB LOGS SCHEMA EDT_DATA_HOME INBOX CDS 12345678901 2345 Example value MHMDS 123456789012345 Example value CAB 123456789012345 Example value RDM ADMIN Example value
40. S R12 User Guide EDT 01 November 2012 5 Troubleshooting 5 1 Viewing Reports EDT creates detailed validation reports for every interchange file processed under relevant data type Sender Id in Subdirectory of EDT DATA HOME REPORTS You can view the reports using Internet Explorer 5 2 Interchange Validation Reports The validation report lists all the errors corresponding to a particular Interchange file A sample report is as shown in Figure 335 A C ocuments and Settings soniat Local Settings Temporary Internet Files OLK3BF EDT_Report_v5BO Microsoft Internet Explorer File Edit View Favorites Tools Help a O RAGA Prawn Peraots O 2 Ba LASWs Address C Documents and Settings soniat Local Settings Temporary Internet Files OLK38F EDT_Report_v5B020_26_30052006114736 html gt Go Links File v5B020_26 xml Action Validate_Send Status Failed 3 error s Size 27 KB Location C EDT_DATA_HOME INBOX CDS ProviderA Time Started 30 05 2006 11 47 35 Time Completed 30 05 2006 11 47 36 Source 3 69 Schema schema_reference 4 Failed to read schema document because 1 could not find the document cos 2 the document could not be read 3 the root element of the document is not CDS i cvc complex type 2 4 a Invalid content was found starting with element ns CDSMessageBody One 13 23 Schema aoe COSBuk of http Aw
41. _HOME Made with IzPack Figure 7A Screen Displaying the Packages Being Installed 8 Click on the Next button or press Enter to go to next screen which displays a summary of the installation paths British Telecommunications plc 2012 IN CONFIDENCE Page 22 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Installation of EDT Client J Please read the following information Following are the details of the Client installation Version 3 5 2 Client installation directory C APPS_HOME Client data directory DataPath C DATA_HOME Made with IzPack Cae Figure 8 Screen Displaying Details of the Client Being Installed Note the information shown in Figure 8 Click on the Next button or press the Enter button to go to the next screen If the user click on the Quit button in any of the screens shown in the above steps until this stage then the user will get the below message as shown in Figure 7A If the user clicks on Yes button then the installation will not complete If No button is clicked then the user will be in the same screen where he clicked the Quit button Are you sure you want to quit Eq G3 This will cancel the installation Figure 7A Screen Displaying the message when the user clicks on the Quit button British Telecommunications plc 2012 IN CONFIDENCE Page 23 of 78 NHS CFH National Spine IN CONFIDE
42. _Only c EDT Client should run and exit successfully The Interchange validation report should be produced under directory lt EDT_DATA_HOME gt REPORTS CDS lt sender gt 5 Validate and Transmit and a TEST interchange a Copy a CDS type TEST interchange to the lt EDT_DATA_HOME gt INBOX CDS lt sender gt directory b Run the following command Windows runEDTClient bat Validate_Send British Telecommunications plc 2012 IN CONFIDENCE Page 32 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 3 5 3 5 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 UNIX runEDTClient sh Validate_Send c EDT Client should run and exit successfully Interchange validation report should be produced under directory lt EDT_DATA_HOME gt REPORTS CDS lt sender gt If the interchange validation was successful it should be transmitted to Spine Refer to the audit log file lt EDT_APPS_HOME gt LOGS EDTAudit log to get the complete trail of transmission Note that Spine does not process TEST interchanges further An interchange has to pass validation to be transmitted to Spine Authorisation and Authentication This section outlines the steps to be performed for the End Point registration Note For issues or instances of failure while configuring the EDT client or performing any of these steps Restart the configuration Section 3 2 1 End Point Registration After successful EDT Client in
43. ansmission handshake request retry attempted Transmission request sent Transmission successful Transmission failed Transmission request retry attempted EDT Sender executed successfully EDT Sender execution failed The audit log will be as shown in Figure 368 British Telecommunications plc 2012 IN CONFIDENCE Page 70 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 a EditPlus C EDT_APPS_HOME LOGS EDTAudit log l x File Edit Yiew Search Document Project Tools Window Help 18 x JGS 0G BSYU t exloo 9 2 0 4M 24 Fala 92 LLI DETAIL Application Type MHMDS Authentication request sent 93 LLIDETAIL Application Type MHMDS Authentication failed LL DETAIL Application Type MHMDS Retry Attempt No l Authentication request retry attempted LL DETAIL Application Type MIDS Authentication request sent LL DETAIL Application Type MHDS Authentication failed LL DETAIL Application Type MHMDS Authentication failed LL DETAIL EDT Sender execution failed 2 LL DETAIL Application Type MHDS Authentication request sent 3 LL DETAIL Application Type MHMDS Authentication successful LL DETAIL Application Type MHMDS Sender senderC File MHMDS 132058 26062006 5 interchanges xml Interchange validation successful 05 LL DETAIL Application Type MHMDS Transmission handshake request sent 5 LL DETAIL Application Type MHMDS Transmission handshake successful
44. cert PEM format Sjllo MsSdv6 4x3VCQqVON DhY 7eMudg3xz12w05 INOKvInfqG z 7dso 3CzJhbg BloWpToosgd ylinu vFUWKOR 7A Purr vTKiFrskiiLxNC1Ziv 1BiDWNaSPAGED EJ view suBcA cert PEM format 04 TECDCCAQQwCwYDVROPBAQDAgWgNCsGA1 UdEAQKMCKADz IwMDowODEZNTY2MjA2 5 install SUBCA cert DER format oRPHj AvOTAANTHxttz AyMDZaMBMGA1 UdJ QOMMAGGOCSGAQUEBwMBMEOGAUdHYRS MEQuQqBAOD6kPDAGMOwwCgYDVQQKEwNualiMxCzAJBGNVBAsTAKNBMQ4wDAYDVQQD Install SUBCA cert PEM format EwVTVUJDQTENMASGA1UEAxMEQi JMMTAf BgNVHSMEGDAVGBTafEZ6c3 bf 8T755ISR KSuVad hkj AdBGNVHO4EF QU 4 paYMOEyvaf sxi TUjr dxo kpowCQYDVROTBAIy ADAZBgkqhkiG9n OHOQAEDDAKGwRUNy 4xAwIDqDANBgkqhkiG9wOBAQUFAAOCAQEA 5 EE DFY2r qgl6sth icQljgvUJNpfRtpfRbHg8 IC B5a8f Doaxa2qxd t vEbKK705AK1 zsskMoHaLHSnSijqjZrv Qdlm1FZ8cxU 60Ga p50nVJax QVo FqkKRu30nSYLZ Q 409X571 3sG OHXLGLtni gel BPqaUpanqi GCOShH3w 104 05QKIBxcTNETZTDL6a N10YKeGqr JzhMAxeNHR4 f baV4g cMielr84EBVdL AeLg3hMvwGl 2VsHINyfu hMzqG 7wSK21MaBmYMLkyAjqE2Ej 8yMf 32588nd29ho7mH110CDjgLxVdoPSRTAC SSL TLS Technical Support SSL ILS Technical support pC100ux0f ShzrmSd50HRMw user cuide Bl 8 END CERTIFICATE Q About You may select the Download option and the certificate will be saved to disk x El Dore SS Local intranet 2 Micro TextPad E 7445 20 3 Inte os 972 16 fm Lsfiles FQT En Ou Figure 23 Screen Displayed After Creation of the Signed EDT Certificate 3 5 2 5 Importing
45. d to run in batch mode mechanisms for detecting failures and providing alerts to the administrators may be required EDT provides the following information for all failure types You can use this to create your own administration tools 1 runEDTClient bat returns 0 zero in case of successful execution any other value means a failure Make your scheduler send an application failure alert in case return status is a non zero value 2 Upon interchange validation failure the failed interchange is moved to lt EDT DATA HOME gt ARCHIVE FAILED folder You can poll this directory periodically to raise interchange validation failure alerts 3 The diagnostic log file contains every error You can search for pattern ERROR in this file The existence of this pattern means that there is a failure This can particularly be useful to detect transmission failures especially as neither options 1 or 2 above can provide this information Once a failure is detected the exact nature of problem can be determined using e Interchange validation reports Refer section 5 2 e EDT Error reports Refer section 5 2 1 e Diagnostic log Refer section 5 3 4 e Audit log Refer section 5 3 1 British Telecommunications plc 2012 IN CONFIDENCE Page 57 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 5 2 4 5 3 4 5 3 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 EDT Admin Utility The
46. e the following command to remove the M character from EDT Unix _ installer script dos2unix EDTClientUninstall sh EDTClientUninstall sh 4 Run the below command so change the permission of the file chmod 755 EDTClientUninstall sh 5 Please take necessary back up of the config files and the certificates before you run the un installer These files folders are present in the EDT client installation directory i e APPS_HOME folder 6 Run the EDTClientUninstall sh file as shown in Figure 24 to uninstall the EDT client from your client machine Please find the screen shot in Figure 24 British Telecommunications plc 2012 IN CONFIDENCE Page 42 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 25 59 33 PUTTY stallationFiles ion txt 5 ED 1lentUnin EDTClientUninstall sh EDTClient installation directory EDT Client _3 5 2 APPS HOME y backup config files certificates be e Installer cont o continue with uninstall y n n Figure 25 Screen shot of the step to uninstall in Unix 7 If you key in n then the un installation will not proceed ahead If you key in y the un installer will un install the EDT client on your machine 8 On successful execution of the un installer all the contents of the EDT client installation directory i e APPS_HOME will be removed If the APPS_HOME directory or APPS_HOME BIN directory in the APPS_HOME
47. e to create a SOAP Message Unable to find the payload schema file on the client Unable to retrieve the schema version and location Unable to send interchange User should pass only one parameter for uploading data Validate_Only or Validate_ Send For download mode it can be three at the most XML document structures must start and end within the same entity British Telecommunications plc 2012 IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT Possible Cause The Spine authenticator server is down or the certificates are invalid or expired The schema file for validating the payload file could not be located on the client The schema on the Spine server is not accessible The file s could not be transferred to the server location Incorrect arguments have been sent with the runEDTClient batch file The interchange failed XML parser s sanity checks IN CONFIDENCE Issue 2 01 November 2012 Possible Solution Contact BT Help Desk Ensure the schema is present in the specified path in the client under lt EDT APPS HOME gt SCHEMA Ensure that the schemaLocation attribute of interchange is correctly set to the complete URL supplied by BT This is a generic error which occurs when file transmission fails See the logs for more details Ensure valid arguments are passed while executing the client batch file Ensure that the XML interchange is
48. ed as follows lt EDT_ DATA HOME gt OUTBOX lt Dataset Name gt SENDER folder Validate amp Send With the Validate amp Send option EDT validates and transmits Interchanges from the Client environment to the SUS environment Validation success failure reports are placed under the relevant Application Sender Id folders of lt EDT_DATA_HOME gt REPORTS directory This option should usually be scheduled to run at the required frequency This section provides an example of how to run it manually whenever required It functions in the same way irrespective of run mode scheduled manual and operating environment Windows UNIX Change directory to lt EDT_APPS_HOME gt BIN and execute following command at the prompt Windows runEDTClient bat Validate Send UNIX runEDTClient sh Validate Send Note Parameter Validate_Send is not case sensitive In normal circumstances the application should exit successfully as shown in Figure 28 British Telecommunications plc 2012 IN CONFIDENCE Page 48 of 78 NHS CFH National Spine IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT 01 November 2012 BT Approved cn C WINDOWS system32 cmd exe C APPS_HOME BIN gt runEDTClient bat validate_send Fri Jul 06 16 52 11 GMT 2012 EDT Sender Version 3 5 0 r British Telecommunicatio ns ple 2012 LoggingInitialiser Initialising Log4j LoggingInitialiser configureFromFile received filename log4j xml
49. ed using various events logged in daily rolling diagnostic log files EDTDiagnostic log Diagnostic events fall under the following categories depending upon their severity FATAL being the most severe British Telecommunications plc 2012 IN CONFIDENCE Page 72 of 78 Issue 2 NHS CFH National Spine BT Approved Error FATAL WARN DEBUG ERROR INFO IN CONFIDENCE Issue 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Table 6 Error Description Description The FATAL level designates very severe error events that will presumably lead the application to abort The WARN level designates potentially harmful situations The DEBUG Level designates fine grained informational events that are most useful to debug an application The ERROR level designates error events that might still allow the application to continue running The INFO level designates informational messages that highlight the progress of the application at coarse grained level INFO and DEBUG level events provide extensive detail particularly useful for application support By default EDT Client is configured to log FATAL ERROR WARN events only This logging level can easily be lowered to provide more information if required Refer to Section 4 5 4 for more details Table 7 attempts to provide guidance for some known issues Contact the help desk for more help Email bt sus helpdesk bt com Phone 08456002558 The error message is as
50. equire any connection to the Spine environment 2 Validate and Send This mode facilitates the user to validate its interchanges and transfer all those if validation is successful In this mode EDT authenticates the host with the Spine system The interchanges are then validated against the centrally held version of the schema on EDT server and where valid the interchange is transmitted to the Spine environment and a confirmation is generated and stored locally If the interchange fails validation against the schema an HTML validation report is created and stored in a pre configured directory 3 Receive This mode facilitates the user to download the NF files viz dataflows NF_DATA_RECON NF_DATA_POSTRECON NF_MANIFEST_RECON NF_MANIFEST_POSTRECON PDS files SUS_DATA_PDS SUS_MANIFEST_PDS and AP14N P14N and DeP14N files from the server EDT first authenticates the host with the Spine system EDT then sends a request to British Telecommunications plc 2012 IN CONFIDENCE Page 9 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 the server for the files it can receive After the list is received it downloads the files one by one to the OUTBOX of the client There are 4 sub modes for receive Receive By ASID In this mode the client downloads all the files it has sent for P14N and DeP14N This mode is not supported for NF_DATA_RECON NF_DATA_POSTRECON
51. er application type is case sensitive Windows British Telecommunications plc 2012 IN CONFIDENCE Page 58 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 5 3 2 4 5 3 3 12564 MSK SUS R12 User Guide EDT 01 November 2012 runEDTClient_admin bat Add Dataset lt application type gt UNIX runEDTClient_admin sh Add Dataset lt application type gt Repeat step 2 to add more application types as required To add a new Sender Id for an existing dataset follow 1 and type Windows runEDTClient_admin bat Add Provider lt application type gt lt Source ID gt UNIX runEDTClient_admin sh Add Provider lt application type gt lt Source ID gt Replace ASID If you are supplied with a new Accredited System ID you can replace the existing ID using the following command For UNIX you need to login as user with root privileges 1 Navigate to lt EDT_APPS_HOME gt BIN 2 Type in the following command and press Enter Windows runEDTClient_admin bat Encrypt Asid lt new ASID gt UNIX runEDTClient_admin sh Encrypt Asid lt new ASID gt Manage Certificates The application of EDTAdmin in registering the EDT client as an end point is detailed in Sections 3 5 1 An EPR form has to be submitted for requesting a renewal revoke to the Spine EPR team You must have the Certificate Serial Number to renew or revoke a certificate The use of EDTAdmin utility to ascertain Certificate Se
52. er the NASP Project Agreement This information is being shared on an as is basis for information only to facilitate closer co operation between the parties The information provided shall in no way be construed as BT providing representations guarantees assurances or making any other contractual commitment to NHS CFH It shall not be published or disclosed wholly or in part to any other party without BT s prior permission in writing and shall be held in safe custody British Telecommunications plc 2012 IN CONFIDENCE Page 2 of 78 NHS CFH National Spine BT Approved Document Control Document Information IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT Title 12564 MSK SUS R12 User Guide EDT Filename 12564 MSK SUS R12 User Guide EDT Issue 2 Author Name Role Mastek Dev Partner Sign Off by Approvers Name Role Susie Day DPM Reviewers Individual Role Susie Day DPM Roy Taylor Sub system Architect Sheona Brookes Quality Document Change Log Issue Date Author Editor Issue 1 Draft A 08 08 2012 Rajiv K lyer Issue 1 Draft B 24 08 2012 Rajiv K lyer Issue 1 30 08 2012 Umesh Dandy Issue 1 5th Sept 2012 Sarah Bateson Issue 2 Draft A 11 09 2012 Rajiv K lyer Issue 2 Draft B 08 10 2012 Rajiv K lyer Issue 2 Draft C 10 10 2012 Rajiv K lyer Issue 2 Draft D 22 10 2012 Rajiv K lyer Issue 2 29 10 2012 Umesh Dandy Issue 2 01 11 12 A MacLeod British Telecommunications plc 2012 IN CONFIDENCE Issue 2 01 No
53. executable and providing some inputs on user friendly screens The installation creates the required directories and installs the software To be able to launch the installer ensure that the specified SUN JAVA Runtime Environment version is already installed on the target server The installer provides for installation of Java 1 5 0_14 on Windows OS only which is required for running the client For any UNIX flavour Operating systems SUN Java 1 5 0_14 only should be used Log on as a user with administration rights on Windows platform or root permissions on UNIX platforms Note EDT Client installation does not write anything to Windows registry Additionally only one installation can exist on a server The release CD comes with directories specific to Windows and UNIX environments You must copy the contents of relevant directory to the target server and go through section 3 2 to complete the installation Installation EDT Client installation consists of four major steps 1 Install software Section 3 2 2 End Point Registration Section 3 5 1 3 Certificate Signing and Importing Signed Reply Section 3 5 2 4 Load ASID acquired from Spine Section 3 5 3 Note 1 Steps 2 3 and 4 may be omitted if the installation is to be used for Validate_Only mode The EDT Client is available in the following versions British Telecommunications plc 2012 IN CONFIDENCE Page 13 of 78 NHS CFH National Spine IN CONFIDENCE Issue
54. f the certificate has expired Steps to Check Certificate Expiry Date 1 Navigate to your EDT clients apps_home Cert directory Your certificate should be visible here Please refer Figure 33 British Telecommunications plc 2012 IN CONFIDENCE Page 62 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 File gdt View Favorites Tools Help der jer al Security Certificate iType Security Certificate Date Modified 11 08 2008 10 11 Size 923 bytes 23 bytes 3 My Computer Figure 33 Please find the CERT folder with the certificate 2 You should have a rootca der subca der and then your EDT signed certificate which you would have named when you downloaded it If you cannot find it here then run a search of your drive to find all der files 3 Double click on the EDT signed certificate to open it and you will see the valid to and from date as shown in Figure 34 British Telecommunications plc 2012 IN CONFIDENCE Page 63 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Certificate x General Details Certification Path Certificate Information Windows does not have enough information to verify this certificate Issued to edt gp yee nhs uk Issued by NHS Level 14 alid from 21 02 2007 to 21 02 2012 Issuer Statement Figure 34 The va
55. folder is still present after uninstalling it has to be deleted manually by the user The contents of the EDT client Data directory i e DATA_HOME will not be removed 3 7 Logging In Not applicable 3 8 Navigating Through EDT Not applicable 3 9 Logging Out Not applicable British Telecommunications plc 2012 IN CONFIDENCE Page 43 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 British Telecommunications plc 2012 IN CONFIDENCE Page 44 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 1 4 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Application Functionality Once EDT installation is complete local testing of EDT can be completed using the Validate only functionality Full details of how to operate Validate only is described in Section 4 4 2 of this document This enables all aspects of the installation to be utilised except the connection to Spine Once local testing using Validate Only has been completed there are a number of steps which should have been followed before live implementation and these are described in Section 3 2 of this document Note Instructions to execute runEDT Client runEDTClient_admin must be preceded by navigation to lt EDT_ APPS HOME gt BIN on the command line View an Alert s Details Not Applicable Business Process To enable a smooth implementatio
56. have access to the system and are familiar with previous releases of the application British Telecommunications plc 2012 IN CONFIDENCE Page 7 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 1 4 Related Documents Not applicable 1 5 Typographic Conventions 1 5 1 User Input System Output and File Names Prompts and user input are shown in a fixed width bold font for example uname a System output and file and directory names are shown in a fixed width font for example Copy the update script updateTheWidget sh to the etc install directory Variable placeholders are shown in italics surrounded by angle brackets for example mv home lt example gt filename sh etc lt example gt filename sh where lt example gt is the part to be replaced with actual data Actual text from files such as a section of a configuration file is shown in a fixed width font inside a box FOLLOWING VARIABLES SPECIFY APPS SERVER 8 1 RESOURCES Parameters for configuration of Generic Resource Adaptor This same configuration is used on any TMS workstream Apps Server instance that the Generic RA is deployed to TMS AS JMS _USER admin TMS AS JMS PASSWORD admin MS AS LDAP HOST dirintrep sds MS AS LDAP_SVRPORT 389 TMS AS LDAP FQDN ou etpsunmq dc cellll1 dc dev dc nhs dc uk TMS_AS LDAP ROOTDN cn Directory Manager
57. ide E vista Help M edb g ana D about Version 7 0 SP1 ii BT E E Done L i i B trusted sites Figure 18 Dialog Box Displayed to Save the SubCA Certificate 3 5 2 4 Downloading the EDT Signed Certificate 1 Navigate to lt EDT_APPS_HOME gt BIN 2 Type the following command and press Enter Windows runEDTClient_admin bat Request_Cert UNIX runEDTClient_admin sh Request _Cert Upon successful completion the certificate request file EDT csr should be placed in the lt EDT_APPS_HOME gt CERT folder as shown in Figure 19 British Telecommunications plc 2012 IN CONFIDENCE Page 36 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 File Edit View Favorites Tools Help Q O O search E Folders E gt Address C EDT_APPS_HOME CERT Folders E Desktop My Network Documents I My Computer FL108814D E AA 3 Floppy A SYSTEM C ctib Compaq Config Msi Documents and Settings EDT_APPS_HOME BN BLOCKED CERT conic Figure 19 EDT csr Certificate Request File The following steps are a onetime activity and any mistakes in their execution will lead to certificate failure If failure occurs you will need to follow the EPR Process again to request new Certificates as explained in section 3 5 1 Go to the ESW Inte
58. ificate for a Web Server make sure that your BJ Install SUBCA cert DER format Common Name CN matches the reference number of the certificate being retrieved when generating the request If you do not know how to generate this request please consult your server documentation J install SUBCA cert PEM format MIIBUDCBugIBADATMRE wD wYDVQODEwg Nj Ux0Te2 ODCBnTANBgkqhkiG9wOBAQEF Pal AAOBiwAugYcCgYEAStROB92 45Lv 68p2g1 YAROP yqLD 6PemaQaRGKwR x7hH1LOxK NSj8yxd2 rjHAYICpY43 40F j t4y4Cr3HPXPBDnU1Bes id ob7Pt2y3 cLMmF ual ihalNyiyonJae7 AVRaTRGPsAg utSO9Nq I UuyQcvEOKVmLD UGINY rmkCAQOg SSL TLS Technical Support ADANBgkqhkiG9wOBAQOF AAOBgQB793 kCmA7kOgrrefLsZjBILCHp Xh4R3hagQyb V9ESLiLwzGzb9EmOObPt 6xCJaHIsWvM iVi f XZpNCt900 JBEOugGS8YwKalnod user Guide 2NIjq4HuF FDOdo1DLT78taSYLfu bRPkcbyVq3 WGNTnbbBqL REeXw7DGkFo6gpo About 3jbptg a 9 Local intranet 2 micro TextPad E 7445 20 op 172 16 fm Ls files EW FQT En 4orce Figure 22 Screen to Create Web Server Certificate from PKCS 10 3 You will be now be given the Signed EDT Certificate Select the download option as shown in Figure 23 and save the file to lt EDT APPS HOME gt CERT in der extension with any name 4 Make sure that this certificate is not saved in txt or any text editor specific extension You can give any name for this certificate e g EDT der British Telecommunications plc 2012 IN CON
59. iles SUS_DATA_PDS control file and data file SUS_MANIFEST_PDS mf files For Installation Re installation of EDT Client note the following If you are installing the EDT client for the first time installation of the full EDT Client Version 3 X X is recommended British Telecommunications plc 2012 IN CONFIDENCE Page 14 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 e To be able to send files for CDS V5 0 MHMDS3 2 MHMDS 3 3 interchanges you need to install 3 0 5 version of the client e If you have EDT client Version 2 X X installed before 1 November 2007 it is recommended that you upgrade the client to Version 3 X X or alternatively you can uninstall the older version and re install the full latest version e If you have EDT client Version 2 X X installed after 1 November 2007 it is recommended that you uninstall the client and re install the latest Version 3 X X e f you have any EDT client of older Version of 3 X X it is advisable to upgrade it to the latest version This will allow additional functionalities to be added Please find below the summary of the recommended version and the supported version EDT Supporte CD CD CD CD PDS MHMD CA RD P14 Nation Versio d S S S S Extra S 3 4 B M n al n 6 0 6 1 6 1 6 2 ct Feed 1 Recon amp Post Recon 3 2 X Inbound X X X X X X R4 3 4 x Outbound X X X X X X X X R6 3 5 x Inbound X X X X
60. j ngInitiali configure cec red filename log4j ngInitiali i mpting to build URL to resource o ath FromFile Suc ully built URL to config at URL file EDT Clien ogs for more d tails Figure 322 Screen Displayed After the Successful Completion of Receive Not_Received Mode The application goes through following steps in response to above command First the application tries to authenticate the EDT Client with the Spine Authentication is retried for set number of attempts if failure occurs due to internet or other problems The application exits if authentication fails or is denied by Spine British Telecommunications plc 2012 IN CONFIDENCE Page 56 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 5 4 5 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 The application then performs a handshaking operation If the handshaking operation is successful all of the interchanges for the specified data type which have never been received are downloaded to client sequentially Transmissions are retried for set number of attempts if failure occurs due to internet or other problems If all the retry attempts are exhausted this and all subsequent interchanges are ignored Note that interchanges are successfully downloaded to the lt EDT_DATA_HOME gt OUTBOX lt Dataset Name gt lt Sender Id gt directory Administration Automated Tracking As the EDT Client is schedule
61. lid from and to date of the certificate is displayed 4 6 2 Steps to renew certificate Method 1 Remove the keystore and install new certificate to be used if Aliases unknown In your install directory there will be a directory called EDTInstallationFiles C WINDOWSI EDTInstallationFiles windows OS or etc EDTInstallationFiles unix OS Rename or delete the following 3 files EDTVersion txt EDT keystore Edt ifo British Telecommunications plc 2012 IN CONFIDENCE Page 64 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Start new certificate renewal process using the EDT user guide Just follow steps described in this guide starting from Section 3 5 1 End Point Registration upto Section 3 5 3 Load ASID Please note all section should be performed and in the right order Method 2 If you know the Alias used when the Certificate were previously installed Do not remove the expired certificate Start new certificate renewal process using the EDT user guide Just follow steps described in this guide starting from Section 3 5 1 End Point Registration upto Section 3 5 3 Load ASID Please note all sections between should be performed and in the right order Be sure to use the same Aliases as used in the original install British Telecommunications plc 2012 IN CONFIDENCE Page 65 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SU
62. logged in the diagnostic log file The list is alphabetically sorted on the Error Message column Table 7 Troubleshooting Error Message Possible Cause Possible Solution ASID passed is empty The EDT Client Refer to Section 3 5 3 to load installation is incomplete the ASID ASID is not loaded AUTH_RETRY_LIMIT The retry count parameter Ensure that the retry count should be greater than for retrying authentication property is properly set in the zero is less than or equal to EDT Sender properties file zero Enter a value which is greater than zero British Telecommunications plc 2012 IN CONFIDENCE Page 73 of 78 NHS CFH National Spine BT Approved Error Message Authentication failed Error occurred while parsing the XML file Error occurred while validating the XML file Invalid dataset name in INBOX folder x Payload schema file on the server could not be located Payload with file size zero SEND_RETRY_LIMIT should be greater than zero Unable to connect to the Receiver server Unable to create a blocked file British Telecommunications plc 2012 IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT Possible Cause The Sender could not be authenticated as an accredited system This can be due to unable to contact the EDT Server because of any firewall blocking or mutual authentication failure An error occurred while parsing the XML file in either the createBlockFile method or
63. n of new Interchanges any operator of EDT must first transfer a Test Interchange for each Application to the SUS environment A Test Interchange is processed by EDT in exactly the same manner as a Live Interchange but on arrival in the SUS environment the Interchange is not processed by the live system The receipt of a Test Interchange in the SUS environment alerts the SUS Message Management Team SMMT that the end user is trying to send through a test message SMMT then performs a number of further checks on the Interchange before contacting the sender by telephone or via an alternative medium to confirm that the Interchange is successful or has failed At this point the Sender can notify SMMT that they are ready to transfer live Interchanges and can specify the start date In addition to any verbal agreement SMMT requires a formal notification by email of the first date on which SUS is required to accept live Interchanges for an Application Any data received before the specified date is rejected and requires re sending The sequence in which data is processed into the SUS data warehouse is significant for many business processes such as submission of CDS interchanges Out of sequence data will compromise the quality of data held in SUS Where a provider of data to SUS British Telecommunications plc 2012 IN CONFIDENCE Page 45 of 78 NHS CFH National Spine BT Approved 4 3 4 4 IN CONFIDENCE 12564 MSK SUS R12 User Guide
64. ne BT Approved 12564 MSK SUS R12 User Guide EDT Abbreviation DeP14N 123456789012345 Example value P14N 123456789012345 Example value ARCHIVE REPORTS Run the following tests to ensure that the installation is functional to the degree specified IN CONFIDENCE Definition DeP14N Dataset which contains all DeP14N SenderID values This folder will be under DeP14N Value is SUSInterchangeSenderldentity tag value in the control file or Sender Identity with which you are registered for SUS DeP14N Dataset which contains all DeP14N SenderID values This folder will be under P14N Value is SUSInterchangeSenderldentity tag value in the control file or Sender Identity with which you are registered for SUS EDT archives processed interchanges under relevant subdirectories as follows FAILED Failed interchanges are moved here This contains further subdirectories to hold interchanges for specific Applications and Sender Ids SENT Successful interchanges are moved here This contains further subdirectories to hold interchanges for specific Applications and Sender Ids Contains interchange validation reports This contains further subdirectories to hold interchanges for specific Applications and Sender lds Refer section 5 3 in instances of failures 1 UNIX platform only Log on as the EDT user to perform these tests 2 Change directory to lt EDT_APPS_HOME gt BIN 3 Dry run without any
65. o navigate to the directory to where this has been copied and execute the bat file from there instead using the command prompt For X Windows mode on UNIX you need to set the JAVA_HOME value as follows export JAVA_HOME lt JRE or J2SDK location till JRE directory gt Example export JAVA_HOME usr jdk jdk1 5 0_14 jre NOTE The JRE should be from SUN To start the installation execute the following command from the directory where you have copied it to chmod 754 edt client installable lt Version gt jar chmod 754 EDT Unix Installer sh EDT Unix Installer sh Launching the installation file displays the screen shown in Figure 1 with EDT Client lt Version gt for the version that you are currently installing British Telecommunications plc 2012 IN CONFIDENCE Page 16 of 78 NHS CFH National Spine BT Approved IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT Installation of EDT Client Figure 1 First Screen during EDT Client Installation 4 Click onthe Next The next screen as shown in Figure 2 displays buttons Previous Pressing the Quit button or press the Enter button displayed on the screen Issue 2 01 November 2012 Next and Quit button will stop installation British Telecommunications plc 2012 IN CONFIDENCE Page 17 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT App
66. o has links to download the Root CA and Sub CA and Signed EDT certificate s Save these to the EDT_APPS_HOME gt CERT folder 3 5 2 1 Downloading Certificates from ESW Interface To access ESW browse to the following URL This is the URL to import DIGITAL Certificates to create a secure environment for mutual authentication The URL to access the Live ESW interface is hitps esw national ncrs nhs uk cda cgi clientcgi action start 3 5 2 2 Downloading the RootCA Certificate Click on the Link Install Root Certificate on the left hand side menu and you will be asked to save the certificate Save it in the EDT APPS HOME gt CERT folder with der extension only as shown in Figure 17 Save the file with the default name rootca der British Telecommunications plc 2012 IN CONFIDENCE Page 34 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 ertificate Enrollme osoft Inte OC Operations 055 Tea i Boe File Edit View Favorites Tools Help Ax Q O h 2 Alp rns O M LA Address https esw national ners nhs ukjeda caj cientegtaction start z gc Links gt NHS Certificate Enrollment Service File Download Security Warning Do you want to open or save this file Name rootca der Type Security Certificate 1019 bytes From esw national ncrs nhs uk on While files from
67. o replace following line lt level value DEBUG gt With British Telecommunications plc 2012 IN CONFIDENCE Page 61 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 5 5 4 5 6 4 6 4 6 1 12564 MSK SUS R12 User Guide EDT 01 November 2012 lt level value WARN gt Refer to Section 5 3 4 for more details on logging levels Archiving It is the administrator s responsibility to set up the necessary procedures to archive processed interchanges validation reports and audit performance diagnostic logs Future Upgrades A software package would be made available from HSCIC as a URL which would contain the upgraded software and instructions on how to apply the upgrade The sender is required to download the software package and install the upgrade Keystore and Certificate Issues EDT keystore in EDTInstallationFiles folder should not be changed as this is generated while importing certificates EDTVersion txt should not be changed as it contains keystore passwords in an encrypted format No Certificates should be imported in this keystore with same aliases and new client certificate without expiry EDT keystore is specific to machine and certificates chain It cannot be used on any other machine except on the machine it is installed on Please find below the steps that one needs to perform to check if the existing certificate has expired and the steps that need to be performed i
68. o the desired value b Type the following command and press Enter Windows runEDTClient_admin bat Import Cert lt other certificate file name gt lt alias name gt UNIX runEDTClient_admin sh Import Cert lt other certificate file name gt lt alias name gt Load ASID You will receive the ASID number from Spine as part of End point Registration Process Refer section 3 5 1 for details Once you have the ASID load it as follows so that the EDT Client can use it to connect to Spine 1 Navigate to lt EDT_APPS_HOME gt BIN 2 Type the following command and press Enter Windows runEDTClient_admin bat Encrypt Asid lt your ASID gt UNIX runEDTClient_admin sh Encrypt Asid lt your ASID gt c C WINNT system32 cmd_exe 3 C NEDT_APPS_HOMENBIN gt runEDTClient_admin bat Encrypt_Asid 87456709 LoggingInitialiser Initialising Log4j LoggingInitialiser conf igureFromFile gt received filename log4j xml LoggingInitialiser conf igureFromFile lt Attempting to build URL to resource o n the classpath LoggingInitialiser conf igureFromFile gt Successfully built URL to resource LoggingInitialiser Loading config at URL file C EDT_APPS_HOME CONFIG log4j xml LoggingInitialiser Logging initialized ASID registered successfully C NEDT_APPS_HOMENBI N gt m Figure 24 Screen Displayed On the Successful Registration of ASID British Telecommunications plc 2012 IN CO
69. ode Authentication request sent Authentication successful Authentication failed Authentication request retry attempted Transmission handshake request sent Transmission handshake successful Transmission handshake failed Transmission handshake request retry attempted Transmission request sent British Telecommunications plc 2012 IN CONFIDENCE Page 71 of 78 NHS CFH National Spine IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT 01 November 2012 BT Approved 5 3 3 5 3 4 Event Description Transmission successful Transmission failed Transmission request retry attempted EDT Sender executed successfully EDT Sender execution failed EDT Sender execution started in receive mode Authentication request sent Authentication successful Authentication failed Authentication request retry attempted Transmission handshake request sent EDT Services Are Disabled Performance Logs Every authentication and interchange transmission request is tracked for commencement and termination The performance log file EDTPerformance log contains start and end time stamps for every single request The performance problems can easily be tracked on the basis of these details The time required for every interchange file validation can also be logged Refer to Section 4 5 4 to raise the level of performance logging so that these times are logged as well Diagnostic Logs The reasons for EDT Client application failures can be easily trac
70. onal ncrs nhs ukjcda cqifclientcgi action start B Go Links NHS Certificate Enrollment Service INHS Close Kn Home Certificate Retrieval Fle Doiie ty Warne E Fie Download security warning E web Browser Web Server Do you want to open or save this file Computer Device or Windows Server Name rootca der Type Security Certificate 1019 bytes From esw national ncrs nhs uk ROOT CA and SUB CA Certficates EJ View ROOTCA cert PEM format 2 Install ROOTCA cert DER format 2 Install ROOTCA cert PEM format View SUBCA cert PEM format Z install SUBCA cert DER format While files from the Intemet can be useful this file type can J install SUBCA cert PEM format potentially harm your computer If you do not trust the source do not asi open or save this software What s the risk cate signing request Tasks This service is typically used by the administrators of NHS end h Certificate Policy Opens in a New S point Message Handling systems to enter the relevant Window j certificate codes to retrieve the corresponding signed public certificate This service does not provide the capability to Help generate the certificate codes these are needed as inputThe signed public certificate can be returned to your browser a SSL TLS Technical Support Opens in a keystore or to the screen in PKCS7 format and subsequently New Window installed on the end point system by your system qi F administrator D user Gu
71. own below Edit 1og4j xm1 to replace following line lt appender ref ref PerfAppender gt With lt appender ref ref PerfAppender gt British Telecommunications plc 2012 IN CONFIDENCE Page 60 of 78 Issue 2 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 5 4 2 12564 MSK SUS R12 User Guide EDT 01 November 2012 Change Level Interchange validation times are not logged by default You can raise the logging level to log them Edit 1og4j xm1 to replace following line lt level value PerfMin class com syntegra nhs nasp rts logging PerformanceLevel gt With lt level value PerfMax class com syntegra nhs nasp rts logging PerformanceLevel gt You can switch it back to the lower level by reversing this action as shown below Edit 1og4j xm1 to replace following line lt level value PerfMax class com syntegra nhs nasp rts logging PerformanceLevel gt With lt level value PerfMin class com syntegra nhs nasp rts logging PerformanceLevel gt For description of the various logging levels refer to Section 5 3 4 Diagnostic Logging Change Level You can raise the level of diagnostic information logged to trace a problem Edit 1og4j xm1 to replace following line lt level value WARN gt With lt level value DEBUG gt You can switch it back to the lower level by reversing this action as shown below Edit 1og4j xm1 t
72. rchanges are read from archived to and the location where reports are generated Note The directory for your installation is EDT _DATA_HOM E This value is configured in EDT Sender properties file in lt EDT_APPS_ HOM E gt config folder 7 Click on the Next button or press Enter and you will get a prompt to states that the target directory be created as shown in Figure 6A If the user clicks on OK button of Figure 6A then the user is directed to the next screen which The following screen displays information regarding e Folders to be created for EDT Client e Size required by each folder e Total size required for EDT Client e Total available space British Telecommunications plc 2012 IN CONFIDENCE is Figure 6 Page 21 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Installation of EDT Client Z Select the packs you want to install 9 Note greyed out packs are required v APPS_HOME DATA_HOME CLIENT_INSTALLATION JRE TEMP WIN 2 doc Description IKRRR Description Total space Required 72 95 MB Available space 6 84 GB Made with IzPack Figure 6 Screen Displaying the Packages Being Installed amp Installation of EDT Client Description E Select the DATA HOME path C DATA_HOM CADATA_HOME Message x The target directory will be created C DATA
73. rface with URL https esw national ncrs nhs uk cda cqi clientcgi action start Figure 20 is displayed British Telecommunications plc 2012 IN CONFIDENCE Page 37 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 NHS Certificate Enrollment Service Microsoft Internet Explorer provided by BT Webtop BEE S X EP http 10 25 57 135 81 eda cgi cientegitaction start o 25 4 x sea ch BT Intranet p Eile Edit View Favorites Tools Help z we k ans Certificate Enrollment Service Home Feeds 3 dh Print 7 Esp Page Tools NHS Certificate Enrollment Service INHS The NHS Certificate Enrollment ompu ix or in rver ee Service ROOT CA and SUB CA Certficates E View ROOTCA cert PEM format ta Install ROOTCA cert DER format The NHS Certificate Enrollment service issues public eR ee certificates signed by a trusted certification authority CA The Zostal SOOTCA sert BEM formati signed certificates are typically used for end point systems to establish a secure communication session with Spine via the Get your TLS or SSL protocols This service can generate the public and 5 DIGITAL CERTIFICATE private key corresponding to the certificate codes in your 9 install SUBCA cert PEM format browser keystore or you may input a certificate signing request CSR generated by your target application Tasks This service is typically used
74. rial Number is illustrated below 1 Navigate to lt EDT_APPS_HOME gt BIN 2 Type in the following command and press Enter Windows runEDTClient_admin bat Display Cert Serial _No lt cert alias gt British Telecommunications plc 2012 IN CONFIDENCE Page 59 of 78 NHS CFH National Spine IN CONFIDENCE 12564 MSK SUS R12 User Guide EDT 01 November 2012 BT Approved 4 5 4 4 5 4 1 UNIX runEDTClient_admin sh Display Cert Serial No lt cert alias gt Note that providing the certificate alias is optional If it is not provided then the default alias present in EDTVersion txt is used Logging Changes The level of information logged under performance and diagnostic logs can be raised or lowered by changing the respective logging levels in logging API s ALI 2 0 which are bundled with EDT release configuration file lt EDT_APPS HOME gt CONFIG 1log4j xml Additionally performance logging can be switched off and back on if it is not required All the changes will be effective in the next run of the application Note that audit logging is done at single level it cannot be changed Logs are rotated on a daily basis Performance Logging Switch Off On Edit 1og4j xm1 to replace following line lt appender ref ref PerfAppender gt With lt appender ref ref PerfAppender 7 gt This will switch off the performance logging To switch it back on you can reverse this action as sh
75. roved 12564 MSK SUS R12 User Guide EDT 01 November 2012 g Installation of EDT Client p Oy doc Description 2 txt 2 J Please read the Following information This installation is For EDT Client software This installation will let you install and configure Client on windows UNIX environments Made with IzPack Figure 2 Second Screen during EDT Client Installation If an EDT client is already installed on the machine the installer will identify and place the same path in the browse button text box This is shown in figure 3A Clicking the Next button prompts you with a dialog box confirming that the directory will be overwritten Click on the YES button to continue as shown in Figure 3 Warning P The directory already exists Are you sure you want to install here and possibly overwrite existing files Figure 3 Confirmation Box for installing EDT Client British Telecommunications plc 2012 IN CONFIDENCE Page 18 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Installation of EDT Client A a Z Figure 3A Screen to select show existing APPS_HOME Path If it is a completely new installation click on the Browse button and select a folder for the EDT Client home directory Clicking on the Next button prompts you with a dialog box confirming that the directory will be created Click on the OK button to continue
76. stallation if it is a fresh installation from scratch rather than an upgrade the End Point Registration EPR process has to be followed to register the client as a Party key and ASID with Spine Follow the instructions below 1 An EPR form can be downloaded from the CFH website as in section 3 5 1 The Fully Qualified Domain Name FQDN must conform to the DNS naming scheme E g Ebxml RZZ anytowntrust nhs uk Once the registration is complete you will be provided with a Reference Code and an authorisation code Reference Code is a number required to make a certificate request Set this value to referenceid variable in administration configuration file 2 Open lt EDT APPS HOME gt CONFIG EDTAdmin properties file and insert the referencelD received from the EPR Process and save the file British Telecommunications plc 2012 IN CONFIDENCE Page 33 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT Issue 2 01 November 2012 zox Fie Edit Format view Help edt_sender EDT Sender properties edtversionname EDTVersion txt asidkeyname asID edt_alias edt_ali referenceid lt your reference t gt blocked_file_absot tote pathsc EDT_APPS BLOCKED block xml Figure 16 Editing the EDTAdmin properties file for inserting reference ID 3 5 2 Certificate Signing and Importing Signed Reply The ESW End Trust Server for the Web interface als
77. terchanges are successfully downloaded to lt EDT_DATA HOMI E gt OUTBOX lt Dataset Name gt lt Sender Id gt directory 4 4 6 Receive by Dataset Not Received With this receive option EDT downloads all the Interchange from the SUS environment to the Client environment for the specified application which has never been received For NF_DATA_RECON NF_DATA_POSTRECON and SUS_DATA_PDS datasets only files that have a generated date the same as or the previous day will be downloaded in this mode British Telecommunications plc 2012 IN CONFIDENCE Page 55 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 This section provides an example of how to run it manually whenever required It functions in the same way irrespective of run mode scheduled manual and operating environment Windows UNIX Change directory to lt EDT_APPS_HOME gt BIN and execute following command at the prompt Windows runEDTClient bat receive lt dataset name gt not_received UNIX runEDTClient sh receive lt dataset name gt not_received Note Parameter receive is not case sensitive Parameter lt dataset name gt is case sensitive Parameter not_received is not case sensitive In normal circumstances the application should exit successfully as shown in Figure 322 bash 3 00 Thu Jul 12 ns ple 2012 Lo ngInitia er Initialising Log4
78. the Intemet can be useful this file type can Potentially harm your computer If you do not trust the source do not open or save this software What s the risk cate signing request This service is typically used by the administrators of NHS end point Message Handling systems to enter the relevant certificate codes to retrieve the corresponding signed public certificate This service does not provide the capability to generate the certificate codes these are needed as input The signed public certificate can be returned to your browser keystore or to the screen in PKCS7 format and subsequently installed on the end point system by your system administrator Managed b Version 7 0 SP1 ead BT E Done LEE BNO trusted sites i Figure 17 Dialog Box Displayed to Save the Root Certificate 3 5 2 3 Downloading the SubCA Certificate Click on the Install SubCA Certificate link placed in the left hand side menu You will be asked to save the certificate Save it in the EDT_APPS_HOME gt CERT folder der extension only as shown in Figure 18 Save the file with the default name subca der British Telecommunications plc 2012 IN CONFIDENCE Page 35 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 File Edit View Favorites Tools Help ay Qe O h GB Pe ferme O 3 A Address https esw nati
79. tion then performs a handshaking operation If the handshaking operation is successful all the interchanges for the specified application are downloaded to the client sequentially Transmissions are retried for set number of attempts if failure occurs due to British Telecommunications plc 2012 IN CONFIDENCE Page 53 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 BT Approved 4 4 5 12564 MSK SUS R12 User Guide EDT 01 November 2012 internet or other problems If all the retry attempts are exhausted this and all subsequent interchanges are ignored Note that interchanges are successfully downloaded to lt EDT DATA HOME gt OUTBOX lt Application gt lt Sender Id gt directory Receive by File Name With this receive option EDT downloads all the Interchange from the SUS environment whose name is specified to the Client environment for the specified data type This section provides an example of how to run it manually whenever required It functions in the same way irrespective of run mode scheduled manual and operating environment Windows UNIX Change directory to lt EDT_APPS_HOME gt BIN and execute following command at the prompt Windows runEDTClient bat receive lt dataset name gt lt filename gt UNIX runEDTClient sh receive lt dataset name gt lt filename gt Note Parameter receive is not case sensitive Parameter lt dataset name gt is case sensitive Parameter
80. validate_only Fri Jul 06 16 55 30 GMT 2012 EDT Sender Version 3 5 0 r British Telecommunicatio ns ple 2012 LoggingInitialiser Initialising Log4j LoggingInitialiser configureFromFile received filename log4j xml LoggingInitialiser configureFromFile Attempting to build URL to resource o n the classpath LoggingInitialiser configureFromFile Successfully built URL to resource LoggingInitialiser Loading config at URL file C APPS_HOME CONFIG 1lo094j xml LoggingInitialiser Logging initialized EDT Sender Completed Please refer the logs for more details C APPS_HOME BIN gt Figure 29 Screen Displayed After Successful Completion of Validate_Only Mode Receive by ASID With this receive option EDT downloads the Interchanges from the SUS environment to the Client environment for all the application types allowed This mode is not allowed for NF_DATA_RECON NF_DATA_POSTRECON and SUS_DATA_PDS datasets This section provides an example of how to run the option manually whenever required It functions in the same way irrespective of run mode scheduled manual and operating environment Windows UNIX Change directory to lt EDT_APPS_HOME gt BIN and execute following command at the prompt Windows runEDTClient bat receive UNIX runEDTClient sh receive Note Parameter receive is not case sensitive In normal circumstances the application should exit successfully as shown in Figure 30
81. vember 2012 Date Issue Review Requirement Author Requested Author Requested Mandatory Details of Change For Initial Review Incorporated review comments Issue for Approval BT Approved Changes required done for QC defects 108720 108670 108661 108660 108721 108720 108769 108849 and 108743 Uplifted for 1A comments and QC defects 108849 and 108743 Incorporated review comments Incorporated review comments Issue for Approval BT Approved Page 3 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide EDT Table of Contents Issue 2 01 November 2012 1 About this Document 7 1 1 Scope 7 1 2 Audience 7 1 3 Assumptions and Constraints 7 1 4 Related Documents 8 1 5 Typographic Conventions 8 1 5 1 User Input System Output and File Names 8 2 Introducing EDT 9 2 1 Purpose 9 2 1 1 EDT Modes 9 2 2 Pre requisites and Dependencies 11 3 Getting Started with EDT 13 3 1 EDT Installation 13 3 2 Installation 13 3 2 1 Installing the software on Windows Platform X Windows Mode on UNIX 16 3 2 2 Installation of software on UNIX in Silent Mode 25 3 3 Post Installation 28 3 3 1 Installation of DATA Sets Application References and Senders 28 3 3 2 EDT Application User Setup on UNIX 28 3 4 Installation Verification Tests 29 3 5 Authorisation and Authentication 33 3 5 1 End Point Registration 33 3 5 2 Certificate Signing and Importing Signed Reply 34 British Telecommunications plc 2012 IN
82. ww nhsia nhs uk DataStandards xMLschema CDS ns CDSMessage is expected ees CDS 135 j5 Schema XMLInterchange CDSBulk The element type ns CDSBulkChangeUpdate must be terminated by the matching end tag cDS ChangeUpdate Top Done Internet Figure 335 Interchange Validation Report British Telecommunications plc 2012 IN CONFIDENCE Page 66 of 78 NHS CFH National Spine IN CONFIDENCE Issue 2 Time Completed Detail information Row Column Type of error XML Schema Error source field Error message File Type BT Approved 12564 MSK SUS R12 User Guide EDT 01 November 2012 Table 3 EDT Report Details Field Description Header information File XML file name Action Validate only or Validate amp Send Status Status of the action whether failed or successful Time Started Date and time when the action started For example 30 05 2006 11 47 35 Date and time when the action is complete For example 30 05 2006 11 47 36 Row of the interchange where the error occurred Column of the interchange where the error occurred Type of error due to the action For example Schema Source of the error Detailed error message Type of XML file For example CDS or MHMDS When validation is successful only the header section is populated as shown in Figure 346 British Telecommunications plc 2012 IN CONFIDENCE Page 67 of 78 NHS CFH National Spine IN CONFIDENCE BT Approved 12564 MSK SUS R12 User Guide

installation documentation

Contents

Download Pdf Manuals

Related Search

Related Contents