Addoro Local 3.0. Installation and Configuration

Transcription

1 Addoro Local 3.0 Installation and Configuration Overview of Addoro Local Addoro Local consists of two Windows Service applications that Addoro customers installs on their local network. Addoro Local Print enables printing of documents created in the Addoro online service to local printers behind the firewall. Addoro Local Print service will automatically log on to the Addoro online service and check for files that should be printed. For each files it finds it will download both the file (as a PDF) and the name of the printer that should be used. The Local Print Service will then print the PDF file on the specified printer. Addoro Local Upload takes files and uploads them to Addoro. There is a graphical configuration tool provided that is used to configure the applications. For Local Print the configuration tool is used to specify which local printers that should be made available for printing from Addoro. The Local Print service will read the information about available printers and connect to the Addoro online service and register which printers that can be selected. (Usage of the Addoro online service is not covered in this document) Installation Prerequisites If Addoro Local Print is used then the applications should be installed on a server from which it is possible to print to all the printers that should be exposed to Addoro. The Windows service must also be run by a user that has access to all the printers, I.e. can print to them from a Windows print dialog. Both the setup program and the application are Java based programs and they need a 32 bit Java version 6 or later to be installed. Java must be available for both the user that runs the setup and the user that is running the Windows service. After that Java has been installed the JAVA_HOME environment variable should be set to point to the Java installation directory, eg JAVA_HOME=C:\Program Files\Java\jre6. The PATH environment variable should be updated to include the bin directory of the Java installation. If Java is installed in the standard directory then the following should be added to the end of the PATH variable ;C:\Program Files\Java\jre6\bin

2 If the setup can not find a suitable Java version it will attempt to download one. Installation 1. Launch the setup by double clicking on it from a Windows Explorer. Note that the setup requires Administrator rights. 2. Read the licence agreement and select I agree if you accept it and then press next. 3. Select which components to install.

3 4. Select the directory to install the application in and then press next.

4 5. Select the name of the program group in the Windows start menu where the configuration tool will be placed. The setup will suggest Addoro which is recommended in most cases. When the group has been selected press next.

5 6. Next all files will be installed and the services will be created. This may take a minute or two. If a suitable Java version 6 or later is not found (and the java component is selected) it will be downloaded and installed. 7. The setup shows an information screen telling you that the setup is done. Press Finish.

6 That s it. Addoro Local Print and Addoro Local Upload are now installed. Before it can be used it must be configured using the configuration tool. See section Configuration below. If any errors were displayed during the installation please visit the troubleshooting section. Upgrade Please uninstall the previous version of Addoro Local before installing the new version. The setup will automatically trigger an uninstall if it detects that an older version is installed. Configuration

7 Overview Configuration is done using the Addoro Local Configuration tool. The configuration tool can be launched from Windows start menu. The standard location in the start menu is under the program group Addoro and is called Addoro Local The configuration tool consists of three tabs: Local Printers. This tab is used to configure the printers that should be used for printing from Addoro. Local Upload. This tab is used to configure the Local Upload application Account. Here the Addoro user and password can be changed. In the bottom of the tool there are a Save button and an Exit button that is used to save the changes and to exit the tool. Account Settings On the account settings tab the user and password that the service uses to connect to Addoro can be changed. The Environment control is used to select if the local print server should connect to Addoros test or production environment. The verify button can be used to check that it is possible to connect with the current parameters. The apply button will apply the new credentials. It will connect to the Addoro server and download the existing logical printers for that account. Local Upload configuration

8 On the Local Upload tab, the batch type that should be used when sending files to Addoro should be selected. Then the folder that contains files that should be sent should be specified. If Enabled upload copy is checked, then the Local Upload application will copy all files to the upload copy folder after the files has been sent to Addoro. Days to keep copy specifies the number of days that the copied files should be kept before they are deleted. Local Printers configuration The local printers tab consists of a list of printers that should be exposed in the Addoro UI. Every printer has a logical name, physical name, Printer Tray and description. Logical name is the name that will be displayed in the Addoro user interface. E.g. Invoice Printer Physical name is the name of the printer on the local machine that the local service is

