Lexmark C925 Lexmark Document Distributor - Page 21

Auto

‑

configure scripts can be triggered by several events. The event that triggers the script is determined by the name

of the script:

•

configureNewSolution.js

—This is triggered when a solution is installed to the LDD system.

•

configureNewSolutionServer.js

—This is triggered when a solution is first added to each LDD server in

the LDD system.

•

configureUpgradeSolution.js

—This is triggered after an existing solution is upgraded in the LDD system.

•

configureUpgradeSolutionServer.js

—This is triggered after a solution is upgraded on each server in

the LDD system.

•

configureRemoveSolution.js

—This is triggered when a solution is removed from the LDD system.

•

configureRemoveSolutionServer.js

—This is triggered when a solution is removed from each server in

the LDD system.

•

configureSolutionRestart.js

—This is triggered when a solution is installed or upgraded, or a server is

restarted, in which case it is run for each solution.

To add an auto

‑

configure script to a workflow solution, create a script using the selected name in the scripts\ folder of

the workflow solution project.

Note:

If a solution performs several actions using an auto

‑

configure script and you are deploying the solution directly

to an LDD system by exporting it from Eclipse, then you may need to increase the value of the Solution Export Wait

Time setting in the Lexmark preferences to allow enough time for deployment.

Using auto

‑

configure methods

All methods used for auto

‑

configure are members of the

caller

object, which is detailed in the

Lexmark Document

Distributor Script Reference

. These methods can also be used in a scheduled script in which the

caller

object is

assigned as follows:

var caller = context.getObject("autoconfigUtilities")

For an example of an auto

‑

configure script that uses several of the available methods, see the configureNewSolution.js

file in the TestMFP template in Eclipse. Additionally, the simplelog.js file in the scheduled\ folder of the TestMFP

template contains the preceding

var

statement and uses auto

‑

configure methods.

Configuring the home screen with auto

‑

configure

The method

caller.setWelcomeScreen(groupName, solutionName, fileName)

configures the

home screen for the specified solution in the specified group. The specified XML file, located in the src\solution

\welcomescreen\ folder, provides a description of the layout of the home screen.

The description of a home screen for an individual device class is specified using the element

<welcomescreen

model="

class

">

, where

class

is one of the following:

•

etask

—e

‑

Task multifunction printers

•

sfp_etask

—e

‑

Task single

‑

function printers

•

etask2

—e

‑

Task 2 multifunction printers

•

etask2+

—e

‑

Task 2+ multifunction printers

•

sfp_etask2

—e

‑

Task 2 single

‑

function printers

•

etask3

—e

‑

Task 3 multifunction printers

•

sfp_etask3

—SFP e

‑

Task 3 single

‑

function printers

Developing workflow solutions

21

Section	Page
Contents	2
Getting started	5
Prerequisite skills for developing workflow solutions	5
Prerequisite skills for developing LDD system components	5
Understanding workflow solutions	6
Understanding solution types	7
Version compatibility of workflow solutions	8
Understanding components	8
What is the LDD SDK?	8
Minimum system requirements	8
Supported printers	9
Supported ECM platforms	12
Getting support	12
Preparing for development	13
Installing the development environment	13
Manually associating JavaScript files with Eclipse	14
Accessing the Lexmark Document Distributor Script Reference Guide	14
Developing workflow solutions	15
Best practices for solution design	15
Creating a new workflow solution project	16
Understanding the contents of a workflow solution project	16
Managing solution projects	17
Editing the properties of an existing workflow solution project	18
Referencing a workflow solution project	18
Evaluating code quality with JSLint	19
Understanding types of scripts	19
Using profile scripts	19
Using library scripts	19
Adding a library script to a solution	20
Accessing the functions of a library script	20
Using auto-configure scripts	20
Using auto-configure methods	21
Configuring the home screen with auto-configure	21
Using forms merge scripts	29
Scripting for different stages of a forms merge	29
Using the PrintClass service with forms merge scripts	32
Printing forms on printers with forms cards	32
Using scheduled scripts	32
Understanding the objects used in solution development	33
Top-level objects	33
Prompts	33
Services	34
Configuring solutions	35
Managing solution settings	35
Managing device policies	37
Managing the Solution Status Page	41
Managing formsets	42
Managing custom reports	42
Using the included document processing components	43
Bar code read support	43
Bar code write support	45
OCR support	46
Using the included solution database	48
Services	49
Understanding the Job Submission Web Service	49
Understanding dynamic prompting support	50
Using Kerberos authentication	51
Developing workflow solutions for previous versions of LDD	51
Testing and deploying workflow solutions	52
Testing with the MFP emulator and performance simulator	52
Accessing the MFP emulator or performance simulator	52
Using the interactive MFP emulator	52
Using the interactive MFP emulator with an LDD system	52
Simulating a scan task	53
Saving print jobs	53
Using the performance simulator	53
Preparing and running tests in the performance simulator	53
Configuring advanced properties	54
Supplying answers to prompts	61
Using JConsole to monitor and modify a running test	63
Determining the single-server throughput for a solution	65
Deploying a solution directly to an LDD server system	66
Restarting the Lexmark Solutions Application Server	67
Distributing a solution file and installing the solution using LMC	67
Managing the LDD 4.x System List	67
Building a workflow solution from the command line	68
Developing components	70
Understanding component design	70
Best practices for component design	70
Creating a new component project	71
Understanding the contents of a component project	71
Including a component in a workflow solution project	72
Troubleshooting	73
Network connection problems occur when installing or updating plug-ins in Eclipse	73
The Lexmark Solution Development perspective or other features are missing	73
Auto-complete does not work or items are missing in auto-complete lists for LDD objects	73
A properties file updated using revision control does not update	74
LDD system times out when directly exporting a solution	74
The MFP emulator does not run	74
The MFP emulator runs but cannot be discovered in LMC	75
The Backspace and left arrow keys do not work when viewing LMC in Eclipse	75
Notices	76
Edition notice	76
Trademarks	76
UNITED STATES GOVERNMENT RIGHTS	76
The Apache Software License, Version 1.1	77
Apache License Version 2.0, January 2004	77

Lexmark C925 Lexmark Document Distributor - Page 21

Using auto-con methods, Configuring the home screen with auto-con

Page 21 highlights