Ch. 003. Download Orders on a Schedule You Set (AWI v1)

AUTOMATED WORKFLOW INTEGRATOR > AWI User Manual & Video

Download Orders on a Schedule You Set

Download Rules tab

After you login, you will be on the Download Rules tab. This is the main control area. This is where you create,
edit, arrange, or delete Download Rules. Download Rules determine which orders Automated Workflow
Integrator will download, what files should be included, where they will put on your computer or network, and
even how they should be named.
 
Directions Format
For directions to a specific area of the Automated Workflow Integrator, we will use the shorthand “Download Rules tab > ✚ icon > Rule Definition window” to indicate how to get to a specific area. For example, “Download Rules tab > + icon > Rule Definition window” means click the Download Rules tab in the application, then click the "✚" (plus) , then use the Rule Definition window that displays to create a new rule.

Download Rules Icons

There are 5 icons used in the creation, editing, and re-ordering of Download Rules:    ⬇ ⬆ ✚ ✎ ⊗
✚ (Plus) is clicked to add a rule
✎ (Pencil) is clicked to edit a rule
⊗ ( X ) is clicked to delete a rule
⬇⬆ (Arrows) are clicked to move a rule up or down the order of execution list.

Adding a Rule

  1. Click the ✚ (Plus) icon in the Download Rules tab to add a rule. The Rule Definition window will pop up. 
  2. Give the rule a name.
  3. Set the location the order file(s) should be downloaded to. If you have configured an FTP location, you may select it by choosing "FTP" in the "Download To" section. Otherwise, you should select a local or network file path by selecting "System Path" in the "Download To" section and then finding the correct location:
    • Windows: Set or select the hot folder you want the order files sent to.
    • Mac users: 
      • In Applications, go to Terminal
      • Type cd /Volumes (note capital V)
      • Type ls
      • Note the exact spelling and casing of the network share you want to use. 
      • In AWI, you cannot click the "..." button to find a network share. Instead, type it in. 
        • The path must begin with /Volumes/Example: if "RIP" is the name of the shared folder, then enter /Volumes/RIP
        • Folders with a space in the name are not supported. Example: the destination folder is named "Rampage RIP". The path /Volumes/data/Rampage RIP will not work. Rename the folder "RampageRIP" and the path /Volumes/data/RampageRIP will work.
  4. Specify the file extension you want if appropriate.  For example, the default "*.pdf, *ps" will download files ending in .pdf or .ps.

    Automated Workflow Integrator will automatically unzip any zip files. The contents of the zip will be put in the target folder, not the zip file. Note that any file name filters in the rule will apply to the name of the zip file rather than to its contents.
  5. Choose the Rule Type and enter Values to match as needed. For example, use "Catch All" to grab everything. However, a catch-all rule is not required.
  6. Set the Rule Attributes, Save.

Rule Types. A number of options are available for the type of rule.

  • Buyer username (or email) matches.This can be used to grab orders placed by a specific person.
  • Catch All. This will grab all orders. A catch-all rule is not required.
  • Printer location matches. If you have more than one production location set in Pressero > Preferences > Locations, this can be used to select orders based on  the production location you have set for a B2B store (Sites > Settings > General tab > Shopping Cart > Location).
  • Product attribute key matches. If you have created one or more Product Attributes (Pressero > Preferences > Attributes), and have assigned the Attribute with a value for one or more Products (Sites > Settings > Products > Attributes tab), the Attribute value can then be used to grab orders for the product(s) that match.
  • Product name (or url) matches. Grab orders based on the product name or its URL.
  • Site name (or url) matches. Grab orders based on the store name or its URL.

