Working with ad hoc rules

EOM Console

under construction

Ad hoc rules are used for documents that exist in Barr EOM, where business rules are used for documents as they enter Barr EOM. The rules are initiated conditionally or by a task created in the Schedule Manager. An example use for ad hoc rules is to merge a set of documents into a package.

See also:


Managing ad hoc rules

The following procedure provides the basic steps for managing ad hoc rules.

  1. From the EOM Console menu bar select Tools | AdHoc Rules. The AdHoc Rules Manager dialog box displays.

  2. The ad hoc rules grid lists all of the defined ad hoc rules in the order they will be processed. Selecting a rule will display the rule for preview below the grid. The ad hoc rules grid is editable. Use the following procedures from the rules grid.

  3. Use the check box in the Enabled column to determine if the rule is enabled or disabled.

  4. To change the follow-on action, click in the Follow-on Action cell and select the action you would like to take after this rule has been processed. You can continue processing rules or select not to process any additional rules.

  5. To modify the rule, double-click the row.

  1. Under the ad hoc rules grid, use the following procedures to configure rules.

  2. To create a rule, click Add. The AdHoc Rule dialog box displays.

  3. To modify a rule, select a rule and click Modify.

  4. To delete a rule, select a rule and click Remove.

  5. To create a copy of a rule, select a rule and click Copy. To rename the rule, double-click the rule or select the new rule and click Modify.

  6. To reorder the rules, select a rule and click Move Up or Move Down.

  1. Click OK or Apply to save your changes.

Top

Creating ad hoc rules

Use the following procedure to create an ad hoc rule. You will configure conditions and actions.

  1. From the EOM Console menu bar select Tools | AdHoc Rules. The AdHoc Rules Manager dialog box displays.

  2. Under the ad hoc rules grid, click Add. The AdHoc Rule dialog box displays.

  3. Enter a rule Name and Description.

  4. Use the Enabled check box to determine if the rule will be enabled or disabled.

  5. If you want to apply the rule to all documents, select the Always execute this rule (no conditions) check box. This will disable the When box as no condition statements are needed. If you select this option, skip the steps for configuring conditions.

  6. Use the When box to create and manage the rule conditions. Multiple conditions can be created and organized into groups. A blue box is used to indicate a condition group. To create a rule condition, perform the following steps.

  1. In the When box, click the <Target> link. Use the list to select the appropriate condition.

  2. Click the Operation link and select the appropriate operation.

  3. Click the Value link and select the appropriate value. This condition statement is now completed.

To include additional condition statements or create groups of conditions:

  1. Under Perform the following actions box, use the following procedures to manage actions.

  1. To create an action, click the <Action> link and select one of the following actions.

  2. Set Document State – Sets the document state to hold or ready.

  3. Route to Destinations – Specifies the destinations where documents should be sent.

  4. Set Document Properties – Configures document properties.

  5. Package Documents – Configures a package of documents.

  6. Zip Package – Zips the merged document or any other documents in Barr EOM.

  7. Merge Package – Configures the document properties of the merged file.

  8. To create additional actions, click Add Action.

  1. To modify an action, click the desired action link or click the area next to the link and click Modify Action.

  2. To delete an action, click the area next to the link and click Remove Action.

  3. To reorder the actions, click the area next to the action link and click Move Up or Move Down.

  1. Move the actions to their appropriate position by clicking the area next to the action link and clicking Move Up or Move Down. For example, the Add Documents to Package action should be above the Merge Package action and the Zip Package action should follow the Add Documents to Package and Merge Package actions.

  2. From the Follow-on Action list, click the action you would like to take after this rule has been processed. You can continue processing rules or select not to process any additional rules.

When new documents are created as a result of a rule action, the processing of the new documents varies from the processing of the original document. The new documents continue with the next rule action. The original document, if you choose Continue processing rules, skips the next rule actions in the current rule, and goes to the next rule.

  1. Click OK to save your ad hoc rule.

  2. Schedule the ad hoc rule using the Schedule Manager. Ad hoc rules do not function unless they are scheduled.

Top

Creating ad hoc rule actions

You can create the following ad hoc rule actions.

To set the document state

Use this action to set the state of documents to hold or ready..

  1. In the Perform the following actions box, click the <Action> link and select Set Document State. The Set Document State dialog box displays.

  2. From the list, click the appropriate document state, Hold or Ready

  3. Click OK.

To route to destinations

Use this action to specify the destinations where documents should be sent.

  1. In the Perform the following actions box, click the <Action> link and select Route to Destination(s). The Select Destination dialog box displays.

  2. Select the appropriate destinations in the tree. You can select multiple destinations by pressing the CTRL or SHIFT keys and selecting destinations. Selecting a destination group will select all destinations in that group.

  3. In the list below the tree, choose if you want to replace the destination already assigned to the document or use multiple destination routing and add to the destination already assigned to the document.

  4. Click OK. A new routing action is shown in the actions box. The action lists all of the selected destinations.

To set document properties

Use this action to configure document properties.

  1. In the Perform the following actions box, click the <Action> link and select Set Document Properties. The Document Properties dialog box displays.

  2. In the grid, configure the document properties. The grid lists the property values that can be configured grouped in the following categories: Basic options, Media selection, Document, Image adjustments, Finishing, and Other properties. To expand a category, click the down arrow next to a category name. To collapse a category, click the up arrow.

  1. Expand the category of the property you want to configure. The first node level in the category determines the print preferences for the properties it contains. In the Mode/Value column, select how the property should be applied when a document is sent to a destination. You can choose from the following options:

  2. Always Apply – Always applies the specified property value. Barr EOM will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Barr EOM will modify the commands to work with the printer family where the document is being sent.

  3. Apply Conditionally – Applies the property value conditionally. Barr EOM will only add or modify commands for the print preference when the printer family that the document is destined for is different from the printer family the document was originally designed for.

  4. Informational Only – Barr EOM makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only.

  1. Under each print preference are the parameters needed to generate that print preference. In the Mode/Value column, specify the document property value. You can use functions to insert and extract data as necessary.

  2. Click OK.

