1. Ensure that the server is stopped.
  2. Using a text editor, edit the file /pks/RippleDown/properties/server.properties to change the interface type as follows:
    1. INTERFACE_TYPE=socket, if your site is using XML over sockets to connect from the LIS to the RippleDown server,
    2. INTERFACE_TYPE=ultra, if your site is using the Ultra file based protocol, or
    3. INTERFACE_TYPE=hl7, if your site is using HL7
  3. If you are using sockets or HL7, edit the file /pks/RippleDown/CommunicatorSettings.txt to define the IP address and port used for communication with the LIS. The entries CommunicatorAddress and CommunicatorPort should be IP address and Port of the computer hosting the RippleDown server. RippleDown will create a server socket at this address and port to which the LIS can connect and send messages. Ignore the entries LisAddress and LisPort as these are only used for the bi-directional clinical interface.Note: RippleDown can accept HL7 messages from several communications ports (LIS systems) simultaneously. To specify multiple ports, separate multiple port  numbers with a colon (:) in the CommunicatorPort entry. Each LIS system will need to be configured to connect on one of these ports. For example:

    #The port on which the communicator will listen for connections. CommunicatorPort=5678 : 6789

    For more information, see Configuring RippleDown for multiple interfaces

  4. If you are using the file-based protocol, then edit the file /pks/RippleDown/CommunicatorSettings.txt and set the entry  Communicator_pk_in to define the full path of the shared directory where the LIS will write the input files for the RippleDown server to read.
  5. Using a text editor, edit the file /pks/RippleDown/properties/server.properties to change the interface type to INTERFACE_TYPE=hl7
  6. Whether you are using sockets or files, the entry RippleDown_archive in the file CommunicatorSettings.txt needs to be set. It  determines the directory where input messages are archived by the RippleDown server after they have been processed.
  7. Edit the file /pks/RippleDown/users.txt to give Auditor privilege to each user who needs to use the Auditor client. The code for the Auditor privilege is ‘d’, so that a user with all privileges will have ‘akvd’ for example.
  8. Start the server.
  9. Start the Knowledge Builder client, and create a new project, for example with name “DataEntry”.
  10. Start the Administrator client, and add the DataEntry project with panel code as specified by the interface, normally “DE”. There is no need to define a library code prefix as no files are sent back to the LIS.
  11. Start the Auditor client. There should be 1 Auditor queue defined, but with no cases queued.
  12. Select the project in the Administrator client’s project table, and check the menu File | Archive cases to project. This will cause all processed cases to be copied to the Archive list in the Knowledge Builder, so that the view of the case can be tidied up. That is, user-friendly names for the data items can be set, unused data items can be hidden from view, and the data items can be ordered and grouped conveniently. This tidy-up task is normally done by PKS support personnel just prior to conducting the user training course.
  13. The RippleDown system is now ready to being processing cases. To check this, do the following:
    1. Trigger the LIS to send a case
    2. Check that the case can be seen in the Knowledge Builder’s archive list
    3. Check that the case is now on the Auditor’s queue, and can be reviewed (press the Review button on the Auditor main screen)
    4. Check that the server log file does not show any errors.