Creating an output

An output folder is a folder that can be monitored by other applications.

If you want to create a new output folder, click the New Output button in the Outputs window. The New Output dialog is displayed:

Enter the required information:

State
You can click , the Enabled button, or , the Disabled button, to switch between the two states.
Name
Enter the output folder name in the designated field.

General tab

Description
Enter a short description for the new output folder.
Estimated Output Speed
You can specify the output speed in either Feet/hour or Sheets/hour.
Note: Depending on the selection you made at the installation time, the measurement system can be different.
Minimum Job Run Time
Specify a number of minutes as the default minimum runtime for each job placed in the output folder. This Minimum Job Run Time is added to the existing runtime for each job from a filter or a batch, that has this output folder as the specified output device.
When you want to determine the total runtime for a batch, a filter, or a group of jobs, the Minimum Job Run Time is added to the runtime of each job.
Adjust Job Paper Before Sending
Specifies whether the job paper properties should match or not a Paper Catalog entry, before sending the job to the Output Device.
Select one of these options:
Off
Select this option in order to send the job to the Output Device, without changing the paper properties. This is the default option.
On, Based on Paper Catalog
Select this option if you want to adjust the job paper properties, so that they match a paper catalog entry, before sending the job to the Output Device.

Configuration tab

Output Type
Select the output type from the list. There are these possible values:
PDF/Postscript
Select this option if you want TotalFlow BatchBuilder to place a PDF/PostScript file in the output hot folder for each job in the batch.
PDF/Postscript and XML
Select this option if you want TotalFlow BatchBuilder to place a PDF/PostScript file and an XML file in the output hot folder for each job in the batch.
Note: You can specify different output hot folder locations for the PDF/PostScript files and for the XML files.
PDF/PostScript and CSV
Select this option if you want TotalFlow BatchBuilder to place the PDF/PostScript file and the generated CSV file in the output hot folder for the each job in the batch.
The Sample XML file is a TotalFlow BatchBuilder internal XML file that is converted to a CSV file using a specified mapping file.
From CSV Output :
  • Click the First Row Contains Field Names checkbox if you want the CSV file to contain field names.

  • Click the One CSV per Batch checkbox if you want to generate one CSV file for all the jobs in the batch.

TotalFlow MIME
Select this option if you want TotalFlow BatchBuilder to place a Multipurpose Internet Mail Extensions (MIME) package in the output hot folder for each job in the batch. The MIME package contains a JMF file, a JDF file, and the job file. The JDF file is generated by the TotalFlow BatchBuilder system using an internal XSL mapping file.

The MIME package file name is the same as the job file name.

PDF/Postscript and RPD List File
Select this option if you want TotalFlow BatchBuilder to create a RICOH ProcessDirector list file in addition to the PDF files for the jobs in the batch. The RICOH ProcessDirector list file is a text file containing the ordered list of file names from the batch. The RICOH ProcessDirector list file is placed in the output hot folder at the last position.
JMF over HTTP
Select this option if you want TotalFlow BatchBuilder to send a MIME package to a virtual printer. A JMF file is sent through an HTTP protocol for each job in the output folder. You must specify the URL and the name of the virtual printer. The MIME package contains a JMF message, a JDF file, and a PDF job file. TotalFlow BatchBuilder converts the job settings into the JDF file through the specified mapping file.
TotalFlow JMF over HTTP
Select this option if you want TotalFlow BatchBuilder to send a MIME package to a virtual printer. A JMF file is sent through an HTTP protocol for each job in the output folder. You must specify the URL and the name of the virtual printer. The MIME package contains a JMF message, a JDF file, and a PDF job file. TotalFlow BatchBuilder converts job settings into the JDF file through Ricoh JTAPI library.
Mapping File
You can use XSL mapping files to configure output devices in TotalFlow BatchBuilder to generate various XML files based on the TotalFlow BatchBuilder schema. Using the XSL mapping file, the output hot folder is configured to generate an XML file based on your custom target schema. This option is available only when the output type is either PDF/Postscript and XML, TotalFlow MIME, JMF over HTTP, or PDF/PostScript and CSV.
The XSLT conversion process uses the TotalFlow BatchBuilder internal schema as an input to generate the XML output for a job.