To package documents

Use this action to create a package of documents. This will take all of the documents that meet the criteria and put them in a multiple document package.

  1. In the Perform the following actions box, click the <Action> link and select Package Documents. The Package Documents dialog box displays.

  2. Enter the Naming prefix for the package document.

  3. In the Ordering property list, choose a document property that will control the order the documents are packaged. The desired property must be selected on the Global Destination Capabilities dialog box when you configure global destination properties.

  4. Use the following options to configure the closing conditions for the package. This will determine when the package is complete. You can configure one or more closing conditions.

  5. Closing document – Select this option to close the package once the specified closing content is received. In the Closing document action, choose if you want to remove the closing content, add it to the current page, or add it to the next page. In the When box, configure the conditions for specifying the content.

  6. Time elapsed since package creation – Select this option to close the package when a specified amount of time has elapsed since the package was created (the first document was added to the package). Specify the time period using the options next to Elapsed time.

  7. Time elapsed since last match – Select this option to close the package every period of time specified. Specify the time period using the options next to Elapsed time.

  8. Specific time of day has occurred – Select this option to close the package at a specified time each day. Use the Time of day spin box to specify the time.

  1. Click OK.

To create a zip package

Use this action to zip the merged document or any other document in Barr EOM.

  1. In the Perform the following actions box, click the <Action> link and select Zip Package. The Zip Package dialog box displays.

  2. Enter the Zip File Name in the box.

  3. If this rule will be used after all documents have been received into Barr EOM, select Used as a post-processing action.

  4. Select the following options as needed: Move original documents to retain and Set merged document to ready.

  5. If the newly created zipped document needs to be sent to a destination, select Route to destination and click the Browse button. From the Select Destination dialog box, select the destination in the tree. In the list below the tree, choose if you want to replace the destination already assigned to the document or use multiple destination routing and add to the destination already assigned to the document.

  6. Click OK.

To create a merge package

Use this action to create a merged file. You can use this action after creating a package to merge all of the documents in to a single document.

  1. In the Perform the following actions box, click the <Action> link and select Merge Package. The Merge Package dialog box displays.

  2. In the Merge file name box, enter the name for the merged file. This file will contain the documents.

  3. Next to Transform, click the Configure button to configure the transform. The Configure Transform dialog box displays.

  4. In the Server list, click the licensed transform server that you would like to use.

  5. In the Transform package list, you can select an existing transform package or create one. Complete the following steps to create a transform package.

  1. Click New. The General tab displays.

  2. Enter the transform package Name.

  3. Select a transform package Type of BarrEOM or DocBridge. DocBridge requires the purchase of a standalone version of the transform software and a separate license. DocBridge has more data types available.  

  4. If you select DocBridge, verify the EXE path is set to the correct folder. The default EXE path is @EOMTransformDir. To change the path, type in the box or click the ellipsis (...) button.

  5. Set the Logging State. The logging state determines if transform logs and temp files will be saved in the document folder. By default, the Logging State is set to Yes. All log files should be inspected during installation and pre-production testing to insure that fonts are correctly mapped. In a production system, the logging can be disabled to save disk space. If the transform operation returns an error (return code not zero), the log and temp files will not be deleted, and are available for troubleshooting.

  6. On the Filter Profiles tab, specify how the transform software will handle the formatting for each data type.

  1. On the Resources tab, specify where the transform software will find the resources needed for the transformation. For example, PDF fonts are usually found at the location of an Adobe installation.

  2. On the Fonts tab, you can control the font mapping of input fonts to output fonts. The defaults are typically correct, but may need to be adjusted for special cases. You can add or modify fonts directly in the grid.

  3. Click OK to create the transform package.

  1. Use the Override input filter profile assigned to document checkbox option to determine if you want to override the input filter profile assigned to the document or if you want to use the filter profile configured in the transform package. Select the checkbox to use the filter profile in the transform package.

  2. In the Output format list, click the format of the output file.

  3. Configure the conversion of each input format in the Input formats grid and then click OK.

  4. For all unlicensed input formats and any input formats you don't want to use, click in the Configuration column and select Do Not Transform.

  5. For licensed input formats, you can select Use Default Options or select a predefined configuration in the Configuration column. To configure a custom input format, click the ellipsis button in the Modify/New column. If Use Default Options or Do Not Transform is selected in the Configuration column, a new configuration will be created. If a predefined configuration is selected, that configuration will be modified. The custom transform options are configured on the Input options tab, Output options tab, and Page Layout tab. If BMP or PDF is selected as the output format, the Bitmap output tab or PDF output tab will also display.

  1. To configure package boundaries, select Package boundaries and click Configure. From the Package Boundary Fields dialog box,

  2. Under Package Properties, determine... You can use the first page properties, the last page properties, or create custom properties.

  3. To configure exception fields, select Exception fields and click Configure. From the Exception Fields dialog box,

  4. Select the following options as needed: Move original documents to retain and Set merged document to ready.

  5. Add blank pages for duplexing...

  6. If the newly created zipped document needs to be sent to a destination, select Route to destination and click the Browse button. From the Select Destination dialog box, select the destination in the tree. In the list below the tree, choose if you want to replace the destination already assigned to the document or use multiple destination routing and add to the destination already assigned to the document.

  7. Click OK.

Top