Receiving Documents using WCF API

Complete this procedure to create WCF API sources.

Documents received by this source will be routed to Output Manager.

The WCF API source type allows programs to submit documents using the WCF interface to specify the file path and document metadata.

  1. In the Sources tree, right-click the source group (folder) where you want to add sources and click New Source.
    This opens the Add Source dialog box.
  2. In the Type list, select WCF API.
  3. Next to Add new devices enter the number of sources you want to create.
    You can create a single WCF API source or create multiple WCF API sources and configure them simultaneously.
  4. Click OK.
  5. Configure the general settings.
    For multiple source configuration, this is configured on the General tab.
    1. Enter the source Name.
    2. In the Server list, click the Output Manager server where the Output Manager Input Service is located for this source.
      The source does not have to be on the same server as the Output Manager Input Service.
    3. Enter any Comments or Location information for the source.
    4. Optional: To change the large source image that displays when configuring a single source, you can click Select Image and choose the appropriate image file (BMP, JPEG, or PNG).
      The selected image will be compressed and scaled to 96x96 pixels. Changing this image will not change the smaller image that displays or the image that displays in the source tree. To change the image back to the default, click Reset Image.
  6. Configure the WCF API settings.
    Source Displays
    Single source configuration Use the WCF API settings tab.
    Multiple source configuration Use the WCF API settings (Bulk Configuration) tab.
    1. Enter the Port number.
      The default value is 631.
    2. Enter the IP address on the local system where the socket device will receive documents.
      In most cases, this can be left blank given that most systems have only one IP address. For systems that have multiple network adapters or support multiple IP addresses, the IP address entered here specifies the IP address for the appropriate port.
    3. Enter the Instance name.
      This identifies the source address and extends the connection URL.
  7. Configure the document properties that will be applied to all documents received by the source.
    Configuration Method
    Single source configuration Use the Document properties tab.
    Multiple source configuration Use the Document properties (Bulk Configuration) tab.
    Determine if you want to use advanced document properties. Advanced document properties facilitate the setting of document properties from multiple sources. This is a complex feature that only advanced users and professional service engineers should configure.
    To Do this
    Use advanced document properties Select Use advanced document properties. This enables the advanced document properties profile list. Select the default profile or an existing profile. To configure document profiles, see the Configuring document property profiles topic.
    Not use advanced document properties If you do not want to use advanced document properties, leave the check box disabled and configure the following:
    • Select the Document owner. This user will be the owner of all documents received using this source. Click the browse button (...) to select a user.
    • Configure the document properties by entering property values directly in the grid. All of the available property values are listed and grouped into categories. Expand the appropriate category by clicking the arrow next to the category name. The first node level in the category determines the print preferences for the properties it contains. On the print preference node, click in the Mode column and configure how the property should be applied when a document is sent to a destination. Select Always Apply to always apply the specified property value. Select Informational Only to use the value for informational purposes only. In the Value column, click in the grid cell to specify the document property value.
    Important: This can only be configured during single source configuration.
  8. Configure the following configuration settings.
    Configuration Method
    Single source configuration Use the More settings tab.
    Multiple source configuration Use the More settings (Bulk Configuration) tab.
    1. Determine if you want all documents received by this source to be in the Hold state as they enter the Output Manager Console.
      This option is disabled by default.
    2. Determine if you want to disable business rule processing for all documents received by this source as they enter the Output Manager Console.
      This option is disabled by default.
    3. Use the following options to determine if you want to analyze documents as they are received by a source and enter the Output Manager Console.
      Selecting these options may cause performance degradation. These options are disabled by default.
      Option Description
      Use quick page counting for PDF documents Enables optimized page counting for PDF jobs. When this option is enabled, the Count pages, Detect color, Detect data type, Detect duplex, and Detect trays options are disabled.
      Count pages Performs a page count on all documents received by this source.
      Detect data type Detects the data type on all documents received by this source. The data type will display in the Documents grid Data Type column.
      Detect trays Determines the document paper tray that will print the document. This will display in the Documents grid Input Bin or Output Bin column. You can configure the Output Bin column to display by using the Administration Configure Document Properties Utility.
      Detect color Detects if the documents received by this source contain color. The Documents grid Color column displays True or False depending if color is detected.
      Detect duplex Detects if the documents received by this source are configured for duplex printing (that is, printing on both sides of the paper). The Documents grid Duplex column displays how the document will print, One Sided, Two Sided Short Edge, or Two Sided Long Edge.
    4. Select the file store that will be used for all documents received by this source as they enter the Output Manager Console.
      The default file store is selected by default. Administrators define file stores and select the default in the Set General Preferences Utility. If the default file store is changed in the Set General Preferences Utility, all sources using the default will be automatically updated.
    5. Assign a document folder for all documents received by this source as they enter the Output Manager Console. The default document folder is Un-Filed Documents.
    6. To create profiles and enter costs associated with printing, select the Advanced Costing Profiles check box.
      If you do not select this option, you can specify only the cost per page for printing.
    7. Determine if you want to send a notification when a document arrives, prints successfully, prints on failover destination, or is in error state.
      The notification can be sent as an email message or pop-up. You can select an existing profile in the list or create one from the Notification Profile dialog box.
      • To create a profile during single source configuration, click New.
      • To create during multiple source configuration, click the browse button (...).
  9. Configure the following output settings.
    Configuration Method
    Single source configuration Use the Output settings tab.
    Multiple source configuration Use the Output settings (Bulk Configuration) tab.
    1. Use the Schedule output option to specify the date and time all documents received by this source will print.
      You can choose to print the documents today, on a specific day, or in the future. You can also choose to print as soon as possible, at a specific time, or in the future.
    2. Use the Route to destination option to specify a destination where all documents received by this source can be routed.
      Click the browse button (...) to select one or more destinations in the tree. Use the Shift and Ctrl keys to select multiple destinations. Destination groups cannot be selected. This option is set to Unrouted by default.
    3. To override the default retain settings for all documents received by this source select the Override default retain settings check box and configure the retain options as necessary.
    4. Select the appropriate output process.
      Output processes can be created to impact documents as they are being sent to a destination. The processes contain a set of actions which could be used for search and replace, setting finishing options, editing PJL commands, inserting overlays, and so on. You can select an existing process in the list or create one using the Process Designer. To create a process during single source configuration, click New. To create during multiple source configuration, click the browse button (...).
    5. Select the appropriate failover profile.
      Failover profiles specify what should happen to documents when they are sent to inaccessible destinations (they are not able to receive documents). You can select an existing profile in the list or create one from the Failover Profile dialog box. To create a profile during single source configuration, click New. To create during multiple source configuration, click the browse button (...).
  10. Click OK.