When the selected output type is TotalFlow MIME or JMF over HTTP, the default XSL mapping file is TotalFlow JTAPI.xsl.

Output XML File Extension
Specify the extension type for the generated output XML file. When the selected output type is PDF/Postscript and XML, you can set the extension for the output XML file.
Important: Make sure the specified XML file extension is different than the corresponding job file extension.
MIME File Extension
Specify the extension type for the generated output MIME package file. When the selected output type is TotalFlow MIME, you can set the extension for the output MIME package file. The default file extension is .mjm.
Output Location (Directory Path)
Specify the path or click Browse… to select the folder location. If the specified folder does not exist, a new folder is created.
Note: If the selected output type is PDF/Postscript and XML you can specify different locations for the PDF files and for the XML files.
Output Location (XML files)
Type in the path or click Browse… to select the output hot folder location for the XML files.
Output Location (PDF files)
Select the Use same location as XML option if you want to use the same output hot folder location for both XML files and PDF files.
Output Location
Type in the path or click Browse… to select the output hot folder location for the PDF files.
PDF file location to specify in the XML file
When the PDF files and the XML files are placed in different output hot folder locations, you must specify the path for the PDF files.
The specified path is used as a file reference to the PDF job file in the corresponding XML file.
Important: If you map a network drive with a read only root directory, make sure the specified folder location on the selected network drive has write access.
Target Device
If the selected output type is JMF over HTTP, you must specify the name of the device where you want to send the JMF file or select from a list of available devices. The device means every virtual printer, printer, or input device that supports the JMF over HTTP protocol.
Target URL
If the selected output type is JMF over HTTP, you must specify the address of the server where you want to send the JMF file over HTTP.
The URL might be different depending on the server. To retrieve the exact path for the server, read the specific documentation about the JMF over HTTP protocol for each server.

Examples

  1. For RICOH TotalFlow Path, the URL can be http://<ServerHostAddress>:28464/<sufix> where <ServerHostAddress> is the host name or the IP address of the computer where the virtual printer is located and sufix is the path configured in the JMF input extension.
  2. For RICOH ProcessDirector, you can use this URL: http://<ServerHostAddress>:15080/aiwservices/v1/jmf where <ServerHostAddress> is the host name or the IP address of the computer where the virtual printer is located.
    Note: Make sure that the device where you want to send the jobs supports JDF input.
  3. For RICOH TotalFlow Production Manager, you can use this URL: http://<ServerHostAddress>:15080/aiwservices/v2/jmf where <ServerHostAddress> is the host name or the IP address of the computer where the virtual printer is located.
  4. For several Ricoh TotalFlow Print Server printers, you can use this URL: http://<ServerHostAddress>/webJmf/Device1 where the target device is a virtual printer and <ServerHostAddress> is the host name or the IP address of the computer where the virtual printer is located.
  5. For several printers with EFI Fiery Controllers, you can use this URL: Http://<ServerHostAddress>:8010/ where the target device is a virtual printer and <ServerHostAddress> is the host name or the IP address of the computer where the virtual printer is located.
Job Status
Select one of these options:
  • Automatic Replies Only: The TotalFlow BatchBuilder system receives the state of the job sent for printing automatically from the printer.
  • Automatic Replies and Poll for Job Status: If a printer does not automatically return the state of the job sent for printing, you can use this option to request Job Status information directly from the printer. Depending on the Job Status information received, the TotalFlow BatchBuilder updates the state of the job to Printed or Output Error.
