Solution Composer Training v1.0 - Lexmark€¦ · Overview Solution Composer is an easy-to-use program that allows you to build custom solutions that run on enabled Lexmark MFPs.

Solution Composer TrainingVersion 1.0Lexmark Software & Solutions

September 2010

Lexmark Confidential

Contents

Overview: What is Solution Composer?

L 1 U d t di th b i Lesson 1: Understanding the basics• Step 1: Adding tasks from the Task Library• Step 2: Configuring properties for each task• Step 3: Validating the solution (Optional)• Step 3: Validating the solution (Optional)• Step 4: Simulating the solution to check its overall flow

(Optional)• Step 5: Saving a project file• Step 6: Deploying the solution to enabled Lexmark devices• Step 6: Deploying the solution to enabled Lexmark devices or deploying to a file for later use

Lesson 2: Building a solution for a real-world scenario

Glossary


Overview

Solution Composer is an easy-to-use program that allows you to build custom solutions that run on enabled Lexmark MFPs. Solutions can range in complexity from g p yone or two-step processes, to more complex workflows.

All solutions built using Solution Composer can be deployed to enabled MFPs instantly or they can bedeployed to enabled MFPs instantly, or they can be saved as files that are deployed at a later time.


Overview

Minimum requirements

Lexmark Solution Composer, version 1.0 A Lexmark MFP running:

Le mark Sol tion Composer Agent Lexmark Solution Composer Agent


Overview

Things to remember

Required fields are marked by indicators. These fields must be populated with data before the solution can be deployed.

Exclamation marks indicate problems that must be fixed before a solution can be deployed.

Hover your cursor over a task in the Design pane to see a list of problems that must be fixed as in thesee a list of problems that must be fixed, as in the following example:

C lt th U ’ G id f d t il d i f ti Consult the User’s Guide for detailed information, definitions, examples, and troubleshooting.


Lesson 1

Understanding the basics



The Solution Composer window is divided into three sections:



The Solution Composer window is divided into three sections: Task Library PaneTask Library Pane

