User Guide Version 1.6.
Connect Send User Guide 2017-04-11 OBJECTIF LUNE Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 http://learn.objectiflune.com © 2016 Objectif Lune Incorporated. All rights reserved.
Table of Contents What is Connect Send? Features List Main steps in OL Connect Send Installation Printer driver Workflow Plugins Moving Workflow to another machine Prerequisites System Requirements Installing OL Connect Send Printer Driver Mass deployment of the OL Connect Send Printer Driver OLCS Notifier Known Issues License modes Basic mode User mode Click Charge mode Incoming print jobs and the license OL Connect Send in Workflow Configuring the OL Connect Send Workflow processes Plugins 4 4 5 7 7 7 8
What is Connect Send? Connect Send is an application with two components. The first is a Windows printer driver and the second includes a set of Workflow plugins. These two components work together – they cannot be used on their own. Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application. It can be used in unlicensed mode and licensed mode. The Unlicensed mode (default) allows users to push documents to Connect Send.
l l Unlicensed mode l Non-interactive job submission. l Free to use. l Confirms job transmission with a message in the Notification Area. Licensed mode l l l Interactive job submission possible. Launches the user’s default browser to display web content produced by a Connect server. Database containing domain, workstation ID, document information and page count information. Main steps in OL Connect Send The main steps in the functioning of OL Connect Send are: 1.
Data plugin" on page 42) will be displayed in the browser. If the plugin is not licensed, or the license is exceeded, this HTTP request is suppressed and the Printer Driver will not launch a browser window. 12. The Printer Driver will display status information using the Notification Area (also called "system tray").
Installation Printer driver The OL Connect Send Printer Driver must be installed on a dedicated machine and a Windows printer must be set up using this driver. Additionally several settings regarding the host for sending print jobs have to be set. All this is done with the Printer Driver installer; see "Installing OL Connect Send Printer Driver" on page 10. Any OL Connect Send Printer Driver with a version number less than 1.0.5 should be uninstalled before installing the newest Printer Driver. 1.
Moving Workflow to another machine When moving Workflow to a different machine, it s important to move the OL Connect Send database (OLCSDB.script) to the other machine as well. The database includes all job information collected to date. 1. Make a backup of the Connect Send database: copy the content found in %programdata%\objectif lune\cpd\ to a safe place. Do not copy any of the other sub folders found under %programdata%\objectif lune\. 2.
l Windows 7, 32 and 64-bit l Windows 8.1, 32 and 64-bit l Windows 10, 32 and 64 bit (including “Anniversary update”) l Windows Server 2008 R2, 64-bit l Windows Server 2012 R2, 64-bit Note For installation on a Windows Server system (2008 and higher), it is a mandatory prerequisite that at least one role is activated or installed before running the OL Connect Send Printer Driver installer.
Installing OL Connect Send Printer Driver Note OL Connect Send Printer Driver can be found on Objective Lune's website at http://help.objectiflune.com. Setup process – new installation The following section describes the installation process for the OL Connect Send (OLCS) Printer Driver. Starting the installation Click the OLCS_Printer_Driver_Setup_1.2.5.98-22.msi file to start the OL Connect Send Printer Driver Setup. Note Do not run the installer from the TEMP folder.
Please read the legal notices and acknowledgements. Click Next to proceed. EULA The next screen shows the EULA. Please read and accept it to proceed further by clicking Next. Communication URL settings With this dialog the URLs for print job submission and the later interaction are to be defined.
URL for print job submission The URL for print job submission allows the URL for Workflow to be entered. This is the server that will capture and process print jobs. It needs to be entered as a full URL, for example: http://demo.objectiflune.com:8080/olcs_transfer The required pattern is: ://:/[/] l : Sets the communication protocol and has to be either HTTP or HTTPS. Any other setting is invalid.
Tip For additional information about secure file transfer, HTTPS certificates and how to request a countersigned certificate, please see this page: SSL HowTo. l l l : The host name or IP address of the target machine. This is either the computer where the related Connect Workflow is running or a gateway machine. : The port entry is mandatory, even if the port should be one of the standard ones (80 for HTTP or 443 for HTTPS). : Optional additional URL path components.
By unchecking Interactive mode you can set this specific printer to only send jobs to the server, without further user interaction. In that case, the printer will not pop up a browser window. Nevertheless, messages will pop up in the tray area, informing about transfer, success or failure. When the Interactive mode is disabled, the HTTP action for interaction field also becomes disabled.
Note If the main URL for print job submission contains any path components, these must be added here as well. Example The URL for job submission is given as http://demo.myhost.com:80/path/to/target/olcs_transfer. The HTTP action for interaction must be entered as: path/to/target/olcs_interaction. When done, click Next to continue. Printer name and logging In the Printer name and logging screen, you can set a name for the printer you wish to create and setup the logging level.
Printer name By default the printer name is OL Connect Send Printer. If a printer with the same name already exists, a number is added and increased until no matching printer name is detected. This then becomes the proposed printer name in this dialog. The printer name must consist of valid characters. Invalid, forbidden characters are: l / = forward slash, 0x2F l " = quote, 0x22 l \ = backslash, 0x5C l * = asterisk, 0x2A l : = colon, 0x3A l ? = question mark, 0x3F l < = less than sign, 0x3C l
l l WARN: This is the default level and should be used for production use. In this mode log files may be empty: this is by design and indicates, that the printer and the driver work as expected. This mode will include ERROR messages too. ERROR: For users familiar to OLCS, this log level reduces the overhead to a minimum. It is intended for machines where OLCS has been working error free for several weeks.
The OLCS Notifier Once a printer driver is installed, an application called OLCS Notifier is also installed. It displays and logs information relating to the preparation and transfer of each print job. For more information see "OLCS Notifier" on page 26. Adding, modifying or deleting a printer To install an additional printer, modify a printer or delete a printer, run the installer again. The installer will detect that it’s not being used for the first time and will present a different screen.
Clicking the Next button will bring you to the selection page where you can decide to: l Add a printer. l Modify the settings of an existing printer. l Delete one or all existing printers.
Adding a printer The wizard pages that follow when clicking the Add printer button are the same as for a new installation. Each printer can have its own settings. Modifying the printer settings Depending on the number of printers already installed, you will either see the Wizard window or a dialog box from which you must select the printer you wish to modify. The wizard pages are the same again, so you can modify any of the values (e.g.
Updating the Printer Driver When a newer version of the installer becomes available, the Connect Send Printer Driver can be updated by installing one new Connect Send printer with it (see "Adding a printer" on the previous page). It is not necessary to delete previously installed OL Connect Send printers: when the new driver is installed, this affects all existing OL Connect Send printers as well.
Mass deployment of the OL Connect Send Printer Driver The OL Connect Send Printer Driver is intended to be installed on computers from which print jobs shall be sent to the respective Workflow server. Often such computers are part of specific domains on which end users are not allowed to install software on their own. Such users may not have the knowledge to install printers, and often dedicated restrictions and policies have to be taken into account.
l The Setup msi file (e.g. OLCS_Printer_Driver_Setup_1.2.5.98-22.msi) l The Silent Setup tool (OLCS_Printer_Driver_Silent_Setup_1.2.5.98-22.exe) l An OLCSClient.ini with the desired settings; see "Configuration file content" below. The deployment tool of your choice then only needs to run the Silent Setup tool and check its exit code.
Section Description Default Port Port number for the Workflow HTTP service. 8080 PrinterName Name for the printer to create and configure. If a printer with that name already exists, the installer will modify the settings for that printer, following the configuration file. The installer will fail if the mentioned printer is not an OL Connect Send printer. There is NO DEFAULT printer name! LogLevel Log level. Valid values are DEBUG, INFO, WARN and ERROR.
Section Description Default set to 0, the OLCS Notifier will not be started until the user logs in. Note Set StartTBN to 0 for mass deployment of the Printer Driver. Starting the OLCS Notifier during setup in a silent installation will lead to issues when the user logs in. This setting is only valid with the very first installation of OL Connect Send.
To confirm that a silent installation was successful, it is also possible to check the installation log file. The log file contains information about the installation and all possible issues. The file path and name are: %ProgramData%\Objectif Lune\CPD\log\Installation Logs\ClientInstaller-.log Silent update To update the driver silently, use the Silent Setup tool to deploy an existing OL Connect Send printer. It is not necessary to delete any previously installed Connect Send printers.
Logged messages To view the messages logged by the OLCS Notifier, right-click the OLCS Notifier icon in the notification area and select Show. This brings up the OL Connect Send Messages window with all the notifications arrived at the OLCS Notifier since installation or since the list was last cleared (using the Clear List button).
[][] Stopping and restarting the OLCS Notifier To stop the OLCS Notifier, right-click the icon in the notification area and select Exit. To restart it, either click Taskbar Notifier in the Start menu (under Objectif Lune), or run it from the folder: %programfiles(x86)%\Objectif Lune\CPD\App Changing the UDP communication Port Each OL Connect Send Printer Driver sends its messages to the OLCS Notifier via UDP.
Known Issues Installing OL Connect Send on a machine with Connect installed When OL Connect Send plugins are installed (either via the pre-release of Connect Send or via a Workflow installation) on the same machine as Connect, an interference between OL Connect Send's internal database and that of Connect may occur, causing the browser popup to be blocked. This issue can be fixed by applying a startup wait to the Connect Server Service.
task during the data mapping of the received file. In that case the data will be corrupted and no preview will be shown in the web template. Paper Size vs Printer Page Size It is important to ensure that paper size settings match the printer driver settings. If this is not done, it’s possible that the print job transferred to Connect Send may include some extra white space on the page. In interactive mode, this can be seen, but in non-interactive mode the job will be processed without notification.
License modes OLCS can operate in three different modes but they cannot be mixed on a single Connect system. The three modes are: Basic, User and Click Charge. The Basic, unlicensed mode: l allows non-interactive job submission. l is free to use. l confirms job transmission with a message in the Notification Area (also called the "system tray"). The User and Click Charge modes are licensed modes in which: l l l interactive job submission is possible.
possible. Workflow will not save any information in the database (see "Plugins" on page 38). User mode User mode requires a license for each domain submitting jobs. A domain license can be obtained to allow 10, 25, 50, 100, 200 or unlimited (Enterprise) users to print. Each domain needs its own domain/user license, but multiple domains/users licenses can be added to a single Connect system to allow job submissions from multiple domains.
documents -, the Click Charge license can be used. It allows any number of domains and users to submit jobs into the Connect system, providing credits are available. 1. This mode enables the Printer Driver to request a web page (which could include a preview of the document) from Connect. For each job that is received, the Job Processor plugin records key data in the database. 2. One click equals one page (any size) of the submitted print job.
Scenario 1 OLCS is licensed in Click Charge mode with 10,000 pages. They have already used 9,870 credits, so 130 are left. l l Case 1: A job comes in with 40 pages. This job can be handled in LICENSED mode, so this is a "licensed job". Case 2: A job comes in with 243 pages. This is more than 130. This job is handled in UNLICENSED mode (reduced metadata and no database entries). This is an "unlicensed job". Scenario 2 Perpetual license with domain = "some.phantasy.com" and number of licensed users = 100.
OL Connect Send in Workflow Just as the Printer Driver is an indispensable part of OL Connect Send, OL Connect Send cannot function without its Workflow plugins, embedded in special Workflow processes. These processes take care of the communication with the Connect Send User Guide and they handle the interaction with the user who sends a print job using the Connect Send User Guide. The following topics explain how to configure these processes.
Sample project The Ad Hoc Mail Consolidation sample project may help you understand the Workflow processes for OL Connect Send and configure your own. l l Watch the sample in action on demo.objectiflune.com. Under Ad Hoc Mail Consolidation, click Demo and follow the instructions. (If you have already installed the printer driver, you don't have to do that again.) Add a Connect Send printer with the given settings and print the provided Word file to that printer.
Workflow. This is what the OL Connect Send Get Job Data plugin is made for. For more information, see "Get Job Data plugin" on page 42. l l Each web page served by an interaction process is generated by the Create Web Content plugin. It creates HTML output from a specified web template. That template needs to be created beforehand with Connect Designer and has to be sent to Workflow. (For information about this plugin, see the Workflow Help: Create Web Content.
Plugins Job Processor plugin The Job Processor plugin appears in the plugin Bar area of Workflow under OL Connect Send. The Job Processor plugin is an output plugin that must be added to a Workflow job transfer process that starts with an HTTP Server Input. The Job Processor plugin is the only other task in that process. The action name of the HTTP Input task must match the last part of the URL for print job submission, that has to be set in the printer driver installer (by default: olcs_transfer).
Configuring the plugin To configure the Job Processor plugin, right-click it after adding it to the Workflow process, and click Properties. The color of the property names in the Job Processor Properties dialog indicates that these fields can contain variables.
Workflow variables To facilitate using job related information for the creation of the target folder and file name/s, the Job Processor plugin maps job relevant information to the standard Workflow variables (%1 to %8). The following mappings apply: Information Workflow Variable When licensed When unlicensed Job ID %1 Job ID Job ID License status for this job %2 "Licensed" "Unlicensed" Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No.
Metadata The plugin will create a Workflow metadata file containing basic information about the job. The values originate from the client machine. In unlicensed mode, the user name, machine name and domain/workgroup name will not be available through the metadata. Security In order to provide security when printing over the internet, OL Connect Send includes several protective features. HTTPS Communication The Printer Driver can be set to use HTTPS for any job transfer.
Several database settings can be modified by creating an ini file. This file must be named “OLCSSvc.ini” and stored in the same folder as the executable OLCSSvc.exe, located under “%CommonProgramFiles(x86)%\Objectif Lune\\Plugins\CPD”. By adding the entry “DBPort = ” under [HSQLDBSETTINGS] and then restarting the service, the communication port is changed. Note: Workflow has to be restarted after such a modification.
Typically, it is used in the interaction process just after the initial HTTP Server Input plugin. The Get Job Data plugin gets all relevant information for the dedicated print job using the Unique Job ID. Unique Job ID: Whenever an OLCS Printer Driver is sending a print job to the OLCS plugin, it creates a unique ID string composed from 10 upper- and lowercase letters and digits e.g. “ri0zZdluLp”.
Note The Get Job Data plugin gets data from the OLCS database which means it only works when Connect is in LICENSED mode. The plugin Settings To configure the plugin, right-click it after adding it to the Workflow process, and click Properties.
General Tab Three different settings affect the general behavior of the plugin: Page 45
l Where to get the Print Job ID. l When to continue with the next step. l Where to store the job information details. Select Job ID Source The plugin can be used in a generic way. Whenever information about a specific print job is required, it can be retrieved as long as the related job ID is known. However, the plugin has been implemented so that it can also be used in the “OLCS_Interaction” process. It can get the job ID from the incoming data of the HTTP Server Input plugin.
Select Output Type l l XML Data to Workflow. This will result in an XML file containing all job related data becoming the new Workflow job file. In this case, the incoming data file of the HTTP Server Input plugin is overwritten and lost. Write to Variables. This allows print job information to be stored in Workflow variables by using a simple drop-down list. In this case, the HTTP Server Input data will be kept as Workflow job file.
some applications do an implicit reformatting of jobs if the intended paper size does not match the paper size as selected in the print dialog. This may lead to the fact that the number of pages, as calculated by the spooler and reported by OLCS, can differ from that value as shown to the user in the application itself. User name: This is the Windows user name of the user who started the application to produce the print job.
Get Data plugin This plugin allows OL Connect Send (OLCS) users (admins, accounting personnel, print masters ...) to get information about all jobs received with OLCS on a dedicated machine. It allows queries of the OLCS Database to be made for the production of reports. All job info that could be retrieved will be written to a temporary results file that is then passed on as the new Workflow job file. It can be used right after the Get Job data plugin in the same Workflow configuration.
General Tab Filter Options Filters are required for: l Start and end date (down to minutes). l Domain(s) l User(s) l Machine name(s). Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names. Tip No spaces are allowed around the listed names resp. before or after a semicolon. Example 1 A valid user name search string would be: %\{global.
Example 2 Domain name is defined as {{objmtl.objectiflune.com}} and user name as {{rentel}}, then the result will only contain all the print job information for objmtl.objectiflune.com where the user name is "rentel". Date and Time Definitions Both date and time entries must be notated in UTC format. During runtime, the dates are checked and, if any other date/time notation is used, a Workflow error log entry is created. UTC notation is described here: https://www.cl.cam.ac.uk/~mgk25/iso-time.html.
l Job UID l Date/Time stamp l Number of copies l Number of pages l User name l Original file name l Original file size l Domain (workgroup) name l Domain / Workgroup Indicator l Machine name l Machine GUID. Results File Format The following result file formats are selectable: l XML l JSON l CSV (Separator = semicolon (0x3B), string indicator = quote (0x22)). Note This file is not automatically saved to disk.
l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the Printer Driver as well as by the OLCS main plugin. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
l l l Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. Machine name: The name of the machine the Printer Driver is running on as retrieved by the respective Windows API.
Using the Printer Driver The OL Connect Printer Driver can be used like any physical printer. Just go through the usual steps: 1. Click the Print button (or use the menu from the software used). The Print dialog appears. 2. In the Print dialog, select a printer that works with the OL Connect Send printer driver and click OK.
The OL Connect Send Printer generates a local PostScript file. This data is zipped and sent in one or multiple chunks to the Workflow server. Depending how the environment has been setup, information is sent using the HTTP or HTTPS protocol. As part of the process, the license is verified and, on a successful handshake and in interactive mode, the browser on the customer’s machine is launched showing the interactive web page defined in the installation process.
Log files Workflow log files The OL Connect Send Workflow plugins write to the Workflow log file. Its location can be found in the Workflow Help (see help.objectiflune.com). Printer log files Each OL Connect Send printer logs its messages in a daily log file. The log files are located under %ProgramData%\Objectif Lune\CPD\Log\ on the machine/s on which the Printer Driver has been installed.
On the first line of this CSV file are its column headers: {{Date;Time;Printer;Job ID;Document Path;Document Name;Pages;Chunks;Chunk No;Status;Mode;User;Target}} The separator character is the semicolon (0x3B). Each following line is one log entry. The file can be loaded with e.g. Excel and filtered, ordered, sorted and modified as desired.
l Printer name l Job ID l l Document path as can be retrieved from the spooler information. Please be aware that some applications suppress this information. Document name as can be retrieved from the spooler information. Please be aware that some applications modify, mix up, enhance or truncate this information. l Number of pages l Number of chunks l Chunk number = number of the currently transferred chunk l Job transfer status.
Troubleshooting There are some known issues that can be encountered when using Connect Send, depending on the way OL Connect Send is installed, configured or used; see "Known Issues" on page 29. If another issue occurs and you find that you cannot solve the issue, there are a few things to check. 1. Switch the OL Connect Send Printer Driver logging to DEBUG. This can be done by modifying the OL Connect Send Printer Driver; see Installing OL Connect Send Printer Driver.
c. Remove the existing OLConnect1.OLConnectLicense from %ProgramData%\Objectif Lune\OL Connect\licenses. d. Put the new license at that location. e. Restart any Connect services you stopped. You may notice that removing the existing license may be forbidden and you need to allow it explicitly. It may even be that you need to log on as an administrator to delete the file. Note This is not an issue with OLCS, but with the Connect and/or Workflow version and under which user it has been installed.