Rule Attributes. Use the checkboxes to select the attributes you want for this Download Rule. 

  • Create folder for item. Every order has at least one item being ordered. Some orders are for several different items. When used with "Create folder for item" this rule attribute will create a subfolder in the order folder for each item.
  • Create folder for Order. This will create a subfolder in the hotfolder.
  • Download generated files. These are files the system creates such as eDocbuilder production files and proof files.
  • Download product assets. These are files you uploaded via the Pressero Asset control and added to a product. This is often used for stock products where you want to avoid staff having to find an use the correct version production file when the order arrives.
  • Download uploaded files. These are files your customer uploaded as part of the ordering process. These are files the attached using the upload files capability your set for a product in Sites > Products > General Information tab > Upload Files.
  • Prepend file name with local date and time of download. This may help sorting orders by date and time.
  • Prepend file name with order and item number.
  • Custom File Names: If BOTH the "Prepend file name with local date and time of download" AND the "Prepend file name with order and item number" options are unchecked THEN a text box is available to construct a custom name. Here are the script tags for custom naming:
  • Script Tag, Description
    {order} order number
    {item} order item number
    {product} product name
    {id} order identifier
    {y} year of download
    {m} month of download
    {d} day of download
    {h} hour of download
    {min} minute of download
    {x} original file extension of file
    {f} original file name without extension
    {t} type of file. The result will be "gen", "asset", or "upload"
    {q} quantity of item being ordered

    These script tags can be put together in any order/combination. Not all need to be used. Text, spaces, hyphens etc can be added. For example: Entering the script {order}- {item}__{product}-{id}.{x} could result in a file being named "1001-1__Business Card-John Smith.pdf" while {product}_{order} Item{item} could result in a file being named "Business Card_John Smith.pdf_1001 Item 1" instead.
    In the above example, the order number is 1001, the order item is 1, the product name is Business Card.


Multiple Download Rules. Automated Workflow Integrator is extremely powerful and versatile. You can create multiple Download Rules, each grabbing a different kind of order and placing it in the appropriate workflow folder. However, the top to bottom arrangement of Download Rules listed in the Download Rules tab will affect how orders are downloaded. Careful attention must be paid to the sequential order of download rules.

For example, let's say you created two rules, one to "Business Cards" to download business card orders and place them in a "Business Cards" hot folder, and a second "Everything Else" rule to download all orders and place them into "Everything Else" hot folder.

As long as the Business Cards rule is first in the list, the second "Everything Else" will then grab the rest of the orders. However, if Everything Else is first, it will grab all the orders, including business cards, and when Automated Workflow Integrator then executes the next rule (Business Cards), nothing will happen. All the business card orders have already been downloaded by the first rule.

Production Software Control Files

AWI supports the ability to create "control files", which are instructional files for specific workflow software systems.  Typically these files are JDF or XML based, but, may be in other formats as the specific integration dictates.  Most control files require the use of custom attributes to be set at the product or pricing engine level, as many workflow solutions need different data than what Pressero typically captures.  Click here to read about product attributes, or click here to read about pricing attributes. Attributes assigned at the pricing level will have a higher priority than attributes set at the product level.  For example, if the attribute for "sides" is set to "single" at the product level and "double" at the pricing level, AWI will use "double", as it is derived from the pricing engine.  You will need to separately define where to save the control file, as many systems require it to be in a different location than the print files.  You may send the control file to an FTP location or to a local system or network path. 

Tucanna Approval

The Tucanna Approval integration requires that the company name in Approval match the site name in Pressero. The user email must also match an existing user in Approval. For cloud instances of Approval, job file and control files must be sent via FTP. The following optional attributes are available:
  • tucannaapproval_min_width_inches: The width of the file, in inches.
  • tucannapproval_min_height_inches: The height of the file, in inches.
  • tucannapproval_min_res_ppi: The minimum resolution.
  • tucannapproval_preflight_profile: The name of the preflight profile to use. If empty, the default profile is used.
  • tucannaapproval_workflow: The name of the approval workflow to be used.  This workflow named is defined in tFlow Approval and must match the value set in Pressero.

Fujifilm XMF