Test Connection
If the selected output type is JMF over HTTP, you can click Test Now to verify if the server where you want to send the JMF file is available or if the specified virtual printer is valid.
    Note:
  1. Make sure that the printer has a proper network configuration (including DNS, gateway, and network mask), in order to have the job state updated correctly. Status updates are sent by the printer, make sure that the Firewall is not blocking communication with the printer.

  2. Sending jobs to the device might fail even when the connection test succeeds. This usually depends on the device protocol implementation. Check the device configuration and resubmit the job.

Paper Catalog tab

In the Paper Catalog dialog you can manually import a paper catalog from one output to another. To import a paper catalog, click the Import Paper button. The Import Paper dialog is displayed.

Output:
Browse the list and select the paper catalog of an output in the system. The papers displayed in the output are checked by default, uncheck the papers you do not want to import.
Click OK. A confirmation message is displayed with the number of imported papers.

You can manually enter a media catalog into TotalFlow BatchBuilder, that is selectable for jobs, batch tickets, and banner sheets. To edit properties, duplicate or delete a paper, select one paper from the list and right-click. To add a new paper, click the Add Paper button. The Add Paper dialog is displayed.

Paper Name
You can edit the name of the paper used. You can enter a string of maximum 256 characters. This field is mandatory.
Product ID
You can edit the product ID. You can enter a string of maximum 256 characters.
Paper Type
You can edit or select the type of paper used from a list:
  • Bond
  • Offset Text
  • Cover
  • Tag
  • Index
Paper Weight
The paper weight varies based on the paper type and the paper size. You can edit the paper weight.
Paper Color
You can type in or select the paper color form a list.
Paper Finish
You can type in or select the paper finish from a list:
  • Uncoated
  • Coated
  • Glossing Finish
  • Ink Jet Finish
  • High Gloss Finish
  • Matte Finish
  • Polymer Finish
  • Satin Finish
  • Semigloss Finish
  • Silver Finish
Paper Width
The width of the paper.
Paper Height
The height of the paper.
    Note:
  • The Input Type column displays either the Local Paper or the Paper Catalog from JMF over HTTP and TotalFlow JMF over HTTP. You can edit, duplicate or delete a Local Paper. You can duplicate a paper received via JMF over HTTP and TotalFlow JMF over HTTP Paper Catalog. The duplicated paper is created as Local Paper. The system displays the Update Paper button in the Paper Catalog tab only for JMF over HTTP and TotalFlow JMF over HTTP printers.

  • The system refreshes the Paper Catalog once a day. If the printer is offline while TotalFlow BatchBuilder is auto refreshing the paper catalog, the existing catalog remains unchanged. When a new or an edited JMF is defined, the system automatically updates the paper catalog, right after the output save. The paper catalog is automatically refreshed only if and after you click first the Import Paper button.

Commands tab

You can create one or more custom commands using batch, order, or job attributes. The TotalFlow BatchBuilder system creates a .bat file containing the specified commands. When a batch is sent to the output, the print files, the banner sheets, the batch tickets, and the xml files are copied to the output folder and then the commands are executed.

Command Timeout
Specify the number of minutes TotalFlow BatchBuilder must wait before the command is timed out and the process it terminated. When a command is timed out, the job state is set to Output Error and an alert is sent.
Command Field
Enter one or more commands separated by line breaks. In each command syntax you can specify batch, order, or job properties using these variables: ${batch.[propName]}, ${order.[propName]}, ${job.[propName]}.
Insert Attributes
You can add job attributes, batch attributes, or order attributes to the custom command syntax. Select the values you want to insert from the available attributes lists.
    Note:
  • When you cancel a batch in Sent state and there are commands running, the TotalFlow BatchBuilder system terminates the processes.
  • Make sure the specified custom commands are in a correct format. The TotalFlow BatchBuilder system sends and alert when an error occurs.

Banner Sheets tab