9 running at. Printer Tray is the tray on the local printer that will be used when printing. Description is a human readable description of the printer that will be displayed together with the logical name in the Addoro online user interface. E.g. Printer in the reception. The Add, Edit and Delete buttons are used to manage the printers. The Add and Edit button will bring up the Edit Printer dialog. The margin can be used to adjust the print margins on each printer. Use this dialog to map all logical printers to a physical printer. Change Location The location concept is used to setup multiple local print installations when the installations use the same Addoro account, but does not share physical printers. If you are only going to use one local print server then you can leave this setting to it s default value. To separate multiple installations each local print installations can be given a unique location, e.g. Stockholm and London. Each printer is is then identified by the location and the logical name together. This means that there can be one printer in London and one in Stockholm with the same name, e.g. Invoice Printer. In the Addoro web user interface the printers are displayed with location and logical name, so when the distribution configuration is done it can be seen which printers that are in London and which is in Stockholm. When the local print server downloads print jobs it will only download the jobs that matches it s location.

10 Saving The Configuration Saving the configuration is done using the Save button. After that the configuration has been saved the Local Print Service will directly start using the new settings Troubleshooting If the service does not start or any other unexpected behaviour is detected then start by investigating the log files. The log files are normally located in C:\ProgramData\Addoro Local\log. Look in the most recently updated log file for error messages. When contacting Addoro support always send the log files to For some of the problems described below the settings of the Windows service needs to be changed. To find the service, open the Service Control Manager (Control Panel\System and Security\Administrative Tools) and locate the service named Addoro Local Print. Choose properties on the service and go to the logon tab where you will find the options. The setup fails Please ensure that the user that runs the setup have local Administrator rights. Use the Run As Administrator command to start the setup. Uninstall all previous versions of Addoro Local. The Service does not start Check that the user that runs the service has Java 7 or later available. The directory where java.exe is located should be included in the PATH environment variable. The JAVA_HOME environment variable should be set to point to the Java installation directory. Normally this is handled automatically by the Java setup. As default the service is set to use the local system account. If the service does not start please change to the user that ran the setup. There is a known bug that connection fails if the password contains characters that need to be url encoded, e.g. %. If this is the case then change the password to a password that only contains letters and digits. Nothing is printed Check that the user that runs the service has access to the printers. Often a regular user is used to run the configuration tool and the system user runs the service. If the regular user has access to the printers and not the system user, then it is possible to add the printers in the tool, but the service will not find the printers. Printing to a printer that stores the document to disk instead of sending to a printer fails. The allow service to interact with desktop must be selected on the service since the

11 service will try to open a dialog where the file name can be specified. The Configuration Tool does not start Please verify that Java 7 or later is installed and included in the PATH variable. To test this try to start the configuration tool from a command prompt. If Java is not installed an error message like this is displayed 'java' is not recognized as an internal or external command, operable program or batch file.. An older Java version is installed and is used instead of Java 7 or later. To test this start a command prompt and type java version. The version returned needs to be 1.7.x or later. To start the configuration tool from a command line prompt first open a command prompt. It is normally found in Windows start menu All Programs Accessories Command prompt. Then try to start the Configuration Tool by typing C:\Program Files (x86)\addoro Local\addoro_localservice_ui.bat <enter>. Advanced Configuration Tanuki Service Wrapper The Addoro Local Print service is a Java application. To make a Java application run as a service on windows a framework called Tanuki Service wrapper is used. The Tanuki framework has a lot of features that can be manually enabled. Among other things it provides monitoring of the service, notifications when problems occur, automatic restart if the Java application crashes. For more information see The Tanuki configuration file is called localprint_winwrapper.properties and can be found in C:\ProgramData\Addoro Local\resources\wrapper. Addoro uses version of Tanuki Service wrapper. Log4J The Local Print server uses a logging framework called log4j. Log4J can be configured by changing its configuration file. The file is called log4j.properties and is located in C:\ProgramData\Addoro Local\resources\localprint and C:\ProgramData\Addoro Local\resources\localupload. In the configuration file the log level can be changed, log messages can be filtered out, sending of error log messages to an address can be added etc. For a full list of Log4Js capabilities see Addoro is currently using Log4J version

12 Print to File Instead of printing it is possible to put all files in a directory by setting addoro.localprint.type.file=true addoro.localprint.file.folder=<folder> In the file C:\ProgramData\Addoro Local\resources\localprint\service.properties. In this case all print jobs will be put as pdfs in that folder.