unified client for canon deployment guide · unified client for canon with autostore deployment...

Unified Client for Canon with AutoStore Deployment Guide Version: 1.0

Date: 2019-06-17 EN-UCC-1.0-AS

Table of ContentsUnified Client for Canon Deployment Guide............................................................................................4

Overview of the Unified Client for Canon for AutoStore Deployment................................................ 4Deploying Unified Client for Canon with AutoStore - Workflow Outline.................................. 4Requirements........................................................................................................................... 5Supported Languages..............................................................................................................5

Prepare for Deployment..................................................................................................................... 6Verify that your device is supported........................................................................................6Verify prerequisites.................................................................................................................. 6

Install and Configure the AutoStore Server....................................................................................... 7Set Up a Canon MFP........................................................................................................................ 7

Configure the Canon MFP in Unified Client Environment.......................................................7Install Canon Application......................................................................................................... 8Install and configure the TLS certificates..............................................................................10

Install Device Registration Service...................................................................................................11Quick Setup Device Registration Service Instructions.......................................................... 11

Set Up Your First AutoStore Capture Workflow...............................................................................14License AutoStore..................................................................................................................15Configure Scan to Folder...................................................................................................... 15Scanning with the Unified Client for Canon.......................................................................... 19

Unified Client for Canon Device Settings........................................................................................ 32Application properties............................................................................................................ 32Unified Client for Canon device properties........................................................................... 33Files Tab.................................................................................................................................35Unified Client for Canon Actions Reference......................................................................... 35Unified Client for Canon Return Codes................................................................................ 36How to add a new Device profile..........................................................................................36How to import Device Information.........................................................................................36Canon Unified Client Launcher Screen.................................................................................37Authentication and Identification............................................................................................39Offline Behaviour................................................................................................................... 40Server Reconfiguration Behaviour.........................................................................................40Hardkey Behaviour................................................................................................................ 41System Timeout..................................................................................................................... 41Main Menu Button................................................................................................................. 42

2

Unified Client for Canon Deployment Guide EN-UCC-1.0-AS

Appendix: Additional Configuration Instructions...............................................................................42Security.................................................................................................................................. 42Configuring AA Common Access Card Authentication Solution........................................... 44CAC Authentication and Equitrac MEAP Authentication Solution.........................................45Canon Licensing.................................................................................................................... 47Moving App Logo to the First Page of Canon Device.......................................................... 48Renaming Embedded Application on Home Screen.............................................................52

Appendix: Additional AutoStore Instructions.................................................................................... 53Configuring authentication..................................................................................................... 53LDAP Lookup Settings dialog box........................................................................................ 54Integration with MFP authentication......................................................................................55Adding and editing groups.................................................................................................... 56Basic form..............................................................................................................................57Scanning Settings..................................................................................................................57Email form..............................................................................................................................58Folder form.............................................................................................................................60SharePoint form.....................................................................................................................61Authentication tab.................................................................................................................. 63Authentication Prompts dialog box........................................................................................64Custom Scripting authentication............................................................................................64Configuring the Scanning Settings........................................................................................66Scripting Overview.................................................................................................................67Unified Client component RRTs............................................................................................ 71Unified Client communication ports.......................................................................................73

Troubleshooting.................................................................................................................................73

3


Unified Client for Canon with AutoStore Deployment Guide

Overview of the Unified Client for Canon for AutoStoreDeployment

Unified Client for Canon provides an enterprise data capture solution that orchestrates the secure deliveryof paper, electronic documents and data into business applications directly on the panel of specific Canon-manufactured Multifunctional Peripheral (MFP) devices.

Unified Client for Canon the Canon MEAP-enabled device.

System architecture with AutoStore

This document will walk you through a clean installation procedure. Follow the steps provided here to beable to have an AutoStore Scan to Folder capture workflow configured on your Canon MFP device.

Deploying Unified Client for Canon with AutoStore - Workflow Outline1. Prepare for deployment

a. Verify that your device is supported

b. Verify prerequisites

c. Verify that installer packages are provided using ControlSuite (for more information on how toinstall ControlSuite, see ControlSuite Configuration and Setup online help)

2. Install and configure the AutoStore server

4


3. Set up a Canon MFP

a. Manually install Unified Client package for Canon

b. Configure the device certificate on the device

4. Install and configure Device Registration Service (DRS)

a. Create and add application in DRS

b. Add and configure the MFP device in DRS

c. Register the Canon device using DRS in AutoStore-only deployment

5. Set up your first AutoStore workflow and verify installation

a. License AutoStore

b. Configure Send to Folder workflow

c. Verify installation

RequirementsComponent Requirement

AutoStore Version 8.0.0.1068 or later.

Device Registration Service Version 8.0.1.11 or later.

Canon platform version Version 3.08 or later.

Canon client version Version 1.0.1037 or later.

Canon firmware version • Version 53.20.01 or later for models iR ADV C5535i/C5540i/C5550i/C5560i/iR ADV C5535i II/C5540i II/C5550i II/C5560i II

• Version 13.20.01 or later for models iR ADV C5535iIII/C5540i III/C5550i III/C5560i III

Supported LanguagesThe Unified Client for Canon interface includes support for the languages listed below. The language isselected automatically based on the MFP language. If the MFP language is not available, English is usedby default.• English (default)

• French

• German

• Italian

• Spanish

• Portuguese (Brazil)

5


Note The embedded application allows the user to switch from one supported language to anotherlanguage while in the same session. For the new language to fully take effect, the device must berebooted. If the device is configured with a non-supported language, the displayed language is English.

Switch Language on Device

On Canon devices, the language and the soft keyboard layout can be switched from the device panel.

It can be set:• Globally for the device: Go to Settings > Device Settings > Preferences > Display Settings > Switch

Language/Keyboard.• For the current user only: Go to Settings > Personal Settings > Preferences > Display Settings > Switch

Language/Keyboard.

Note A shortcut can be created for the Personal Settings (left-hand side) and a Switch Language/Keyboard Button can be displayed at the bottom of the screen.

Prepare for Deployment

