Eurolight Automatic Order Submission Tool Setup Guide

Transcription

1 Eurolight Automatic Order Submission Tool Setup Guide Version 700 July 2014

2 Eurolight Automatic Order Submission Tool Setup Guide 2014 All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Printed: July 2014 in Amsterdam Publisher Soops b.v. sales@soops.nl I

3 Eurolight Automatic Order Submission Tool Setup Guide Contents Table of Contents Chapter I About This Guide 4 Chapter II 6 1 Installation... Steps 7 2 Directory... creation 8 3 EurolightXMLOrderImport.ini ConnectionSettings.xml Post... Install Command prompt registering 13 Register ALL... XML Order Im port Services 14 Register Single... XML Order Im port Service 15 Register Multiple... XML Order Im port Services 16 Unregister... XML Order Im port Service 17 Uninstall Chapter III Appendix A, example configurations

4

5 Eurolight Eurolight Automatic Automatic Order Order Submission Submission Tool Tool Setup Setup Guide Guide Chapter 1 About This Guide

6 About This Guide Chapter 1 About This Guide This guide describes the steps required to set up the Eurolight Automatic Order Submission Tool to work within the Eurolight environment. Throughout this guide, the names XML Order Import and Automatic Order Submission Tool, are used. These two indicate the same tool, but they are named differently in various contexts. Please regard these as one and the same. In certain places the phrase 'Scripting' is used as well; this name will be phased out in future deployments, but is currently still in use. This guide is intended for experienced Eurolight users that are familiar with, and have authority to do the administrative tasks required for this setup. Before starting with the setup procedure of the Eurolight XML Order Import service, please make sure you have full administrative permissions for installation and running the Windows Command tools. During the various steps links are provided to detailed descriptions helping set up important values in external files and applications. Values displayed in Bold should be edited towards your environment where indicated. Follow the steps in sequence. At the end, during the first full run, examining the results in the loggingeurolightxmlorderimportservice[...].log file can be helpful to indicate oversights or errors. 4

7 Eurolight Eurolight Automatic Automatic Order Order Submission Submission Tool Tool Setup Setup Guide Guide Chapter 2

8 Chapter 2 Run the installer by doubleclicking the EurolightXMLOrderImportService.msi file. Choose an install Directory. Please note that full administrator permissions will later be required for this directory. Edit the ConnectionSettings.xml and EurolightXMLOrderImport.ini files that are just installed manually to facilitate your local requirements. 6

9 2.1 Installation Steps Follow the following steps in this sequence for the initial setup of a Eurolight XML Order Import Service: Request a special Eurolight User Account for Automatic Order Submission from the exchange to be used as an XML Order Import Account. Run the Eurolight XML Order Import Service (XXX).msi installer Create, or ensure access to, the polling directories. See here. Open the installation directory. (Default: C:\Program Files (x86)\eurolight XML Order Import Service) Edit the EurolightXMLOrderImport.ini and ConnectionSettings.xml files Open a Windows Services Console (services.msc), and find the EurolightXMLOrderImportService[_ALL_] service Optional: Open a Windows Command Prompt in order to register your service(s) following the steps here. Optional: In the Windows Services Console, refresh (F5) and start your service(s). Ensure they are indeed started. (This may take a few seconds). Refresh (F5) as required. Verify that the service is operating correctly by looking in the loggingeurolightxmlorderimportservice[<servicename>].log file 7

10 2.2 Directory creation Manually create or ensure access to the following Directories for each Service you will register : default path: C:\ProgramData\Eurolight\XMLorderimport\NL\<ServiceName> subdirectories: TradingAction files are polled from the root directory results Needed for result files received from exchange. Directory must be created manually and needs not be in this location invalid Created automatically after registering service, needed for polling operation. System required directory. pending Created automatically after registering service, needed for polling operation. System required directory. Must never include files besides these generated by the Eurolight Automatic Order Submission Tool. valid Created automatically after registering service, needed for polling operation. System required directory. This directory tree is referred to in the ConnectionSettings.xml file under the <ServiceName> tag and will be used by that service to manage the actual XML Order Import files. 8

