tFLOW Documentation - 09b. tBot Guideline

tFLOW > tFLOW Documentation

tBot Guideline

Table of contents

Overview    3

How to install    3

How to update    3

User interface    3

Instance name    4

Settings    4

Import/Export Configuration    4

Set instance name    6

Configure notifications    6

Log    7

Profiles    7

Help    8

Send to support    8

Queues list    8

How to add new Queue    8

How to edit Queues    9

How to remove Queues    9

How to copy Queues    9

Process list    10

How to filter processes by status    10

How to see processes from different queues    10

How to restart processes    11

How to force complete batch processes    11

Actions    12

Download Action    12

How to connect tBot to tFlow    12

How to connect tBot to FTP server    15

How to config tBot batches    15

How to config Fill flat trigger for batch    16

How to config Time trigger for batch    16

How to config Job count trigger for batch    16

tBot integrations with third parties    17

Move Action    17

Copy Action    18

Delete Action    19

Upload Action    20

How to connect tBot to tFlow    20

How to connect tBot to FTP server    23

Configure source folder    23

Configure upload parameters    24

Print Action    24

Transfer Action    24

Sender instance    25

Receiver instance    25

Configure Rules and Options    26

Adding Name Settings    26

Replace Text Settings    27

Date or Time Settings    27

Make Sequential Settings    28

Job Settings    30

Integrations    31

How to config Impostrip integration    31

How to config Insoft Imposition integration    33

How to config Nexio and NetSuite integration    35

Primary Functionality    35

Objective/Key Benefits    35

Caldera connection requirements    35

tFLOW connection requirements    35

Benefits    35

Limitations    35

Nexio configuration    35

tBot configuration    36

How to config Ergosoft integration    39

How to config Compose integration    40

How to config Zund integration    42

How to config Phoenix Imposition integration    44

Configure Phoenix    44

Configure tBot    45

How to config Griffin integration    46

 

Overview

 tBot is a special tool for automation of downloading, renaming, and routing files. Additionally, tBot allows connections to other production tools and provides seamless integration with existing workflows.

How to install

  1. Download last installer version from http://support.aleyant.com/kb/a1048/tbot-installer.aspx

  2. Extract installer from zip-file and run it.

  3. Run tBot from Desktop:

  1. On first run you should enter instance name:

How to update

There are two ways to update tBot:

  1. Download last installer version from http://support.aleyant.com/kb/a1048/tbot-installer.aspx

  2. Click “Update tBot”:

C:\Users\DrozdovVA\Desktop\3.png

  1. Run tBot from Desktop:

  1. These notifications means that new version of tBot is available:

User interface

tBot main screen contains from 5 main zones:

  1. Instance name

  2. Version number

  3. tBot tools and settings

  4. Queue list and settings

  5. Work area with list of files and their statuses

Instance name

 

Instance name used to identify tBot queues in tFlow production queues list.

C:\Users\DrozdovVA\Desktop\3.png

Settings

C:\Users\DrozdovVA\Desktop\3.png

Import/Export Configuration

tBot provides interface to transfer configuration between instances.

To export current configuration or part of it you should make steps below:C:\Users\DrozdovVA\Desktop\3.png

  1. Click “Settings” -> “Export”

  2. Select queues to export

  3. Edit queue properties before export (changes will not affect for current configuration)

  4. Click “Export” and choose file name for configuration file

  5. Default name for file is configuration.xml.

 

To import configuration or part of it from configuration file you should make steps below:

  1. Click “Settings” -> “Import”

  2. Choose path to configuration file

  3. Select queues to import. They could be of three types:

    1. “New” – this queue do not present in current configuration

    2. “Equal” – this queue exist and has the same settings for all parameters.

    3. “Error” – this queue exist, but some settings are different. You could compare new parameters (left side) and current parameters (right side) and edit configuration before import.

  4. Click “Import”,  queues will be imported to configuration.C:\Users\DrozdovVA\Desktop\3.png

Set instance name

To change tBot instance name you should make steps below:

  1. Click “Settings”-> “Set instance name”

  2. Enter new instance name

  3. Click “Save”

  4. Instance name in tFlow will be updated on next request to server (Check interval value for Download action)

Configure notifications

tBot can send an email notification if error occurred in process. To configure notifications you should make steps below:

  1. Click “Settings”-> “Configure notifications”

  2. Enter valid email on which tBot will send notification.

  3. Edit Subject and body if you want to receive some special information.

  4. You could set custom values for smtp server. Make steps below to change default smtp server (for default tBot uses smtp.gmail.com:587)

    1. Open config file (default location: c:\Program Files (x86)\Turbot\TurbotService.exe.config) in text editor.

    2. Edit “TurbotService.Properties.Settings” section:

C:\Users\DrozdovVA\Desktop\3.png

  1. Click “Send test message” to check configuration and send message

  2. Click “Save” to save notifications configuration

Log

On log screen you could find information messages about tBot activities and errors description

If you need to save log, you will need to do:

:

 

Profiles

tBot able to make integration between third party systems. This integrations based on integration profiles. To manage integration profiles you should make steps below:

  1. Click “Profiles” button on main screenC:\Users\DrozdovVA\Desktop\3.png

  2. Select profile from list or create new one

  3. Select source and destinations systems

  4. Fill parameters for destination system connection. For source system connection system will be configured in related queue action

  5. Fill mappings between source system fields and destination system fields

  6. Click “Save” to confirm changes

Help

Send to support

