Canto RoboFlow : Installing
   
Installing
Canto provides an installer application which guides you through the installation process. After you have installed RoboFlow, you must activate it via the Remote Admin module of the Server Console.
Canto RoboFlow consists of the RoboFlow PlugIn for the Cumulus Web Server Console, the RoboFlow Server Application and the RoboFlow Trigger ESP.
The RoboFlow Server Application has to be installed on the computer that you want to perform the tasks on. This can be any computer with TCP/IP network access to the Cumulus Server. It is a Cumulus Java Classes application that communicates with the Cumulus Server just like a Cumulus Client does. The system requirements are the same as for Cumulus Java Classes.
If RoboFlow is expected to do a lot of cataloging or other processor intensive tasks, it is recommended not to install RoboFlow Server Application on the computer running the Cumulus Server.
If one of the tasks performed by the RoboFlow Server Application requires certain software to be installed (e.g. a Cumulus or third-party option), this software must be installed on the computer running the RoboFlow Server Application.
NOTE: The RoboFlow Trigger ESP will only be available after restarting the Cumulus Server. This means that you should restart the Cumulus Server after installing RoboFlow if you are going to set up workflows employing any trigger actions.
The installation differs depending on the operating system.
Installing under Windows or macOS
If RoboFlow is expected to do a lot of cataloging or other processor intensive tasks, it is recommended not to install it on the computer running the Cumulus Server.
To install RoboFlow Server Application under Windows or macOS:
 
1.   Log on to the local machine as the Administrator for the machine.
  Log on to local machine.
2.   Double-click Install_Canto_RoboFlow_11xx.exe.
 Double-click Install Canto RoboFlow 11xx and authenticate yourself as an administrator.
NOTE:   Java Required for Running Installer!
If no Java is pre-installed, macOS may ask you to install Java for running the installer. After the installation the bundled JRE will be used with all our products.
The installation resources are extracted and you are asked to select a language. This language is used for the installation process as well as for the application being installed.
3. Select a language and click OK. The installer is launched.    
4. When the Introduction screen is displayed, click Next to continue. The software license agreement is displayed.
5. Read the displayed license agreement and activate the I accept the terms of the License Agreement option.
6. Click Next to continue. The Choose Install Folder dialog opens.  
7. To accept the default installation location, click Next to continue. Or, if you do not want to accept the default location, click Choose to choose a different location. The Browse For Folder window opens. Select the folder of your choice and click OK to return to the previous window. Then click Next to continue.
The Choose Install Features window opens.  
8. Choose the features you want to install:
Canto RoboFlow – installs the RoboFlow Server Application.
Cumulus Server PlugIn – installs the module that enables RoboFlow to communicate with the Cumulus Server.
9. Click Next to continue.
The Choose Cumulus Server window is displayed.
10. To accept the default, click Next to continue. Or, if you do not want the default or if the Cumulus Server is running on another machine, click Choose to choose a different location. The Browse For Folder window opens. Select the folder where the Cumulus Server resides and click OK to return to the previous window. Then click Next to continue.
The Pre-Installation Summary is displayed.
11. Click Install to start the installation. The installer begins copying files.
12. When the installation is finished, the Install Complete window is displayed. Click Done to end the installation and close the window.
Important: Configure a Daily Restart of the Service
In order to work properly, the RoboFlow service must be restarted on a regular schedule, e.g. daily. This can be achieved by creating a Windows Scheduler tasks that executes the RoboFlowRestartService.bat script (located in the Canto RoboFlow installation folder) every night.
Installing under Linux
With UNIX versions, a CONSOLE mode installation is provided. It guides you through all steps necessary to install Canto RoboFlow. To accept the default values [shown in square brackets] press the Enter key.
To install the RoboFlow Server Application under Linux:
 
1. Open a UNIX shell and change your identity to superuser (enter su for super user and then the password.) The CONSOLE mode installation is started manually by typing the script name at the command prompt.
2. Start the CONSOLE mode installation by entering:
sh CantoRoboFlow1100.bin
3. When the Introduction is displayed, press the Enter key to continue. The software license agreement is displayed.
4. Read the displayed license agreement and enter y to accept.
The default installation location is displayed.
5. To accept the default installation location, press the Enter key to continue. Or, if you do not want to accept the default location, enter the absolute path for the desired installation folder and press Enter to continue.
The Pre-Installation Summary is displayed.
6. Press Enter to start the installation.
The installer begins copying files. When the installation is complete, the Install Complete information is displayed.
7. Press Enter to end the installation and exit.
Important: Configure a Daily Restart
In order to work properly, the RoboFlow daemon must be restarted on a regular schedule, e.g. daily. This can be achieved by creating e.g. a crontab that executes the RoboFlowRestartService.sh script (located in the Canto RoboFlow installation folder) every night.
TIP: Cataloging Office Documents
In order to generate high-quality previews and thumbnails when cataloging RTF files or MS Office, Open Office, Open Document files and templates, RoboFlow needs LibreOffice to be installed on the same machine. For details Support for Office Formats: LibreOffice
Activating
Canto RoboFlow is activated as any other newly purchased Cumulus option via the Remote Admin module of the Server Console. For details see Activation.
Running the RoboFlow Server Application as a Service
The (Domain) user running the service or daemon should have all the necessary permissions to the network and other resources such as mail, as required by the workflows.
For installing the RoboFlow Server Application as a service, Canto provides following scripts:
For macOS and Linux: InstallCantoRoboFlowService.sh
NOTE:   With the installation of RoboFlow the Server Application automatically registers as a service.
For Windows: InstallCantoRoboFlow.bat
Scripts can be found in the Canto RoboFlow installation folder, e.g. C:\Program Files\Canto\Canto RoboFlow