11 2.3 EurolightXMLOrderImport.ini Edit the EurolightXMLOrderImport.ini file. The Bold arguments in the supplied EurolightXMLOrderImport.ini file must be modified to reflect your local situation. The actual settings will be provided by the Exchange. [Scripting] UserLoginSettingsFile=ConnectionSettings.xml [Server] SystemName=Eurolight [Logging] LoggingEnabled=true LoggingFilename=logging.log LoggingLevel=info Maximum Filesize= SyslogHost=localhost SyslogLoggingEnabled=false SyslogLoggingLevel=notice SyslogPort=514 TranscriptLoggingEnabled=false TranscriptLoggingLevel=notice Explanation of settings: The settings defined within the.ini file only correspond to the EurolightXMLOrderImportService.exe within the same installation folder. -UserLoginSettingsFile: UserLoginSettingsFile=<ConnectionSettings.xml> Recommended not to change the default setting. Specifies the name of the.xml file within the same directory that will be used to connect and login to Eurolight at the exchange. -LoggingFilename: loggingfilename=<directorypath+ Filename> Specifies the directory to which Eurolight XML Order Import logs will be saved; it s recommend that this directory is not on the same hard disk as the application is. Note that the name of the logging file will automatically include the name of the service it refers to. Example: logging-eurolightxmlorderimportservice[_all_].log -Maximum Filesize: Maximum Filesize=<filesize in bytes> After filling the allotted space, the first entries will be removed. This creates a rolling logfile. 9

12 -All other settings: Do not modify unless specifically instructed by an exchange support engineer. 10

13 2.4 ConnectionSettings.xml Edit the ConnectionSettings.xml file. The Bold arguments in the supplied ConnectionSettings.xml file must be modified to reflect your local situation. Please note that the ConnectionSettings.xml file is referred to in the EurolightXMLOrderImport.ini file. Important: It is technically not possible to include settings with identical LoginNames to different exchangeservers within the same ConnectionSettings.xml file. In the example below two service settings are defined, <?xml version="1.0" encoding="utf-8"?> <!-- Sample settings file contents --> <SettingsList xmlns="urn:eurolight:scripting:clientsettings"> <Setting> <LoginName>PWRNLAAXML</LoginName> <Password>1234****</Password> <ServerPort>443</ServerPort> <ServerAddress>IP or DNS address of Eurolight Exchange Server</ ServerAddress> <UseSecureConnection>true</UseSecureConnection> <ScriptLocalChannel> <LoadDirectory>C:\ProgramData\Eurolight\XMLNL</LoadDirectory> <ResultDirectory>C:\ProgramData\Eurolight\XMLNL\results</ ResultDirectory> <Delay>5</Delay> </ScriptLocalChannel> <ServiceName>Service1</ServiceName> </Setting> <Setting> <LoginName>PWRNLABXML</LoginName> <Password>12345***</Password> <ServerPort>443</ServerPort> <ServerAddress>IP or DNS address of Eurolight Exchange Server</ ServerAddress> <UseSecureConnection>true</UseSecureConnection> <ScriptLocalChannel> <LoadDirectory>C:\ProgramData\Eurolight\XMLBE</LoadDirectory> <ResultDirectory>C:\ProgramData\Eurolight\XMLBE\results</ ResultDirectory> <Delay>5</Delay> </ScriptLocalChannel> <ServiceName>Service2</ServiceName> </Setting> 11

14 </SettingsList> LoginName User ID used to log in at the exchange server. This Used ID will also be the submitting user for the imported orders. Password Password assigned by exchange for the UserID above ServerPort Server port of the exchange server ServerAddress Server address (IP Address or DNS Name) of the exchange server UseSecureConn Must be true or false. Indicates use of secure connection to Mux server ection LoadDirectory Local: Directory used to poll the XMLOrderImport file from, to be submitted to the exchange ResultDirectory Local: Directory used to write the received report.xml files to. Can be set to a directory outside the Service directory structure ServiceName Local: Name of the registered Service using the settings above. Must be unique on the system and must consist only of AlphaNumeric characters. 12

15 2.5 Post Install Command prompt registering After the initial installation a Windows Service named EurolightXMLOrderImportService[_ALL_] is available. This service processes ALL connections to Eurolight as configured in its ConnectionSettings.xml file. This default setting can be modified to accommodate either Multiple services or Single Service setups. Access the Windows Services Management Console (services.msc) as Windows Administrator. Select the EurolightXMLOrderImportService[_ALL_] You have the option to install different service configurations, depending on your requirements. The default (ALL) setup can be used by organizations that do not require each UserID to have a separate connection. The (Single) setup can be used by organizations that have connections with different UserIDs, or the same UserIDs to different Eurolight servers. The (Multiple) setup can be used by organizations that have connections with different UserIDs to a single Eurolight server, or different UserIDs to different Eurolight servers. --register This will register the EurolightXMLOrderImportService[_ALL_] service. --register Service1 This will register the EurolightXMLOrderImportService[Service1] service. --register Service1 Service2... This will register the EurolightXMLOrderImportService[Service1,Service2,...] service. Important: A service must never be registered as _ALL_ without brackets or anything else, as this will cause Windows to buckle and fall apart. --register _ALL_ This will cause serious issues. 13

