Notify Addon Setup Guide

1 Notify Addon Setup Guide

1.1 Overview

The TotalFlow BatchBuilder Notify Addon is a Windows Service Application that automatically notifies the TotalFlow BatchBuilder system when a job has been printed on an supported printer. If a job from a TotalFlow BatchBuilder output hot folder is printed on a supported printer, the Notify Addon application updates the system job status to Printed .

The TotalFlow BatchBuilder Notify Addon application is a separate feature. To use the TotalFlow BatchBuilder Notify Addon feature after the trial version of the product has expired, you must purchase a separate license.

The TotalFlow BatchBuilder Notify Addon feature is installed separately and you can configure it to be used with multiple printers. When a job has been printed on a supported printer, the TotalFlow BatchBuilder Notify Addon sends a notification to the TotalFlow BatchBuilder system and the job is marked as Printed .

You can use the TotalFlow BatchBuilder Notify Addon with printers that support XML and SNMP protocols, as well as with InfoPrint 5000 printers. Custom Add-ons are also available with professional services.

1.2 Installing and Configuring

1.2.1 Installing the TotalFlow BatchBuilder Notify Addon

To install TotalFlow BatchBuilder Notify Addon:

  1. Log in to Windows as an administrator.
  2. Insert the TotalFlow BatchBuilder installation media in the drive.
  3. Go to the Setup folder on the installation disk and run setup_NotifyAddon_x64.exe on the 64–bit system.

    Select the installation language and click OK .

    The Introduction dialog is displayed.

  4. Click Next .

    The License Agreement dialog is displayed.

  5. In the License Agreement dialog:
    1. Read the license agreement.
    2. Click I accept the terms of the License Agreement.
    3. Click Next .

    The Choose install folder dialog is displayed.

  6. In the Choose install folder dialog:

    If you accept the default installation folder and it does not exist, the installer creates it.

    To change the default installation folder, click Choose. Navigate to the folder where you want to install TotalFlow BatchBuilder Notify Addon and click OK .

    If you want to restore the default installation folder, click Restore Default Folder.

    Make sure that the install path for TotalFlow BatchBuilder Notify Addon contains only characters from the same code page as the operating system.

    Click Next .

    The Choose shortcut folder dialog is displayed.

  7. Select where you want to create the product icons:
    In a new Program Group
    You can edit the name of the new program group.
    In an existing Program Group
    Select the program group from the list.
    In the Start Menu
    Select this option if you want to place a shortcut icon in the Start Menu.
    On the Desktop
    Select this option if you want to place a shortcut icon on the Desktop.
    In the Quick Launch Bar
    Select this option if you want to place a shortcut icon in the Quick Launch Bar.
    Other
    Type in the folder path where you want to place the shortcut icon or click Choose and manually select a folder.
    Do not create icons
    Select this option if you do not want to create any shortcut icons.
    Note: If you want to create icons for all the users, click the Create Icons for All Users checkbox.

    Click Next .

    The Pre-installation summary dialog is displayed.

  8. Review the information in the Pre-installation summary dialog and click Install.

    The TotalFlow BatchBuilder Notify Addon software is installed.

  9. The Install complete dialog displays the installation report. Click Done to finish the installation procedure of TotalFlow BatchBuilder Notify Addon.
  10. Configure the TotalFlow BatchBuilder Notify Addon. See Configuring the TotalFlow BatchBuilder Notify Addon.
  11. Start the TotalFlow BatchBuilder Notify Addon service.

Note: To apply the changes made in the configuration settings, you must restart the TotalFlow BatchBuilder Notify Addon services.

1.2.2 Configuring the TotalFlow BatchBuilder Notify Addon

To configure the TotalFlow BatchBuilder Notify Addon you must edit the config.ini configuration file.

Log in to Windows and go to Start All Programs RICOH TotalFlow BatchBuilder Notify Addon . Click Open Config File to open the configuration file.

You can edit the config.ini configuration file:

[General]
pluginsPath=<installationDirectory>/plugins
dataRetention=30

[Subscriber]
url=http://server.address:port/BatchBuilder/externalApi

[Device]
name=example-XML-printer
actionName=markJobAsPrinted
plugin=XML
xsl=<filepath>
pollingInterval=20
location=<filepath>

[Device]
name=example-Infoprint-printer
actionName=markJobAsPrinted
plugin=INFOPRINT5000
address=<hostname>
pollingInterval=10

[Device]
name=example-Ricoh-SNMP-printer
actionName=markJobAsPrinted
plugin=SNMP
address=<hostname>
pollingInterval=10
readCommunityName=public

