PT-X Drive. Installation Guide

Transcription

1 PT-X Drive Installation Guide

2 Notices Copyright Bottomline Technologies, Inc All Rights Reserved Information in this document is subject to change without notice and does not represent a commitment on the part of Bottomline Technologies. Bottomline Technologies makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability or fitness for particular purpose. Bottomline Technologies Internet: Europe, Middle East, Africa 115 Chatham Street Reading, Berkshire, RG1 7JX UK Telephone: Fax: emea-info@bottomline.com

3 Contents Notices... 2 Introduction... 4 Contacting Bottomline Technologies... 4 Technical Services... 4 Training... 4 Documentation... 4 Prerequisites... 5 System Requirements... 5 Operating Systems... 5 Java Runtime... 5 Access... 5 Installation... 6 Deploying the Software... 6 Software contents... 6 Running PT-X Drive... 8 Usage... 8 Using PT-X Drive... 9 Setting up PT-X drive options on Payment Profiles Watch folder pattern Delete files on upload Automatically download Bacs Messages Uploading files Logging Tray icon Troubleshooting... 12

4 Introduction The PT-X Drive client enables you to upload data files seamlessly to the PT-X cloud solution. This document covers the installation and setup of PT-X Drive. Contacting Bottomline Technologies This section provides contact information for Technical Services, Training, and Documentation. Technical Services If you have questions about a Bottomline product and are unable to find the answers in the product documentation, contact Technical Services ( Europe (United Kingdom) Emea-support@bottomline.com Telephone: ( if calling from outside the UK) Fax: ( if calling from outside the UK) Technical Services is available from 0830 to 1730 Monday through Thursday and from 0830 to 1700 on Fridays. Training Bottomline Technologies offers training courses in many products. For information, contact your account representative. Documentation Bottomline Technologies is always interested in improving the quality of the product documentation. If you find errors or omissions in this documentation, or have suggestions on how to improve it, your comments to documentation@bottomline.com. You can send comments anonymously or provide contact information so that we can contact you.

5 Prerequisites This section describes the checks and tasks that are necessary before starting to install the PT-X Drive software. System Requirements Ensure that your system meets the requirements shown in the following sections. Operating Systems Any Microsoft supported Windows OS (32 or 64 bit) Java Runtime The JRE deployed with PT-X Drive is version 1.7. Note: If the Jar is run directly with an alternative JRE it must be with a version 1.7.x or above. Access The software must have access to the PT-X hosted URL over the internet.

6 Installation This section describes how to install the PT-X software. Make sure that you have checked the prerequisites described in the previous chapter before starting the PT-X Drive installation. Deploying the Software To install PT-X Drive software: 1. Save the Bottomline_PT-X-Drive.zip file to the target machine 2. Unzip Bottomline_PT-X_Drive.zip to the desired installation path. Software contents ptx-drive.jar o The executable PT-X Drive service ptx-drive.bat o batch file used to run PT-X Drive on 64 bit operating systems ptx-drive-32bit.bat o batch file used to run PT-X Drive on 32 bit operating systems bottomline-ptx-drive-windows-service.bat o batch file used to configure PT-X Drive and install it as windows service on 64 bit operating systems bottomline-ptx-drive-windows-service-32bit.bat o batch file used to configure PT-X Drive and install it as windows service on 32 bit operating systems start-bottomline-ptx-drive-windows-service.bat o batch file used to start PT-X Drive windows service on 64 bit operating systems start-bottomline-ptx-drive-windows-service-32bit.bat o batch file used to start PT-X Drive windows service on 32 bit operating systems stop-bottomline-ptx-drive-windows-service.bat o batch file used to start PT-X Drive windows service on 64 bit operating systems stop-bottomline-ptx-drive-windows-service-32bit.bat o batch file used to start PT-X Drive windows service on 32 bit operating systems nssm-2.24.bat o batch file used to configure nssm to set up PT-X Drive as windows service on 64 bit operating systems nssm bit.bat o batch file used to configure nssm to set up PT-X Drive as windows service on 32 bit

7 operating systems nssm-2.24 o Folder containing nssm for 32 bit and 64 bit operation systems jre1.7.0_75 o Folder containing the packaged Java Runtime for 64 bit operation jre1.7.0_75-i586 o Folder containing the packaged Java Runtime for 32 bit operation

8 Configure PT-X Drive and set it up as windows service Usage Normal usage is to either double click the batch file bottomline-ptx-drive-windows-service.bat (or bottomlineptx-drive-windows-service-32bit.bat as required) or from a command prompt navigate to the PT-X Drive install directory and execute the batch file. Before running this batch file, close any PT-X drive if it s already running. This will configure PT-X Drive by taking the required details from the user; install it as a windows service with the name Bottomline-PTX-Drive and start PT-X drive automatically. 'Bottomline-PTX-Drive is configured to start up automatically on reboot of PC. To start 'Bottomline-PTX-Drive windows service Normal usage is to either double click the batch file start-bottomline-ptx-drive-windows-service.bat (or startbottomline-ptx-drive-windows-service-32bit.bat as required) or from a command prompt navigate to the PT-X Drive install directory and execute the batch file. If the windows service is started successfully or already running, it will give appropriate message. 'Bottomline-PTX-Drive windows service can also be started from windows services. To stop 'Bottomline-PTX-Drive windows service Normal usage is to either double click the batch file stop-bottomline-ptx-drive-windows-service.bat (or stopbottomline-ptx-drive-windows-service-32bit.bat as required) or from a command prompt navigate to the PT-X Drive install directory and execute the batch file. If the windows service is stopped successfully or already stopped, it will give appropriate message. 'Bottomline-PTX-Drive windows service can also be stopped from windows services. Running PT-X Drive from command prompt (not as windows service) Usage Normal usage is to either double click the batch file ptx-drive.bat (or ptx-drive-32bit.bat as required) or from a command prompt navigate to the PT-X Drive install directory and execute the batch file.

9 For advanced usage the following command line options are available. -c, --config Rebuild configuration -h, --help Display help message -v, --version PT-X Drive Version Sample command line D:\PT-XDriveInstall\run -c On first run, or on specifying the c option to rebuild the configuration, you will be prompted for the following information: Using PT-X Drive Once running PT-X Drive will store the URL and address in a locally created settings.xml file, it will then contact PT-X. Item Description PT-X URL The URL of the PT-X instance you are connecting to, unless DR has been invoked and PT-X is running from an alternative URL the default should be chosen Pressing enter selects the default ( PT-X user address PT-X password for < address> This is the address of the user you wish PT-X to authenticate with. This user should have rights to upload data files to the Payment Profiles that have been enabled for use with PT-X Drive. The password associated with the specified user account. Note: this will be taken one time, encrypted and stored in local file. Note: this will be requested each time PT-X Drive is run PT-X Drive Log Level The applicable log levels for PT-X drive are TRACE, DEBUG, INFO, WARN, ERROR, FATAL. The default log level is INFO. If log level is set to DEBUG you will see log messages of level DEBUG and above.

10 Setting up PT-X drive options on Payment Profiles To enable PT-X Drive, within the PTX UI navigate to the file import tab of the payment profile and select Allow imports from PT-X Drive. Once enabled you can specify the options below, any changes made to the Payment Profile options will not be picked up by PT-X drive until it is restarted. Watch folder pattern If Watch folder pattern, is specified PT-X drive will start watching that folder for files to be uploaded. If the Watch folder pattern is left blank, within the PT-X drive install directory, a folder will be created with a name as a 'slug' of the payment profile name. If you specify an absolute or relative path in the Watch folder pattern, make sure that folder path is valid and the folder is already created. Delete files on upload By choosing Delete local files upon successful upload, PT-X drive will delete the files after successfully uploading them. If this option is not specified then after successful upload the files will be moved into the 'uploaded' folder. Automatically download Bacs Messages Enabling this option will allow PT-X drive to automatically retrieve bacs messages when they become available within PT-X. The bacs message will be downloaded into PT-X on a regular basis seven days a week. The downloaded bacs messages will be placed in bacs-messages\<sun> folder, within PT-X drive. Downloaded Bacs messages will be in XML / XHTML format and FPS messages will be in XML/CSV format. Both Bacs and FPS messages associated to the SUN will be placed under the corresponding SUN folder. Once the Bacs message is retrieved successfully by PT-X Drive they will be marked as downloaded to prevent duplicates.

11 Uploading files To upload a file it should be copied into the watch folder (if one is specified in the payment profile) or the default directory created for that payment profile in PT-X drive. The file will then be uploaded to PT-X via the user account that Drive is using to authenticate. Once the file is uploaded your payment data will then be available within PT-X! Logging PT-X drive will let you to choose the log level. Log level can be setup by running ptx-drive.bat with the c or config option. The default log level is INFO and you can choose the log level to DEBUG if a detailed logging is required. There will be two log files generated activitylog.out and log.out, under the logs folder within PT-X drive. activitylog.out will have activity information like user authentication, file detection, file uploaded or failed, file moved or deleted. Logs with log levels INFO and above will be logged into the activitylog.out. Based on log level setting, log.out will have detailed logging. Tray icon If you're using PT-X Drive on Windows or Mac, you'll also see a tray icon. This indicates that PT-X Drive is running and allows you to temporarily disable or exit the program.

12 Troubleshooting Certain issues can prevent PT-X Drive from connecting to PT-X, in this instance the following may help. Ensure you can log in with the specified account via a browser from the machine where PT-X Drive is running. If PT-X drive needs to connect via a proxy it is possible to edit the java.net.usesystemproxies entry in the configuration file in PTXDrive\<jre version>\lib\net.properties to true. o Restart PT-X drive to resolve the connection timeout issues due to proxy settings Confirm that local antivirus and firewall software is not preventing the connection