This contains all the User Prompts and Scan Actions ((collectively known as “tasks”) that users can choose to include in their solution.solution.



The Solution Composer window is divided into three sections: Design Pane

This is where the tasks are ordered and the sequence of events for a

Design Pane

sequence of events for a solution is determined.

Double-click or drag and drop tasks onto the Design Pane to add them to your solution.



The Solution Composer window is divided into three sections: Task Properties PaneTask Properties PaneTask Properties Pane

Each individual task added to the Design pane has configurable

Task Properties Pane

has configurable properties.

When a task is selected in h d i hthe design pane the available properties for that task are shown here.



The process of developing solutions in Solution Composer follows a b i f lbasic formula:

1. Adding tasks, such as Scan to Network, from the Task Library

2 Configuring properties for each task2. Configuring properties for each task

3. Validating the solution (Optional)

4 Simulating the solution to check its overall flow (Optional)4. Simulating the solution to check its overall flow (Optional)

5. Saving a project file

6. Deploying the solution to enabled Lexmark devices or 6 ep oy g t e so ut o to e ab ed e a de ces odeploying to a file for later use



Step 1: Adding tasks to the solution workflowThere are four types of tasks: User Prompts, ScanThere are four types of tasks: User Prompts, Scan

Actions, Index Files, and Confirmations. Together, they form the basis for all solutions built using Solution Composer.

User Prompts require input from, or deliver messages to, users via the MFP touch screen. Scan Actions, Index Files, and Confirmations, on the other hand, save or send files to locations such as e-mail addresses, FTP f ld t k hfolders, or network shares.

You can add a task to your solution in one of two ways:two ways:•Double-click an icon in the Task Library•Drag an icon from the Task Library into the Design pane

Tips



Step 1: Adding tasks to the solution workflow

1. Multiple Choice—This prompts users to select from a list of options.

2. Numeric Entry—This prompts users to enter a numerical value.3. Message—This displays a message on the MFP touch screen

and requires no user input.

1 2

3 4 q p4. Text Entry—This prompts users to enter a text string.5. Scan to Email—This sends scanned files to specified e-mail

addresses.6. Scan to Network—This saves scanned files to a specified

network location.7. Scan to Fax—This sends scanned files to specified fax

destinations.8. Copy—This prints scanned files at the device.9. Scan to FTP—This saves scanned files to a specified FTP

destination.

5

7

6

8 destination.

9



Step 1: Adding tasks to the solution workflow

1. Index File to Network—This saves a custom index file that lists details about the scan job and/or the MFP to a specified network location.

2. Index File to FTP—This saves a custom index file that lists details about the scan job and/or the MFP to a specified FTP 1 2 j pdestination.

3. Print Confirmation—This prints a confirmation at the device.4. Email Confirmation—This e-mails a confirmation to a specified

e-mail address.

3 43 4



Step 2: Configuring properties for each task

1. Single-click the desired task in the Design pane to display its properties in the Task Properties pane.

12

2. Configure the task properties as necessary.*

*Note: For detailed information about configuring task properties

T d l t t k f th D i i l li k th t k

*Note: For detailed information about configuring task properties, see the “Building custom solutions” chapter and the Appendix in the User’s Guide.

Tips

• To delete a task from the Design pane, single-click the task icon, and then press the Delete key on your keyboard.

• To rename a task in the Design pane, double-click the name of the task, and then type a new name.



Step 3: Validating the solution (optional)

-OR-

Tools > ValidateTools > ValidateValidating a solution package is an optional step before

saving or deploying it.

Whether you validate a solution or not all problems must beWhether you validate a solution or not, all problems must be fixed before the solution can be deployed. You will be notified of any problems when you try to deploy the solution.



Step 4: Simulating the solution (optional)Tools > Simulate

The Simulator gives you a means of checking the basic look, flow, and syntax of a Solution Composer project.p p j

It is device-independent, meaning that the Simulator can only approximate how a solution y ppwill look once it has been deployed to a device.

• Click the icon on the Simulator window to launch the simulation

Tips

Click the icon on the Simulator window to launch the simulation.• You can view the settings for the Task Properties on a particular

screen by clicking Show Details.• Use the computer keyboard to enter data for prompts that require

user input.


Understanding the basicsStep 5: Saving projects

File > Save As

• Solution Composer “projects” are saved as lwfs files

-or-File > Save As … With Password

• Solution Composer projects are saved as .lwfs files. “.lwfs” files represent open or in progressprojects, not completed solutions.

• lwfs files can be opened and edited later• .lwfs files can be opened and edited later.

• .lwfs cannot be installed

Note: Projects must be “deployed” before they become installable solutions Once deployedNote: Projects must be “deployed” before they become installable solutions. Once deployed, a solution package is generated with the file extension of “.lwfd”. Only files with an extension of .lwfd can be installed on a Solution Composer enabled MFP

.lwfd files cannot be opened and edited


Understanding the basicsStep 6: Deploy the solution Note: Solutions must be “deployed” before they can be installed. You can choose to deploy a solution in one of 2 ways; 1 To a file -or- 2 Directly to a Solution Composer enabled MFP

Tools > Deploy

solution in one of 2 ways; 1. To a file -or- 2. Directly to a Solution Composer enabled MFP.

Tools > Deploy Solution (to File or Device)Here you configure your y g ysolution’s Name, Version, Image, and Description. You can also edit the required support Information.


Understanding the basicsStep 6: Deploy the Solution

Naming the solution and configuring its properties

1

2

1. Type the name that will appear above the solution icon on the MFP home screen.

2. Type the version number of the solution, using only numbers and periods.

2

3

g y(Example: 2.0.0)

3. Click browse to locate the PNG, GIF, JPEG, or BMP image that will represent the solution on the MFP home screen. The icon pictured on the tab will be used if noicon pictured on the tab will be used if no image is specified.

4. Type the description that will appear on the solution information tab on the MFP Embedded Web Server.

4

Note: Because solutions built using Solution Composer may require technical support, it is important that the information in the Solution Properties pane be filled out completely and correctly.

5. Click Close.


correctly.

Understanding the basicsStep 6: Deploy the Solution

Naming the solution and configuring its properties

Tools > Edit Support Info1. Type the name of who supports

the solution.2. Type the phone number to call for

1

2

support on the solution.3. Type the Web site URL for the

company that will support the solution.

4 T th t il dd

3

4

4. Type the support e-mail address of the company that will support the solution.

Note: Because solutions built using Solution Composer may require technical support, it is important that the information in the Solution Properties pane be filled out completely and correctly.


y

Understanding the basicsStep 6: Deploying the solution (Method 1 – Deploy to a file )

Tools > DeployTools > Deploy Solution to File

Solutions can be deployedSolutions can be deployed to a “.lwfd” file, which can be installed on enabled Lexmark devices via the Solution Composer AgentSolution Composer Agent on the devices Embedded Web Page.



Step 6: Deploying the solution (Method 2)

T l > D lTools > Deploy Solution to DeviceYou can deploy a solution directly to an MFP that yhas the Solution Composer Agent Installed by entering the IP address of the device here

Note: Deploying a solution directly to a device does not create a solution package (.lwfd file). It simply installs your solution on an enabled device.


It simply installs your solution on an enabled device.

Understanding the basicsManually Installing your solution package

Note: Once deployed as a “.lwfd” file, the solution can be manually installed on a Solution

Open the Embedded Web Server by pointing the browser to the IP

From a Web browser…Composer enabled MFP.

by pointing the browser to the IP address of the MFP running Solution Composer Agent.

From the Embedded Web Page, click Applications > Solution Composer to navigate to the page where you will upload solution packages.

Browse to the solution package (the .lwfd file), and then install it. The solution will then be available from the home screen of the MFP.

Tips

The Solution Composer agent must be installed on the MFP prior to attempting this step.


Lesson 2

Building a solution for a real-world scenario


Scenario: Solution for a small insurance agency

“I own a small insurance agency. When we receive a claim, we have to e-mail a scanned image of the claim form along with certain pieces of information to headquarters for processing.”

The solution will prompt users to enter claim and policy numbers before scanning the claim form.

Solution Composer will use variables to capture user input so that it can be included in the subject line of the e mailso that it can be included in the subject line of the e-mail message.


Create a new project and add a Numeric Entry prompt

1 F th S l ti1. From the Solution Composer file menu, click File > New.

2 Double click a2. Double-click a Numeric Entry prompt to add it to the workflow.

3. Double-click the name beneath the icon in the Design

t “Cl ipane, type “Claim Number” and press Enter on your keyboard.

Lexmark ConfidentialLexmark Confidential

y


Prompt users to enter a claim number

1. From the Task Properties pane, click the text entry field next to Prompt.

2 T “Pl t th l i b ”2. Type “Please enter the claim number.”



Add a Numeric Entry prompt

1. Double-click a Numeric Entry prompt to add it to the workflow.

2. Double-click the name beneath the icon in the Design pane, type “PolicyDesign pane, type Policy Number,” and press Enter on your keyboard.



Prompt users to enter a policy number

1. Single-click the “Policy Number” icon to display its properties in the Task Properties pane.

2. From the Task Properties pane, click the text entry field next to Prompt.

3. Type “Please enter the policy number.”



Add a Message prompt

1. Double-click a Message prompt to add it to the workflowworkflow.

2. Double-click the name beneath the icon in the Design pane, type “Place on Scanner” and press Enter on your keyboard.



Prompt users to place the document on the scanner glass

1. Single-click the “Place on Scanner” icon to display its properties in the Task Properties pane.

2 From the Task Properties pane click the2. From the Task Properties pane, click the ellipses button in the Message row.

3. Type “Please place the document facedown on the scanner glass” in the Message text prompt that appears, and then click OK.



Add a Scan to Email action

1. Double-click a Scan to Email action to add it to the workflow.

2. Double-click the name beneath the icon in the Design pane, type “ScanDesign pane, type Scan to Email” and press Enter on your keyboard.



Configure the Scan to Email task properties1 Single-click the “Scan to Email” icon to1. Single-click the Scan to Email icon to

display its properties in the Task Properties pane.

2. From the Task Properties pane, click the ellipses button in the To row.

3 Type an e-mail address in the To text3. Type an e mail address in the To text prompt that appears, and then click OK.



Add variables to the Subject field

1. Right-click the Subject field, and then select Insert Variable from the menu.

2 From the Variable Selection menu click2. From the Variable Selection menu, click Claim Number > Response, and then click OK.



Add variables to the Subject field

1. Right-click the Subject field, and then select Insert Variable from the menu.

2 From the Variable Selection menu click2. From the Variable Selection menu, click Policy Number > Response, and then click OK.



Tools > Deploy Solution

Name the solution and configure its propertiesTools > Deploy Solution

to File1. In the Solution Properties

section, enter the Name, Version, and Description , pof your solution.

2. Click Browse… to locate the PNG, GIF, JPEG, or BMP image that willBMP image that will represent the solution on the MFP home screen. The icon pictured on the left will be used if no image is specified.


Name the solution and configure its properties

Tools > Edit Support Info1. Type the name of the company

that will support the solution.2. Type the phone number of the

company that will support the solution.

3. Type the Web site URL for the company that will support the solutionsolution.

4. Type the e-mail address of the company that will support the solution.



• The choices made for Solution Properties determine how the solution will look on the MFP home screen.

• Data from the Edit Support Information dialog appears on the device Embedded Web Server, which can be accessed by pointing a Web browser to the device IP address.



Save the projectFile > Save As

Save the project on your computer. This will allow you to open and edit the project later using Solution Composer Remember that these files represent open

File > Save As

Composer. Remember that these files represent open projects, not completed solutions. Projects must be deployed before they become solutions.



Deploy the solution to a device running Solution Composer Agent

Tools > Deploy Solution to D iDevice

Type the IP address in the Device Addressfield, and then click OK.



What users see on the MFP touch screen











GlossaryActions—Actions are available in the Solution Composer Library pane and, when used as part of a solution, entail some sort of activity carried out by the MFP. Specifically, they save or send files to locations such as e-mail addresses, FTP folders, or network shares.Embedded Web Server—This is the Web interface for Lexmark devices. It is accessed by typing the IP address or DNS hostname of a device into the address field of a Web browserhostname of a device into the address field of a Web browser.Index file—Index files can contain data gathered from both individual workflow tasks, as well as the overall solution. Generic index files can be created as part of certain tasks (such as Scan To FTP), or they can be customized as part of the Index File to FTP and Index File to Network tasks.Prompts—Prompts are available in the Solution Composer Library pane and, when used as part of a solution, entail some sort of activity on the part of the user. Specifically, they require input from, or deliver messages to, users via the MFP touch screen.y p p y, y q p , g ,Simulator—The Simulator provides users with a means of checking the basic look, flow, and syntax of a Solution Composer project before deploying it.Solution—This term is used synonymously with "solution package" to refer to the finished applications built using Solution Composer.Solution Composer Agent—The Solution Composer Agent is an eSF application that allows Solution Composer scripts to be installed and run on Lexmark devices. The term “enabled Lexmark device” means that an MFP is running the Solution Composer Agent and can therefore recognize and run the scripts produced by Solution Composer.Solution Package—This term is used synonymously with “solution” to refer to the finished applications built using Solution Composer.Task properties—These determine the behavior of the individual tasks (Actions and Prompts) in a Solution Composer project.Tasks The Actions and Prompts that make up a Solution Composer projectTasks—The Actions and Prompts that make up a Solution Composer project.Variables—Variables represent data drawn from the MFP itself (such as its IP address) or from user input (such as which choice a user made from a list of options). They are available as a right-click option in most text fields in the Task Properties pane, and they are used as a dynamic means of gathering data to report back on system conditions and user choices.Workflow—Workflow refers to the sequence of events created by the group of tasks that make up a Solution Composer project.


Solution Composer Training v1.0 - Lexmark€¦ · Overview Solution Composer is an easy-to-use program that allows you to build custom solutions that run on enabled Lexmark MFPs.

Documents