General section
You can specify a value for dataRetention to set the number of retention days. The pluginsPath specifies the location of the plug-ins on the disk.
Subscriber section
You can specify the URL for the TotalFlow BatchBuilder system where server.adress is the host name or IP address of the computer where TotalFlow BatchBuilder is installed.
If you want to use the TotalFlow BatchBuilder Notify Addon with multiple TotalFlow BatchBuilder clients, you can add a new Subscriber section and specify one URL for each machine where TotalFlow BatchBuilder is installed. TotalFlow BatchBuilder Notify Addon and TotalFlow BatchBuilder must have the same the same version.
Device section
You can configure the printer you want to collect information from. Specify the printer unique name and the plug-in file type.

There are three available plug-in file types:

  1. The specified default plug-in type is XML. This plug-in type is used with printers that generate XML files after printing.

    This type of printer creates a separate XML file for each job printed. You can configure the Notify Addon application to save the printer created XML files and place them in a hot folder. Set a path for the location of the hot folder and a time interval you want the TotalFlow BatchBuilder Notify Addon to scan the hot folder for new XML files.

    You can also specify a file path for an XSL file. The XSL file is used to transform the XML file from the printer to a different XML file format that can be processed by the TotalFlow BatchBuilder system based on an existing .XSD schema file. When the notification is received, the corresponding job is marked as Printed in the TotalFlow BatchBuilder subscribed systems.

  2. The SNMP plug-in type is used with printer models that support communication through RICOH Job MIB over SNMP. If you set the polling interval, the TotalFlow BatchBuilder Notify Addon feature checks the printer status and the printer job list. When a job is printed the Notify Addon sends a notification through the SNMP protocol to the TotalFlow BatchBuilder system and the corresponding job is marked as Printed in the TotalFlow BatchBuilder subscribed systems.
  3. The InfoPrint5000 plug-in type is used with the InfoPrint 5000 printer model. The Notify Addon verifies printer events in the printer job log. When a job is printed, the information is written in the job log and the Notify Addon sends a notification to TotalFlow BatchBuilder through an Infoprint private communication protocol. The job is marked as Printed in the TotalFlow BatchBuilder subscribed systems.

The address specifies the IP or host address of the print system.
Important: The TotalFlow BatchBuilder Notify Addon allows you to configure more than one printer by adding a new [Device] section in the config.ini configuration file for each printer.

1.2.3 Configuring TotalFlow BatchBuilder Notify Addon to use HTTPS protocol

Ricoh TotalFlow BatchBuilder provides support for using the HTTPS security protocol. The HTTPS protocol facilitates secure network communication by establishing an encrypted link between the server and the web browser user interface and ensures the privacy and integrity of all transmitted data. To allow communication with a TotalFlow BatchBuilder system that uses the HTTPS security protocol, you must configure TotalFlow BatchBuilder Notify Addon to use the HTTPS security protocol.

This is the procedure for enabling HTTPS on Windows 10. There might be minor differences in other versions of Windows.

If you changed the default installation path, make sure that you replace C:\Program Files\RICOH\TotalFlow BatchBuilder - NotifyAddon\ with the path where TotalFlow BatchBuilder Notify Addon is installed everywhere in the procedure.

To enable HTTPS, you need to import the digital certificate created for the TotalFlow BatchBuilder subscriber.

  1. Obtain the digital certificate and store it in C:\Program Files\RICOH\TotalFlow BatchBuilder - NotifyAddon\jre\bin on the computer where TotalFlow BatchBuilder Notify Addon is installed.
  2. On the computer where Ricoh TotalFlow BatchBuilder Notify Addon is installed, open a Command Prompt window as an administrator. Go to the folder that contains the Java keytool, using this command:
    cd "C:\Program Files\RICOH\TotalFlow BatchBuilder - NotifyAddon\jre\bin"
  3. To import the generated keystore file into Java security certificate run this command:
    keytool -import -alias selfsigned -keystore "C:\Program Files\RICOH\TotalFlow BatchBuilder - NotifyAddon\jre\lib\security\cacerts" -storepass "changeit" -file "C:\Program Files\RICOH\TotalFlow BatchBuilder - NotifyAddon\jre\bin\selfsigned.crt"

    where selfsigned.crt is the name of the certificate file.

  4. Configure the config.ini file
    1. Modify the C:\Program Files\RICOH\TotalFlow BatchBuilder - NotifyAddon\config.ini file as follows:
      In the url field under Subscriber section inside config.ini
      1. In the web address line, replace value http with https
      2. In the web address line, replace value 19080 with 19443
  5. Restart the TotalFlow BatchBuilder Notify Addon service.

Make sure that you repeat the procedure for enabling HTTPS whenever the certificate is about to expire. You must also repeat this procedure each time you run the installation process to reinstall, upgrade, or repair TotalFlow BatchBuilder Notify Addon.

    Note:
  • When users access the system, they are redirected to the secure protocol without having to take any action themselves. However, if you use a self-signed certificate or if the certificate is not specifically tied to the server, the web browser issues a warning that the certificate is not trusted.