In order to automate the flow of jobs into the XMF workflow, some of the following attributes will be necessary. Please read the XMF/Pressero Integration notes, provided by Fujifilm, for detailed information and examples.
  • JDF_NumberOfPages: Number of pages in the job.
  • Fuji_JobName.  By default the Pressero job name and product name will be used.  This attribute allows you to override that job name.  You may use the following script tags to customize the job name:
    • {order} order number
    • {item} item number
    • {product} product name
    • {id} name of job (if supplied)
    • {q} quantity
    • {ordernotes} notes provided on the checkout screen
    • {itemnotes} notes provided on the product detail screen for the ite
    • {pn} printer's part number
    • {ppn} customer facing part number
    • {po} purchase order number/code provided at checkout
  • Fuji_TemplateName: Can reference a defined template within XMF. If not supplied, the name of the product will be utilized.
  • Fuji_JobPriority: Integer between 1 and 100 to indicate the priority of the job.
  • Fuji_Comment: Written into the comment field for the job.
  • Fuji_PermitRemoteFileUpload: Set to "true" to enable Remote upload of content for this XMF job.
  • Fuji_ApprovalDaysBeforeDueDate: Set the number of days before the due date of the job that the customer has to approve the job.
  • Fuji_ApprovalComment: Written into the approval comment field for the job.

HP JDF (SmartStream)

HP complaint JDF files should be saved to the \\Hostname\Jobs\JDF folder, where the Hostname is the server name of the SmartStream DFE.  A path to the production PDF file on Pressero is embedded in the JDF so the location of the actual PDF file can be set to a temporary folder.  You should create the following product attributes (Preferences > Product Attributes > Add New Attribute).    Please note that all measurements consider your country for unit of measure.  For example, 8.5 will be interpreted as inches if your company is in the US.   All attributes are optional.
  • HP_JobSpec: Refers to a production template configured on the DFE.  
  • JDF_Substrate_Name: Primary stock to use
  • JDF_Substrate_Width: Width of primary stock.  
  • JDF_Substrate_Height: Height of primary stock.  
  • JDF_Substrate_StockType: Type of stock
  • JDF_Substrate1_Name (1, 2, 3....): Additional stock definition
  • JDF_Substrate1_Width (1, 2, 3....) 
  • JDF_Substrate1_Height (1, 2, 3....)
  • JDF_Substrate1_StockType (1, 2, 3....)
  • JDF_Substrate1_SheetRange (1, 2, 3....): If additional stock is used, set the sheet range using x-y syntax.  For example, 5-8 for pages 5 to 8.
  • JDF_Plex: Do not set for simplex, or set as Duplex or TumbleDuplex
  • JDF_Page_Width: Width of document
  • JDF_Page_Height: Height of document
  • JDF_Imposition_Template: Name of imposition template to use, if required.

ImpoStrip from Ultimate Technographics:

It is highly recommended that you create one attribute called impostrip_QueueName.  Each product should assign a value to that attribute, indicating which queue ImpoStrip should use.
 

Metrix

A number of product attributes should be define and used on a per product basis. A default value will be used
unless the product attribute is set at the product level.
Attribute  Value Default
metrix_DisplayColor Color for layout in metrix. RGB value in r,g,b format.
For example 255,0,0
255,255,0
metrix_DryingTimeMultiplier Drying time multiplier. 1
metrix_Grade  Stock grade, from 1-5 1
metrix_stockName Name of stock to be used Undefined Stock
metrix_Thickness Thickness of stock .1
metrix_Vendor Vendor for stock House
metrix_WeightUnit gsm or lb lb
metrix_type Flat, Folded, or Bound Flat
Metrix_FinishedTrimWidth Trim Width .1
metrix_FinishedTrimHeight Tim Height .1
metrix_BleedTop Top bleed 0
metrix_BleedLeft Left bleed 0
metrix_BleedBottom Bottom bleed 0
metrix_BleedRight Right bleed 0
metrix_Rotation Rotation 0
metrix_pageCount Page Count (Per Metrix, this will also be rounded up to an even number when needed) 2
     

Canon (Océ) Prisma

