About Composer Class

Setting a composer class for a Composer is useful in situations where you want a Composer to process specific scan jobs based on the source of the scan job; for example, you want a specific composer to handle jobs that originate in the mailroom.

To configure the composer class, the Administrator has to modify the prComposerClass property of the Composer. By default, the value of this property is a blank string. The Administrator can modify the property to set a suitable text string.

When you configure a Composer to have a class, the Composer processes only those jobs that have a matching prComposerClass property assigned to them.

Note: A scan job without any configured property value is the same as a "blank" text string. It will therefore match any composer that has the prComposerClass property value set as a blank string.

If a job specifies a composer class (including missing or blank property) but there are no corresponding composers assigned to that class, the job will fail with the following message: "No conversion server configured."

Configuring Composer Class

You can configure Composer class by using the Server Administrator > Components node.

To configure a Composer class

  1. Start the Server Administrator.
    On the Start menu, click Upland AccuRoute > Upland AccuRoute Server Administrator.

  2. Click the Compose component in the Component details page. The Properties dialog box appears.

  3. Click the Compose option in the Properties page. All Composers in your server environment are listed.

  4. Select the composer you want to configure and click Properties. The Composer Package Properties dialog box appears.

  5. In the Class box, enter the desired text string value.

  6. Click OK to save your changes.

You can also set the value for prComposerClass property in control files. For information on how to create control files, see Guidelines for creating control files.

See also

List of Control File Keywords

Using Custom Variables in Control Files