If you have any problems with tBot work or configuration, you could contact support via special form in application. tBot will send an email with technical information to support. To send the email you should follow the steps below:

  1. Click on “Help” -> “Send to support”

C:\Users\DrozdovVA\Desktop\3.png

  1. Fill all fields on form:

    1. “Client” – Fill information about your company and contact information for feedback: phone or email

    2. “Subject” - Shortly describe your problem

    3. “Body” – Give us some details: When problem occurs, what actions you made

  2. Click “Send” button

 

Queues list

How to add new Queue

  1. Click “Add” button on main screen

  1. Give name to new queue

  2. Add some actions to queue and configure them

  3. Click “Save” button

C:\Users\DrozdovVA\Desktop\3.png

How to edit Queues

  1. Click “Actions” button on Queue in list

  1. Select “Edit”

  2. You can edit any setting on new screen

C:\Users\DrozdovVA\Desktop\3.png

 

How to remove Queues

  1. Click “Actions” button on Queue in list

  1. Select “Delete”

  2. Confirm action or not

 

How to copy Queues

  1. Click “Actions” button on Queue in list

  1. Select “Duplicate”

  2. Change queue name

Process list

This section provides information about all processes in tBot, their statuses and results.

How to filter processes by status

Select “All” tab to see all process or select specific status to filter process by it.

C:\Users\DrozdovVA\Desktop\3.png

 

How to see processes from different queues

Collapse queues list to see processes from all queues, otherwise processes will be shown only for selected queue.C:\Users\DrozdovVA\Desktop\3.png

 

How to restart processes

  1. Select a process from list

  2. Click right-click mouse on it

  3. Select “Restart process” from context menu

 

How to force complete batch processes

  1. Select a process from list

  2. Click right-click mouse on it

  3. Select “Force batch to complete” from context menu

  4. All files in batch will be processed

Actions

Download Action

Action can be two types:

  1. tFlow (tBot is connecting to tFlow via http and is using the tFlow API to connect, publish the queues and exchange data)

  2. FTP (tBot can be used as FTP client to manage remote files)

How to connect tBot to tFlow

  1. Create a service user in tFlow

    1. Login in tFlow with an account with admin rights then go to Users and create a new account.

    2. Name it tBot and set is as admin. Assign it to the main instance company and make sure the flags for "Auto assign this user to new Orders" and "Auto assign to new company" are checked.

    3. In the email address field just enter a fake email address like "tbot@domain.net".

    4. Disable all the email notifications for this user (Email alerts)!

      You could find additional information here:
      http://support.aleyant.com/kb/a937/how-to-connect-tbot-to-tflow.aspx

http://support.aleyant.com/AvatarHandler.ashx?fid=128961&key=1294230357

  1. Login with tBot user in tFlow

    1. When logged in click on top right on the user avatar then select "My profile"

http://support.aleyant.com/AvatarHandler.ashx?fid=128962&key=2128016599

    1. Scroll the profile page to bottom and click on "Show Api credentials"

    2. Copy the 2 API and Secret key (we will use at next step).

  1. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

    1. Production (default value)

    2. Proof file

  10. Click “Test Connection”. You should see message that connection settings are valid.

 

How to connect tBot to FTP server

  1. Choose “FTP” as data source

  2. Enter FTP server url to field 1(Example: ftp.myserver.com - only root url required)

  3. Enter FTP port to field 3 (21 is default value for most of ftp servers)

  4. Fill remote path in field 4 to scan on FTP (for root path leave “/” value)

  5. Fill Login in field 5 or leave it blank to use Anonymous account

  6. Fill Password in field 6 or leave it blank to use Anonymous account

  7. Choose “Download folder” - local directory for downloaded files(You can write it by hand or press F2/ellipsis to open directory selection dialog )

  8. Choose interval to check new files on server

  9. Choose retrieve interval and attempts count

  10. Click “Test Connection”. You should see message that connection settings are valid.

How to config tBot batches

 

tBot allows to process multiple downloaded files at once. Batch parameters are configured in “Download” action and could be used for several integrations and all other actions. Integrations which support batches:

    Impostrip integration

    Ergosoft integration

    Griffin integration

    Phoenix integration

tBot supports three types of triggers. When trigger event occurs tBot process all files in batch at once.

How to config Fill flat trigger for batch

  1. Select “Fill flat” from trigger list

  2. Set maximum media size, when new downloaded file will exceed summary layout the trigger event will occur

  3. Set “Calculate flat include quantity” flag if you want to include quantity of copies from tFlow, otherwise each file will be calculated in flat only once

  4. Set maximum timeout for trigger event. In example below, event will be generated after 600 minutes from first file was included into batch.

C:\Users\DrozdovVA\Desktop\3.png

How to config Time trigger for batch

  1. Select “Time” from trigger list

  2. Set maximum timeout for trigger event. In example below, event will be generated after 60 minutes from first file was included into batch.

C:\Users\DrozdovVA\Desktop\3.png

How to config Job count trigger for batch

  1. Select “Job count” from trigger list

  2. Set maximum count of files to include into batch, when new downloaded file will exceed this quantity the trigger event will occur

  3. Set maximum timeout for trigger event. In example below, event will be generated after 30 minutes from first file was included into batch.

C:\Users\DrozdovVA\Desktop\3.png

 

tBot integrations with third parties

 

Integration is available now only for tFlow data source. To configure integration you should make steps below:

  1. Choose destination system in list

  2. Fill required parameters

  3. You could find more information about settings and examples in related section of this document

