Ch. 004. Download Rules (AWI 2)

AUTOMATED WORKFLOW INTEGRATOR > AWI User Manual & Video

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.

 

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.  This behavior may be modified in the General tab of the rule.

 

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
⊗ (Trash) is clicked to delete a rule
⬇⬆ (Arrows) are clicked to move a rule up or down the order of execution list.

Adding a Rule

Click the ✚ (Plus) icon in the Download Rules tab to add a rule. The Rule Definition window will pop up. This windows is divided into 5 tabs.  After making changes it is critical to click the "Save" button.

General Tab

On this tab you may create a name for the rule and configure the options that will trigger the rule to process:

  • Rule Name: You may assign a name for your own reference.
  • File Name Pattern: Specificy one or more patterns using a wildcard (*) if necessary.  Separate rules with a comma.
  • Rule Type: This indicates how AWI should analyze the order to see if it should apply to the order.
    • 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.
  • Value Matches: Utilized for certain rule types needing to evaluate some text. 
  • Key Matches: if the rule type is for a product attribute key match. 
  • Allow Subsequent Rules to Process: Normally when an order item is matched and processed by a rule, subsequent rules may not process the file.  If checked, rules that are evaluated after this rule can also apply to the order item.

Download Tab

If you would like this rule to download files for the order item, check the box. 

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

Control Files Tab

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.  To generate a control file for the order item, check the box to generate the control file, select the control file type, and specify where to place the control file.

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 attributes are available:
  • tflow_product: Required attribute that indicates which product in tFlow to assign the job to.  The value must match a defined product name in tFlow.
  • tflow_queue: Which output queue the job should be sent to when released.  This must match a queue name defined in tFlow.
  • 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.
  • 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.
In addition to the attributes, selecting the Tucanna tFlow control file will show two new fields in the tab.  These allow you to provide custom Job Name and Order Names using a combination of text and variable tags.  Click here to see the reference section on using Variable Tags.

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_ScaleMode: How the image shoud be scaled.  Options include MAXEXTENT, PERCENT, WIDTH, or HEIGHT
  • ergoSoft_ScaleValue: The actual scaling of the image, which depends on the ScaleMode set.  If ScaleMode is PERCENT, then setting ScaleValue to 100 means to print at normal size.
  • ergoSoft_Position: LEFTTOP (default), RIGHTTOP, LEFTBOTTOM, or RIGHTBOTTOM
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.

Phoenix Software by Tilia Labs (http://tilialabs.com/phoenix.html)

You will need to define at least one attributes in the Pressero pricing calculator named JDF_substrate_Name which will determine the primary stock to us. It is preferred that you also list the stock weight/grade separately if possible and use JDF_Substrate_Grade attribute for this. We will pass the Product Name, Quantity ordered, Stock, Grade, Artwork file, Order number and Notes. Consult with the Tilia Labs documentation or support staff to learn how to effectively use these settings. 

Queuing Tab

You may wish to hold jobs until you can release them in a batch in order to gain some production efficiencies.  You may do this by checking the "Enable Queuing" box.

Release Type:

  • Number of Unique Jobs or Order Items: AWI will wait to release until a certain number of jobs has been reached.  For example, this rule could be used to wait for at least 5 orders for the same type of business card.  With this type the quantity of each order item is not considered.  So whether a business card order is for 250 cards or 5000 cards it will be considered as a single job.  When selecting this type you should configure the "Minimum Threshold" which is the number to wait for.  As a safeguard, you may override this by also specifying a "Max Hold Hours" to prevent jobs from waiting too long.
  • Total Quantity: AWI will wait until the combined orders reach a certain quantity.  Unlike the previous release type this does consider how much is being ordered.  For example, setting the threshold to 5000 could be filled by a single order of 5000 cards or 10 orders of 500 cards.
  • Hours: This will release every time the number of hold hours has been reached.
  • Daily: This will release once per day when the defined time is reached.
  • Weekly: This will release once per week on the day and time defined.
  • Monthly: This will release once per month on the day of month and time assigned.  If you select a day of the month that exceeds the total number of days in the month, the queue will be released on the last day of the month.  For example, if you assign 31 as the day, the queue will be released on the 30th in June.

Status Tab

AWI can automatically change the status of the order item in Pressero after successfully processing the rule.  Enable this option by checking the "Enable Status Change" box.  You may select which general status to change the order item to.

Please note: For orders using a custom workflow (this does not apply to default workflow stages) in order for your custom stage to appear in the AWI, the Stage Meaning needs to be set to "None" in Pressero (Preferences > Workflows > Select or Create a workflow > Select or Create a stage > Stage Meaning).

Options Tab

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.
Format 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. Click here to learn more about this.

Report Tab

AWI can automatically generate the corresponding Pressero report(s) for the order item.  Check the box next to each report needed and specify the download location.