Installation Guide Version 1.
Connect Send Installation Guide 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 System Requirements .................................................................................. 1 Plug-In ............................................................................................................................. 1 Printer Driver .................................................................................................................. 1 HTTP ....................................................................................................................
Overview ....................................................................................................................... 24 The Plug-In Settings ...................................................................................................... 25 OL Connect Send Get Data Plug-In ............................................................. 29 General Tab ................................................................................................................... 29 On Error Tab ..........
System Requirements Plug-In The OL Connect Send (OLCS) Plug-In is designed to work with the workflow module (Workflow) of PlanetPress Connect and PReS Connect (Connect) which means it will run on any operating system by those products. Printer Driver The OLCS Printer Driver is compatible with 32 and 64 bit versions of Windows 7, 8.0, 8.1 and 10. HTTP Communications between the Printer Driver and the Plug-In is achieved using HTTP.
Overview OLCS is an application with two components. The first is a Windows printer driver and the second includes a set of Workflow plug-ins. These two components work together – they cannot be used on their own. OLCS 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. Unlicensed mode (default) allows users to push documents to OL Connect Send.
Installing OL Connect Send Printer Driver Setup Process – New Installation The following section describes the installation process for the OLCS Printer Driver Note If the Taskbar Notifier is left running on a machine the installer cannot be (re-) started. An error message will be displayed by Windows. The Taskbar Notifier must be closed before switching to a different user account on the same machine, unless the current user is still logged in. 1.
If Workflow is active, the Test button can be used to validate the connection. (It does not check if the OLCS plug-in is installed and answering.) If the No interaction checkbox is enabled, it will cause this printer to send jobs to the server without requesting an HTML response. Use this mode to deliver print jobs without further interaction. When enabled, a web browser window will not be opened, but SysTray messages will pop up indicating job transmission success or failure.
Page 5
3. 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 The setup program will check if a printer with the same name and number already exists. If so, the number is automatically increased until no matching printer name is detected. This then becomes the proposed printer name in this dialog. As opposed to the other settings, the printer name can’t be changed after installation.
4. Communication Settings The next screen contains communication settings. In order to deliver jobs to Workflow, an HTTP Action name for print job submission needs to be setup. If OLCS is licensed and/or interactive mode is enabled (or required), then an HTTP Action name for subsequent interaction is required. The names of these HTTP action can be changed, but they must match the relevant Workflow settings. When done click Next to continue. 5.
Once a printer driver is installed, a SysTray application is also installed. It displays information relating to the preparation and transfer of each print job. Modifying an Existing Installation 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.
Adding a New Printer Allows you to create a new OLCS printer. The wizard pages 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.
Removing the Printer Driver Depending on the number of OLCS printers installed, you will either get a selection box to identify which printer to remove, or you can just delete the only one. Shared Printers The OLCS Printer Driver is not a shareable driver. This is because the browser interaction cannot be routed through the print server to the end user's desktop. Also a shared printer would transfer the print server's machine name, user name, domain etc.., thus invalidating the intended behavior.
Page 11
Installing OL Connect Send Plug-Ins Overview The OL Connect Send Plug-In installer adds three Connect Send plug-ins and one Connect plug-in to Workflow: OL Connect Send OL Connect Send Job Info OL Connect Send Get data Create Preview PDF. The OL Connect Send plug-in is an output plug-in that must be added to a job transfer process. OL Connect Send Job Info and Create Preview PDF can be used in an interactive process that may be started when a job has been received.
c. Select OL Connect Send Plug-in and click Uninstall: d. Do the same (previous step) for OL Connect Send Printer Driver 3- Proceed with the Connect 1.6 upgrade IMPORTANT Installing the OLCS Plug-In from a shared drive on Windows 10 will fail. This is an issue of the underlying msi and can currently not be fixed. It is therefore recommended to copy the setup file to a local folder on Windows 10 and run the setup from there.
When starting the OLCS Plug-In Setup, this first screen appears, containing basic information. Click Next to proceed. The next page shows the EULA. Please read and accept it and proceed by clicking on Next. The next page will ask you to continue by clicking on Install. A progress bar is shown, while the installation process is running. After the successful installation the finish dialog is shown. Click Finish.
In Connect 1.6 (Workflow 8.6) the three Connect Send plug-ins will be installed in Workflow in the Connect Send tab. The Create Preview PDF plug-in will be added to the Connect tab. Re-installing Plug-Ins When installing OLCS plug-ins version 1.0.5.44 or higher on a machine, where OLCS plugins version 1.0.5.43 or lower are installed, a proper uninstall of the existing OLCS plug-ins has to be done before starting the installation of the new plug-ins. Otherwise the new setup will not work properly.
OL Connect Send Plug-In The OL Connect Send plug-in appears in the Plug-In Bar area of Workflow under Uncategorized. The OL Connect Send plug-in is an output plug-in that must be added to a Workflow job transfer process that starts with an HTTP Server Input. It is recommended to add a Change Emulation task before the OLCS Plug-in to guarantee accurate incoming data recognition. The OLCS plug-in is the last task in the process.
The color of the property names in the OL Connect Send 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 OLCS plug-in maps job relevant information to the standard Workflow variables (%1 to %8).
No. of Pages 1 %5 Number of pages of the job Number of pages of the job No. of Copies 1 %6 Number of copies set by the user Number of copies set by the user Domain Name 1 %7 The Domain Name "na" Machine Name 1 %8 The Machine Name "na" 1) These values originate from the Printer Driver machine. The variables can and should be used to create dynamic file and folder names for each print job.
11. The Printer Driver (if licensed and interactive) will launch a browser window and send an HTTP request to Workflow. The result of the receiving interactive process will be displayed in the browser. If the plug-in is not licensed, 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 SysTray. License Modes OLCS can operate in three different modes but they cannot be mixed on a single Connect system.
If one is not available, it will still be accepted, but only in unlicensed mode. The client will get a message indicating that the job was received in unlicensed mode. No page count checking is done for this mode. Click Charge Mode Where the domain & number of users is unknown at the point of sales – for example a public service driven by users creating their own accounts via the web for onboarding documents, the click charge license can be used.
Scenario 2 Perpetual license with domain = "some.phantasy.com" and number of licensed users = 100. Case 1: A job comes in from the domain “some.phantasy.com” and from a machine named "KATERKARLO". The domain is right and this is the first job, so KATERKARLO is added to the UUSI and handled in LICENSED mode. Case 2: Meanwhile many, many users have printed from that domain, so all 100 UUSI’s (Unique User Slot Identifiers) are full (100 different machine names are in the list).
Communication between the plug-in and the database occurs using port 9001 (the default port for HSQLDB). However, there may be situations where this port is already blocked by another application and may need to be changed. 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”.
OLCS Plug-In and Printer Driver on the same machine When running the printer driver and plug-in on the same machine the host name must be “127.0.0.1” instead of “localhost”, otherwise the communication between the two won’t work. Plug-In's temp folders not removed when file transfer is complete When a file is sent to the server after the transfer is complete, the clean-up routine does not remove the folder leaving an empty folder on disk.
OL Connect Send Job Information Plug-In Overview Creating an interactive process for incoming print jobs using OLCS requires that the relevant information about the respective job is available and can be used in Workflow. Job Information retrieval is made easy with the OLCS Job Info plug-in. It is installed along with the OLCS plug-in and appears besides it in the Plug-In Bar area of Workflow under Uncategorized.
The Plug-In Settings To configure the plug-in, right-click it after adding it to the Workflow process, and click Properties.
Select Job ID Source The plug-in 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 plug-in 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 plug-in.
Database Tab Please refer to the Database Connection section in the OL Connect Send Job Information plug-in chapter. On Error Tab Please refer to the Using the On Error tab paragraph from the Workflow documentation. Comments Tab Please refer to the Comments tab paragraph from the Workflow documentation. Returned Information For each job received by the main OLCS plug-in the following values will be available.
Page 28 add info to the name (like Notepad++) while others don’t (like Adobe Reader). OLCS can only use what it gets from the spooler. It does not interact with the applications itself. Original file size: The size of the print job - NOT the size of the document file. Domain (workgroup) name: The name of the domain or workgroup the printing user belongs to. This is not necessarily the name of the domain the machine itself belongs to.
OL Connect Send Get Data Plug-In General Tab This plug-in allows OLCS users (admins, accounting personnel, print masters ...) to get info 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 Job Info plug-in in the same Workflow configuration.
Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: Workflow variables Job variables Names. Important hint: No spaces are allowed around the listed names resp. before or after a semicolon. Example A valid user name search string would be: %\{global.
Searches with entries in different criteria: AND Results For each job that matches the search criteria, the following information will be put in the resulting data file: Job UID Date/Time stamp Number of copies Number of pages User name Original file name Original file size Domain (workgroup) name Domain / Workgroup Indicator Machine name Machine GUID Results File Format The following result file formats are selectable: 1. XML 2. JSON 3. CSV.
Number of pages: This is the number of pages for one copy of the print job. This value is calculated by the Windows spooler, when processing the printing order. Please be aware that 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.
Create Preview PDF Plug-In Overview The Create Preview PDF was created to generate a PDF preview for a single record as fast as possible. This preview is typically used for previews embedded in web pages. The process does not involve the Output Engine and therefore the result does not have output optimizations applied. Omitting this optimization step scrapes of another few milliseconds in the rendering process resulting in even faster PDF creation times.
Standard Data mapping configuration option as seen in the All in One plugin. JSON string Alternatively, one could set the data source to the JSON string option. In web environments, it is common to send and retrieve data from a server using an AJAX request (typically invoke from within JavaScript). In this scenario, the data is often exchanged in JSON format. JSON is short for JavaScript Object Notation. It is a way to store information in a structured and easy to read format.
"documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jobid}')" } An example where the entire JSON string is provided in Job Info 1: %1 Constructing the JSON string by retrieving information from a XML job data file.
Troubleshooting If you find that you cannot solve an issue here are a few things to check. 1. Check if the OLCS Database service is running on the machine where you have installed Workflow and the plug-in. The service is called OL Connect Send DBServer. Make sure that the service is running. If not, uninstall and then reinstall the OLCS plug-in. After reinstallation, make sure that the service is running. 2. Switch OLCS printer driver logging to “DEBUG”.
Important: This is not an issue with OLCS, but with the Connect and/or Workflow version and under which user it has been installed. This issue will occur with any license activation on such machines. If none of the above mentioned should help, then collect all relevant information before contacting support or dev: The OLCS Printer Driver log files (located under “%ProgramData%\Objectif Lune\CPD\Log\” on that machine/s, where the Printer Driver has been installed) The OLCS plug-in log
Click Charge License Renewal This chapter deals with such cases and scenarios which require a Workflow license renewal and what must be taken care of if this license contains an OLCS Click Charge license. Current license: This is the existing license which needs to be renewed and/or replaced with a new one. This current license file will or has already become invalid due to one of the scenarios outlined below.
In this case, there is no chance at all to recover the OLCS DB nor the secret file. The account manager for this customer must therefore clarify the amount of OLCS pages to be activated for this customer. Moving the OLCS Database All OLCS DB files are located under: %ProgramData%\Objectif Lune\CPD All files have a name following the pattern “OLCSDB*.*” (The OLCSDB.log file can be deleted before the move/copy action). Before copying the files, all related applications and services need to be stopped: 1. 2.