C:\Users\DrozdovVA\Desktop\3.png

Move Action

This action allows to move and rename files from one directory to another.

To configure move action you should make steps below:

  1. Add Actions to action list:

C:\Users\DrozdovVA\Desktop\3.png

  1. Set action parameters:

C:\Users\DrozdovVA\Desktop\3.png

    1. Set input folder. If you leave it blank files from previous step will be processed.

    2. Configure filter options. Only files that meet filter conditions in Input folder will be processed

    3. Set output folder – destination place for files.

  1. Filter option list:

    1. Match field:

      1. File name – search pattern in file name

      2. Extension – search patter in file extension

      3. File size – filter by file size

      4. File date– filter by file date

    2. Match type:

      1. Equal

      2. Not equal

      3. Contains

      4. Not contains

      5. Starts with

      6. Ends with

      7. Regex

      8. More/less than

      9. Between

    3. Condition value (or values for between type)

    4. Choose “Ignore case” if you want to make case insensitive filter for text match type

  2. Rename options (detailed description for rules you can find in section: “Configure Rules and Options”):

    1. Add text settings

    2. Replace text settings

    3. Add date or time settings

    4. Make sequential

How to config tBot batches

 

How to config Fill flat trigger for batch

  1. Select “Fill flat” from trigger list

  2. Set maximum media size, when new downloaded file will exceed summary layout the trigger event will occur

  3. Set “Calculate flat include quantity” flag if you want to include quantity of copies from tFlow, otherwise each file will be calculated in flat only once

  4. Set maximum timeout for trigger event. In example below, event will be generated after 600 minutes from first file was included into batch.

C:\Users\DrozdovVA\Desktop\3.png

How to config Time trigger for batch

  1. Select “Time” from trigger list

  2. Set maximum timeout for trigger event. In example below, event will be generated after 60 minutes from first file was included into batch.

C:\Users\DrozdovVA\Desktop\3.png

How to config Files count trigger for batch

  1. Select “Files count” from trigger list

  2. Set maximum count of files to include into batch, when new downloaded file will exceed this quantity the trigger event will occur

  3. Set maximum timeout for trigger event. In example below, event will be generated after 30 minutes from first file was included into batch.

 

Copy Action

This action allows to copy and rename files from one directory to another.

To configure copy action you should make steps below:

  1. Add Actions to action list:

C:\Users\DrozdovVA\Desktop\3.png

  1. Set action parameters:

C:\Users\DrozdovVA\Desktop\3.png

    1. Set input folder. If you leave it blank files from previous step will be processed.

    2. Configure filter options. Only files that meet filter conditions in Input folder will be processed

    3. Set output folder – destination place for files.

  1. Filter option list:

    1. Match field:

      1. File name – search pattern in file name

      2. Extension – search patter in file extension

      3. File size – filter by file size

      4. File date– filter by file date

    2. Match type:

      1. Equal

      2. Not equal

      3. Contains

      4. Not contains

      5. Starts with

      6. Ends with

      7. Regex

      8. More/less than

      9. Between

    3. Condition value (or values for between type)

    4. Choose “Ignore case” if you want to make case insensitive filter for text match type

  2. Rename options (detailed description for rules you can find in section: “Configure Rules and Options”):

    1. Add text settings

    2. Replace text settings

    3. Add date or time settings

    4. Make sequential

Delete Action

This action allows to delete files from some directory.

To configure delete action you should make steps below:

  1. Add Actions to action list:

C:\Users\DrozdovVA\Desktop\3.png

  1. Set action parameters:

C:\Users\DrozdovVA\Desktop\3.png

    1. Set input folder. If you leave it blank files from previous step will be processed.

    2. Configure filter options. Only files that meet filter conditions in Input folder will be processed

  1. Filter option list:

    1. Match field:

      1. File name – search pattern in file name

      2. Extension – search patter in file extension

      3. File size – filter by file size

      4. File date– filter by file date

    2. Match type:

      1. Equal

      2. Not equal

      3. Contains

      4. Not contains

      5. Starts with

      6. Ends with

      7. Regex

      8. More/less than

      9. Between

    3. Condition value (or values for between type)

    4. Choose “Ignore case” if you want to make case insensitive filter for text match type

 

Upload Action

Action can be two types:

  1. tFlow (tBot is connecting to tFlow via http and is using the tFlow API to connect, publish the queues and upload artworks.)

  2. FTP (tBot can be used as FTP client to upload files for remote folder)

How to connect tBot to tFlow

  1. Create a service user in tFlow

    1. Login in tFlow with an account with admin rights then go to Users and create a new account.

    2. Name it tBot and set is as admin. Assign it to the main instance company and make sure the flags for "Auto assign this user to new Orders" and "Auto assign to new company" are checked.

    3. In the email address field just enter a fake email address like "tbot@domain.net".

    4. Disable all the email notifications for this user (Email alerts)!

http://support.aleyant.com/AvatarHandler.ashx?fid=128961&key=1294230357

  1. Login with tBot user in tFlow

    1. When logged in click on top right on the user avatar then select "My profile"