Banner Sheets
Click the First sheet and/or Last sheet checkboxes if you want to include banner sheets for job files in the output folder.
File Handling
Click the checkbox if you want to insert the banner sheets into the PDF job file.
Sheet Location of Banner Content
Specify the location of the content on the banner sheet. You can select one of these options: Front, Back , or Front and back.
Banner Content Offset
Specifies the top or left position of the Banner Sheet content relative to the top or left corner of the page.
Paper
If you select the Banner Sheets checkboxes, the paper presets are available. Properties set here become banner sheets defaults;
  • Match Job — disables the controls that configure media and uses default settings.
  • Custom — enables the controls that configure media, any setting specified are included in banner sheets XML/JDF/CSV.
If you select Custom value, you can type in or select a media from the output Paper Catalog list. To add a paper type, click the Add Paper button.
Border/Sheet Color
Click the checkbox if you want to print color on the document sheet edges.

Select the Color Location;

  • Entire sheet — applies the color to the whole sheet.
  • From sheet edge — specify the distance from the sheet edge where you want to apply the color.

Custom Colors
You can set custom border/sheet depending on job properties. To choose the desired color, click any color rectangle. The color picker opens. To close the color picker, click any side of the screen.

To configure the criteria for the banner sheet:

  1. Select the attribute type from the first list.
  2. From the second list, select one of these operators:
    • Is
    • Is not
    • Between
    • Greater than
    • Less than
    • Greater than or equal
    • Less than or equal
  3. To complete the criteria, enter or select a value for the specified attribute type.

Specify a percentage value from 0 to 100 for each color from the CMYK color model:

  • C — cyan
  • M — magenta
  • Y — yellow
  • K — key (black)

Color Preview displays the color created with the specified CMYK values.

You can select one or more attributes to use as criteria for the banner sheet. To add a new attribute, click , the Add Criteria button. To remove an attribute, click , the Remove Criteria button.

Batch Tickets tab

Specify if you want to print the batch details and the location where to send the batch ticket. The system generates a batch ticket file containing the batch details.

Batch Ticket Printer
Send Batch Tickets to a Printer Select this option to send the batch ticket to a printer. Choose a printer from an existing list of printers mapped to the TotalFlow BatchBuilder server. You can also specify the number of copies of batch tickets you want to print.
Send Batch Tickets to Output Device Select this option to send the batch ticket to the specified output device. The batch ticket file is placed as the first job in the batch and the job sequence number for the batch ticket is 0. The batch ticket file is not displayed in the batch detail dialog and does not appear as a job in the user interface. Paper

Properties set here become batch ticket defaults. Specify which job properties you want to use for the batch ticket media:

  • A4: Uses the default media settings for job properties.
  • Custom: Allows you to specify media settings for job properties.
      Note:
    • The first value for the Paper properties is displayed based on installation settings. A4 is displayed for metric system and Letter is displayed for imperial system.
    Paper Name
    You can edit the name of the paper used. You can enter a string of maximum 256 characters.
    Product ID
    You can edit the product ID. You can enter a string of maximum 256 characters.
    Paper Type
    You can select the type of paper used from a list:
    • Bond
    • Offset Text
    • Cover
    • Tag
    • Index
    Paper Weight
    The paper weight varies based on the paper type and the paper size. You can edit the paper weight.
    Paper Color
    You can type in or select the paper color form a list.
    Paper Finish
    You can type in or select the paper finish from a list:
    • Uncoated
    • Coated
    • Glossing Finish
    • Ink Jet Finish
    • High Gloss Finish
    • Matte Finish
    • Polymer Finish
    • Satin Finish
    • Semigloss Finish
    • Silver Finish
    Paper Height
    You can specify the height of the paper.
    Paper Width
    You can specify the width of the paper.

To create the new output hot folder, click OK.

To close the New Output panel and discard the entered information, click Cancel.

Note: You can also create a new output by duplicating an existing output folder.

To create a copy of an existing output hot folder:

  1. From the list of output sources, select an output folder.
  2. Right-click and select Duplicate…. An edit window with the copy of the existing output is displayed. All output properties are copied including mapping attributes.
  3. Edit the output properties and click OK.