Please note that this integration is in testing (beta). No attributes are predefined for this .OCT structure, however, any attribute whose name follows a defined structure will be included, along with its value. The name format is "OCT_{section}.{parameter}".  Valid Section names include "job", "client", and "receiver".  
 
For example, a product attribute named "OCT_job.Message_Text" with a value set at the product level of "This is the message text" will set the Message_Text to be "This is the message text" in the [job] section of the .OCT file.
 
Please see the section marked "Oce Custom Ticket (OCT) in the Prisma User Manual for a full list of the section and parameter names.
 

ErgoSoft:

It is highly recommended that you define three attributes:  ergoSoft_ScaleValue, ergoSoft_ScaleMode, and ergoSoft_Position. Consult with the ErgoSoft documentation or support staff to learn how to effectively use these settings.

Metamation: 

It is highly recommended that you define one attribute in Pressero named metamation_grainDirection. Consult with the Metamation documentation or support staff to learn how to effectively use this setting.

Using Product Attributes in Rule Definitions

If you have created one or more Product Attributes (Pressero > Preferences > Attributes), and have assigned the Attribute with a value for one or more Products (Sites > Settings > Products > Attributes tab), the Attribute value can then be used to grab orders for the product(s) that match.
  • You add and name the Attribute.
  • In the Sites > Products >Attribute tab you select the Attribute, set a Value for it, add it to the list, and Save.
  • To set a Rule Definition that places orders with an "imposition" Attribute value into an Imposition hotfolder you could create a Rule called "Imposition". Set the Download folder to one you created on your local drive called "imposition", for Rule Type select "Product attribute key matches" and enter "imposition" for the Value Match and "workflow integrator" for Key Matches.

Polling 

You can set how often the files are downloaded from Pressero by using the Polling menu in the Download Rules
tab.

The maximum frequency you can select is every 15 minutes. Other options are 30, 60, and 120 minutes. Note: regardless of the frequency you select, only orders over 15 minutes old will be retrieved. This allows enough time for eDocBuilder production files to be generated and available for downloading.

Example: Three orders arrive,
Order #231 at 2:30,
Order #232 at 3:00 ,and
Order #233 at 3:14.

The Automatic Workflow Integrator connects to Pressero at 3:15. It will only retrieve Order #231 because it is the
only one over 15 minutes old. It will retrieve orders 232 and 233 at the next scheduled download when they will
be over 15 minutes old.The 15 minute delay between when the order is placed and when AWI will retrieve it can
be reconfigured but is not advised. Contact Aleyant if this type reconfiguring is desired.

Any connection issues to Pressero servers will be logged in Automatic Workflow Integrator rather than popping
up a message box (which stops further processing). Automatic Workflow Integrator will attempt to recover and
continue processing after a connection issue occurs.

Processing Download Rule(s)

In the Download Rules tab, select the Polling frequency and click the Process button.
  • Automated Workflow Integrator will begin processing the Rule(s) starting with the first rule in the list. 
  • A log of the Automated Workflow Integrator activities will display in the black pane. In the highlighted area of the screenshot below, it shows order item 637-2 being processed, and being downloaded to the local C hard drive folder called "pressero orders" with a subfolder labeled 637 being created inside pressero orders, and a subfolder labeled 637-2 being created inside the 637 folder, with the file called 637-2.pdf being deposited there.
  • A progress bar will display at the bottom of the window. It will also indicate which item is being processed, as well as the total number to be processed. The screen shot below shows item 6 of 26 is being processed.

Processed Rules tab

When processing is complete, click the Processed Rules tab displays a list of the orders that have been
downloaded, as well as some basic information about each. Use the horizontal scroll bar to see data on the far
right of that tab.

There is a Requeue checkbox that can be used to rerun the download for the selected items. This can be useful
in case a staff member accidentally deleted an item from the hotfolder for example. Or, you may have changed
the Download Rule and want to reprocess based on the new rule criteria. In either case, by checking the
Requeue box and clicking the Process button, you can have Automated Workflow Integrator reprocess the
marked item(s) into their respective hotfolder(s).