http://support.aleyant.com/AvatarHandler.ashx?fid=128962&key=2128016599

    1. Scroll the profile page to bottom and click on "Show Api credentials"

    2. Copy the 2 API and Secret key (we will use at next step).

  1. Configure tBot upload action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 2(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose interval to check new files on server

  6. Choose retrieve interval and attempts count

  7. Click “Test Connection”. You should see message that connection settings are valid.

 

How to connect tBot to FTP server

  1. Choose “FTP” as data source

  2. Enter FTP server url(Example: ftp.myserver.com - only root url required)

  3. Enter FTP port (21 is default value for most of ftp servers)

  4. Fill remote path to access on FTP (for root path leave “/” value)

  5. Fill Login or leave it blank to use Anonymous account

  6. Fill Password or leave it blank to use Anonymous account

  7. Choose interval to check new files on server

  8. Choose retrieve interval and attempts count

  9. Click “Test Connection”. You should see message that connection settings are valid.

Configure source folder

  1. Set action parameters:

C:\Users\DrozdovVA\Desktop\3.png

    1. Set input folder. If you leave it blank files from previous step will be processed.

    2. Configure filter options. Only files that meet filter conditions in Input folder will be processed

  1. Filter option list:

    1. Match field:

      1. File name – search pattern in file name

      2. Extension – search patter in file extension

      3. File size – filter by file size

      4. File date– filter by file date

    2. Match type:

      1. Equal

      2. Not equal

      3. Contains

      4. Not contains

      5. Starts with

      6. Ends with

      7. Regex

      8. More/less than

      9. Between

    3. Condition value (or values for between type)

    4. Choose “Ignore case” if you want to make case insensitive filter for text match type

 

Configure upload parameters

If you use tFlow data source, you will be able to upload artworks for jobs. To do this you need to meet a few conditions:

  1. Job should be in “Waiting for Artwork” or “Waiting for Revision” state

  2. File name of pdf file should be equal to existing job or if you set “Create order if not exists” should be equal to a new order/job name.

  3. You need to fill parameters:

    1. Select instance user, this user will be assigned to Job. The artwork will be uploaded to job under this user.

    2. Select product, this value needs for order/job creation.

    3. Select date increment – this is count of day from upload date. This value will be used for Ship date field of new job/order

C:\Users\DrozdovVA\Desktop\3.png

Print Action

This action allows to print file which was process on a previous step.

To configure print action you should make steps below:

  1. Add Actions to action list:

C:\Users\DrozdovVA\Desktop\3.png

  1. Select printer:

C:\Users\DrozdovVA\Desktop\3.png

 

Transfer Action

This action used to transfer files between tBot instances, so they need to be on different servers. First of all you need to configure sender instance and then receive instance.

 

Sender instance

To configure sender instance you should make steps below:

  1. Add Transfer action to action list on sender server:

C:\Users\DrozdovVA\Desktop\3.png

  1. Set action parameters:

C:\Users\DrozdovVA\Desktop\3.png

  1. Choose server type: “Sender”

  2. fill server address field with ip – address of receiver instance

  3. Configure connection options: check interval and retries on failure

  4. Click “Test connection”(Receiver instance should be online)

  1. If you see error message, please check:

  • Receiver instance is online.

  • Ip – address is correct and available

  • Check you brandmauer or antivirus, tBot use port 10456 to communicate between instances – this port should be opened for incoming and outgoing connections

  1. Save queue

Receiver instance

To configure receiver instance you should make steps below:

  1. Add Transfer action to action list on sender server:

C:\Users\DrozdovVA\Desktop\3.png

  1. Set action parameters:

    1. Set server type to “Receiver”

    2. Choose sender from list

    3. Set folder for incoming files

    4. Configure connection options

  1. Save queue

 

Configure Rules and Options

Adding Name Settings

  1. Click “Add” button and select “Name Settings”

  1. Fill filter parameters(When) and action (Then)

    1. Match field:

      1. File name – search pattern in file name

      2. Extension – search patter in file extension

      3. File size – filter by file size

      4. File date– filter by file date

    2. Match type:

      1. Equal

      2. Not equal

      3. Contains

      4. Not contains

      5. Starts with

      6. Ends with

      7. Regex

      8. More/less than

      9. Between

    3. Condition value (or values for between type)

    4. Choose “Ignore case” if you want to make case insensitive filter for text match type

    5. Fill text what you want to add to filtered files

    6. Select position:

      1. Before file name

      2. After file name

      3. As new file extension

  1. Click “Remove rule” to delete option

 

Replace Text Settings

  1. Click “Add” button and select “Replace text settings”

  1. Fill source text parameters(When) and new text parameters (Then)

    1. Select replace parameter:

      1. Full name – search source text in full file name

      2. Base name  - search in base name, without extension

      3. Extension – replace only in extension

 

Date or Time Settings

  1. Click “Add” button and select “Date or time settings”

  1. Fill filter parameters(When)

  1. Match field:

    1. File name – search pattern in file name

    2. Extension – search patter in file extension

    3. File size – filter by file size

    4. File date– filter by file date

  2. Match type:

    1. Equal

    2. Not equal

    3. Contains

    4. Not contains

    5. Starts with

    6. Ends with

    7. Regex

    8. More/less than

    9. Between

  3. Condition value (or values for between type)

  4. Choose “Ignore case” if you want to make case insensitive filter for text match type

  1. Fill Action parameters(Then):

    1. Choose Date type:

      1. Created –Date, when file was created

      2. Modified – File Last updated date

      3. Last opened – Date, when file was opened last time

      4. Current – Current system time, when file will be processed

    2. Select date format:

      1. Month Day Year – default value

      2. Year Month Day

      3. Day Mont Year

    3. Select place to add date time:

      1. Before file name

      2. After file name

      3. As new file extension

    4. Choose date delimiter:

      1. Space

      2. Underline

      3. Dash

      4. Forward slash

      5. None  - without delimiter

    5. Set leading zeros to True is you want to full date time mask (For Example 20160101 instead of 201611)

 

Make Sequential Settings

  1. Click “Add” button and select “Make Sequential”

  1. Fill filter parameters (When). File will be processed if file with the same name exists in destination folder or file matches filter parameters.

  1. Match field:

    1. File name – search pattern in file name

    2. Extension – search patter in file extension

    3. File size – filter by file size

    4. File date– filter by file date

  2. Match type:

    1. Equal

    2. Not equal

    3. Contains

    4. Not contains

    5. Starts with

    6. Ends with

    7. Regex

    8. More/less than

    9. Between

  3. Condition value (or values for between type)

  4. Choose “Ignore case” if you want to make case insensitive filter for text match type

  1. Fill Action parameters(Then):

    1. Select place to add counter:

      1. Before file name

      2. After file name

      3. As new file extension

    2. Choose start number – 0 is default

    3. Choose delimiter:

      1. Space

      2. Underline

      3. Dash

      4. Forward slash

      5. None  - without delimiter

    4. You can pad all numbers to same length by adding number of digits(For Example if us set value to 3, first sequence will be 001)

 

Job Settings

  1. Click “Add” button and select “Job Settings”

  1. Fill filter parameters (When). This option is available only for tFlow data source.

  1. Match value:

  1. Job name – source files will be filtered by job name

  2. Job description – source files will be filtered by job description

  3. Job notes – source files will be filtered by job notes

  4. Print width – source files will be filtered by job parameter: print width

  5. Print height – source files will be filtered by job parameter: print height

  6. Quantity – source files will be filtered by job parameter: quantity

  7.  
  1. Match type:

  1. Equal

  2. Not equal

  3. Contains

  4. Not contains

  5. Starts with

  6. Ends with

  7. Regex

  8. More/less than

  9. Between

  1. Condition value (or values for between type)

 

Integrations

How to config Impostrip integration

 
  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

    1. Production (default value)

    2. Proof file

  10. Click “Test Connection”. You should see message that connection settings are valid.

  1. Click on “Impostrip” checkbox:

C:\Users\DrozdovVA\Desktop\3.png

  1. Select ini-file with Impostrip configuration(sample file: https://www.dropbox.com/s/umglhr8hqbvb69h/SampleConfiguration.ini?dl=0 ) Default location for configuration file is C:\Program Files (x86)\Ultimate Technographics\Impostrip Automation\

  2. Check combo box with hot folders, it should contains actual hot folders

  3. Save Queue

  4. tBot will create in tFlow “virtual queue” for each Impostrip hot folder, so user can select in tFlow destination. Format of queue will be: {Queue name} – {Hot folder name}

  1. Impostrip integration supports batches:

    1. Sample xml file generated by tBot for single job:

<UltimateImposition>

 <Redirection>

   <PrintJob JobID="1">

     <QueueName>

       <Name>Business-Cards</Name>

     </QueueName>

     <CustomValues>

       <CustomValue key="Order" value="686-9" />

     </CustomValues>

     <Documents>

       <DocFile>

         <FullPathName>C:\AWI\Files\2016-02-25-16-06-02-686.9-686-9-.pdf</FullPathName>

         <PageRange UseAllPages="true" />

         <Quantity>5.0</Quantity>

       </DocFile>

     </Documents>

   </PrintJob>    

 </Redirection>

</UltimateImposition>

  1. Sample xml file generated by tBot for two jobs:

<UltimateImposition>

 <Redirection>

   <PrintJob JobID="1">

     <QueueName>

       <Name>Business-Cards</Name>

     </QueueName>

     <CustomValues>

       <CustomValue key="Order" value="686-9" />

     </CustomValues>

     <Documents>

       <DocFile>

         <FullPathName>C:\AWI\Files\2016-02-25-16-06-02-686.9-686-9-.pdf</FullPathName>

         <PageRange UseAllPages="true" />

         <Quantity>5.0</Quantity>

       </DocFile>

     </Documents>

   </PrintJob>

   <PrintJob JobID="2">

     <QueueName>

       <Name>Business-Cards</Name>

     </QueueName>

     <CustomValues>

       <CustomValue key="Order" value="686-10" />

     </CustomValues>

     <Documents>

       <DocFile>

         <FullPathName>C:\AWI\Files\2016-02-25-16-06-02-686.10-686-10-.pdf</FullPathName>

         <PageRange UseAllPages="true" />

         <Quantity>10.0</Quantity>

       </DocFile>

     </Documents>

   </PrintJob>   

 </Redirection>

</UltimateImposition>

How to config Insoft Imposition integration

 
  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key to

  4. Enter Secret key to

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

    1. Production (default value)

    2. Proof file

  10. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Insoft Imp” from systems list:

  2. Load materials list from Imposition configuration file

    1. Click “Load materials”

    2. Select ini-file with Imposition configuration(sample file: https://www.dropbox.com/s/6u3or73c3ogc9ez/ConfigXML.xml?dl=0 )

C:\Users\DrozdovVA\Desktop\3.png

  1. Check combo box with materials and grades, it should contains actual values

  1. Save Queue

  2. tBot will create in tFlow “virtual queue” for each material and grade, so user can select in tFlow destination. Format of queue will be: {Queue name} – {Grade name} – {GSM ID}

  1. Please, note that tBot requires ImpLink API 7.0.

How to config Nexio and NetSuite integration

Primary Functionality

Connects Caldera Nexio and Aleyant tFLOW via tBOT to facilitate data exchange between the two applications. Through Nexio, tBOT can read Caldera printer configurations and publish them to tFLOW as virtual production queues, to which tFLOW users can send files to be printed. When a print file is sent to Caldera via the production queues, tBOT generates the JDF and JMF files used by Nexio to automate print setup in the RIP.

tBOT can also read the print log from Nexio such as print time, ink consumption, job state, etc., and send the information to another system such as an MIS.

Objective/Key Benefits

The JDF/JMF data exchange enables automated setup and print, speeding up the production process while decreasing the possibility for user error. Jobs can be defined upstream in the workflow and sent all the way through to print without user intervention.

Caldera connection requirements

    Caldera RIP

    Nexio license

    Correctly configured Nexio plugin

tFLOW connection requirements

    tFLOW Enterprise

    tBOT

    Correctly configured tBOT production queue connected to Nexio

Benefits

  1. One hot folder is created in each RIP

  2. tBOT connects to the Nexio, reads printer configurations, and automatically creates queues

  3. tBOT queues become visible in tFLOW, allowing user to submit from tFLOW to a specific printer configuration and parametrize RIP functionality on the fly

Limitations

  1. Requires more setup than simple hot folder Benefits

  2. Only one folder is needed in each RIP

  3. Job parameters can be configured on the fly - resolution, substrate, quantity, etc.

  4. JDF or XML instructions that accompany the print file pre-program the RIP with instructions

  5. New print configurations are updated as tBOT queues automatically

  6. Full print automation

  7. Bi-directional flow of information allows print data to be sent back upstream 

Nexio configuration

  1. Configure Nexio plugin on Caldera RIP

  1. Fill Field 1 “Base URL” with your Caldera RIP instance address

  2. Check Field 2 – Status should be “Running”

  3. Check field 3 “Base Path” (Field 3) – it will be needed later.

  4. Check field 4 “Path” (Field 4) – it will be needed later – this is Nexio hot folder.

tBot configuration

  1. If you need integration between Net Suite and Calder you should configure profile:C:\Users\DrozdovVA\Desktop\3.png

    1. Click “Profiles” button on main screen

    2. Select profile from list or create new one

    3. Select source and destinations systems

    4. Fill parameters for destination system connection. For source system connection system will be configured in related queue action

    5. Fill mappings between source system fields and destination system fields

    6. Click “Save” to confirm changes

 
  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

    1. Production (default value)

    2. Proof file

  10. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Caldera (via Nexio)” from systems list.

  2. Set connection settings:

    1. Set URL address to Nexio: it should be combination of “Base URL” and “Base path” from step Nexio configuration step.

    2. Click “Load Devices” to get list of printers.

    3. Select Export profile from step 1 if you need to export data to Net Suite.

    4. Select Nexio hot folder  - you can take it from Nexio configuration step 2.d

C:\Users\DrozdovVA\Desktop\3.png

  1. Save queue.

  2. tBot will create in tFlow “virtual queue” for each hot folder, so user can select in tFlow destination. Format of queue will be: {Queue name} – {device name}

  3. Sample of JDF file generated by tBot
    <?xml version="1.0" encoding="utf-8"?>
    <JDF xmlns:cal="http://www.caldera.com/jdf"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.CIP4.org/JDFSchema_1_1" ID="2 FALSSB7G2 Falcon 7ft Spike Graphic
    Package" JobID="2 FALSSB7G2 Falcon 7ft Spike Graphic Package" JobPartID="1"
    Status="Waiting" Activation="Active" Type="DigitalPrinting" Version="1.4"
    ICSVersions="Base_L1-1.4" DescriptiveName="Production - Carlsbad: 2 FALSSB7G2 Falcon 7ft
    Spike Graphic Package">
    <ResourcePool>
    <RunList Class="Parameter" ID="RL001" Status="Available">
    <LayoutElement>
    <FileSpec URL="file://FILES/1102110-4__HR.pdf" />
    </LayoutElement>
    </RunList>
    <DigitalPrintingParams Class="Parameter" ID="DPP001" Status="Available" />
    <Device Class="Implementation" ID="DEV001" Status="Available"
    DeviceID="Rhotex-322:Stretch" />
    <Component Class="Quantity" ID="C001" Status="Unavailable"
    ComponentType="FinalProduct" />
    </ResourcePool>
    <ResourceLinkPool>
    <DigitalPrintingParamsLink Usage="Input" rRef="DPP001" />
    <DeviceLink Usage="Input" rRef="DEV001" />
    <RunListLink Usage="Input" rRef="RL001" />
    <ComponentLink Usage="Output" rRef="C001" Amount="1" />
    </ResourceLinkPool>
    <AuditPool>
    <Created AgentName="Production - Carlsbad" AgentVersion="10.0"
    TimeStamp="2016-11-18T07:04:32-08:00" />
    </AuditPool>
    </JDF>

  4. Sample of information extracted by tBOT for MIS system
    <print_width unit="Inchs">12.000000</print_width>
    <print_height unit="Inchs">24.400000</print_height>
    <media_width unit="Inchs">126.000000</media_width>
    <media_height unit="Inchs">24.400000</media_height>
    <media_usage_ratio>0.095238</media_usage_ratio>
    <job_id>5402</job_id>
    <job_name>1102110-4__HR.pdf</job_name>
    <job_state idx="7">Finished</job_state>
    <job_error/>
    <server_name>Rhotex-322</server_name>
    <server_host>10.0.20.23</server_host>
    <create_time timestamp="1478900221">Tue Nov 22 01:02:15 2016</create_time>
    <job_mode idx="3">PDF</job_mode>
    <cut_barcode>63905CFC</cut_barcode>
    <nb_printed>8</nb_printed>
    <begin_time timestamp="1478901971">Tue Nov 22 01:03:15 2016</begin_time>
    <print_time_sec>13</print_time_sec>
    <op_time timestamp="1478901971">Tue Nov 22 01:03:28 2016</op_time>
    <ink_cons unit="ml" total="0.585580">
    <ink name="Cyan" short="C" unit="ml">0.100731</ink>
    <ink name="Magenta" short="M" unit="ml">0.126355</ink>
    <ink name="Yellow" short="Y" unit="ml">0.138821</ink>
    <ink name="Black" short="K" unit="ml">0.134930</ink>
    <ink name="LightBlack" short="k" unit="ml">0.084743</ink>

 

How to config Ergosoft integration

 
  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

  1. Production (default value)

  2. Proof file

  1. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Ergosoft” from systems list.

  2. Select ini-file with configuration(sample file: https://www.dropbox.com/s/pgr62dxdbg5l2ww/SampleConfiguration.ini?dl=0 ), default location is “<UserDir>\Data\PrEnvFiles”

C:\Users\DrozdovVA\Desktop\3.png

  1. Save Queue

  2. tBot will create in tFlow “virtual queue” for each hot folder, so user can select in tFlow destination. Format of queue will be: {Queue name} – {hotfolder path}

  1. If you want to use environments, you need to select related flag:

    1. tBot will scan ini folder for *.prenv files
    2. For each file tBot will create virtual folder : {Queue name} - {Printer environment name}



    3. In XML tBot will add additional information about Printer environment

  2. Ergosoft integration supports batches:

    1. Sample xml file generated by tBot for single job:

<?xml version="1.0" encoding="utf-8"?>

<HotFile NumCopies="5">

 <Image FileName="F:\Work\_tmp\0987-2_.pdf" />

</HotFile>

  1. Sample xml file generated by tBot for two jobs:

<?xml version="1.0" encoding="utf-8"?>

<HotFile NumCopies="5">

 <Image FileName="F:\Work\_tmp\0987-1_.pdf" />

</HotFile>

<HotFile NumCopies="10">

 <Image FileName="F:\Work\_tmp\0987-2_.pdf" />

</HotFile>

 
  1. When file will be processed tBot will generate xml file in selected hot folder, example:

  2. https://www.dropbox.com/s/ysiya5reupptt69/OutputExample.xml?dl=0

 

How to config Compose integration

 
  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

  1. Production (default value)

  2. Proof file

  1. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Compose XML” from systems list.

  2. Set path for xml tickets (Example: “F:\Work\_tmp\tBot\Compose\Ticket”, there xml ticket will be generated)

  3. Set path for job files (Example: “F:\Work\_tmp\tBot\Compose\Files”, there artworks will be saved)

C:\Users\DrozdovVA\Desktop\3.png

  1. Save queue.

  2. Sample xml file generated by tBot for a single job:

<?xml version="1.0" encoding="utf-8"?>

<orderInfo xmlns="http://w2p.aleyant.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <OrderID>918</OrderID>

    <OrderNumber>996</OrderNumber>

    <OrderDate>2017-03-11T07:00:00.0000000+07:00</OrderDate>

    <OrderedBy>

        <LastName></LastName>

        <FirstName></FirstName>

        <Email></Email>

    </OrderedBy>

    <OrderItems>

        <orderInfoItem>

            <ItemId>1158</ItemId>

            <Seq>1</Seq>

            <ItemName>1-1-Store Banner, 4x8</ItemName>

            <productName>Store Banner, 4x8</productName>

            <productURL>store-banner-4x8-full-color</productURL>

            <Quantity>1</Quantity>

            <PricingParms>

                <Options>

                    <Option>

                        <Key xsi:type="xsd:string">Colors</Key><Value xsi:type="xsd:string"></Value>

                        <Key xsi:type="xsd:string">Paper Stock</Key><Value xsi:type="xsd:string"></Value>

                    </Option>

                </Options>

            </PricingParms>

        </orderInfoItem>

    </OrderItems>

</orderInfo>

How to config Zund integration

 
  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

  1. Production (default value)

  2. Proof file

  1. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Zund” from systems list.

  2. Load material from config file (Example: )

  3. Check materials list

  1. Enter Zund server url(Example: http://localserver:8080/ - only root url required)

C:\Users\DrozdovVA\Desktop\3.png

  1. Save queue.

  2. tBot will create in tFlow “virtual queue” for each hot folder, so user can select in tFlow destination. Format of queue will be: {Queue name} – {material}

  1. tBot will make http request to Zund server and submit a new job.

How to config Phoenix Imposition integration

 

Configure Phoenix

  1. Configure Hotfolder in Phoenix Imposition:

    1. Set hotfolder name

    2. Set input path for xml-tickets

    3. Set output path for generating reports

C:\Users\DrozdovVA\Desktop\3.png

  1. Configure default actions:

<?xml version="1.0" encoding="UTF-8"?>

<phoenix-actions version="1.0">

  <create-job id="10" />

  <set-press id="20">

     <set-press-resource>

        <name>Defaults/B1 Sheetfed Offset</name>

     </set-press-resource>

  </set-press>

  <set-plate id="21">

     <set-plate-resource>

        <name>Defaults/745 x 605 mm</name>

     </set-plate-resource>

  </set-plate>

  <set-sheet id="22">

     <set-sheet-resource>

        <stock>Gloss Coated</stock>

        <name>1000 x 707mm Long</name>

     </set-sheet-resource>

  </set-sheet>

  <import-product-csv id="30"/>

  <save-job id="80"/>   

</phoenix-actions>

    1. Actions with id = 10 and 30 are mandatory. Make sure that your configuration contains these actions.

    2. Make note, if you add report generation into actions list, it format should be json.

  1. Run Phoenix server and check log for details:

Configure tBot

  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

  1. Production (default value)

  2. Proof file

  1. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Phoenix imposition” from systems list.

  2. Configure integration parameters:

    1. Set Hotfolder path for generating xml-tickets

    2. Select “Wait for report” if you want to retrieve information from Phoenix

    3. Set folder for reports in json-format (Required only for retrieving results from report )

C:\Users\DrozdovVA\Desktop\3.png

  1. Save Queue

  2. tBot will wait for report for 7 days. If report not be generated – tBot will remove this job from list as unused.

Report should be generated in JSON format to its default location: “Out path” + “Job name” + job.json.

  1. Here is examples of files

    1. Sample xml ticket:

<?xml version="1.0" encoding="UTF-8"?>

<phoenix-resources version="1.0">

<create-job-resource idref="10"><id>1-1</id></create-job-resource>

<import-product-csv-resource id="30"><path>F:\Work\tBot\Phoenix\1-1.csv</path></import-product-csv-resource>

<save-job-resource idref="80"><path>1-1/job.phx</path></save-job-resource></phoenix-resources>

  1. Sample csv file with products:

Name,Description,Ordered,Stock,Grade,Artwork File,Notes

1-1,"first test order-1",1,,,"F:\Work\tBot\Phoenix\1-first test order-1.pdf",""

 

How to config Griffin integration

  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

  1. Production (default value)

  2. Proof file

  1. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “Griffin” from systems list.

  2. Set path for xml tickets

  3. Set default values for xml:

    1. Choose media type: Sheet or Role

    2. Set Width and Height for media size

    3. Set default values for Bleed and Spacing in mm

    4. Set Substrate value

C:\Users\DrozdovVA\Desktop\3.png

  1. Save queue.

  2. If you want to set dynamic values for default values you need to set additional properties for each job:

    1. Width (XML)  - Print Width(tFlow) - print_width (API)

    2. Height (XML)  - Print Height (tFlow) - print_height (API)

    3. Substrate (XML)  - Substrate (tFlow) - print_substrate (API)

    4. Bleed (XML)  - Artwork Bleed (tFlow) - artwork_bleed (API)

    5. Spacing (XML)  - Artwork Spacing (tFlow) - artwork_spacing (API)

  3. Sample xml file generated by tBot for a sheet media type:

<?xml version="1.0" encoding="utf-8"?>

<griffin-auto version="1.0" substrate="PVC" substrate-type="Sheet" substrate-width="1600mm" substrate-height="3200mm">

<artwork><quantity>1</quantity><bleed>5mm</bleed><spacing>3mm</spacing><front><path>F:\Work\_tmp\tBot\Phoenix\1-first test order-1.pdf</path></front></artwork></griffin-auto>

  1. Sample xml file generated by tBot for a roll media type:

<?xml version="1.0" encoding="utf-8"?>

<griffin-auto version="1.0" substrate="Polyester" substrate-type="Roll" substrate-width="1600mm">

<artwork><quantity>1</quantity><bleed>5mm</bleed><spacing>3mm</spacing><front><path>F:\Work\_tmp\tBot\Phoenix\1-first test order-1.pdf</path></front></artwork></griffin-auto>

How to config PrintFactory integration

 

Configure PrintFactory

  1. Configure Hotfolder in PrintFactory RIP:

    1. Set hotfolder name

    2. Set input path for xml-tickets

  1. Generate MIS Key to access cloud application:

    1. Go to http://app.printfactory.cloud/settings/external-api

    2. Generate Key

Configure tBot

  1. Create new queue and add download action to it

  2. Configure tBot download action:

  1. Choose “tFlow” as data source (default value)

  2. Enter tFlow server url to field 1(Example: http://testtflow.com:8080/ - only root url required)

  3. Enter API key

  4. Enter Secret key

  5. Choose “Download folder” - local directory for downloaded files (You can write it by hand or press F2/ellipsis to open directory selection)

  6. Choose interval to check new files on server

  7. Choose retrieve interval and attempts count

  8. You can group files in “Download folder” by customer’s names or order number. This means that tBot will create special folder for customer’s name or order in “Download folder” and put related files to this directory.

  9. Choose file type to download. You can select:

  1. Production (default value)

  2. Proof file

  1. Click “Test Connection”. You should see message that connection settings are valid.

  1. Select “PrintFactory” from systems list.

  2. Configure integration parameters:

    1. Set Hotfolder path for generating xml-tickets

    2. Set MIS Key from previous step

    3. Set Cloud server URL (default is  http://api.aurelon.com)

  1. Click “Load Devices” to check connection settings. You should see devices list in related combobox.

  2. Save Queue