Create business rule actions
Use this procedure to create business rule actions.
Business rule actions are created to perform actions on documents. Examples include routing to destinations, transforming to other print languages, assigning to document folders, and editing document properties.
Steps necessary to configure action types are listed by procedures in this section. Perform the steps in the appropriate procedure to configure business rule actions.
Action | Description |
---|---|
Assign Profiles to Document |
|
Burst |
|
Extract Text | |
Modify Document Contents |
|
Modify Document Exceptions |
|
Set Document Properties |
|
Route to Destinations | |
Set Document Owner | Configures the document owner. |
Transform Document |
|
Analyze Document | Processes documents and populates document properties. |
Assign to Document Folder | Assigns documents to specific document folders. |
Convert Fixed Block to Variable Block | Converts FBA to VBA and FBM to VBM. It can be used when dealing with mainframe tape formats. |
Delete Document | Deletes documents. |
Delete Client Popup | |
Move Document to File Store | Moves documents to another location (file store). |
Package Banner | Adds a banner to the beginning of the package. The banner will be added as a separate document within the same package. |
Power Rule | Allows you to build multiple rules inside of one rule. |
Remove from Document | |
Run Ad hoc Rule | Runs an existing ad hoc rule. |
Run Command | Performs a command line operation on the document. |
Schedule Output | Schedules documents to print at a specific date and time. |
Send Email | Sends email messages when specific events occur in the document life cycle. |
Set Billing Accounts | Documentation coming soon |
Set Document State | Sets the document state to hold or ready. |
Set Retain Period | Determines how long documents will be retained. |
Unpackage | Separates documents that are in a package so they can act as individual documents in Output Manager. |
Unzip Document | |
User Information Stamping | Adds the user name or other value and date to documents. |
Watermarking | Adds a watermark from a PNG file to documents. |
To set failover profiles
-
In the Perform the following actions box, click the
<Action> link and then click .
This opens the Set Failover Profile dialog box.
-
Select an existing Profile from the list or click
New to create a new failover profile.
In the Failover Profile dialog box, you can determine what should happen if all of the retries fail and when to place the document in an error state.
You can click Edit to edit the selected profile or click Manage to display the Manage Failover Profiles dialog box which lists all of the defined profiles. When managing profiles, you can create, import, and export profiles, as well as manage all existing profiles.
- When you have selected your profile, click OK.
To set filter profiles
Use this action to associate a transform filter to a document. This filter tells Output Manager how to format fonts and additional information for printing. This filter is used when the document is viewed or printed.
-
In the Perform the following actions box, click the
<Action>link, and then click .
This opens the Set Filter Profile dialog box.
-
To prevent the filter profile from parsing information, do the following:
- Click the Calculate profile from parse of a document property browse button (...) to open the @Parse dialog box.
-
Configure the @parse function as necessary, then click
OK.
For instructions on configuring the function, see Configuring the @parse function.
- In the Format list, select the data type.
-
Select an existing Profile from the list or click
New to create a new filter profile in the Configure Filter Profile dialog box.
See Configuring a CpMillProfile resource for instructions on configuring a filter profile. If you chose to calculate the profile from the parse of a document property, you must still select a profile. This profile will be used if the @parse profile does not result in a valid filter profile.
Xerox and AFP data may require more than one input profile per document. To write multiple filter profiles for XRX, LCD, MMD, and AFP data types, name the profile in the following format:
MyProfile**Description.
Where "MyProfile" is used for all of the profiles that should be written out together. "Description" is not used in the comparison, so it can be anything. You must include the "**" for the profiles to be considered. For example, if you have an LCD profile and you want to write an XRX and an XIF profile with it, you could name them as follows:
- LCD profile: Profile1**MyLcdProfile
- XRX profile: Profile1**MyXrxProfile
- XIF profile: Profile1**MyXIFProfile
If you have more than one profile of the same type with the same name up to the "**" the last one overwrites the others.
-
You can click Edit to edit the selected profile or click
Manage to display the Resource Manager dialog box, which lists all of the defined
profiles.
When managing profiles, you can create, import, and export profiles, as well as manage all existing profiles.
- When you have selected your profile, click OK.
To set library filing profiles
Use this action to send documents to the document library. You will specify the library folder where documents will be sent, the file store, any notifications, and how long to keep documents before deleting.
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Set Library Filing Profile dialog box.
- Select an existing Profile from the list or click New to create a new library profile from the Document Library Profile dialog box.
-
You can click Edit to edit the selected profile or click
Manage to display the Manage Document Library
Profiles dialog box, which lists all of the defined profiles. When
managing profiles, you can create, import, and export profiles, as well as manage
all existing profiles. Complete the following steps to configure a library
profile.
-
Click New.
This opens the Document Library Profile dialog box.
- Specify the library profile Name and Description.
-
Determine where documents will be placed in the library.
You must first click the Base folder browse button (...) to select an existing folder. You can then specify one or more Dynamic folder levels to be placed under the selected Base folder. To create dynamic folders, click Add and enter a folder name.
The folder name can consist of text, one or more document properties, and functions. To insert document properties, right-click in the text box and click Insert Document Property. Some example document properties are date/time, document name, data type, and so on. To insert functions, right-click in the box, click Insert Function, and choose the appropriate function. Review the Using Output Manager functions help topic for information on configuring functions. Once you have entered the folder name, click OK.
You can add, edit, and remove folders, and change the folder order using the buttons next to the box. Each level added becomes a sub folder of the folder above it in the list.
-
Choose if you want to Send email notification upon
filing.
If you want to send an email notification when a document is sent to the library, select the check box and click Email. Configure the email setting on the Send Email dialog box.
-
Specify the file store for documents sent to the library.
You can choose to leave them in their current file store or move them to a specified file store.
- In the Purge documents box, specify how long documents should stay in the library before they are deleted.
- Click OK.
-
Click New.
- When you have selected your profile, click OK.
To set notification profiles
Use this action to send notifications when specific events occur in the document life cycle.
Notifications are sent according to defined notification profiles. Notification profiles specify which events generate notifications (document arrives, prints successfully, prints on failover destination, or is in error state), the type of notification for each event (email or pop-up), the text of notifications for each event, and who should get notified. For example, you can configure a pop-up to display after a document prints successfully.
- In the Perform the following actions box, click the <Action> link and click . This opens the Set Notification Profile dialog box.
- In the Profile list, click an existing profile or click New to create a new notification profile.
-
You can click Edit to edit the selected profile or click
Manage to display the Manage Notification
Profiles dialog box, which lists all of the defined profiles. When
managing profiles, you can create, import, and export profiles, as well as manage
all existing profiles. Complete the following steps to configure a notification
profile from the Notification Profile dialog box.
- Click New.
- Specify the profile Name and Description.
-
If this profile will send email notifications, select the Email
profile that will be used with those notifications.
You can select an email profile from the list or click the Browse button and mange profiles from the Manage Outbound Email Profiles dialog box. From this dialog box you can create and modify email profiles using the Outbound Email Profile dialog box.
-
Click directly in the Notifications grid to
configure the notifications that will be sent. You will need to configure
each grid column. You can add and remove notifications (grid rows) using the
Add and Remove
buttons.
- When the document — Select when a notification will be sent. You can choose to send a notification when a document Arrives, Prints Successfully, Prints on Failover Destination, or Is In Error State.
- Send notification via — Select how the notification will be sent and displayed. You can choose to send notifications using the Tray Client Pop-up or as an Email Message.
- Notify owner — Choose if the document owner will be sent a notification.
- Recipients — Click the Browse button to select who will receive the notification. You can select users and groups in the User and Group Selection dialog box. If the user or group you want is not listed, click More Users to search for additional users. See Adding users and groups to Output Manager for detailed procedures on adding users.
- Message — Enter the notification text. You can insert document properties in the body text by right-clicking in the text box, clicking Insert Document Property, and choosing the appropriate properties. Document properties will display enclosed in brackets ([]). The values of the properties will display in the notification. To insert functions, right-click in the box, click Insert Function, and choose the appropriate function. Review Using Output Manager functions for information on configuring functions.
- Click OK.
- When you have selected your profile, click OK.
To set output processes
Use this action to impact a document as it is being sent to a destination.
Examples of actions performed on a document include search and replace, setting finishing options, editing PJL commands, and inserting overlays.
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Set Output Process dialog box.
-
Select an existing Profile from the list or click
New to create a new output process using the
OM Process Designer.
See Working with output processes for specific output process procedures.
-
You can click Edit to edit the selected profile, or click
Manage to display the Manage Output Process
Profiles dialog box, which lists all of the defined profiles.
When managing profiles, you can create, import, and export profiles, as well as manage all existing profiles.
- When you finish selecting a profile, click OK.
To burst using line mode
Use this action to split line data documents (text documents with or without carriage control) based on data contained in the document, desired output size, or number of output documents desired.
Bursting creates new documents. For example, when you burst a document into 10 documents, 10 new burst documents are created. The new burst 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.
-
In the Perform the following actions box, click the
<Action> link, and then click .
This displays the Extract Text tab in the Burst - Line Mode dialog box.
- In the Server list, click the licensed rules agent server that you want to use.
-
Under Detect, choose to detect the text to extract by
Lines or by Records.
- Choose Lines if you want to use carriage control when specifying the position of variables on the page.
- Choose Records to count records, ignoring carriage control, when specifying the position of variables on the page.
- In the Format list, click the data format.
- In the Code page list, click the associated code page.
-
If desired, select Banner mode.
- In the Search for box, specify the text that defines the recognition string.
- In the Page box, specify the page at which to start searching.
- In the Column box, specify the column at which to start searching.
- In the Lines boxes, enter the line numbers between which you want to search.
Selecting this option allows the recognition string location to vary on the page. This will search the document for a recognition string. The recognition line becomes line 1 and the extraction variables will be relative to it. -
Under Extraction variables, create one or more variables
that will be used for bursting or extraction. You can add, modify, and remove
variables using the buttons above the grid. To add a new variable, complete the
following steps.
-
Click New.
This opens Text Extraction Variable Definition dialog box.
-
Enter the Name, Description,
and Type of extraction variable.
There are two types of extraction variables, those used for bursting and those used to extract data.
- If you want to remove spaces that exist at the start and end of the extracted text, select Trim spaces.
-
Under Location on page, specify the
Line/Record number from which the text will be
extracted.
If you are using record mode, it will be the record number of the current page (that is, variables on page 2 and greater are relative to line 1 on that page). If you selected Banner mode, the recognition line becomes line 1 and the extraction variables are relative to it.
- In the Column box, specify the start column for the extraction.
- In the Extract box, enter the number of characters to extract.
-
If this is an Extract type variable, under
Page selection specify the page of the newly
created burst document from which you want to extract the text.
You can enter a Page number or select First page with non-blank value in selected location.
-
Click OK.
Once a variable of a particular type has been created, it cannot be changed to the other type.
-
Click New.
-
On the Burst Conditions tab, specify what how to create the
new documents. You can create documents using one of the following options:
Option Description Extracted variables Allows for selecting the extraction variables created from the Extract Text tab as conditions in the Burst when box. You can choose the extraction variable and condition that will cause new documents to be created. Number of pages Allows for splitting documents based on the number of pages. When you select this option, the Split.Pages in new document and Split.Pages in current document variables are available in the Burst when box. Number of output documents Splits a document into a specified number of equally sized output documents. For example, if you submit a document with 99 pages and you set the number of output documents to 3, you would get 3 output documents of 33 pages each. If necessary, you can select extraction variables created from the Extract Text tab as conditions in the Burst when box. Output Manager will find the position in the source document where the split should occur based on pages per documents, and then start a new document after the additional condition is met. This allows the boundary between split documents to be better controlled based on the contents of the document. -
The Burst when box is used to create and manage the burst
conditions. Multiple conditions can be created and organized into groups. A blue
box is used to indicate a condition group. To create a burst condition, perform
the following steps. If you chose to split based on the number of output
documents, the Burst when box is not available.
-
In the Burst when box, click the
<Target> link and select the appropriate
variable. The variables that display vary depending what the split is based
on.
Variable Description Extracted variables The extraction variables added on the Extract Text tab will be listed in the menu. Number of pages You can choose the following variables: - Split.Pages in current document — Specifies the total number of pages in the current document.
-
Split.Pages in new
document — Specifies the number of pages to
be contained in each new burst document. The number of
pages is determined from the beginning of the document
or from the previous burst. If the total number of
pages of the current document is not equally divisible
by this value, the final burst document will contain
fewer pages. For example, if you create a condition [where Split.Pages in new document is equal to 20 AND Split.Pages in current document is between to 0 AND 200, when you submit a 100 page document, the process will split it into 5 20 page documents. Each page is analyzed to determine if it is the 20th page since a burst or the beginning of the document. When the 20th page is reached, a new burst document is created containing those 20 pages (that page combined with the previous 19 pages). The page count process repeats until the end of the document.
- Number of output documents — The extraction variables added on the Extract Text tab will be listed in the menu.
- Click the Operation link and select the appropriate operation.
- Click the Value link and select the appropriate value. This condition statement is completed.
-
To include additional condition statements or create groups of
conditions:
- Select a condition radio button (inside the box) to enable the Add Condition and Remove Condition buttons for adding and removing condition statements.
- Select a group radio button (outside the box) to enable the
Add Group and Remove
Group buttons for adding and removing groups.
This will also enable the Add Condition button for adding a condition to the selected group.
-
Under Follow-on action, specify the action you want
the input document (original document) to take after this rule has been
processed.
You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action.
-
In the Burst when box, click the
<Target> link and select the appropriate
variable. The variables that display vary depending what the split is based
on.
-
On the Set Document Properties tab, configure the document
properties for the newly created burst documents. 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.
-
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:
- Always Apply – Always applies the specified property value. Output Manager will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Output Manager will modify the commands to work with the printer family where the document is being sent.
- Apply Conditionally – Applies the property value conditionally. Output Manager 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.
- Informational Only – Output Manager makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only.
-
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. See Using Output Manager functions.
-
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:
- Click OK to save the business rule.
To burst using page mode
-
In the Perform the following actions box, click the
<Action> link, and click .
This displays the Extract Text tab in the Burst Document - Page Mode dialog box.
- In the Server list, click the licensed transform server that you want to use.
- In the Transform package list, you can select an existing transform package for bursting or create one.
-
Select the Override input filter profile assigned to
document check box if you want to use the filter profile configured
in the transform package.
Selecting this check box overrides the input filter profile assigned to the document. Clearing the check box uses the filter profile configured in the transform package.
- In the Additional Parameters box, specify additional parameters needed for the transform software.
-
Under Extraction variables, create one or more variables
that will be used for bursting or extraction. You can add, modify, and remove
variables using the buttons above the grid. To add a new variable, complete the
following steps.
-
Click New.
This opens the Text Extraction Variable Definition dialog box.
- Enter the Name, Description, and Type of extraction variable. There are two types of extraction variables, those used for bursting and those used to extract data.
- If you want to remove spaces that exist at the start and end of the extracted text, select Trim spaces.
-
Under Location on page, specify the region
(rectangle) from which text will be extracted. This is done by entering the
upper left corners X and Y coordinates, width, and height.
The region values can be found by viewing a document with the Output Manager viewer. In the viewer, clickin the menu bar. Then, drag the cursor to select the desired region. The coordinates will appear in the status bar.
- If this is an Extract type variable, under Page selection specify the page of the newly created burst document from which you want to extract the text. You can enter a Page number or select First page with non-blank value in selected location.
-
Click OK.
Once a variable of a particular type has been created, it cannot be changed to the other type.
-
Click New.
-
From the Burst Conditions tab, specify what how to create
the new documents. You can create documents using one of the following
methods:
Option Description Extracted variables Allows for selecting the extraction variables created from the Text Extraction Variable Definition dialog box as conditions in the Burst when box. You can choose the extraction variable and condition that will cause new documents to be created. Number of pages Allows for splitting documents based on the number of pages. When you select this option, the Split.Pages in new document and Split.Pages in current document variables are available in the Burst when box. Number of output documents Splits a document into a specified number of equally sized output documents. For example, if you submit a document with 99 pages, and you set the number of output documents to 3, you would get 3 output documents of 33 pages each. -
The Burst when box is used to create and manage the burst
conditions. Multiple conditions can be created and organized into groups. A blue
box is used to indicate a condition group. To create a burst condition, perform
the following steps. If you chose to split based on the number of output
documents, the Burst when box is not available.
-
In the Burst when box, click the
<Target> link and select the appropriate
variable. The variables that display vary depending what the split is based
on.
- If Extracted variables is selected, the extraction variables added from the Text Extraction Variable Definition dialog box will be listed in the menu.
- If Number of pages is selected, you can choose
the following variables:
- Split.Pages in current document — Specifies the total number of pages in the current document.
- Split.Pages in new document — Specifies the number of pages to be contained in each new burst document. The number of pages is determined from the beginning of the document or from the previous burst. If the total number of pages of the current document is not equally divisible by this value, the final burst document will contain fewer pages.
Example For example, if you create a condition where Split.Pages in new document is equal to 20 AND Split.Pages in current document is between to 0 AND 200, when you submit a 100 page document, the process will split it into 5 20 page documents. Each page is analyzed to determine if it is the 20th page since a burst or the beginning of the document. When the 20th page is reached, a new burst document is created containing those 20 pages (that page combined with the previous 19 pages). The page count process repeats until the end of the document. - Click the Operation link and select the appropriate operation.
- Click the Value link and select the appropriate value. This condition statement is completed.
-
To include additional condition statements or create groups of
conditions:
- Select a condition radio button (inside the box) to enable the Add Condition and Remove Condition buttons for adding and removing condition statements.
- Select a group radio button (outside the box) to enable the Add Group and Remove Group buttons for adding and removing groups. This will also enable the Add Condition button for adding a condition to the selected group.
- Under Output format, you can specify if you want to transform the document in this rule action. You can leave the output format the same as the input format or change it to a format in the list.
- Under Follow-on action, specify the action you want the input document (original document) to take after this rule has been processed. You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action.
-
In the Burst when box, click the
<Target> link and select the appropriate
variable. The variables that display vary depending what the split is based
on.
-
On the Set Document Properties tab, configure the
document properties for the newly created burst documents. 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.
-
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:
- Always Apply — Always applies the specified property value. Output Manager will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Output Manager will modify the commands to work with the printer family where the document is being sent.
- Apply Conditionally — Applies the property value conditionally. Output Manager 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.
- Informational Only — Output Manager makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only.
- 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 (see Using Output Manager functions ).
-
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:
- Click OK to save the business rule.
To extract text using line mode
-
In the Perform the following actions box, click the
<Action> link and then click .
This opens the Extract Text tab in the Burst Document - Line Mode dialog box.
- In the Server list, click the licensed rules agent server that you want to use.
-
Under Detect, determine if you want to detect the text to
extract by Lines or Records.
Option Description Lines Select this option if the lines end with carriage controls and you know the number of lines per page. You will need to enter the value. Records Select this option if your document does not have carriage controls at the ends of the lines or if you do not know how the lines will appear on the page. - In the Format list, click the data format.
- In the Code page list, click the associated code page.
-
If desired, select Banner mode. This will search the
document for a banner, and the banner text will become the start of the new
document.
- In the Search for box, specify the text that defines the banner.
- In the Page box, specify the page at which to start searching for the banner text.
- In the Column box, specify the column at which to start searching for the banner text.
- In the Lines boxes, enter the line numbers between which you want to search for the banner text.
-
Under Extraction variables, create one or more variables
that will be used for extraction. You can add, modify, and remove variables using
the buttons above the grid. To add a new variable, complete the following
steps.
-
Click New.
This opens the Text Extraction Variable Definition dialog box.
- Enter the Name and Description of extraction variable.
- If you want to remove spaces that exist at the start and end of the extracted text, select Trim spaces.
- Under Location on page, specify the Line/Record number from which the text will be extracted. If this is record mode, it will be the record number of the entire document.
- In the Column box, specify the start column for the extraction.
- In the Extract box, enter the number of characters to extract.
- Under Page selection specify the page of the newly created burst document from which you want to extract the text. You can enter a Page number or select First page with non-blank value in selected location.
- Click OK.
-
Click New.
-
On the Set Document Properties tab, configure the document
properties for the newly created documents.
-
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:
- Always Apply — Always applies the specified property value. Output Manager will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Output Manager will modify the commands to work with the printer family where the document is being sent.
- Apply Conditionally — Applies the property value conditionally. Output Manager 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.
- Informational Only — Output Manager makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only.
- 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.
-
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:
- Click OK to save the business rule.
To extract text using page mode
-
In the Perform the following actions box, click the
<Action> link, and then click .
The Extract Text tab displays in the Burst Document - Page Mode dialog box.
- In the Server list, click the licensed transform server that you want to use.
- In the Transform package list, you can select an existing transform package or create one.
- If you want to override the input filter profile assigned to the document and use the filter profile in the transform package, select the Override input filter profile assigned to document check box. Clear this check box if you want to use the filter profile configured in the transform package.
- In the Additional Parameters box, specify additional parameters needed for the transform software.
-
Under Extraction variables, create one or more variables
that will be used for extraction. You can add, modify, and remove variables using
the buttons above the grid. To add a new variable, complete the following
steps.
-
Click New.
This opens the Text Extraction Variable Definition dialog box.
- Enter the Name and Description, and Type of extraction variable.
- If you want to remove spaces that exist at the start and end of the extracted text, select Trim spaces.
-
Under Location on page, specify the region
(rectangle) from which text will be extracted. This is done by entering the
upper left corners X and Y coordinates, width, and height.
The region values can be found by viewing a document with the Output Manager viewer. In the viewer, select View Text Selection Mode in the menu bar. Then, drag the cursor to select the desired region. The coordinates will appear in the status bar.
- Under Page selection specify the page of the newly created document from which you want to extract the text. You can enter a Page number or select First page with non-blank value in selected location.
- Click OK.
-
Click New.
-
On the Set Document Properties tab, configure the document
properties for the newly created documents.
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.
-
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, choose one of the following
options to determine how the property should be applied when a document is sent to
a destination:
Option Description Always Apply Always applies the specified property value. Output Manager will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Output Manager will modify the commands to work with the printer family where the document is being sent. Apply Conditionally Applies the property value conditionally. Output Manager 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. Informational Only Output Manager makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only. -
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. For more information, see Using Output Manager functions
- Click OK to save the business rule.
To modify document contents
Use ADM to modify the contents of documents.
ADM (Advanced Document Modification) is a process where each page of the document is read, portions of the document can be changed, or values extracted, and then the page is written. Documents can be reordered, split, transformed to a different data type, bar codes added, OMR marks added, and logos changed using ADM. ADM can be executed in a business rule action or in the output process.-
In the Perform the following actions box, click the
<Action> link, and then click .
This displays the Configuration tab in the Modify Document dialog box.
- In the Server list, click the licensed transform server that you want to use.
- In the Transform package list, you can select an existing transform package or create one.
- In the Additional Parameters box, specify additional parameters needed for the transform software.
- Use the Override input filter profile assigned to document check box 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 check box to use the filter profile in the transform package.
-
In the Unit library list, you can select an existing unit
library or create one.
Unit libraries are JavaScript modules that CpMill calls at certain known times while processing a document (for example, begin document, page start, and page end). The modules can modify the contents of the document, extract information from the document, write the document, or parts of it, to a new location, or perform many other operations. For more information on configuring unit libraries, contact Support. See the Configuring a cpMillUnitLibrary resource topic for instructions on creating a unit library from the Configure Unit Library dialog box.
-
Next to Unit library will create select one of the
following options:
Option Description the same document Select if your unit library is modifying the input document and writing it to the same location. See the default comments in unit library for how to tell Output Manager the names of the new documents that are created. different document(s) Select if your unit library is modifying the current document and outputting it into a new document, or if your unit library is bursting the document into many different documents. See default comments in unit library for how to tell Output Manager the names of the new documents that are created. multiple documents combined into one Currently not available. -
Under Follow-on action, specify the action you want the
input document (original document) to take after this rule has been
processed.
You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action.
-
On the Document Properties tab (Modify Document), configure
the document properties for the newly created documents.
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.
-
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:
Option Description Always Apply Always applies the specified property value. Output Manager will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Output Manager will modify the commands to work with the printer family where the document is being sent. Apply Conditionally Applies the property value conditionally. Output Manager 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. Informational Only Output Manager makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only. -
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. For more information, see Using Output Manager functions
- Click OK.
To route to destinations (Advanced)
-
In the Perform the following actions box, click the
<Action> link and then click .
This opens the Route to Destination (Advanced) dialog box.
-
Select how you want to locate the CSV file. You can use one of the following
options:
Option Description Path Enter the path and file name of the CSV file, or click the browse button (...) to navigate to the file. Resource Select the appropriate resource from the list, or click the browse button to choose the resource from the Manage CsvDocProp Resources dialog box. -
In the Lookup data box, right-click and then click the
document property that will control the routing.
The value contained in this document property will determine the row used in your .csv file.Example For example, the following table shows an example .csv file using the Class property. To route by Class using this example, select Class in the Lookup data box, enter MyClass in the Key column name box, and MyPrinter in the Destination column name box. When the document is routed the value of the Class property will determine which destination is used. For example, if the Class value is A, the document will be routed to printer 1.
MyClass MyPrinter A printer1 B printer2 C printer3 - In the Key column name box, enter the column name in your CSV file that corresponds to the selected document property.
- In the Destination column name box, enter the column name in your CSV file that contains the destination name where you want the documents routed.
- 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.
- Click OK.
To route to destinations (Basic)
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Select Destination dialog box.
-
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.
- 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.
- Click OK.
To set document properties
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Document Properties dialog box.
-
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.
-
In the grid, expand the category of each 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 column, select how the
property should be applied when a document is sent to a destination. Click in the
grid cell and choose from the following options:
Option Description Always Apply Always applies the specified property value. Output Manager will add commands to the print stream to enforce the print preference. If the document already contains commands for that print preference, Output Manager will modify the commands to work with the printer family where the document is being sent. Apply Conditionally Applies the property value conditionally. Output Manager 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. Informational Only Output Manager makes no changes to the print stream when the document is sent to the destination. The value is for informational purposes only. -
In the Value column, specify the document property
value.
You can use functions to insert and extract data as necessary. For more information, see Using Output Manager functions.
- Click OK to save the business rule.
To transform documents using the Adept transform suite
Use this action to transform documents using the Adept transform suite.
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Transform Adept dialog box displays.
- In the Server list, click the licensed rules agent server that you want to use.
-
Under Parameters, configure the following options as
needed:
To configure Do this Convert from Select the format you are converting from Xrx and/or Afp. In the To list, specify the format you are converting to. Ini Specify the resource that will control the format of the printed output. You can select a defined Ini resource in the list or click Browse to create, modify, or import Ini resources from the Resource Manager dialog box. Ini resources are created using the Ini Resource dialog box. Ini description Specify the Ini description. Ini default Select the Ini resource that will be used as the default. Exe path Click the browse button (...) and select the Adept executable path. -
Select the Follow on actions check box for the input
document (original document).
You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action.
- Click OK.
To transform documents using page mode
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Configure Transform dialog box.
- In the Server list, click the licensed transform server that you want to use.
- In the Transform package list, you can select an existing transform package or create one.
- Use the Override input filter profile assigned to document check box 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 check box to use the filter profile in the transform package.
- In the Output format list, click the format of the output file.
-
Configure the conversion of each input format in the Input
formats grid and then click OK.
- 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.
- 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 be visible.
-
Select the Follow on actions for the input document
(original document).
You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action.
- Click OK.
To transform documents using record mode (Advanced)
This advanced option is used to perform custom conversions using DCO chains. This provides flexibility to specify code pages, carriage controls, record formats, and other options for the incoming document and the desired output.
-
In the Perform the following actions box, click the
<Action> link and select Transform
Document
Record Mode (Advanced).
This opens the Transform Record Mode (Advanced) dialog box.
- In the Server list, click the licensed rules agent server that you want to use.
-
Under Parameters, configure the following options as
needed:
Option Description Code page in Specify the code page that represents the current status of the input document. The default format is 037 (EBCDIC). Code page out Specify the code page that represents how the file is being transformed. The default format is 437 (ASCII). FCB Select the FCB resource that will control the vertical format of printed output. You can select a defined FCB in the list or click the browse button (...) to create, modify, or import FCB resources. See Configuring an FCB resource for instructions on creating an FCB resource in the FCB Resource dialog box. FCB description Click to view/update the description of the selected FCB. FCB default Select the default FCB. The default is STD, a predefined FCB with 66 lines and channel stop 1 on line 1. In type Specify the input data type. Out type Specify the output data type. Data type after conversion Select the data type of the output documents. Use block lengths Determine if you want to enable or disable the use of block lengths in the record. When this option is selected, records include a block count. The block count will directly precede the record count. In the following example,
the block count is 00 0C 00 00 and the record count is 00 08 00 00.00 0C 00 00 00 08 00 00 F1 F2 F3 F4
FCB override Use this list to enable or disable overriding FCBs. Selecting Yes causes FCBs in the beginning of the data to be ignored, functioning as if there were no FCBs in the data. Send FCB Use this list to enable or disable sending FCBs to the printer. Delimiter Select the type of delimiter you want to use. Choose one of the following: - None — Records do not include delimiter characters.
- ASCII — Records include an ASCII delimiter. Each record ends in a carriage return and line feed character. The actual record length is two bytes more than the fixed record length specified above.
- EBCDIC — Records include an EBCDIC delimiter. Each record ends in a carriage return and line feed character. The actual record length is two bytes more than the fixed record length specified above.
Truncate trailing blanks Enable or disable the truncating of trailing blanks. Pad record Enable or disable record padding. Selecting Yes pads blank records with a space. Pad skip1 Enable or disable pad skip to channel 1. Selecting Yes pads blank records with a space. Length Specify the length of the fixed records. The default value is 80. Follow on actions Specify follow on actions for the input document (original). You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action. - Click OK.
To transform documents using record mode (Basic)
-
In the Perform the following actions box, click the
<Action> link, and then click .
This opens the Transform Record Mode (Basic) dialog box.
- In the Server list, click the licensed rules agent server that you want to use.
-
Select the Follow on actions for the input document
(original document).
You can choose to delete, retain, or process the next rule for the original document. The newly created documents (output documents) continue with the next rule action.
- Click OK.
To analyze documents
- In the Perform the following actions box, click the <Action> link and select Analyze Document. The Analyze Document dialog box displays.
- Select the server where the document should be analyzed.
- Select the type of page counting method you want to use: ControlSuite Analysis Engine, Legacy Analysis Engine, or PDF Quick Page Counting.
-
If you selected the OM Legacy method, select the
properties you want populated.
Property Description Count pages Reads the entire document and sets the total number of pages for the document. Detect data type Reads the first portion of the document and attempts to determine the documents data type. This works well for postscript, PDF, and PCL files. Detect trays Looks for input and output tray settings. Detect color Reads the entire document looking for pages that contain color information. Detect duplex Looks for duplex commands in the document. Detect copies Looks for more than one copy of the document. - Click OK.
To assign to document folders
-
In the Perform the following actions box, click the
<Action> link, and then click Assign to
Document Folder.
This opens the Select Document Folder dialog box.
- Select the appropriate folder in the tree.
- Click OK.
To convert fixed block to variable block
- In the Perform the following actions box, click the <Action> link and then click Convert Fixed Block To Variable Block.
- Specify the fixed block record length in bytes.
- Click OK.
To delete documents
To move documents to a file store
-
In the Perform the following actions box, click the
<Action> link, and then click Move
Document To File Store.
This opens the Move Document To File Store dialog box.
-
In the File Store list, select the new file store
location.
The list displays all file stores defined in the Set General Preferences Utility.
- Click OK.
To prepend a banner
-
In the Perform the following actions box, click the
<Action> link, and then click Package
Banner.
This opens the Package and Prepend banner dialog box.
-
In the Resource list, select an existing banner resource,
or click New to create a banner resource using the Banner Resource dialog box.
See Configuring a banner resource topic for instructions on creating a banner resource.
- Click OK.
To create power rules
-
In the Perform the following actions box, click the
<Action> link, and then click Power
Rule.
The Power Rule dialog box displays. Each rule contained in the power rule is represented as one row spanning the Conditions and Actions grids.
-
To manage the condition statements, click Select
conditions and use the following procedures from the
Select Conditions dialog. When you are finished working
with conditions, click OK.
To Do this Add conditions to the rule Select the appropriate conditions in the Available conditions list and click Add. The conditions are moved to the Selected conditions list. When you click OK, the new conditions will be displayed as columns in the Conditions grid. Remove conditions from the rule Select the appropriate conditions in the Selected conditions list, and click Remove. The conditions are moved to the Available conditions list. When you click OK, these conditions will be removed from the Conditions grid. Change the condition processing order Select a condition and click Move up or Move down. When you click OK, the new order will display in the Conditionsgrid. Conditions are processed in the Selected conditions list order, from top to bottom.
-
Configure the condition statements by clicking directly on the
Conditions grid.
For each rule, you must specify the Operator and Value. If you have more than one condition, you will also need to select the Conjunction, either AND or OR.
-
To manage the action statements, click Select actions and
perform the following procedures in the Select Actions
dialog box.
To Do this Add actions to the rule Select the appropriate actions in the Available actions list and click Add. The actions are moved to the Selected actions list. When you click OK, the new actions will be displayed as columns in the Actions grid. Remove actions from the rule Select the appropriate actions in the Selected actions list and click Remove. The actions are moved to the Available actionslist. When you click OK, these actions will be removed from the Actions grid.
Change the action processing order Select an action and click Move up or Move down. When you click OK, the new order will display in the Actions grid. Actions are processed in the Selected actions list order, from top to bottom.
- When you are finished working with actions, click OK.
-
Click directly in the Actions grid to configure the
action statements for each rule.
Statement Description Route to Destination Click the browse button (... to display the Destinations dialog box. Select the appropriate destinations in the tree. You can select multiple destinations by pressing the Ctrl or Shift keys and selecting the destinations. Selecting a destination group will select all destinations in that group. When finished, click OK. Set Document Folder Click the browse button (...) to display the Document Folders dialog box. Select the appropriate folders in the tree. You can select multiple folders by pressing the Ctrl or Shift keys and selecting folders. When finished, click OK. Set Document Library Select an existing profile from the list or click the browse button (...) to create or manage profiles in the Manage Document Library Profiles dialog box. Set Document Owner From the User and Group Selection dialog box, select the appropriate user or group in the grid. If the desired user or group is not listed, click More Users to search for additional users. Click OK. Set Document State In the list, select one of the following document states: Any, Ready, Hold, or Error. Set Failover Profile Select an existing profile from the list or click the Browse button to create or manage profiles from the Manage Failover Profiles dialog box. Set Notification Profile Select an existing profile from the list or click the Browse button to create or manage profiles from the Manage Notification Profiles dialog box. Set Output Process Select an existing profile from the list or click the Browse button to create or manage profiles from the Manage Output Process Profiles dialog box. Set Schedule Click the browse button (...) to display the Schedule dialog box. Specify the appropriate values for the Day and Time options. You can choose to print the documents today, on a specific day, or in the future. Click OK. -
Use the following procedures to control the individual rules contained in the
power rule. Each rule is represented as one row spanning the
Conditions and Actions
grids.
To Do this Create a rule Click Add. A row will be added to the bottom of both grids. Delete a rule Select a rule and click Remove. The selected row will be deleted from both grids. Create a copy of a rule Select a rule and click Copy. Reorder the rules Select a rule and click Move up or Move down. - Click OK.
To run ad hoc rules
- In the Perform the following actions box, click the <Action> link, and select Run AdHoc Rule.
- In the AdHoc rule list, select an existing ad hoc rule.
-
In the Run mode list, choose if you want to run the rule
against all documents in the spool or against all newly received documents since
the last time the rule was run.
The rule will not be run against retained documents.
- Click OK.
To run commands
-
In the Perform the following actions box, click the
<Action> link and select Run
Command.
This opens the Run Command dialog box.
-
Enter the command line.
To insert document properties in the command line, right-click in the text box and click Insert Document Property. Some example document properties are date/time, document name, data type, and so on. To insert functions, right-click in the box, click Insert Function, and choose the appropriate function. Review the Using Output Manager functions help topic for information on configuring functions.
- Choose the server you want to run the command.
- Click OK.
To schedule output
-
In the Perform the following actions box, click the
<Action> link, and then click Schedule
Output.
This opens the Schedule dialog box.
-
Set the appropriate Day option.
You can choose to print the documents today, on a specific day, or in the future.
-
Set the appropriate Time option.
You can choose to print as soon as possible, at a specific time, or in the future.
- Click OK.
To send emails
-
In the Perform the following actions box, click the
<Action> link, and then click Send
Email.
This opens the Send Email dialog box.
-
In the Profile list, click the appropriate email
profile.
You can also click the browse button (...) to open the Outbound Email Profile dialog box. This dialog box lists all of the defined email profiles, so that you can use it to create, import, and export profiles, as well as to manage all existing profiles. To create a new email profile, click New, and configure the email profile from the Outbound Email Profile dialog box. When you are finished, click OK, and then click Close.
-
In the Send Email dialog box, select the
Priority level of the email message.
You can select an importance level of low, normal, or high.
-
Enter the email addresses you want to be sent notifications in the
To, CC, and
Bcc boxes.
You can enter multiple email addresses separated by a comma.
-
In the Reply to box, enter an email address where replies
will be routed.
You can enter multiple email addresses separated by the comma.
- Enter the email Subject text.
-
In the Digest group, specify whether to send the
notification messages for multiple events concatenated into one email. To enable
the digest feature, in the Send Digest list, choose from
the following options:
Option Description Every interval Sends the digest according to the time interval specified. You will receive a message every interval, even if no alerts were received during the interval. At time interval Sends the digest according to the time interval specified. The time interval will start when the first notification messages is received. You will be notified when at least one notification has been received. Every hour Sends the digest every hour. You will receive a message every interval, even if no alerts were received during the interval. Every half hour Sends the digest every half hour. You will receive a message every interval, even if no alerts were received during the interval. If necessary, specify the Interval in minutes. In the Max Alerts box, you can specify the maximum number of alerts to be included in the digest. -
Enter the body text.
To insert document properties in the body text, right-click in the text box, click Insert Document Property, and choose the appropriate properties. The values of the properties will display in the email message. To insert functions, right-click in the box, select Insert Function, and choose the appropriate function. Review the Using Output Manager functions help topic for information on configuring functions.
- Click Validate to validate the body text.
- Click OK.
To set document owner
-
In the Perform the following actions box, click the
<Action> link, and then click Set
Document Owner.
This opens the User and Group Selection dialog box.
-
Select the appropriate user or group in the grid.
If the desired user or group is not listed, click More Users to search for additional users.
- Click OK.
To set document states
-
In the Perform the following actions box, click the
<Action> link, and then click Set
Document State.
This opens the Set Document State dialog box.
- In the list, click the appropriate document state, Hold or Ready.
- Click OK.
To set retain periods
-
In the Perform the following actions box, click the
<Action> link, and then click Set
Retain Period.
This opens the Set Retain Period dialog box.
-
Set the retain period.
- Use the Retain for options to retain documents for a specified time period. Time periods can be specified in years, months, days, hours, and minutes.
- Use the Retain until options to retain documents until a specified date and time.
- Click OK.
To unpackage documents
To add user information to documents
-
In the Perform the following actions box, click the
<Action> link, and then click User
Information Stamping.
The User Information Stamping dialog box opens.
- In the Server list, click the licensed transform server that you want to use.
- In the Transform package list, you can select an existing transform package or create one.
- In the Additional Parameters field, specify additional parameters needed for the transform.
-
In the Text to stamp field, do one of the
following:
- Type the text to appear on the document.
- Right-click in the field and select . Select a property from the document.
You can use PCL, PDF, PS, and Plain Text files. Documents in other formats must be transformed into one of the supported formats before this feature will work properly. - Configure the format and location of the text.
- Click OK.
To add a watermark to documents
-
In the Perform the following actions box, click the
<Action> link, and then click
Watermarking.
The Watermarking dialog box opens.
- In the Server list, click the licensed transform server that you want to use.
- In the Transform package list, you can select an existing transform package or create one.
- In the Additional Parameters field, specify additional parameters needed for the transform.
-
You can use an existing watermark or create a new one. Do one of the
following:
- In the Watermark/Stamp list, select one of the existing watermarks: Confidential, Do Not Copy, Draft, or Internal.
- Click New. In the Create Resource dialog box, complete the fields for the new watermark. In the Import Resource Data section, click Browse and select the file you want to use as a watermark.
You can use PCL, PDF, and PS files. Documents in other formats must be transformed into one of the supported formats before this feature will work properly. - Click OK.
To create a new transform package
-
In the Transform Package section, click
New.
This displays the General tab.
- Enter the transform package Name.
- Select the transform package type.
-
If you selected a third-party transform package, verify that 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 browse button (...).
-
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.
-
On the Filter Profiles tab, specify how the
transform software will handle the formatting for each data type.
- To configure a profile, click the browse button
(...) in the
Modify/New column for the appropriate
formats, and then in the Configure Filter Profile
dialog box, configure the profile as needed.
The profile contains a communications and printer definition section. For instructions on configuring a filter profile, see Configuring a CpMillProfile resource.
- To select a profile, click in the Configuration column for the appropriate formats and select the profile from the list.
- To configure a profile, click the browse button
(...) in the
Modify/New column for the appropriate
formats, and then in the Configure Filter Profile
dialog box, configure the profile as needed.
-
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.
-
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.
- Click OK to create the transform package.