16 2.5.1 Register ALL XML Order Import Services It is possible to have one Eurolight XML Order Import Service running all connections. This setup is the default installed setup. In this setup a connection failure on any single connection will have impact on all UserIDs configured in this connection, even if these connections are to different Eurolight servers. Important: It is technically not possible to include settings with identical UserIDs to different Eurolight servers within the same service. To manually setup a EurolightXMLOrderImportService[_ALL_] follow these steps: Open a Command prompt in administrator mode Go to the installation directory (default "C:\Program Files (x86)\eurolight XML Order Import Service") Type: EurolightXMLOrderImport.exe --help to see possible options Type :EurolightXMLOrderImport.exe --register (To create a single Eurolight service that handles ALL configured connections as set in its ConnectionSettings.xml) In the Windows Services Management Console (services.msc) the installed service can be found under the name EurolightXMLOrderImportService[_ALL_]. Fresh services are by default set to start manually, but can be set to automatic if desired. 14

17 2.5.2 Register Single XML Order Import Service It is possible to have an Eurolight XML Order Import Service running a single connection. You can register multiple services each running a single, different connection. Use this setup if you need to make connections for the same UserID to different Eurolight servers, and/or require each connection to run separate from other connections. To manually setup a EurolightXMLOrderImportService[ServiceName] follow these steps: Open a Command prompt in administrator mode Go to the installation directory (default "C:\Program Files (x86)\eurolight XML Order Import Service") Type: EurolightXMLOrderImport.exe --help to see possible options Type :EurolightXMLOrderImport.exe --register ServiceName (To create a single Eurolight service that handles 1 connection, as set in its ConnectionSettings.xml) Repeat step 4 as required for each service you want to register. In the Windows Services Management Console (services.msc) the registered services can be found under the name EurolightXMLOrderImportService[ServiceName]. Fresh services are by default set to start manually, but can be set to automatic if desired. 15

18 2.5.3 Register Multiple XML Order Import Services It is possible to have an Eurolight XML Order Import Service running multiple connections. This setup can be used to combine several connections within the same service. Important: It is technically not possible to include settings with identical UserIDs to different Eurolight servers within the same service. To manually setup a EurolightXMLOrderImportService[<ServiceName1>,<ServiceName2>] follow these steps: Open a Command prompt in administrator mode Go to the installation directory (default C:\Program Files (x86)\eurolight XML Order Import Service) Type: EurolightXMLOrderImportService.exe --help to see possible options Type for 2 connections: EurolightXMLOrderImportService.exe --register Service1 Service2 (To create a single Eurolight service that handles 2 different connections) Note that more than 2 connections can be created this way Each Service defined here must be configured in the ConnectionSettings.xml file under the <ServiceName> tag In the Windows Services Management Console (services.msc) the installed service can be found under the name EurolightXMLOrderImportService[Service1,Service2]. Fresh services are by default set to start manually, but can be set to automatic if desired. 16

19 2.5.4 Unregister XML Order Import Service To unregister any EurolightXMLOrderImportService, use any one of the options below: --unregister This will unregister the Service EurolightScriptingService[_ALL_] --unregister Service1 This will unregister Service EurolightScriptingService[Service1] --unregister Service1 Service2... This will unregister Service EurolightScriptingService[Service1,Service2,...] --unregisterallservices This will unregister all known Scripting Services. Note that unregistering does not imply uninstallation Uninstall To uninstall Eurolight XML Order Import, run the Remove Eurolight XML Order Import Service tool in the Windows Start Menu. Note that uninstalling Eurolight XML Order Import will also remove any registered Eurolight XML Order Import Services and their respective ConnectionSettings.xml and EurolightXMLOrderImport.ini files. You might want to manually make a backup of your ConnectionSettings.xml and EurolightXMLOrderImport.ini files for later use. If during the uninstall procedure any running EurolightXMLOrderImportServices are detected, you will be prompted for further action first. 17

20

21 Eurolight Eurolight Automatic Automatic Order Order Submission Submission Tool Tool Setup Setup Guide Guide Chapter 3 Appendix A, example configurations

22 Appendix A, example configurations Chapter 3 Appendix A, example configurations Scenario 1 Using the default setup; EurolightXMLOrderImportService[_ALL_] 3 Connections are configured to 2 Eurolight Servers with 3 different UserIDs. 20

23 Appendix A, example configurations Scenario 2 3 Connections are configured to 2 Eurolight Servers with 2 different UserIDs. User1 exists on Server1 and on Server2. In this case the default setup will not work. Due to technical limitations a Windows Service can only hold one connection for each UserID. Therefore we have to split the Windows Service. The following Scenario shows a combination of a Single and a Multi service. 21