Ch. 001c. Getting Started with AWI

AUTOMATED WORKFLOW INTEGRATOR > AWI User Manual & Video
INSTALLATION
 
The current version of AWI is available on Ch. 001b. Installation on our support site. The date the last version was posted will always be noted there. It is important to keep your AWI updated to the current version, but currently the only way to check if it has been updated is to check that page. We hope to provide better notification for AWI updates in the future.
 
After running the installer, you will have a desktop icon for Pressero Automated Workflow to launch the application. The first time you launch AWI, it will prompt for your AWI user credentials. Only one Admin user in your Pressero account will be activated for AWI. You can check your list of admin users by logging into your Pressero account and going to Preferences > Admin Users. If you do not know the password for your AWI user, it can be reset from Preferences > Admin Users in your account.
 
FIRST RUN
 
When AWI is run for the first time, it will create a folder /Documents/AutomatedWorkflowIntegrator in the local user account folders on the machine running AWI. The folder /Documents/AutomatedWorkflowIntegrator will contain the file database.db, a folder for Logs if enabled, and possibly a couple of other temporary database files. But all the settings, downloaded orders and rules for AWI are contained in the database.db file in this folder. We will need a copy of your database.db file if you are seeing any unexpected behavior that you would like us to check, or if you have any questions about your AWI setup.
 
 
The first time AWI is run, it will also show a message saying that there are no rules setup. The first step is to create at least one basic Catch All rule. How many rules will be needed for your workflow will be determined by what requirements you have for what jobs should be processing to what hot folders you need those order files pushed to. You could have one rule, or a hundred rules setup in your installation of AWI.
 
 
 
TABS AND BUTTONS ON THE AWI WINDOW
 
When you are looking at the AWI window, there are three tabs that have different purposes. Download Rules shows any download rules you have setup. Processed Items contains any orders processed by AWI. Queued Items contains any orders that are queued for processing at set intervals, depending on what settings are enabled on the Queuing tab of any download rule. When you are initially setting up AWI, it is recommended to get your rules and your workflow setup, and enable any queuing once you are confident that AWI is processing your orders as expected.
 
The Settings button at the bottom of the window gives you access to any preference settings in AWI. The button Process is used to tell AWI to manually process over the orders in your account, but you do not have to hit the button to make AWI process the orders, AWI will process over your orders every hour provided it is launched and running on your workstation. AWI will also be listening continually for new orders in your account. The hourly process ensures that AWI will catch any orders that have been paid and approved since the last time AWI has processed. The Close button will shut down AWI, and it will need to be relaunched in order to be active on your machine.
 
DOWNLOAD RULES
 
Creating a new rule is easily done by clicking the plus button at the upper-left of the AWI console window. If you need all the files from all orders in your Pressero account to go to one destination for processing, then you just need one rule. If you need the order files to go to different destinations based on what site they come from, or what product they are ordered on, then you might have multiple rules setup in your AWI.
 
Each Download Rule that is created has a series of tabs that allow you to adjust the settings for that rule. The tabs General, Download, Control Files, Queuing, Status, Options and Report give you access to any settings that can be adjusted for that rule.
 
The General tab lets you set a name for the rule, what file name patterns it will download, the type of rule, a value that might be matched and the name of an attribute if using a rule type that references a product attribute.
 
For example, a Catch All rule is going to match to all the orders in your account. If you enable a Catch All rule, and set a download path for the files on the Download tab for the rule, it will be looking at every order in your account, and downloading any associated order files according to what settings are enabled on that download rule. The Rule Type setting also allows for matching the orders from specific sites, users, locations, or even according to product attributes assigned to the products.
 
It's important to note that the rule in AWI specifies what type of files to download with *.ps and *.pdf files being the default file names to match when downloading. For example, if you have a product setup with a file upload field intending to allow clients to upload Excel files on their orders, you would need to add *.xls and *.xlsx to the File Name Pattern field on the rule in order for those files to be downloaded through AWI.
 
 
The Download tab allows you to specify where any downloaded order files for the rule will be placed. This could be set to point to a local folder, a hot folder or other location on your network, or potentially even an FTP site that the rule will upload files to.
 
The Control Files tab allows for setting the rule to create a vendor-specific XML, JDF, or Text file that contains additional information about the order and product. Control files can also be downloaded to a local folder, a network hot folder, or pushed to an FTP site. The format options for the control files are mostly vendor-specific options, but there is a generic option called Pressero XML that contains most of the information about the order; dates, quantity, price, tax, user information, site information, any pricing calculator options chosen for the order, and more.
 
The Queuing tab allows setting AWI to only push the order files to the destination folders based on the number of jobs, total quantity or various intervals. The Status tab allows for enabling the ability to change the status on the orders in your Pressero account, which can  indicate that AWI has recieved a particular order, and that the order has moved on to the next stage in the workflow. Queuing is disabled by default, and AWI will just process and push files for any orders that match the download rule. Queuing is only enabled if you specifically need to hold onto the order files until a certain limit or interval is reached.
 
The Status tab allows for choosing a status that AWI can change on any orders that it downloads. Most of what AWI does involves downloading orders and files from Pressero, but this tab allows for telling AWI to update the status on any orders that it processes. This option can be used so that you can see what orders have been downloaded by AWI, just by looking at the status on the orders in your Pressero orders listing.
 
The Options tab has additional options that apply to the order files The options to download all the types of order files are enabled by default. AWI can download eDocBuilder generated production PDF files, files that have been uploaded from the product on the order, or asset files associated to the product on the site. It is possible to have AWI rename the order files in a specific manner, get the preview files associated to the order, or even control if downloaded zip files are unzipped or not unzipped when downloaded.
 
The Report tab lets you separately enable downloading of the order reports that generate for every order placed in Pressero. Order report files are human-readable PDF files that show the information about the order. The report files can also be directed to a particular folder, hot folder, or pushed to an FTP site. These are the report files that are generated for any Pressero order, and can also be manually viewed from the order listed in the Pressero orders area.
 
 
LIMITATIONS
 
AWI only downloads order information and files, so any files that AWI will be able to download will only be from orders placed on your sites, and not from standalone form submissions enabled on site pages. For standalone form downloads and files, you will need to go to Tools > File Manager in your account, and then to the Uploads folder, AWI cannot process or download fies placed into the Uploads folder using forms assigned to pages or using the FTP command on sites.
 
AWI will download files for orders when those orders meet the criteria that is set on the download rules, if those orders are  marked approved and paid in Pressero, and if the orders are within the timeframe specified by the "Number of Days to Search" setting in the settings for that copy of AWI.
 
AWI is a desktop utility and must be open to process any orders in the Pressero account, it does not run as a service, the utility must be open on a machine in order to process orders. The AWI will process orders every hour, looking back over the orders that are within the "Number of Days to Search" range in the AWI settings, checking if any orders have been placed, or paid and approved, since the last time the orders were processed.
 
SUPPORT
 
If AWI is not behaving as expected and you are running the current version of AWI, please open a ticket to our support department at support.aleyant.com, and include your database.db file with your request. Including the database.db file allows us to load up the settings you are working with and test it from our side.
 
MORE INFORMATION
 
For more information regarding AWI settings and usage, please see the specific chapters below.