Verify that your device is supportedFor the latest list of supported Canon models, consult your local Canon representative or refer to KofaxSupported Device Search webpage (https://kofaximaging.custhelp.com/app/imaging/supported_devices/p/3981?mfr=1).

Verify prerequisitesBefore you begin, ensure that the following requirements are met for a single-server installation ofAutoStore and Device Registration Service (DRS).

Check Description

Ensure that hardware meets ControlSuite requirements as described in ControlSuite SystemRequirements. For more information on how to install ControlSuite, consult ControlSuiteConfiguration and Setup online help.

Check that the operating system is one of the following 64-bit ones:• Windows Server 2016 R2 (x64 with IIS 8.0 and .NET 4.5)• Windows Server 2016 (x64 with IIS 10.0 and .NET 4.6)• Windows Server 2012 R2• Windows Server 2012 Standard and Datacenter (enable ASP.NET for Microsoft .NET 4.5 or

ASP.NET for Microsoft .NET 4.6. before installation)

Verify that you have Administrative access rights to Windows on the server.

Check that all required Windows updates are installed.

6

https://kofaximaging.custhelp.com/app/imaging/supported_devices/p/3981?mfr=1

https://kofaximaging.custhelp.com/app/imaging/supported_devices/p/3981?mfr=1


Check Description

Verify that Microsoft Windows Updates is turned ON while you are deploying AutoStore. This isnecessary for the successful installation of Microsoft Windows Identity Foundation (WIF).

Ensure that Windows Identity Foundation 3.5 is installed on the server (to verify it, launchServer Manager > select Local Server > verify that Windows Identity Foundation 3.5 is listed underRoles and Features).

Allow incoming firewall exceptions for the following ports:• 80: Device port used for HTTP connections• 443: Device port used for HTTPS connections to the device• 587: SMTP Email server port used if TLS is enabled• 8443: Device port used for configuration• 8753: The default port for the Device Registration Service Web Service• 8755: The default port for the Device Registration Service REST-based Web Service• 9000: The port used by the server to communicate with the web client. This port is specified in

the Service settings in the DRS Device Configuration Manager

and outgoing firewall exceptions for ports 3310, 8753, 8843, 49629, 49630, 50083. (Note thatport 3310 is configurable and you should update your firewall accordingly).

Verify that IE Enhanced Security Configuration is turned OFF for Administrators in IE EnhancedSecurity Configuration (to access this, go to Server Manager > then select Local Server).

Check that you have all required components downloaded and within easy reach (componentsand download locations are listed in the section below). Check the following licensing steps inCanon Licensing required to install the client.

If you are planning to use any AutoStore Route component that requires client software, ensurethat this software is installed on your server machine before starting deployment.

Verify that you have Administrative access to the device.

Install and Configure the AutoStore ServerOnce you have verified that all prerequisites are met, you can start deploying the package. Start byinstalling the AutoStore server as described in AutoStore Installation Overview.

Add the Unified Client component to an AutoStore workflow to provide capture functionality for Canondevices as described in AutoStore Process Designer.

Set Up a Canon MFP

Configure the Canon MFP in Unified Client EnvironmentThe MFP should be set to the language you wish to use before install. While the client does allow forthe devices language to be changed after installing, it is advised to set it before installing. If the deviceslanguage is changed after installing, it is recommended that the device is rebooted after the MFPconfiguration is changed. For more information, see Supported Languages.

7


Important Specific Canon device settings vary by geographic location and setup. Consult yourCanon technician for any Multifunctional Peripheral (MFP)-specific settings needed for your particulardeployment.

Install Canon ApplicationBefore you start: Check the following licensing steps in Canon Licensing required to install the client.

Complete the following task.

1. Open a web browser and enter Canon MFP's IP address to open the Canon MFP web interface.

2. Under Management Tools, select Service Management Service.

3. Select Install MEAP Application/License.

4. Choose application and license files from your local machine from previously downloaded installationpackage files.

8


5. Choose operation to perform (Install and Start option is default) and click Install.

6. Check Application Information and click Yes.

Note Canon imageWARE Enterprise Management Console (iWEMC) tool can be used for bulkdeployments. This tool is available via Canon.

9


Install and configure the TLS certificatesIn order to ensure secure communication between the MFP and external services, it is advised to enableTLS. Before performing any Device Registration Service (DRS) actions, if TLS is being configured, it isrecommended that you verify the following TLS certificate configuration on the Canon MFP.

Note If you are not using a self-signed certificate (generated by the device), but instead using acertificate signed by a Certificate Authority (CA), you must import the CA certificate into the trusted CAstore of the Windows system where DRS is installed.

After installing DRS, complete the following steps.1. Verify that the device certificate is installed and the TLS certificate is specified.

a. Open device web page (which allows users to remotely monitor and change the networkconfiguration via web browsers as long as the target MFP is networked and has an IP address)and go to Settings/Registration > Preferences > Network Settings > TLS Settings .

b. If the TLS Settings key and certificate option is not imported, browse and select it from yourlocal machine. For further details, see Changing the TLS Settings .

Note Also make sure to create a self-signed certificate in AutoStore under Unified Client >Unified Client Settings > Preferences tab > Server options > Use SSL (checked).

2. Restart device.

10


Install Device Registration Service

Quick Setup Device Registration Service InstructionsBEFORE YOU START: Administrative access to the server is required. All steps outlined are performedfrom the server where the installation takes place. In Start menu under Administrative Tools, go to ServerManager > Local Server > IE Enhanced Security Configuration and turn off Administrators.

1. Install DRS and create the application in DRS.

a. Select the Applications tab.

b. Click the green ( ) button at the top of the left Applications pane. The Add Applicationfunction loads into the right pane.

c. In the Name field (required), enter a name for the application. You can use any name you like;for this example, 'Canon' was used.

d. In the Application Type drop-down list (required), select Canon Unified Client.

e. In the AutoStore Server Address field (required), enter the IP address or the hostname usedby the AutoStore server.

f. In the AutoStore Server Port field, enter the server port used by the AutoStore server. Thedefault value is 3310.

11


g. In the AutoStore Server Use TLS field, select True or False. This setting should reflect yourAutoStore server configuration. Verify it in the Preference tab of Unified Client for Canoncomponent. By default, the AutoStore setting "Use TLS" is OFF. If you leave it as OFF, youshould select False in DRS.

h. Click the Save button ( ) at the top of the Add Application screen.

12


2. Add the device in DRS.

a. Select the Devices tab.

b. Click the green ( ) button at the top of the left Devices pane. The Add Device function loadsinto the right pane.

c. In the Name field (required), enter a name for the Canon device or device group that identifies iton the network.

d. In the Address field (required), enter the IP address or the hostname of the device.

e. Enter the Username and Password for the device. By default, the username is admin and thepassword is blank.

f. In the Application field, select the application you have created from the list.

g. In the Application Name field, enter text if you wish to customize the application name;otherwise leave empty and the default will be ‘Kofax’.

h. In the Enable Debug Log entry, select True or False (default).

i. Click the Save ( ) button at the top of the Add Device pane.

13


3. Configure installed Unified Client for Canon client application onto the device.

a. From the drop-down list at the top of the Details pane, select Configure option. For details, seeUnified Client for Canon Actions Reference. Note: To go back to default values for assets; youmust set and resync.

b. Click the Run Action button . You can follow deployment status feedback under ActionHistory.

The Configure action may take a few moments to complete. Once finished, a Successfullycompleted message appears in the Action History pane at the bottom of the screen.

Set Up Your First AutoStore Capture WorkflowAt this point in the deployment workflow, you should already have a fully functioning installation. To verifythis, create and configure an AutoStore capture workflow (Send to Folder) and test it on your device.

14


License AutoStoreThis is the prerequisite step before you can start configuring your first AutoStore workflow.

Configure Scan to Folder1. In AutoStore, go to AutoStore Process Designer (APD).

2. Select the Home tab and choose New.

3. Define Task Properties and click OK on the Task Properties dialog.

4. Click and drag the Unified Client icon from the Capture list located on left side of the AutoStoreProcess Designer Toolbox anywhere on the newly created workflow canvas on the right side of

15


the screen to an AutoStore workflow to provide AutoStore capture functionality for Canon devices onwhich the Unified Client for Canon is installed.

16


5. Scroll down to the bottom of the Route list and click and drag Send to Folder to the workflow.

6. Right-click on the Unified Client icon and select Properties.

17


7. Select the Preferences tab. Your settings under Server must match the ones you specified in DRS.If you kept the default values there, type 3310 in the Web Server Port field, and leave Use SSLunchecked. Otherwise, ensure that these values match the ones you set in DRS.

Note Verify and ensure that no other AutoStore Capture components are using the same WebServer Port simultaneously.

8. Go to the Groups tab, and click on Common Group for the Canon component configuration.

9. Go to Add Form > Basic Form > select Canon from list of devices. Name the form 'Sample' andclick on the Components tab to configure the folder to route the scan to.

10. Select ... and add the path of the destination folder.

18


11. Click ... next to Folder path and create a folder such as c:\Scans to send scans to. Check offRename file to ensure file names are unique.

12. Click OK. and Save to save the configuration to a folder such as c:\asconfigs.

13. Click Start at the top of AutoStore Process Designer. You should now be able to start and use thisworkflow from the MFP.

AutoStore has a lot more AutoStore capture workflows to offer. Consult the downloaded productdocumentation on how to set those up.

Scanning with the Unified Client for Canon

Basic Scan OverviewOnce you have AutoStore configured for scan workflows following Configure Scan to Folder , you canstart the workflow from the Unified Client Launcher.

19


As this is a simple scan, there are no fields for entering data about the scan. You will have only the Scanbutton and Change scan settings button. With a scan workflow open, you can use the Scan hard key totrigger the scan to start or the soft Scan button.

While the device is scanning, you will see a Please wait... screen that will update as pages are scanned.Upon scan completion, you will be taken back to the scan workflow screen where you can start anotherscan or return back to the Launcher. While the device is scanning you can stop the scan with the Stopbutton. Pressing the Stop button will cancel the scan without option to change this decision.

20


There are several scan settings that can be changed. Once you have the scan settings you want, pressDone. Pressing the back button acts as a cancel and will reset scan settings back to what they were whenyou entered the screen.

Note Not all scan settings are supported on all devices. If you start a scan with the Unified Client usingthe scan settings not valid for the machine, it will try to revert back to device system defaults. If this isnot possible, the scan will fail and the user will need to change the scan settings to something the deviceallows. For example, it is not possible to perform two-sided scanning if the paper is placed on the glass(in this case, the ADF must be used for two-sided scanning) and the scan job will be cancelled.

Scan SettingsCurrently, the Unified Client for Canon supports a subset of the settings and options that are originallyavailable on Canon devices. These are as follows:

Setting Options Notes/Limitations

21


File format JPEG, PDF, PDF/A, TIFF, TIFF/JPEG(Auto)

Note that you cannot use TIFF forcolor scans and JPEG for B&Wscans, PDF (Compact) is currentlynot supported.

Color Mode Auto (Color/Gray), Full Color, Black &White

Resolution 100x100 dpi, 150x150 dpi, 200x200dpi, 300x300 dpi, 400x400 dpi,600x600 dpi

The mixed resolutions are notsupported (for example 200x100 dpi).

Original Type Text/Photo, Text, Photo Slider for the Text/Photo option is notsupported, we use the device defaultoption.

2-Sided Original One Sided, Book, Calendar If you select any two-sided setting,you must use the ADF.

Scan Size Auto, Mixed Size - Same Width,Mixed Size - Different Width,A3 Landscape, A4 Portrait,A4 Landscape, A5 Portrait, A5Landscape, A6 Landscape,B4 Landscape, B5 Portrait,B5 Landscape, Ledger, LegalLandscape, Letter Portrait, LetterLandscape, Folio, Statement Portrait,Statement Landscape, ExecutivePortrait, Executive Landscape

The selected scan size must also besupported physically by the deviceto be able to start scanning with theselected paper size. Otherwise, thescan will either fail (when scanningfrom glass) or will be performedwith a default valid scan size for thedevice (when scanning from ADF).

Density 0-16

Sharpness 0-6

The change in settings is only applied when leaving the Scan Settings screen using the Done button. Theleft arrow acts as a Cancel button and the changes are not applied. When selecting scanner settingsoptions in a way that they form an invalid set of options (for example, TIFF with Full Color), the applicationwill automatically adjust the settings when trying to start the scan job and produce an information levelnotification to the user.

22


Scan Form OverviewIn this section you can find information about the various types of inputs that can be part of a form on ascan workflow. These inputs may contain prefilled data coming from the server that may or may not berequired to be filled before you start scanning (required fields are indicated with an asterisk) and inputvalidation can also be applied.

Depending on the workflow setup, modifying a field can cause a notification of the change to be sent tothe server which in turn can change the contents on the scan form. For more information, see the complexscan overview section.

Text FieldThis is a simple field for free-form text input. The entered text can be cleared by pressing the clear icon( ) on the right side of the input area. Text can be entered using the Canon soft keyboard after touchingthe input area.

When the soft keyboard appears, it is also possible to use an attached hard keyboard for text entry (incase the hard keyboard is supported by the device firmware).

23


Numeric Input FieldThe numeric input is similar to the text input, but it is only possible to enter decimal numbers and fractions.Input is validated for format and range upon change and invalid entries will be cleared. The set languageon the device will be taken into consideration when checking the input format for decimal separators.When entering fractions with higher precision than what is defined for the input, the entered number willbe rounded to the defined precision.

Simple List FieldThe simple list field is used for single-selection lists in which users cannot add entries, only select from thepredefined items.

The current selection is displayed in the input area and it can be cleared by pressing the X ( ) on theright side of the input area. Pressing the input area or the search icon will bring up the list of selectableoptions.

24


Pressing one of the options in the pop-up list will select the item and close the list. Pressing the X ( ) willclose the pop-up without selecting anything and the previous selection will remain selected.

Entering text into the search field on the pop-up screen and then pressing the search icon will filter thelist based on the search term. Exiting the pop-up screen without selection will retain the search when thepop-up is opened again. However, selecting an item from the filtered list will clear the search term and theunfiltered list will be visible again when opening the pop-up list.

The list field loads its data dynamically when scrolling. On larger lists when scrolling, a slight delay mayoccur as it is possible that while scrolling an empty list - area is shown momentarily.

Extendable/Multiselect/Database Lookup FieldsThis field is used for lists in which either multiple selection is enabled or when users can add their ownitems. Selected items will be enlisted in the input area separated by semicolons. The selection(s) can becleared by pressing the clear icon ( ) on the right of the input area.

25


Pressing the input area or the search icon will bring up the item selection/search screen.

The available (not selected) options are listed on the left. To-be-selected items are listed on the right. It isimportant to note that changes in the selection are not actually performed until this screen is dismissedusing the Done option.

26


Options can be filtered using the pre-defined filter buttons on the left, or by entering text into the searchfield on top of the available options list. Multiple items can be marked for selection from the options andthen touch the arrow to select the marked items. Selected items will no longer appear on the options list.To undo a selection, use the Remove button, and to enter a new item not available in the list of optionsuse the Add button.

Note The list field loads its data dynamically when scrolling. On larger lists when scrolling there can be aslight delay, it is possible that while scrolling an empty list area is shown momentarily.

Date FieldThe date picker can be used to enter dates. Various formats of display are supported depending on theserver configuration. The format on picker field is always Year - Month - Day.

When using long (text) formats, month and day names will be localized according to the set languageon the device for supported languages. With a date range enforced the date picker will not let you entera date outside of the range. If you try to go outside of the range, the date picker will display the highest/lowest date possible depending on the direction you are trying to go.

27


Tree FieldThe tree field can be used for either navigating in a predefined tree or in a folder structure (the latterrequiring server interaction while navigating). The path separator changes according to the type of tree.The selection is not modified until the tree window is dismissed by the Done button in the title bar. Leavingthe window by using the left arrow acts as Cancel and does not alter the selection.

Tree navigation (examples):

Folder navigation (examples):

28


Button FieldThe button field is used for initiating server-side script code to run and it always causes servercommunication to occur. The result is an updated form.

29


Checkbox FieldThe checkbox field can have two states, checked or unchecked. The state change can be sentimmediately to the server, or just before initiating the scanning.

Label FieldThe label is a non-interactive field, mainly used for explaining the purpose of other fields or for separatingparts of the scan form.

30


Complex Scan OverviewThe Unified Client for Canon supports Dynamic Forms for the scan workflows, meaning that it is possibleto notify the server of changes in the entered data on the scan forms. When the notifications arrive to theserver with the data, a user-defined script is run and the result of that is an altered scan form which theclient will display. The altered form can have the same visible input fields with altered contents or entirelydifferent ones. For example, making a selection in a list can cause a second list to appear on the form, ora previously disabled field can become enabled based on input validation and so on.

These scripts can also run when the Scan button is pressed, which means that pressing the scanbutton does not necessarily result in the actual start of the scan job. Ultimately, it depends on the serverresponse whether the next action is Start the scan job, Show an error notification, or Show an alteredscan form to enter additional data.

While the change notification is processed (request sent to the server and waiting for the response),controls are disabled on the form and a busy indicator will be shown on the right side of the title bar.

31


Scan LimitationsIn addition to the scan settings limitations explained in the Scan Settings section, the following limitationsapply when initiating a scan with the application.• Currently the application does not support job building (meaning adding additional pages to the

currently scanned document), hence scanning multiple pages from the glass into a single document isnot supported.

• Scanning a large number of pages (over 1500) in a single document is not possible. When nearing thelimit, warning messages will appear and going over the limit will cause the scan job to be canceled.

• Device capabilities are currently not checked for displaying the options for scan settings, thus A4devices will still show larger paper sizes among the options. When selecting an invalid option for thedevice, the scan will either fail (when scanning from glass), or will be performed with a default validscan size for the device (when scanning from ADF).

• When selecting PDF as the File Format, the file is created on the device after the physical scanning isfinished. For a large document, this can take a long time during while the Please Wait screen is shownto the user as this phase is still considered as part of the scanning process by the application. Afterthat, file transfer can happen in the background.

Unified Client for Canon Device SettingsThese sections describes how to configure a Unified Client for Canon device.

Application propertiesA Device Registration Service application profile for the Unified Client for Canon specifies connectioninformation for an AutoStore server. This information allows a device to use capture and printmanagement services on these servers.

These properties appear in the Device Registration Service Details pane when you add or edit a UnifiedClient for Canon application. You cannot change the application type for an existing application.

Property Description

Name A name that uniquely identifies an application.

Application Type To create a new Unified Client for Canon application inDRS, choose Canon for this option.The remaining properties shown here appear after youmake this selection. You cannot change the applicationtype after you save a new application profile.

AutoStore Server Address Identifies an AutoStore server to be used to capturedocuments.This can be an IP address, a system name (if thesystems are in the same domain), or a fully qualifieddomain name. We recommend that you use an IPaddress only if it is static.

32



AutoStore Server Port The port that the AutoStore server uses to communicatewith clients.This setting must match the port number that is seton the Preferences tab of the Unified Client for Canoncomponent settings in AutoStore. The default is 3310.

AutoStore Server Use TLS Select True or False. This setting should reflect yourAutoStore server configuration. Verify it in the Preferencetab of Unified Client for Canon component. By default,the AutoStore setting "Use TLS" is OFF. If you leave it asOFF, you should select False in DRS.

Unified Client for Canon device propertiesUnified Client for Canon device properties are configured in the Device Registration Service web console.

When configured for a device group, they can be propagated to any device in the group.

33


The following parameters define the device settings. Click the edit button to edit the parameters for adevice. Click the save button to save changes to the parameters or click the cancel button to discardchanges.


Name The name of the Canon device or device group.

Address The IP address or hostname of a Canon device.

Note This is a device only parameter and will not bedisplayed when configuring parameters for a devicegroup.

Inherit Properties from Group This option is visible only when a device is located in agroup folder in the Devices pane.• True specifies to use property settings for the group.

The remaining property settings will be inherited fromthe group and unavailable for configuration here.

• False specifies to configure property settingsseparately for this device. The remaining settingswill be available for configuration here except in theirdescription.

Note As application is not inherited, you must haveseparate groups for separate applications.

Username The administrator user name for the Canon device.

Password The administrator password for the Canon device.

Application A DRS application with Canon Unified Client as itsApplication Type. When a device is in a group, thisproperty setting is always inherited the group and doesnot appear for a device.

Device Group Click a group name in this box to change groupmembership. When a device is a member of a groupit can optionally inherit device settings defined for thegroup. This allows you to simultaneously managesettings for multiple devices. Select the [Devices] optionin this list to remove a device from group membershipand move it to the root folder in the Devices pane. Thisoption is not visible while you are configuring options fora new device.

Application Name The application name to display on the device.

Enable Debug Log Specifies whether you want to enable debug logging:• True• False (default).

34


Files TabThe Files tab in the Device Registration Service web client lists is not applicable for Unified Client forCanon application installation. Instead, a manual installation of package on the MFP is required.

Unified Client for Canon Actions ReferenceActions that can be performed from the Device Registration Service for a Unified Client for Canon device.An action can be performed on a single device or on all devices in a group.

To perform an action, first select a device on the Device tab in the Device Registration Service webconsole. Then, in the box at the top of the Details pane, click an available action to perform on the deviceand click the run button . You can follow deployment status feedback under Action History. This

includes the following entries:

Action History entry Description

Time Shows date and time.

Action Specifies current action type information.

Message Specifies current action message information (success/fail).

Status Specifies current status message information (running/complete).

Success Specifies current success message information (Yes/No).

Device Shows all devices in use.

Address Shows IP address in use.

Return Code Shows Return Code number.

To perform an action on all devices in a group, first select the group folder on the Device tab, and then runthe action.

Action Description

Configure Use this action to configure a Unified Client for Canondevice.

35


Unified Client for Canon Return CodesUnified Client for Canon return codes appear for device actions that you perform through DeviceRegistration Service.

The following return codes may appear for Unified Client for Canon history items in the Action Historypanel in the Device Registration Service Web Client.

Return Code Message Description

0 Successfully installed. Configuration successfullycompleted.

1 Installation Failed Configuration failed with the followingerror message:Failed to configure device. Ensure the client package is installed and running.

How to add a new Device profileThis task explains how to create a Device profile. The profile enables you to manage Unified Client forCanon, AutoStore and authentication settings on the Device through Device Registration Service.

1. Open Device Registration Service web client in a supported internet browser window.2. On the toolbar, click Devices.3. On the Devices toolbar, click the add button .4. In the Name box, enter a name to uniquely label the Device profile.5. In the Address box, type an IP address for the device to associate it with this Device profile.

This option is specific to a Device and does not appear when you configure properties for a Devicegroup.

6. In the Username box, type the administrator user name for the Device.The user name is not required to complete a profile, but may be required to perform Actions on adevice.

7. In the Password box, type the password associated with the user name.8. In the Application box, select the application to associate with the Device profile.

The Application setting specifies an application profile listed on the Applications tab. This definesthe client type and server configurations for a device.

9. In the Application Name field, enter the desired label or name for the button that launches the clienton the device.

10. In the Enable Debug Log setting, specify whether you want to enable debug logging.11. Click the save button on the Add Device toolbar.

How to import Device InformationThis task explains how to import Device information into Device Registration Service from a CSV file.

The Application name and type specified for an imported Device must match the name and type of anexisting Application on the DRS server where you want to import a Device. The import will fail for a Device

36


if there is no Application on the server with the name and type specified in the DRS Device export file. In aDRS export file, the Application name and type correspond to the values specified in a Device entry by theApplicationProfile and DeviceType fields.

1. In your web browser, open the Device Registration Service web client.2. Click Devices.3. Click the import button on the Devices toolbar and select the import method:

Click To

Import from file To import Device information from a CSV filethat was contains previously exported Deviceinformation.Browse to the CSV file and click Upload.

The Import Results window shows success or failure for each Device that was specified in the DRSexport file and a message for Devices that were not imported successfully.

4. Close the Import Results window after you review the results of the import.5. If necessary, edit properties for imported Devices.

Imported Devices are always added to the root Devices folder. After you successfully import a Device, youcan optionally drag it to a group folder with the same Application profile. For more information, see theDRS Installation Guide.

Canon Unified Client Launcher ScreenThe Canon Unified Client Launcher screen is very similar to the Canon Main Menu screen. To access theLauncher screen, press the Kofax icon and get past any identification requirements.

You will see a list of workflows over one or more pages depending on how AutoStore is configured. Thisincludes menus and the order of the workflows as they appear in the AutoStore Process Designer. Youcan page left and right using the arrows on the bottom.

37


Example: Page 2 (as the number ot workflows does not fill the screen, the layout alters to reflect that).

The menu button top right will allow the user to bring up the About screen. If identification is already setup, a logout option appears that allows the user to logout of AutoStore.• If the system has a third party authentication application, this logout action will log you out of the device.• If there is no third party authentication, you will be taken back to the Identification screen.

Use the Main Menu button to return back to the Canon Main Menu screen.

38


Authentication and IdentificationThe Canon Unified client supports the Canon MFP configured to include the unlocked device or torequire authentication system locking down access to the MFP. However, the Canon Unified client doesnot support a device configured for application level authentication. This means that either the deviceis totally unlocked or the device is fully locked down and you must authenticate to use it. This level ofauthentication is different to the AutoStore authentication setup (named identification here). While you arenot authenticating to use the device, you are identifying to use the Unified Client application. If you use athird party authentication system (CAC for example), the Unified Client will support single sign-on (SSO).This means that the user that logs into the MFP will also identify AutoStore.

The following scenarios are available:1. Device has the third party authentication and AutoStore has no authentication configured: User data

could be shared from the third party to AutoStore server.2. Device has the third party authentication and AutoStore has authentication enabled: When the user

logs in to the device, they will be identified against AutoStore. In case the identification process fails,the user will be prompted for additional identification data when they try to use the Unified Client.

3. Device has no authentication and AutoStore has no authentication: The user can start the UnifiedClient without entering in any identifying data. They should ensure they leave any workflow beforethey walk away from the MFP device. In this case, logout (either on the device or in the application)is not required.

4. Device has no authentication and AutoStore has authentication; The user will be prompted foridentification when they start the Unified Client application. This user data is not shared with thedevice. Once the user is finished using the Unified Client, they should use the Unified Client logoutoption to end their session and take them back to the Unified Client identification screen. Note: In this

39


case, there is no connection between application logout and the device logout. For more informationon setting up identification on AutoStore, see Configuring authentication.If you have identification enabled in AutoStore without third party authentication system configured, auser will see the following screen when they start the Kofax application.

The user will enter their credentials to login to the AutoStore server in order to see the scanworkflows they have access to. Pressing the Cancel button will clear the prompts and if the userexits back to the main menu, the next user to start the Kofax client will see cleared prompts.The user can use the Menu button top right to bring up an About screen. Pressing the Login buttonwill trigger the system to attempt to identify against the AutoStore server. The exact prompts shownwill depend on what type of AutoStore authentication was setup.

Offline BehaviourIn case of communication failure between the MFP and AutoStore server, the following occurs:

1. The current session will be closed and any active workflow will not complete.2. If the user has provided credentials to AutoStore, they will be logged out of AutoStore.3. A blank Launcher screen will load with an alert that there was an issue talking to the server.4. This will remain until server communication is restored at which point the user will go back to seeing

the screen they would upon walking up to an operational device.5. The offline behaviour will also be seen upon installation of the solution should it be triggered on the

device before the configuration is sent from DRS.6. If a third party system was used for authentication, the application will no longer have the login

credentials used and the user will need to manually logout and log back in. They can still use the restof the system while AutoStore is offline.

Server Reconfiguration BehaviourIf DRS pushes a new configuration to the device or the AutoStore server is reconfigured, the user willexperience the following:

1. The current session will be closed and any active workflow will not complete.2. If the user has provided credentials to AutoStore, they will be logged out of AutoStore.

40


3. The application will load the new configuration from the server it is configured to communicate withand show either an updated Launcher screen or identification screen depending on how exactly theserver configuration changed.

4. A DRS change of configuration that does not change the IP of AutoStore will not trigger this.5. If a third party system was used for authentication the application will no longer have the login

credentials used and the user will need to manually logout and log back in. The user can continue touse the rest of the device without any impact.

Hardkey BehaviourCanon MFPs that offer hard keys have the following special behaviour:

1. With a Unified Client Scan workflow in progress, the Start button will act the same as the Scan softbutton. When pressed, the workflow will try to start the scan. As with the Scan soft button, any errorthat stops the scan from starting will cause an error message to be displayed.

2. When the MFP is scanning a document, the Stop button will cause the scan to stop and the user willbe returned to the scan workflow. Note: The entire job will be cancelled.

3. When the Unified Client application is visible, the Reset button will cause one of the following actionsto occur depending on where the user currently is:

a. If the user is on an identification screen, the screen will reset and all content will be cleared.

b. If the user is past the identification screen (or the system has no identification active), pressingthe Reset button will return the user to the top level Unified Client Launcher screen with all pop-ups (and similar) dismissed.

c. If the user is in the middle of a scan job, the Reset button is ignored.

d. If point a. or b. was performed due to a server reconfiguration, the client will reach out to theserver to get the new configuration and any current session will end.

System Timeout

If the Auto Reset Time has been configured under Settings/Registration > Preferences > Timer/EnergySettings > Power Save Settings, the Unified Client will respond when the timer is triggered.

What occurs depends on the device configuration: With the device setup for the third party authentication(for example CAC), when the timer triggers, the user will find themselves logged out of the device andback on the third parties authentication screen. When this occurs, the Unified Client is reset back to alogged out state.

If the third party authentication is not available, the user will find that when the timer is triggered, theUnified Client will cause one of the following scenarios:

1. If the user is on an identification screen, the screen will reset and all content will be cleared.2. If the user is past the identification screen (or the system has no identification active), the timer will

return the user to the top level Unified Client Launcher screen with all pop-ups and similar dismissed.3. If the user is in the middle of a scan job, the timer will not be triggered.4. If point 1 or 2 happened after a server reconfiguration, the client will reach out to the server to get the

new configuration and any current session will end.

41


Main Menu Button

The Canon MFP provides a button that is used to exit the Unified Client and return to the Canon MFPnative home screen. When a user presses the Main Menu button, they will leave the Unified Client andreturn to the Canon Native home screen where upon they can interact with the rest of the device.

When the user returns to the Unified Client application, they will see the same screen that was visiblebefore they pressed the Main Menu and can continue working on the application as if they never left thatpoint.

Note If the device is not locked down and the user does this with a scan workflow active, the next usercan see what that user was typing. In this case, it is important to ensure that the Auto Reset Timer isconfigured on the device to minimize the chance of a second user seeing private data from the first user,or ensure the first user presses the Reset button before they leave the Unified Client. See Canon AutoReset Timer.

If the AutoStore server is configured to prompt for identification, the screen is cleared if the user leavesthe identity screen before completing the process. This ensures that the next user is not able to login asthe previous user.

Appendix: Additional Configuration Instructions

SecurityThis section describes changing the TLS settings, information on FIPS and the Canon Auto Reset Timer.

Changing the TLS SettingsBefore performing any Device Registration Service (DRS) actions, if TLS is being configured, it isrecommended that you verify the following TLS certificate configuration on the Canon MFP.

Changing the TLS settings is performed:

• From the web-base device administration (using remote UI portal or Service Management Service):Allows users to remotely monitor and change the network configuration using web browsers as long asthe target MFP is networked and has an IP address, and

• From the device. For more information, see Canon documentation.

Changing the TLS settings from the web

Follow these steps to open from the web-base device administration:

1. Open a web browser and enter http://<MFP IP Address> in the Address field. The device web pageopens.

2. Provide administrator user name and password, if prompted, for login.

42


3. Go to Settings/Registration > Preferences > Network Settings > TLS Settings > SettingsThat Use TLS and change the settings.

4. Go to Settings/Registration > Preferences > Network Settings > TLS Settings > SpecifyAllowed Versions and change the settings.

5. Go to Settings/Registration > Preferences > Network Settings > TLS Settings > AlgorithmSettings and change the settings.

6. Go to Settings/Registration > Preferences > Network Settings > TLS Settings > Key andCertificate and change the settings.

7. Click OK.

FIPS

In addition, Federal Information Processing Standards (FIPS) are compatible. FIPS are publiclyannounced standards developed by the United States federal government for use in computer systems bynon-military government agencies and government contractors.

Whenever you are doing an AutoStore server upgrade from AutoStore 7, if you have already changed theFIPS compliance setting on our server, then in order to retain your configuration from the previous versionit is required that you re-enter the passwords for LDAP, Send to Email and SharePoint, and then re-savethis configuration for it to take effect.

Canon Auto Reset TimerYou can set the Canon Auto Reset Timer to return to the default screen after your task is completed orwhen a key operation is not performed or if the machine is idle for a certain period of time.

43


It is recommended for security reasons to set the Canon Auto Reset Timer in order to terminate the usersession when using authentication enabled configurations.

1. Press (Settings/Registration) → [Preferences] → [Timer/Energy Settings] → [Auto ResetTime].

2. Press [-] or [+] to specify the desired Auto Reset Time → press [OK].

Configuring AA Common Access Card Authentication Solution Unified Client for Canon supports AA Common Access Card (AA CAC) 1.8.0.0005 that has authentication capabilities and prevents unauthorized access to MFPs with AutoStore installed.

A US Department of Defense (DOD) CAC authentication solution provides US federal government customers with the ability to use their exiting ID cards with the solution, increasing user satisfaction, security and productivity.

The CAC authentication solution provides the following benefits:

• Easy to use turn-key solution • Holders of a valid CAC can perform copy, scan, fax, and/or document server functions • Card is inserted into CAC reader connected to MFP and PIN is entered • Upon successful authentication the multifunction device is unlocked for use

For US Government accounts, the embedded client can use CAC cards for user authentication when configured with AutoStore.

Complete as follows:

1. Install CAC. For more information, see Canon’s AA Common Access Card Installation and Configuration Guide.

2. Register and configure Canon MFP devices using CAC authentication.

3. Login with your card. Go to Main Menu > Configuration > Set User Authentication System > User Login Mode and choose to login using: • Card and Keyboard • Keyboard Only • Card Only.

When logging in with keyboard, enter your CAC PIN code to log in.

For more information, see Canon AA CAC documentation.

Configuring and Using DRS for a CAC Device

Selection on the Canon device – DRS Web client

1. Open the http://<DRSIP>:9000/device.

Note If '0' is selected, the Auto Reset Time mode is not set.

44


DRS action steps

1. Select the device which has CAC on it.

2. Run action Configure.

CAC Authentication and Equitrac MEAP Authentication SolutionUnified Client for Canon supports Advanced Authentication Common Access Card (AA CAC) that hasauthentication capabilities and prevents unauthorized access to MFPs with all supported applications(AutoStore).

For more information, see relevant Canon documentation: Advanced Authentication CAC Version 1.8Installation and Configuration Guide and Advanced Authentication CAC Version 1.8 User's Guide.

A US Department of Defense (DOD) CAC authentication solution provides US federal governmentcustomers with the ability to use their exiting ID cards with the solution, increasing user satisfaction,security and productivity.

The AA CAC authentication solution provides the following benefits:• Easy to use turn-key solution.• Holders of a valid CAC can perform copy, scan, fax, and/or document server functions.• Card Only/Keyboard Only and Card and Keyboard solutions are supported by AA CAC (see Advanced

Authentication CAC Version 1.8 User's Guide).

45


• The Equitrac Authentication is supported by the Canon Unified Client.

Upon successful authentication, the MFP is unlocked for use.

For more information on how to install and operate AA CAC or on how to install Smart Card Service in order to operate the AA CAC, see Advanced Authentication CAC Version 1.8 Installation and Configuration Guide and Advanced Authentication CAC Version 1.8 User's Guide.

For more information on how to install Smart Card Service in order to operate the AA CAC, see Smart Card Service Version 4.4 Installation and Configuration Guide.

In all cases, after the login using any third party Authentication Application (AA CAC or Equitrac), the same user name will be used by Canon UC to login into the AutoStore Workflow.

There is no required configuration option in the Canon UC client to integrate with CAC or Equitrac. Once the device is configured with AA CAC (or Equitrac) and the Canon UC client is installed and configured,the client will pick-up the User ID and email made available on the device by the login process. The Canon UC client will validate the userid with the AutoStore server and perform SSO if the userid is accepted by the AutoStore server, which will depend on the CAC server domain and AutoStore serverdomain and authentication configuration.

AutoStore has the following Authentication Types under Authentication in Unified Client: None, Windows, and Custom Script.

46


If the type is None any authenticated user can see the workflow without additional authentication.

If the type is Windows and Domain is the same domain used by the third party (or AA CAC):• The user is recognized and it is the same user on Windows and the user provided by the third party (no

additional authentication needed) SSO.• The user provided by third party (or AA CAC) is not recognized - additional authentication screens are

displayed by Canon UC.

If the type is Script - only the user name is provided to the Script from the third party, the password isnever supplied.• If the user name is enough for validation and the user name is valid (no additional authentication

needed) SSO.• If the user name is NOT enough for validation - additional authentication screens are displayed by

Canon UC.

From the Canon UC point of view, there is no difference between AA CAC, EQ Login Application or anyother Authentication Application.

Note The SSO/no SSO decision does not depend on the type of the authentication, but only on theresult of authentication.

Canon LicensingCanon licensing uses a new royalty free licensing agreement between Kofax and Canon, as the CanonMEAP license used by Kofax embedded applications is now a royalty free A1 license.

To obtain and apply your A1 LIC license file:1. Open the LAN file that was included with the application JAR file and record the license access

number.2. Record and add the serial number for each Canon MFP you wish to license in a CSV format.3. Navigate in a web browser to the Canon License Management System (http://www.canon.com/

meap).4. Enter the LAN number and click Next.5. Verify information and click Apply to Issue a License.6. Navigate to the CSV file on your local machine.

47

http://www.canon.com/meap

http://www.canon.com/meap


7. Complete the rest of the steps until a license (.lic) file is downloaded.8. Open a web browser and enter http://<MFP IP>:8000/sms in the Address field.9. Login using the SMS password.

10. On the System Management Services page, navigate to System Management > EnhancedSystem Application Management.

11. In the Install Enhanced System Application/License section, click Browse to locate the path tothe embedded application file.

12. Click Browse to locate the path to the matching license file.13. Click Install.

Moving App Logo to the First Page of Canon DeviceIn case you want application logo (Kofax United Client) to be available on the first page of Main Menu,complete as follows:

Before you start: By default, the settings icon is grayed out. To enable it, go to Quick Menu > Personal> login as administrator on the login screen > Main Menu.

1. Open the Main Menu settings button in the upper right corner of the screen.

48


2. Click Main Menu Button Display Settings.

49


3. Find "Kofax Unified Client" and use Up and Down buttons to move it to the screen and place youwant it displayed.

50


4. Press OK.

5. Verify that application logo is available on the first page of Main Menu.

51


Renaming Embedded Application on Home ScreenDRS allows the system administrator to rename the embedded application on the device's home screen (asingle device or multiple devices). This rename process overrides the default name of the application onthe device's home screen independently of the locale set on the device.

The following example presents the default behavior for the application to be renamed as "Kofax UnifiedClient" when nothing is configured. Complete as follows:

1. In DRS, select a device under Devices and go to Details > Application Name > rename application to"Kofax Unified Client".

2. Under Details, select Configure action.

3. Verify that this action has been completed under Action History.

52


4. In the device web interface, perform restart under Settings/Registration in order to these changestake effect.

5. On the device's home screen, after restart, verify that application has been renamed. For moreinformation on how to place this application to be on the first page, see Moving App Logo to the FirstPage of Canon Device.

Appendix: Additional AutoStore Instructions

Configuring authenticationBy enabling authentication at this level (by selecting this tab), the user is enabling authentication at aglobal level. This authentication procedure will be used for all devices. The user does also have the optionof enabling authentication at the group level.

53


These settings do not control authentication to the MFP, they are used for authentication with AutoStore.1. Click the Authentication tab.2. On the drop down menu for Authentication Type, select the authentication method you want to use:

Option Description

None Select this option to not have the device promptfor credentials. All users have access to allworkflows.

Windows Select this option to use Windowsauthentication. Unless the device is setup forSSO, this will prompt the user for a Windowsuser name, domain and password. In theDomain box, enter the name of a Windowsdomain to be used as the default domain forauthentication. If attributes other than emailaddress are needed, see LDAP Lookup Settingsdialog box on how to setup LDAP.

Custom Script The administrator has full control over theprompts that will be presented to the user aswell as how the prompts are validated. In theScript File Path box, specify the script to beused for authentication. This option can be usedwith device SSO. For more details, see CustomScripting authentication.

Note If a device is setup with SSO, AutoStore attempts to use that data to authenticate. If it fails,the user needs to fill in additional fields to complete the authentication process.If a device is setup with SSO, AutoStore attempts to use that data to authenticate. If it fails, theuser needs to fill in additional fields to complete the authentication process.

LDAP Lookup Settings dialog boxUse this dialog to configure LDAP search settings.

This dialog box is opened when you select to Use an LDAP search to retrieve additional informationand click the Configure button on the Authentication tab. These settings are optional and only used byWindows and Custom Script authentication methods.

Option Description

LDAP Server Type the address or host name of the LDAP server.

Root DN Type the distinguished name for the node wherethe search should start. For example: DC=Sales,DC=MyCompany, DC=com. If this field is left empty, thenthe starting point of the search will be the root of thedirectory tree.

Login as Anonymous Select this check box to allow anonymous connections tothe LDAP server.

54


Option Description

Login with following credentials Select this check box to log in to the LDAP server withthe specified user name and password.

Directory Type Select the type of directory that it will be searched, if anoption other than Custom is selected then predefinedattributes will be used to match the authenticated username and retrieving the email address.

Match User name against This option configures a variable that can only bechanged by the system administrator. Check with yoursystem administrator to adjust this settings.

Get email address from This option configures a variable that can only bechanged by the system administrator. Check with yoursystem administrator to adjust this settings.

Additional Attributes Type the name of the user attributes separated by asemicolon. If no attributes are specified in this boxthen only the email address will be retrieved. Theseattributes will be available as user attributes replacementtag names (URTNs). For more information aboutURTNs supported by this component, see Unified Clientcomponent RRTs.

Integration with MFP authentication

This type of authentication is called also as SSO or Single Sign On. While AutoStore authentication onlyimpacts access to AutoStore, device authentation impacts access to the entire MFP. If the device hasbeen setup with authentication, either provided by Kofax or another third party like CAC, the Unified Clientuses this information to authenticate AutoStore.

This type of authentication has the following properties:• ~SenderRRT variables use device credentials if the Unified Client has access to that information. It

does not depend on the authentication method selected in AutoStore• The Launcher screen of the Unified Client is shown as the start page after logging in and starting the

Unified Client application. Some platforms allow you to automatically start the Unified Client after login.• If the MFP authentication mechanism does not populate all the required fields, the user may see

Windows prompts or the Launcher screen upon starting the Unified Client• If the AutoStore authentication uses a custom script, and the authentication is successful, the Launcher

screen appears as the start page after starting the Unified Client. If the authentication fails, an errormessage is shown, and the user can enter the credentials.

• On MFPs where the Unified Client controls device authentication, the starting screen can be selected.For more details, see the client specific guides.

The following options are available:• Using no authentication (option None in the Authentication tab):

• The user will be taken directly to the device menu.• ~SenderRRT variables will use device credentials.

55


• Using Windows authentication ~SenderRRT variables will use device credentials and the user will betaken directly to the device menu in the following cases:• The device has been configured to use Windows authentication.• The device has been configured to use third-party authentication that passes valid Windows

credentials (name and domain). If the domain is not passed, then the user must be in the defaultdomain that has been configured for Windows authentication.

In any other cases the user will be prompted for credentials.• Using an authentication method based on a Custom Script:

• If the custom script has prompts configured, the user will be shown a login screen where thespecified prompts must be re-entered. The associated script will have access to device credentials inaddition to the prompt information.

• If the custom script does not have prompts configured, the initial login screen is skipped and theassociated custom script is invoked immediately and the associated script will have access to thedevice credentials. If the result of the script is that authentication is not valid, then the user will seean error message. At this time the only option for the user will be to Exit. If the authentication is valid,~SenderRRT variables will use credentials based on the results of the script execution.

Adding and editing groups

How to add a new groupNote The Common Group cannot be removed.

1. Click the Groups tab and click Add Group.2. In Group Settings, type a name for the group in the Name box.

This name does not appear on the MFP display as it is used strictly for identification purposes.3. For Temporary Repository, select the following:

Option

Internal HTTP(S) AutoStore's internal web server will be used toreceive scanned documents.

4. Add the MFP devices that will be associated to this group by entering the IP Address or host name ofthe MFP in the MFP Address/Host Name list.The MFP address list must contain at least one MFP.

Tip Using the network name is preferable because the IP address can change if you are usingDynamic Host Configuration Protocol (DHCP).

5. If the MFP devices in this group should authenticate the user, click the Authentication tab, andselect the Requires Authentication check box.For more information about configuring the Authentication options, see Authentication tab.

6. Click OK.

How to enable group level authentication1. Highlight the group and click Edit

56


2. Click the Authentication tab and select the Requires Authentication check box.

Note To use the same authentication settings that were configured for authentication globally,select the Use Global Authentication Settings check box.

3. Complete instructions described in the Configuring authentication procedure.

Basic formA basic form provides basic settings to capture files from a Unified Client MFP.

To add a basic form to a process, click any group or menu node on the Groups tab of the Unified Clientconfiguration dialog box, and then click Add Form > Basic Form on the menu bar.

Configure options for a basic form on the General, Fields, and Components tabs in the Form Settingsdialog box.

When setting up any type of form, the following three tabs must be configured: General tab, Fields taband Components tab.

Scanning SettingsThis topic describes scanning settings that are available for the Canon component. These settings areconfigured on the General tab in the form settings. Select the Allow Changes check box next to any optionto allow users to change the setting on the device console.

Setting Description

Color Mode Indicates whether to scan the original in color or blackand white mode:• Auto (Color/Gray) — Auto color/gray detection for

scanning.• Black&White: Scan in black and white.• Full Color: Scan text and photos in full color,

regardless of whether the original is in color or inblack.

File Format Indicates the type of the file to save scanned data. Thefollowing file types are supported:• PDF — Save to PDF format.• PDF/A — Save to PDF/A format.• JPEG — A file format widely used in digital cameras.

Suitable for saving photo data. This type does notsupport the saving of multiple pages into one file.

• Tiff — Specifies TIFF format. This type creates eithera separate file for each page scanned or multiplepages, depending on the Multi Page setting.

• Tiff/JPEG (Default) — Specifies TIFF or JPEG format.

57


Setting Description

Resolution Indicates the scanning resolution:• 100x100dpi — Select this option to scan the lowest

resolution.• 150x150dpi — Select this option to scan a lower

resolution.• 200x200dpi — Select this option to scan a standard

original.• 300x300dpi — (Default) Select this option to scan a

standard original with higher resolution.• 400x400dpi — Select this option to scan an original

containing small characters and drawings.• 600x600dpi — Select this option to convert an original

into a file of the maximum size. This option is availablewhen scanning an original such as a full-color photo,which requires a fine level of image.

Original Type Choose the appropriate type from this list:• Text/Photo• Text• Photo

Scan Size Choose the appropriate image mode from this list: Auto,Mixed Size - Same Width, Mixed Size - DifferentWidth, A3 Landscape, A4 Portrait, A4 Landscape,A5 Portrait, A5 Landscape, A6 Landscape, B4Landscape, B5 Portrait, B5 Landscape, Ledger, LegalLandscape, Letter Portrait, Letter Landscape, Folio,Statement Portrait, Statement Landscape, ExecutivePortrait, Executive Landscape.

2-Sided Original Choose the appropriate 2-Sided Original from this list.• One Sided• Book• Calendar

Sharpness Choose the appropriate sharpness from 0-6.

Density Choose the appropriate density from 0-16.

Email formUse an Email form when you need to send the document to an email destination. An Email form is used inconjunction with the Send to SMTP and Send to Exchange Route components.

An email form can be added by right-clicking any Group or Menu node, pointing to Add Form and thenclicking Send to Email Form.

Refer to the Basic form to configure settings on the General, Fields, and Components tabs.

58


Option Description

Do not show a From field. This will use the device logged on user's email addresscheck box to omit the From field. This option is selectedonly to hide the [From] field. In this case, administratorshould decide which RRT to use on the server side.If this option is selected, ~UFD::SenderEmail~ or thesimple [Text] field RRT must be set in the From field.

Show a CC Field This will show the CC field in which the user can specifya secondary list of people that will receive the message.

Show a BCC Field This will show the BCC field in which the user canspecify people that will receive the message secretly.

Global Address List Allows the user to search the Global Address List foraddresses that can be added to the To, CC and BCCfields. In the Display As box, type the display value forthis search option. The Global Address List that will besearched as follows: If there is no logged on user thenthe search will be performed on the Global Address Listassociated to the service account for the service. Note:The service account for the AutoStore service must haveenough permissions to perform this search.

Exchange Contacts (This option is disabled on the server side for the UnifiedClient component). Select this check box to allow usersto search their Microsoft Exchange contacts folder foraddresses that can be added to the To, CC and BCCfields.• Display as — Type the display value for this search

option. This should be a user friendly value thatdescribes this search location, for example “MyContacts”.

• Server — Type the IP address or host name of theExchange server . Contact your system administratorif you are uncertain of what to put here.

• Use SSL — Select this check box if a secure socketlayer (SSL) connection is required to connect to theExchange server.

59


Option Description

LDAP Server Select this check box under Contacts Search Locationsto allow the users to search an LDAP Server foraddresses that can be added to the To, CC and BCCfields.• In the Display As box type the display value for this

search option.• In the LDAP Server box type the address or host

name of the LDAP server.• In the Search Root DN box type the distinguished

name for the node where the search should start. Forexample: DC=Sales, DC=MyCompany, DC=com.If this field is left empty then the starting point of thesearch will be the root of the directory tree.

• In the Email Address field type the name of the LDAPattribute that represents the email address.

• In the Name Field type the name of the LDAP attributethat represents the name of the user.

• Choose the Login as Anonymous option to establishan anonymous connection to the LDAP server.

• Select the Login with following credentials option tolog on to the LDAP server with the specified Username and Password.

After you configure LDAP settings, click Test LDAP tovalidate the settings.

Possible LDAP Ports:• • Standard LDAP: 389

• Active Directory Global Catalog: 3268• LDAP over SSL: 636• Active Directory Global Catalog over SSL: 3269

Folder formUse a Send to Folder form when you need to send the document to a folder destination. A Send to Folderform is used in conjunction with the Send to Folder and Send to Folder eConnector components.

A folder form can be added by right-clicking any Group or Menu node, pointing to Add Form and thenclicking Send to Folder Form.

Refer to the Basic form to configure settings on the General, Fields, and Components tabs.

Note This function works only if the administrator sets proper RRT in the Components tab.

Option Description

Base Directory Enter the location of the directory that the user canbrowse to select the destination of the document.

60


Option Description

Default Document Name Type the default name that will be used for the documentname field.

SharePoint formUse a Send to SharePoint form when you need to send the document to a SharePoint Office 365 orSharePoint 2010/2013 server.

This type of form allows users to browse document libraries, folders and list values at the device. A Sendto SharePoint form is commonly used in conjunction with the Send to SharePoint 2010/2013 eConnectorand route components.

A SharePoint form can be added by clicking any group or menu node, and then clicking Add Form >Send to SharePoint Form on the menu bar.

Refer to the Basic Form Options to configure settings on the General, Fields, and Components tabs.

Option Description

Server Version Specify the correct version:• SharePoint 2010/2013 Services• SharePoint Office 365 Services

Note If you want to change the Server Version afterthe connection has been established and Site fieldhas been populated, click OK to dissmis the dialogand re-open it again in order to ensure the Site hasbeen updated from the new Server.

Server Address Enter the path to the SharePoint2010/2013 server whereyou will be storing the documents.This field can contain "http://" or "https://" followed by theserver name or IP address. For example, both “http://sp2010” or “https://192.199.292.255” will work. The fieldcan also contain only the server address, for example,sp2010. In this instance, the component will insert"http://" before the server address automatically.

User name Enter the user name which will be used to log on to theserver.If you are using a domain user account to connectto SharePoint 2010/2013, enter the user namewith the domain name. For example, enter domain\SharePoint_username . If you are logged intothe server, you only need to enter the user name, forexample SpUser.

User Password Enter the user password which will be used to log on tothe server.

Prompt for document name Select this check box to allow users to provide adocument name that can be used in the file renamingschema of the SharePoint component.

61


Option Description

Site Enter the name of the SharePoint site where you want tostore the documents.This can be done either manually or by selecting a valuefrom the drop-down list. You can specify a sub-site ofthe site by entering its name after the parent site namefollowed by "/", for example SubSite1/SubSite1_1.

Document library Enter the name of the default document library to whichyou want to send the documents. This can be doneeither manually or by selecting a value from the drop-down list.

Allow user to Change Document Library Select this check box to allow the document library to bechanged on the device.

Default Folder Enter the name of the default folder where the routedfiles will be stored, this can be done either manually or bybrowsing to the desired folder. Click the browse button(...) next to the box to open the Select Folder dialog box.

Allow user to Change Folder Select this check box to allow the folder to be changedon the device. This option is always on if Allow user toChange Document Library is selected.

Content Type Enter the name of the default content type to associateto the document. This can be done either manually orby selecting a value from the drop-down list. Note thatthe user will only be able to select a Content Type atthe device panel if there is more than one content typeassigned to the selected document library; otherwise thecontent type is assigned automatically.

Allow user to change Content Type Select this check box to allow the content type to bechanged at the device. If Allow user to change DocumentLibrary is selected then this option is always on.

SharePoint fields

SharePoint document libraries allow the creation of differentcolumn types, with an additional set ofconfiguration choices for each column type. Canon UC supports only single line text fields and choicefields. It does not support default value, column format, maximum length, column formatting and so on.

Option Description

Name and type Enter the name of the column and select the type of therequired information.

Note Single line of text does not properly set thedefault value and does not enforce the maximumfield length.Choice options appears correctly as a list, but doesnot follow the selected Display choices using option.Yes/No appears as list field, not as a checkbox.

62


Option Description

Additional Column Settings Enter a description for the column and specify therequired details.

Authentication tabUse settings on this tab to globally enable authentication for the Unified Client component at the domainlevel.

Authentication requires MFP users to provide valid credentials to send documents to the workflow server.The authentication settings are configured for the server, and they can be enabled or disabled for anygroup of MFPs.

Option Description

Authentication Type Specifies the authentication method to be used by thecomponent.• None — No authentication method will be used.• Windows — Uses Windows authentication.• Custom Script — The administrator has full control

over the prompts presented to the user and validationof user entries.

Domain Specify the name for the default domain to be used toauthenticate users when Windows is selected as theAuthentication Type.Do not use the fully qualified Domain NameServer (DNS) domain name. Do not use top leveldomain qualifiers such as .com, .net or .org. Forexample, if the user is listed as mydomain/user1 [email protected], then in a User PrincipalName (UPN) format, the domain should be "mydomain",not "mydomain.domain.com".

Custom Script The administrator defines prompts that are displayed tothe user. An event is sent to the server when a user logsin. The administrator must provide the .NET plug-in DLLthat responds to the event.• Script File Path — Specifies the path to the VB.NET

script that contains the code to authenticate the user.You can click the browse button ( ...) to locate thescript file.

• Edit Script Code — Click this button to open a scripteditor window with basic script code. For details onthe script editor window and the object model usedto authenticate users, click the help button in thescript editor.

Prompts Click this button to open the Authentication Promptsdialog box and configure the prompts that will bedisplayed to the user. For more information, seeAuthentication Prompts dialog box.

63


Option Description

Use an LDAP Search to retrieve additional userinformation

You can configure an LDAP search to retrieve additionalinformation about the authenticated user, such as theiremail and full name. To enable this feature, selectthe Use an LDAP Search to retrieve additional userinformation check box. Click the Configure button toopen the LDAP Lookup Settings dialog box to configuresettings for the LDAP server.

Note When Windows is selected as theAuthentication Type, the email address is retrievedautomatically as part of the authentication, so anLDAP search is not required if you only need theemail address.

For more information, see LDAP Lookup Settings dialogbox.

Authentication Prompts dialog boxUse this dialog box to configure prompts that will be used to collect user information. These prompts willbe displayed for user entry in the MFP control panel.

To create a new prompt, type a name in the first blank box in the Name column of the table. To deletea prompt, click in the first column of the table to select a row, and then press the Delete button on thekeyboard.

Option Description

Name Specifies the name of the prompt that will be used toreference it in the script.

Display Specifies the label for the prompt on the MFP. If thisoption is left empty, the name will be used to label theprompt.

Default Specifies a default value for a prompt. This is optional.

Select this check box to require the user must to enter avalue for the prompt.

Select this check box to mask text entered by the user atthe MFP device panel for security.

Custom Scripting authenticationCustom Script is a way to create your own way to authenticate. The administrator has full control on whatprompts are displayed and how the authentication happens.

Prompts are not necessary if the device is setup for SSO, and the device provides SSO data forauthentication.

1. Configure the prompts that will be used to collect user information by clicking the Prompts button.Form more information, see Authentication Prompts dialog box.

64


2. Enter the path to the VB.NET script that contains the code that will authenticate the user after he hasfilled the prompts at the device.• If you have an existing script you want to use you can click the browse button (...) next to the

Script File box.• You can also click the Edit Script Code button to open a script editor window with basic script

code.

When creating a custom script, you can use the following predefined fields:• authData.GetData("Username")• authData.GetData("Password")• authData.GetData("#IPAddress")• authData.GetData("#DeviceUserName")• authData.GetData("#DeviceDomain")• authData.GetData("#DeviceEmail")• authData.GetData("DOMAIN")• authData.GetData("EMAIL_ADDRESS")• authData.GetData("USER_ID")• authData.GetData("IDENTIFIER")• authData.GetData("DISPLAY_NAME")

These fields are not visible to the end user, these are only used by the SSO hooks to pass backdata that the Unified Client populates. The fields that are populated depend on what data theauthentication application provides. It can be different by device and by authentication application.Create a test script to see what fields are populated for the configured setup. With this data, a scriptcan then be created to do what is needed.The following result field has to be populated by the script for the proper operation of Unified Client:• result.IsAuthenticated

• true means that the login is valid .• false means the login failed.

The following field should be filled in. If LDAP integration is selected, you must populate the followingitem:• result.UserInfo.UserName

If the user name provided is not in LDAP, the lookup will fail.

To add custom data to the ScanJob.xml file, include the following fields in the results:• result.UserInfo.UserAttributes.Add("Attr1","Test 1")• result.UserInfo.UserAttributes.Add("Attr2","Test 2")• result.UserInfo.UserAttributes.Add("Attr3","Test 3")

3. Select the Use an LDAP search to retrieve additional information check box if you need to lookup the email address and other attributes about the authenticated user.

Note When windows authentication is selected the email address is retrieved automatically as partof the authentication, so an LDAP search is not required if only the email address is needed.

4. If you select the Use an LDAP search to retrieve additional information check box, clickConfigure to enter the settings for the LDAP search.

65


This opens the LDAP Lookup Settings dialog box. For more information about options in this dialogbox, see LDAP Lookup Settings dialog box.

5. To test the search settings, enter a sample user name in the Username box and click Test.

Example: Example of a custom script:Option Strict Off

Imports SystemImports NSi.AutoStore.Capture.DataModel

Module Script Sub CustomAuthenticate(ByVal authData As MetadataCollection, ByVal result As AuthResult) 'Sample custom authentication for a configuration with two authentication "Prompts...": username and password 'When defining the authentication Prompts, both username and password fields should be required using the ! checkbox option. 'The password filed should be masked using the # checkbox option for security reasons. Dim username As String = authData.GetData("username") 'As client authenticated user's username Dim password As String = authData.GetData("password") 'As client authenticated user's password 'In this sample we set the authentication result to true if the username matches the password. result.IsAuthenticated = password = username

'Additionally, Custom User Attributes can be added to the result passed back to the client. result.UserInfo.UserAttributes.Add("Attr1","Test 1") result.UserInfo.UserAttributes.Add("Attr2","Test 2") result.UserInfo.UserAttributes.Add("Attr3","Test 3") 'These will be returned with the scanned image's JobFile.XML and can be referenced during processing.

End SubEnd Module

Configuring the Scanning Settings

In Scanning Setting, select Form Availability for the following device types: Canon, Ricoh SOP, SamsungSmart UX and Toshiba.

66


Note It is possible to set the color and file type of the scan in the Scanning Settings dialog box ofthe device. If the selected File Type does not support the selected Color Mode, an error message isdisplayed.

Scripting OverviewThe scripting capabilities of the component allows you to provide your own authentication method or tomodify the standard behavior of a form.

Some of the scenarios where you can use scripting include:• Implement a custom authentication method.• Add and remove fields to a form dynamically.• Change field contents (for example: load the contents of a list field from a database).• Validate field contents before the document is scanned and sent to the workflow server.

About the scripting environment

When using scripting for dynamic forms you must provide a script file that contains the code to respond toevents. A script editor is provided as part of the component; to access the editor, do the following:• To edit Custom Authentication scripts click the Edit Script button in the Authentication tab in the main

component window• To edit Dynamic Form scripts click the Edit Script button in the General tab of the Form Settings

window.

67


The included script editor facilitates the creation and edition of scripts, provides intellisense and allowsfor the compilation of scripts. To compile the script click the Compile button in the script editor window, iferrors are found you can double click the error message to go to the associated line of code.

Both Visual Basic .NET and C# are supported for writing scripts with Visual Basic as the default language.Switching to your language of choice can be achieved using the Languages submenu located under theCompilation menu in the script editor.

With Visual Basic .NET, your code must be contained inside a Module named Script, for example:Imports SystemImports NSi.AutoStore.Capture.DataModelModule Script 'Add your event handlers here...End Module

With C#, your code must be contained inside a public static class named Script, for example:

using System;using NSi.AutoStore.Capture.DataModel;public static class Script { // Add your event handlers here...}

By default only the component library and the following assemblies are loaded in the scriptingenvironment at runtime:• System.dll

• Mscorlib.dll

• System.Web.dll

• System.DirectoryServices.dll

If you need to use other .NET libraries you will need to add the following comment at the top of your scriptin order to load the respective assembly:'LoadAssembly:AssemblyName.dll//LoadAssembly:AssemblyName.dll

Where assembly name is the name of the assembly, for example to use the System.Data assembly youwould specify:'LoadAssembly:System.Data.dll//LoadAssembly:System.Data.dll

Note You can load native .NET framework assemblies, Global Assemblies or .NET assemblies that arelocated in the workflow server installation directory. If you plan to use a third party assembly you mustmake sure that it meets one of the above criteria.

Besides any namespaces you want to reference in your script, you will also need to import theNSi.AutoStore.Capture.DataModel namespace. This contains the classes that will allow you tointeract with the form, fields and authentication data.

Responding to Events

To respond to events generated by a form or custom authentication you need to provide an event handlerfor the desired event.

68


Authentication Event

This event is generated when Custom Script authentication has been configured for the component andthe user presses OK in the device login screen. The syntax for the procedure that responds to this eventis:Sub CustomAuthenticate(authData As MetadataCollection, result As AuthResult) 'TODO add code here to authenticate based on the information entered at MFPEnd Subpublic static void CustomAuthenticate(MetadataCollection authData, AuthResult result) { //TODO add code here to authenticate based on the information entered at MFP}

See the AuthResult class for an example of how to respond to this event.

Note The code for responding to the authentication event must be included in the script file selected inthe Authentication tab of the component.

Form Events

The form can generate two events, one when the form is loaded and one when the form is submitted(when the user presses the OK button on the form screen). Form events are only fired if you explicitlyconfigured the component to do so. For details on doing this please refer to the Dynamic Form section ofthe component help.

The syntax for the procedure that responds to the form load event is:Sub Form_OnLoad(ByVal eventData As MFPEventData)public static void Form_OnLoad(MFPEventData eventData)

The syntax for the procedure that responds to the form submit event is:

Sub Form_OnSubmit(ByVal eventData As MFPEventData)public static void Form_OnSubmit(MFPEventData eventData)

See the MFPEventResult.IsFormValid property for an example of how to respond to this event.

Field Events

Fields can generate an event when the value of the field is changed. This event is only fired if youexplicitly configured the field to do so. For details on doing this please refer to the Adding Fields section ofthe component help.

The syntax for the procedure that respond to the field changed event is:Sub FieldName_OnChange(ByVal eventData As MFPEventData)public static void FieldName_OnChange(MFPEventData eventData)

In addition to the changed event, the ListField can also generate an even when the user press the Findbutton on the device. The syntax for a procedure that respond to the list field find event is:Sub FieldName_OnFind(ByVal eventData As MFPEventData)public static void FieldName_OnFind(MFPEventData eventData)

69


Note When using FieldName_OnFind, the function should check that valid values are returned. Ifinvalid values are returned, the field becomes empty.

The code for responding to form events must be included in the script file selected in the Dynamic Formsection of the form settings.

In case of Numeric fields, if multiple commas are entered as Default value, the commas are ignoredduring the conversion. To avoid it, use the following script:Option Strict Off

Imports SystemImports NSi.AutoStore.Capture.DataModel

Module Script Sub Form_OnLoad(ByVal eventData As MFPEventData) On Error Resume Next 'Option 1, set limits Dim fields = eventData.Form.Fields For Each field As BaseField In fields If TypeOf field Is NumericField Then Dim myField As NumericField = DirectCast(field, NumericField) 'Overrides for NumbericField myField.MaxValue = 6 myField.MinValue = 4 myField.Precision = 2 myField.Display = "Scripted NumericField" 'This changes the field label myField.Value = "5,4" 'sets the initial value (default). The client locale's decimal character must match, in this example a comma is used. End If Next 'Option 2, set limit on specific field. Dim myField2 As NumericField = DirectCast(eventData.Form.Fields.GetField("Numericfield"), NumericField) 'Overrides for NumbericField myField2.MaxValue = 10 myField2.MinValue = -10 myField2.Precision = 2 myField2.Display = "Specific NumericField" 'This changes the field label myField2.Value = "7,3" 'sets the initial value (default). The client locale's decimal character must match, in this example a comma is used. End SubEnd Module

Debugging scripts

To trace into the scripting code using a VisualBasic.Net debugger (such as Visual Studio) you can attachthe debugger to the batch.exe process (this is the workflow server service process).

Also if you don't have a debugger but want to display detailed information about the script execution,you can run the workflow server in server mode, and use the methods from the System.Console classto display information in the command window. To run in server mode you need to type the followingcommand in a command window:<Workflow Server Install Path>\batch.exe -e -c<Path to configuration script>

70


So if your script is invoked by a configuration file located at C:\My.cfg then you will have to use thefollowing command line:<Workflow Server Install Path>\batch.exe -e -cc:\My.cfg

Unified Client component RRTs

Component RRT ID

The RT ID for this component is UFD .

Reserved Replacement Tag Names (RRTN)

The following table describes the reserved RTN values for this component:

Name Description

FormName Name of the form.

Sender The user name of the authenticated user that issubmitting documents.This RRT is populated in the following cases:• The component has been configured to use an

authentication method other than None.• The device authentication is turned on for Extensible

Services (Custom Services).• Authentication has been configured for the device

SenderEmail The email address of the authenticated user.

SenderDomain The authenticated user’s domain name.This RRT is populated in the following cases:• The component has been configured to use Windows

authentication.• The component has been configured to use Custom

authentication and the associated Script.NET scriptpopulates the Domain property of the UserInfo object.

IP The IP address of the MFP device.

HostName The resolved host name of the MFP device.

ServerIP The IP address of the Unified Client application serverassociated with the device.

ServerHostName Host name of the Unified Client application serverassociated with the device (IIS server host name).

PageCount Number of pages of the scanned file.

Format Format of the scanned file. Possible values are:• PDF• JPEG• TIFF• MTIFF

71


Name Description

FileSize Size in bytes of the scanned file.

Field Replacement Tag Names (FRTN)

This component supports FRTNs and replacement of field names generated from the MFP devices. Thefollowing example provides some examples:

~UFD::%ClientID%~This is replaced by "Company" if the user types in "Company" for the field name called "Client ID".

User attributes Replacement Tag Names (URTN)

This component supports URTNs and replacement of user attributes specific to the authentication methodused. The following example provides some examples:

If Custom authentication is used and there is a user attribute named "Full Name" with the value" JohnDoe" then the RRT will look like:

The RRT ~UFD::User,%FullName%~ will be replaced by "John Doe"

If an LDAP Search is used to retrieve additional attributes and a user enters "displayName" on theAdditional Attributes box, then for an authenticated user which displayName is "Jane Doe":

The RRT ~UFD::User,%displayName%~ will be replaced by "Jane Doe"

Special Set Replacement Tag Names (SSRTN)

This component supports all the Date/Time tag names listed below:

Name Description

% a Abbreviated weekday name

% A Full weekday name

% b Abbreviated month name

% B Full month name

% d Day of month as decimal number (01 – 31)

% H Hour in 24-hour format (00 – 23)

% I Hour in 12-hour format (01 – 12)

% j Day of year as decimal number (001 – 366)

% m Month as decimal number (01 – 12)

% M Minute as decimal number (00 – 59)

% p Current locale’s A.M./P.M. indicator for 12-hour clock

% S Second as decimal number (00 – 59)

% U Week of year as decimal number, with Sunday as firstday of week (00 – 53)

72


Name Description

% w Weekday as decimal number (0 – 6; Sunday is 0)

% W Week of year as decimal number, with Monday as firstday of week (00 – 53)

% y Year without century, as decimal number (00 – 99)

% Y Year with century, as decimal number

Unified Client communication ports

The following ports are used by the Canon Unified Client• Possible LDAP Ports:

• Standard LDAP: 389• Active Directory Global Catalog: 3268• LDAP over SSL: 636• Active Directory Global Catalog over SSL: 3269

• DRS communication port: 8443• Default port for AutoStore: 3310

TroubleshootingIssue Cause Solution

Numeric field (on the server side):The user is able to apply an invalidvalue.

The value is dropped, and the userwill see blank.

If the default value contains decimals,then the separator must match thelocale of the device that displays thatdefault. For this, use a script to setdefault value with decimals.

User is kicked out of current workflowafter a server configuration change.

Administrator has changed the serverconfiguration, for example by addinga new scan workflow.

This is to be expected. If the serverconfiguration changes, the user willhave any ongoing session terminatedand will need to restart their sessionon the MFP in order to do a scan.

73

unified client for canon deployment guide · unified client for canon with autostore deployment...

Documents