Solution Composer User's Guide September 2011 www.lexmark.com Lexmark and Lexmark with diamond design are trademarks of Lexmark International, Inc., registered in the United States and/or other countries. All other trademarks are the property of their respective owners. 2011 Lexmark International, Inc. All rights reserved. 740 West New Circle Road Lexington, Kentucky 40550
Edition notice September 2011 The following paragraph does not apply to any country where such provisions are inconsistent with local law: LEXMARK INTERNATIONAL, INC., PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions; therefore, this statement may not apply to you. This publication could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in later editions. Improvements or changes in the products or the programs described may be made at any time. References in this publication to products, programs, or services do not imply that the manufacturer intends to make these available in all countries in which it operates. Any reference to a product, program, or service is not intended to state or imply that only that product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any existing intellectual property right may be used instead. Evaluation and verification of operation in conjunction with other products, programs, or services, except those expressly designated by the manufacturer, are the user s responsibility. For Lexmark technical support, visit support.lexmark.com. For information on supplies and downloads, visit www.lexmark.com. If you don't have access to the Internet, you can contact Lexmark by mail: Lexmark International, Inc. Bldg 004-2/CSC 740 New Circle Road NW Lexington, KY 40550 USA 2011 Lexmark International, Inc. All rights reserved. UNITED STATES GOVERNMENT RIGHTS This software and any accompanying documentation provided under this agreement are commercial computer software and documentation developed exclusively at private expense. Trademarks Lexmark, Lexmark with diamond design, and MarkVision are trademarks of Lexmark International, Inc., registered in the United States and/or other countries. All other trademarks are the property of their respective owners.
Contents 3 Contents Edition notice...2 Overview...5 Understanding the basics...5 System recommendations...5 Building custom solutions...7 Getting started...7 Step 1: Creating a new project and adding tasks...9 Step 2: Validating solutions (optional)...9 Step 3: Simulating solutions (optional)...10 Step 4: Saving projects...10 Step 5: Deploying solutions...11 Sample solutions...15 Scenario 1: Scanning W 4 forms to a corporate FTP site...15 Scenario 2: Scanning HR forms and saving an index file to a network...17 Troubleshooting...20 A solution has been deployed to a device, but it does not appear on the device home screen...20 The Scan to Email or e mail actions cause the solution to fail...21 The Scan to Email task fails to send an e mail...21 The Scan to Fax or fax actions cause the solution to fail...21 Frequently asked questions...22 Appendix...24 Licensing Solution Composer Agent...24 Properties for user prompts...24 Properties for scan actions...28 Properties for index files...43 Properties for confirmations...46 Variable definitions...47
Contents 4 Notices...55 Glossary...65 Index...66
Overview 5 Overview Solution Composer is a user friendly program that lets you build custom workflow solutions for Lexmark multifunction printers (MFPs) running the Solution Composer Agent. These solutions can range from one or two step processes to more complex workflows involving multiple user prompts and index files. Using a simple drag-and-drop interface, the program is designed to enable users to begin building solutions almost immediately no programming experience required. Solutions built using Solution Composer can be deployed directly from the Solution Composer application, or as a file that can be loaded onto a device from its Embedded Web Server or from the Lexmark Virtual Solution Center. Understanding the basics Solution Composer relies on four main components for producing solutions that will run on enabled devices: The main application window This is where solutions are built. Using the different panes of the main window, users can select and configure the tasks that make up solutions. The main application window is made up of three panes: Task Library This pane contains the actions and prompts used to form the sequence of events in a solution. The Task Library includes four categories: User Prompts, Scan Actions, Index Files, and Confirmations. Design This pane is where tasks are put in order and the sequence of events for a solution is determined. Task Properties This pane is where properties are set for each individual task in the Design pane. Simulator Accessible from the Solution Composer menu or toolbar, the simulator gives users a means of checking the basic look, flow, and syntax of a Solution Composer project. Solution Packages All Solution Composer projects are deployed as solution packages. These can be installed on printers running the Solution Composer Agent. Solution Composer Agent This is an embedded application that makes it possible for solutions built using Solution Composer to be installed and run on a printer. Solution Composer Agent is a licensed application. To learn more about licensing, see Licensing Solution Composer Agent on page 24. The process of developing solutions in Solution Composer follows a basic formula: 1 Adding tasks, such as Scan to Network, or user prompts 2 Configuring properties for each task 3 Validating the solution (optional) 4 Simulating the solution to check its overall flow (optional) 5 Deploying the solution to enabled devices (also involves naming and configuring solution properties) System recommendations Solution Composer will run best on a system that includes: Windows XP SP3 or Windows 7 Java version 1.6 or later 1GB or more of RAM
Overview 6 1.8GHz or faster processor PDF reader (for Help files)
Building custom solutions 7 Building custom solutions Getting started Before you begin to build custom solutions, it can be helpful to take a look at some of the available tasks and how they are used. The Task Library There are two broad types of tasks: actions and prompts. Together they form the basis for all solutions built using Solution Composer. Activities like saving scanned files to a network location (an action), or requiring users to make a selection from a list of options (a prompt), create the workflow for each solution. Actions represent activity on the part of the printer, while prompts represent activity on the part of the user. Specifically, actions save or send files to locations such as e mail addresses, FTP destinations, and network shares. Prompts, on the other hand, require input from users or deliver messages to them through the printer touch screen. The Task Library is made up of four categories: User Prompts: Multiple Choice This prompts users to select from a list of options. Numeric Entry This prompts users to enter a numerical value, such as a PIN. Message This shows a message on the printer touch screen and requires no user input. Text Entry This prompts users to type a text string, such as a user ID. Scan Actions: Scan to Email This sends scanned files to specified e mail addresses. Scan to Network This saves scanned files to a specified network location. Multi Send This scans a file once and sends the scanned file to multiple destinations. Multi Send supports FTP, network, e mail, fax, and print destinations. Scan to Fax This sends scanned files to specified fax destinations. Copy This prints scanned files at the device. Scan to FTP This saves scanned files to a specified FTP destination. Index Files: An index file is used to store key information about another (usually larger) file. Index File to Network This saves a custom index file containing user defined content, such as details about a scan job, to a specified network location. Index File to FTP This saves a custom index file containing user defined content, such as details about a scan job, to a specified FTP destination. Confirmations: Print Confirmation This prints a page of text, such as a confirmation message, at the device. Email Confirmation This e mails text, such as a confirmation message, to specified e mail addresses.
Building custom solutions 8 Putting tasks in order When creating a workflow, you must arrange tasks in the order in which they will be needed in the finished solution. For example, if you want to include a Text Entry User Prompt asking users to log in, and then use that text entry as a variable for the Username property for a Scan to Network task, then the Text Entry User Prompt must appear before the Scan to Network task in the workflow. There are two ways to arrange tasks: Plan the flow of actions and prompts in advance, and then add them to the workflow in order (in the Design pane). Click and drag workflow tasks already inside the Design pane to arrange them as needed. Task properties The Task Properties pane is used to configure various attributes for each task you add to a workflow. Configuring task properties may involve filling in a text field, selecting options from a drop down menu, or inserting predefined variables. The Task Properties pane consists of the following data input options: Text boxes Single line text boxes These generally require a small string of text. Specify values in these boxes by clicking anywhere in the text field and typing. Multi line text boxes These allow for longer blocks of text. Specify values in these boxes by clicking the ellipsis button and then typing text in the dialog that appears. Note: Text boxes can also be populated with one or more variables. These variables can be inserted by themselves or embedded within text. For more information about using variables, see the following section. Drop down boxes These contain a set of choices specific to a particular field. Check boxes Select these boxes to enable a specific feature. Clear the boxes to make the feature unavailable. Numerical entry boxes These allow for customized numeric entries. Asterisks indicate required fields. Solutions cannot be deployed until all required fields have been populated. However, you can save solutions without populating all required fields. Using variables Variables can be added to any task property field where text can be typed. Variables represent data that is dynamically updated based on conditions at the time a solution is run. For example, if you select a system variable such as MFP IP Address or Date and Time, then that information will be gathered from the printer when the solution is run. Variables can also come from previously added workflow tasks, such as a User Prompt. For example, if you add a Text Entry User Prompt to the workflow asking users to enter their login credentials, then the response variable from that text entry can be selected as a variable for the Username property in a Scan task. To see the list of variables available for a particular property, click inside the text entry field for that property, and then click { } on the Task Properties toolbar. You can also right click inside the text entry field for the property, and then select Insert Variable. For a complete list of the variables available in Solution Composer, see Variable definitions on page 47.
Building custom solutions 9 Step 1: Creating a new project and adding tasks 1 To create a new project, open Solution Composer, or do one of the following: From the file menu, click File > New. From the toolbar, click. 2 From the Task Library pane, select one of the four task categories, and then double click a task icon, or click and drag it into the Design pane. 3 In the text box beneath the task icon, type a descriptive name for the task (optional). Task names are for user reference only and do not affect the workflow. You can rename a task in the Design pane by double clicking its name and then typing a new name. 4 From the Task Properties pane, configure the properties for the task. To access the properties for a task, select its icon in the Design pane. For a comprehensive list of the properties available for each task, see Appendix on page 24. If you add a new task to the workflow before correctly configuring the required properties of an existing task, then a red exclamation point appears next to the existing task. Mouse over the task icon to show a dialog listing the configuration problems. Deleting tasks from a workflow 1 From the Design pane, select a task. 2 Do one of the following: Right click the task, and then select Delete Task. Select the task, and then press Delete on your keyboard. Step 2: Validating solutions (optional) Solution Composer projects are saved and deployed as solution packages. Validating a solution before saving or deploying it is optional, but can help identify errors that need to be corrected while you are still working on the solution. Solutions are automatically checked for errors when they are deployed. 1 With the project open, from the file menu, click Tools > Validate. Note: You can also click on the toolbar. 2 From the Validation Summary dialog that appears, take note of any errors, and then click Close. 3 Correct the noted errors. 4 Repeat step 1 through step 3 until the Validation Summary reports No Problems Found. Note: All errors must be corrected before a solution can be deployed.
Building custom solutions 10 Step 3: Simulating solutions (optional) Before saving or deploying a solution in Solution Composer, you can use Simulate to check the basic look, flow, and syntax of a project. Simulate can approximate how a solution will look after it has been deployed to a device. It cannot show exactly how the solution will look on a specific device. Make sure all task properties in your solution are configured correctly before you use Simulate. If you do not configure all required task properties or if properties are configured incorrectly, then you will not be able to simulate the solution or parts of the solution. The simulation will stop as soon as Simulate reaches the first task that contains errors. If certain task property values are not available during the simulation, then an Information not currently available message will appear. 1 With the project open, from the file menu, click Tools > Simulate. Note: You can also click on the toolbar. A generic representation of the printer home screen appears, showing only the icon for your solution. 2 Click the icon for the solution. 3 Navigate through the screens by clicking Next, Back, or Home, and by responding to user prompts on the simulated printer touch screen. Use the computer keyboard to type data for prompts that require text input. You can view the settings for the task properties on a particular screen by clicking Show details. In the Details pane, you can expand and collapse the lists of task properties for the screen you are viewing. To close the Details pane, click Hide details. You cannot modify task properties settings from the Details pane. If you want to modify settings, then close the Simulator dialog, and then modify the settings from the Task Properties pane. 4 Click Next on the final screen to return to the home screen. Step 4: Saving projects You can save Solution Composer projects as.lwfs files that can be opened and edited later using Solution Composer. These files represent saved work, not completed solutions, and.lwfs files cannot be deployed to a device. Projects can be saved with or without a password. A generic encryption key is used when saving non password protected projects, but those projects can be opened by any Solution Composer user. To restrict access to a project, save the file using the Save As...With Password option. Saving projects without a password 1 From the file menu, click File > Save. Note: You can also click on the toolbar. 2 Browse to the location where you want to save the file, and then name the file. 3 Click Save.
Building custom solutions 11 Saving projects with a password 1 From the file menu, click File > Save As...With Password. Note: You can also click the arrow next to on the toolbar, and then select Save As...With Password. 2 Browse to the location where you want to save the file, and then name the file. 3 Click Save. 4 Type a password in the dialog, and then click OK. When you attempt to open the file, you will be prompted for this password. Step 5: Deploying solutions You can deploy valid Solution Composer projects two different ways: as a saved deploy file, or directly to devices from Solution Composer: Deploying to a file This is useful if you need to save the solution package to a network location for others to install on multiple devices, or if a network is not available for direct deployment at a particular time, such as when you are working remotely. Deploying directly to a device This lets you deploy directly to a device from within Solution Composer. When deploying directly to a device, you will need the device IP address or host name. If you need to deploy to multiple devices, then you must deploy to each one individually. Deploying solutions to a file Solutions can be saved as.lwfd files that can be installed using the Solution Composer Agent on the device Embedded Web Server or using the Lexmark Virtual Solution Center. 1 With the project open, from the file menu, click Tools > Deploy Solution to File. 2 In the Deploy Solution to File dialog, fill in the following fields: Solution Properties The solution properties define the basic information that will be available about a solution both on the device and from the device Embedded Web Server. Asterisks indicate required fields. Solutions cannot be deployed until all required fields have been populated. Name Type the name that will appear above the solution icon on the printer home screen.
Building custom solutions 12 This name will also be used to represent the solution in the list of Installed Solutions on the device Embedded Web Server. Solutions installed on the same device should each have a unique name. If you install a solution using the Solution Composer Agent on the Embedded Web Server and there is already a solution on the device with the same name, then either the existing installed solution will be overwritten, or the Embedded Web Server will show an error message. If an error message is shown, then uninstall the existing solution before installing the new solution. Version Enter the version number of the solution. Only numbers and periods can be used in the Version field. (Example: 2.0.0) Version numbers cannot start with a period or contain two or more consecutive periods. The version number is used for reference only. An existing version of a solution will be automatically overwritten if another instance is deployed. Image Click Browse to locate the image that will represent the solution on the printer home screen. Use a PNG, GIF, JPG, or BMP file. Images will be automatically resized to fit the icon. Solution Composer will use a default icon for the custom solution if no image is specified. Description Type the description that will appear on the solution Information tab on the device Embedded Web Server. Support Information Because solutions built using Solution Composer may require technical support, the support information must be filled out completely and correctly. Asterisks indicate required fields. Solutions cannot be deployed until all required fields have been populated. Support information can be accessed from the device Embedded Web Server by clicking Applications > Solution Composer > [solution name]. Name Type the name of the company responsible for supporting the solution. Phone Enter the phone number of the company responsible for supporting the solution. Website Type the Web site URL of the company responsible for supporting the solution. Email Type the e mail address of the company responsible for supporting the solution. 3 Click Deploy, and then use the Save dialog to name and save the file to a location of your choice. Note: The Deploy button will not be enabled until all required fields have been populated.
Building custom solutions 13 Deploying solutions directly to a device 1 With the project open, from the file menu, click Tools > Deploy Solution to Device. Note: You can also click on the toolbar. 2 In the Deploy Solution to Device dialog, type the IP address or host name of the destination device in the Device Address field. Note: You can deploy solutions to one device at a time. Multiple devices must be handled separately. 3 Fill in the following fields: Solution Properties The solution properties define the basic information that will be available about a solution both on the device and from the device Embedded Web Server. Asterisks indicate required fields. Solutions cannot be deployed until all required fields have been populated. Name Type the name that will appear above the solution icon on the printer home screen. This name will also be used to represent the solution in the list of Installed Solutions on the device Embedded Web Server. Solutions installed on the same device should each have a unique name. If you deploy a solution directly to a device and there is already a solution on the device with the same name, then the existing installed solution will be overwritten. Version Enter the version number of the solution. Only numbers and periods can be used in the Version field. (Example: 2.0.0) Version numbers cannot start with a period or contain two or more consecutive periods. The version number is used for reference only. An existing version of a solution will be automatically overwritten if another instance is deployed. Image Click Browse to locate the image that will represent the solution on the printer home screen. Use a PNG, GIF, JPG, or BMP file. Images will be automatically resized to fit the icon. Solution Composer will use a default icon for the custom solution if no image is specified. Description Type the description that will appear on the solution Information tab on the device Embedded Web Server. Support Information Because solutions built using Solution Composer may require technical support, the support information must be filled out completely and correctly.
Building custom solutions 14 Asterisks indicate required fields. Solutions cannot be deployed until all required fields have been populated. Support information can be accessed from the device Embedded Web Server by clicking Applications > Solution Composer > [solution name]. Name Type the name of the company responsible for supporting the solution. Phone Enter the phone number of the company responsible for supporting the solution. Website Type the Web site URL of the company responsible for supporting the solution. Email Type the e mail address of the company responsible for supporting the solution. 4 Click Deploy. A status indicator appears, followed by a confirmation message indicating whether the solution deployed successfully. Note: The Deploy button will not be enabled until all required fields have been populated.
Sample solutions 15 Sample solutions The following two scenarios are designed to demonstrate how Solution Composer might be used to build solutions that accomplish real world tasks. For information about specific properties or settings, see Appendix on page 24. Scenario 1: Scanning W 4 forms to a corporate FTP site In this scenario, a simple solution is created that enables franchise retail stores to scan W 4 forms for new employees to a corporate FTP site. The solution first scans both sides of the form into a single file, which is then saved to a location on the corporate FTP site using a specified file name that users cannot change. After the scan is complete, the solution shows a message on the printer touch screen reminding the user to file the W 4 form in the employee's personnel file. For step by step instructions on creating a Solution Composer project, see Building custom solutions on page 7. For a comprehensive list of task properties and variables available in Solution Composer, see Appendix on page 24. Building the solution in Solution Composer 1 To create a new project, open Solution Composer, or do one of the following: From the file menu, click File > New. From the toolbar, click. 2 In the Task Library pane, under User Prompts, double click Message or click and drag it into the Design pane, and then give it a descriptive name, such as Load forms. 3 In the Task Properties pane, click the ellipsis button next to the Message field to open a text entry box. Use the text entry box to instruct users to load the W 4 form onto the scanner glass or into the automatic document feeder. 4 From the Task Library pane, click Scan Actions, double click Scan to FTP or click and drag it into the Design pane below the Message prompt, and then give it a descriptive name, such as Scan document. 5 In the Task Properties pane, do the following: Clear the Prompt at Runtime check box so that users will not be able to change settings when running the solution. Provide the URL and credentials needed to connect to the FTP destination. In the Output section, configure the Scan filename setting: a Type w4_from_mfp_ in the text entry box. b Right click inside the text entry box after the text you entered. c Select Insert Variable to show the Variable Selection dialog.
Sample solutions 16 d In the Variable Selection dialog, click System Variables > MFP IP Address > OK. e In the Scan filename text entry box, type the _ symbol after the MFP IP Address variable. When you are finished, the contents of the text box should look like w4_from_mfp_system Variables.MFP IP Address_. When documents are scanned to the corporate FTP destination using this solution, file names will reflect the IP address of the printer from which they were sent. Verify that Append timestamp is selected to ensure that multiple files sent from the same printer will not be overwritten. The resulting file name will look something like w4_from_mfp_192.168.1.57_2011_06_23_10_33_26_050.pdf. In the Scan Settings (Basic) section, select Duplex in the Original Sides (Duplex) field. 6 From the Task Library pane, click User Prompts, click and drag Message into the Design pane below the Scan to FTP action, and then give it a descriptive name, such as File completed forms. 7 In the Task Properties pane, use the Message field to remind users to file the W 4 form properly after scanning. 8 Check the solution for errors by doing one of the following: From the file menu, click Tools > Validate. From the toolbar, click. 9 Take note of any errors reported in the Validation Summary dialog, correct the errors, and then validate again. 10 After validating, check the overall flow of the solution by doing one of the following: From the file menu, click Tools > Simulate. From the toolbar, click. 11 Do one of the following: Use the Deploy Solution to File option on the Tools menu to set solution properties and support information, save the script, and then send the file to individual stores with instructions for installing the solution on Lexmark devices running the Solution Composer Agent. Use the Deploy Solution to Device option on the Tools menu to set solution properties and support information, and then install the solution on Lexmark devices running the Solution Composer Agent. To deploy directly to devices, you must be on the same network as the target devices, and you will need the IP address or host name of each device. What users see when using the solution 1 From the printer home screen, the user touches the icon for the solution. 2 The printer prompts the user to load the W 4 form onto the scanner glass or into the automatic document feeder. 3 The user loads the document, and then touches Next. 4 The printer shows a message while it scans the document to the appropriate FTP folder. 5 The printer shows the custom message reminding the user to file the W 4 form in the employee's folder. 6 The user touches Next and returns to the printer home screen.
Sample solutions 17 Scenario 2: Scanning HR forms and saving an index file to a network In this scenario, a more complex solution is created that prompts users to select the type of document they want to scan, scans the document to a network location, and then saves an index file to the same location. Such a scenario could be used by the same franchise stores as in the first scenario, only this time they can scan many different types of HR forms to a specified location on the corporate network. This solution will use variables based on user input to populate the index file. For step by step instructions on creating a Solution Composer project, see Building custom solutions on page 7. For a comprehensive list of task properties and variables available in Solution Composer, see Appendix on page 24. Building the solution in Solution Composer 1 Create a new Solution Composer project. 2 In the Task Library pane, under User Prompts, double click Multiple Choice or click and drag it into the Design pane, and then give it a descriptive name, such as Choose document. 3 In the Task Properties pane, do the following: Use the Prompt field to instruct users to select the type of document they want to scan. Click the ellipsis button next to the Choices field to show the Choices dialog. To create document types from which users can select: a In the Choices dialog, click Add. b Type Administration in the Label field. The Value field is automatically populated with this label. c Click Add. d Type Benefits in the Label field of the second entry. e Click Add. f Type Employment Application in the Label field of the third entry. g Verify that the Allow multiple selections check box is cleared. h Click OK to save the list and return to the main window for this task. 4 In the Task Library pane, under User Prompts, double click Message or click and drag it into the Design pane below the Multiple Choice prompt, and then give it a descriptive name, such as Load document. 5 In the Task Properties pane, use the Message field to instruct users to load the document onto the scanner glass or into the automatic document feeder. 6 From the Task Library pane, click Scan Actions, double click Scan to Network or click and drag it into the Design pane below the Message prompt, and then give it a descriptive name, such as Scan document. 7 In the Task Properties pane, do the following: Clear the Prompt at Runtime check box so that users will not be able to change settings when running the solution. Provide the URL and credentials needed to connect to the network destination.
Sample solutions 18 In the Output section, configure the Scan file name setting: a Right click inside the text entry box, and then select Insert Variable to show the Variable Selection dialog. b In the Variable Selection dialog, click Choose document > Selected Text List > OK. c In the Scan file name text entry box, type the _ symbol after the Selected Text List variable. d Right click inside the text entry box at the end of the entry, and then select Insert Variable to show the Variable Selection dialog. e In the Variable Selection dialog, click System Variables > MFP IP Address > OK. When you are finished, the contents of the text box should look like Choose document.selected Text List_System Variables.MFP IP Address. When a document is scanned to the network destination using this solution, the file name will include the type of document scanned (as selected by the user) and the IP address of the printer from which the document was sent. Verify that Append timestamp is selected to ensure that multiple files sent from the same printer will not be overwritten. The resulting filename will look something like Employment Application_192.168.1.57_2011_06_23_10_33_26_050.pdf. In the Scan Settings (Basic) section, select Duplex in the Original Sides (Duplex) field. 8 From the Task Library pane, click Index Files, and then double click Index File to Network or click and drag it into the Design pane below the Scan to Network action. 9 In the Task Properties pane, do the following: Provide the URL and credentials needed to connect to the network destination. In the Output section, configure the Base filename setting: a Right click inside the text entry box, and then select Insert Variable to show the Variable Selection dialog. b In the Variable Selection dialog, click Choose document > Selected Text List > OK. c In the Base filename text entry box, type the _ symbol after the Selected Text List variable. d Right click inside the text entry box at the end of the entry, and then select Insert Variable to show the Variable Selection dialog. e In the Variable Selection dialog, click System Variables > MFP IP Address > OK. f In the Base filename text entry box, type _index after the MFP IP Address variable. When you are finished, the contents of the text box should look like Choose document.selected Text List_System Variables.MFP IP Address_index. When a document is scanned to the network destination using this solution, the file name will include the type of document scanned (as selected by the user) and the IP address of the printer from which the document was sent. Verify that Append timestamp is selected to ensure that multiple files sent from the same printer will not be overwritten. The resulting file name will look something like Employment Application_192.168.1.57_index_2011_06_23_10_33_26_050.txt. Click the ellipsis button next to Content Text to show the Content Text dialog, and then do the following: a On the first line, type Date:. b Right click next to Date:, and then select Insert Variable. In the Variable Selection dialog, click System Variables > Date and Time > OK. c On the second line, type File:. d Right click next to File:, and then select Insert Variable. In the Variable Selection dialog, click Choose document > Selected Text List > OK. e On the third line, type User:. f Right click next to User:, and then select Insert Variable. In the Variable Selection dialog, click Scan document > Username > OK. g Click OK to save your selection. When the index file is created, it will contain the text and variables specified in the Content Text dialog.
Sample solutions 19 10 Check the solution for errors by doing one of the following: From the file menu, click Tools > Validate. From the toolbar, click. 11 Take note of any errors reported in the Validation Summary dialog, correct the errors, and then validate again. 12 After validating, check the overall flow of the solution by doing one of the following: From the file menu, click Tools > Simulate. From the toolbar, click. 13 Do one of the following: Use the Deploy Solution to File option on the Tools menu to set solution properties and support information, save the script, and then send the file to individual stores with instructions for installing the solution on Lexmark devices running the Solution Composer Agent. Use the Deploy Solution to Device option on the Tools menu to set solution properties and support information, and then install the solution on Lexmark devices running the Solution Composer Agent. To deploy directly to devices, you must be on the same network as the target devices, and you will need the IP address or host name of each device. What users see when using the solution 1 From the printer home screen, the user touches the icon for the solution. 2 The printer prompts the user to select the type of HR document they want to scan from a list of choices. The user makes a selection, and then touches Next. 3 The printer prompts the user to load the document onto the scanner glass or into the automatic document feeder. 4 The user loads the document, and then touches Next. 5 The printer shows a message while the scan file is being saved to the network destination. 6 The printer shows a message while the index file is being saved to the network destination. Note: In some cases, the scan or index file is saved to the network destination quickly enough that this message appears briefly or not at all. 7 The solution automatically returns the user to the printer home screen.
Troubleshooting 20 Troubleshooting A solution has been deployed to a device, but it does not appear on the device home screen Try one or more of the following: LICENSE AND RESTART SOLUTION COMPOSER AGENT If one or more solutions were deployed before Solution Composer Agent was licensed on a device, then you will need to restart Solution Composer Agent after licensing to enable the deployed solutions. 1 Obtain the printer IP address: From the printer home screen From the TCP/IP section in the Network/Ports menu By printing a network setup page or menu settings page, and then finding the TCP/IP section Note: An IP address appears as four sets of numbers separated by periods, such as 123.123.123.123. 2 Open a Web browser, and then type the printer IP address in the address field. 3 From the Embedded Web Server, click Settings or Configuration. 4 Click Device Solutions > Solutions (esf), or click Embedded Solutions. 5 Select the Solution Composer Agent check box in the Installed Solutions list. 6 Click Stop. The screen reloads showing Solution Composer Agent in a Stopped state. 7 Select the Solution Composer Agent check box, and then click Start. The screen reloads showing Solution Composer Agent in a Running state. Previously deployed solutions packages now appear on the device home screen. Note: For information about licensing Solution Composer Agent on a device, see Licensing Solution Composer Agent on page 24. REDEPLOY THE SOLUTION The solution may not have installed successfully on the device, and it may need to be redeployed. For instructions on deploying solutions, see Step 5: Deploying solutions on page 11. INSTALL THE SOLUTION FROM THE DEVICE EMBEDDED WEB SERVER If the solution cannot be deployed directly to the device, then try deploying it to a file and then installing it using the Solution Composer Agent application on the device Embedded Web Server. Solution Composer Agent can be deployed to devices from the Lexmark Virtual Solution Center. For information about the Virtual Solution Center, contact your solutions provider.
Troubleshooting 21 To access the Solution Composer Agent solution management page from the Embedded Web Server, click Applications > Solution Composer. The Scan to Email or e mail actions cause the solution to fail MAKE SURE THE E MAIL SETTINGS ARE CONFIGURED CORRECTLY ON THE PRINTER For the e mail tasks in a solution to work properly, the e mail settings on the printer running the solution must be configured correctly. For more information on configuring e mail settings, see the documentation that came with the printer. The Scan to Email task fails to send an e mail CHECK THE REPLY ADDRESS FIELD IN THE PRINTER E MAIL SETTINGS If you selected Use Printer Setting in the From field of the Scan to Email task, then make sure the Reply Address field in the printer e mail settings contains a valid e mail address. 1 Obtain the printer IP address: From the printer home screen From the TCP/IP section in the Network/Ports menu By printing a network setup page or menu settings page, and then finding the TCP/IP section Note: An IP address appears as four sets of numbers separated by periods, such as 123.123.123.123. 2 Open a Web browser, and then type the printer IP address in the address field. 3 From the Embedded Web Server, click Settings or Configuration. 4 Click E mail/ftp Settings > E mail Settings > Setup E mail Server. 5 Make sure the Reply Address field contains a valid e mail address. 6 Click Submit. The Scan to Fax or fax actions cause the solution to fail MAKE SURE THE FAX SETTINGS ARE CONFIGURED CORRECTLY ON THE PRINTER For the fax tasks in a solution to work properly, the fax settings on the printer running the solution must be configured correctly. For more information on configuring fax settings, see the documentation that came with the printer.
Frequently asked questions 22 Frequently asked questions Will solutions built using Solution Composer work on my Lexmark device? Yes, if the device is a multifunction printer running the Solution Composer Agent. Solution Composer Agent must be licensed on the device in order to run solutions. A hard drive must be installed on the device in order to run solutions containing Multi Send tasks. Do solutions built using Solution Composer require certification? No, Solution Composer is designed to produce solutions that can be used immediately, without the need for certification. How do I rename a task in the Design pane? Double click the name of the task beneath the icon, and then type a new name. Will later versions of solutions overwrite earlier ones? Solution Composer does not check the version of previously deployed solutions. If a solution is deployed to a device that is already running another version of that solution, then the version being deployed will replace the existing one. Why aren't the scan settings that I set in the Task Properties working on my device? Scan settings are device and situation specific, so not all scan settings are available on all devices in all situations. If you have selected scan settings in your solution that are not supported by a particular device, then the default scan settings for that device will be used. See the User's Guide that came with the device for a complete list of available scan settings. Do I have to save a project before validating or simulating? No, you can validate or test projects using Simulate before saving or deploying them.
Frequently asked questions 23 Do I have to validate or simulate a project before saving or deploying it? No, you can save or deploy projects without validating or simulating them first, but running one or both of these checks can help ensure you have a working solution before you load it to a device. Note: Solutions are automatically validated as part of the deployment process.
Appendix 24 Appendix Licensing Solution Composer Agent The Solution Composer Agent is offered with a 30 day trial license that allows you to deploy fully functioning solutions built using Solution Composer. To continue using the Solution Composer Agent on your printers after the trial period, you must obtain a full license. For more information about purchasing application licenses, contact your solutions provider. Obtaining a license 1 Obtain the printer IP address: From the printer home screen From the TCP/IP section in the Network/Ports menu By printing a network setup page or menu settings page, and then finding the TCP/IP section Note: An IP address appears as four sets of numbers separated by periods, such as 123.123.123.123. 2 Open a Web browser, and then type the printer IP address in the address field. 3 From the Embedded Web Server, click Settings or Configuration. 4 Click Device Solutions > Solutions (esf), or click Embedded Solutions. 5 Click System. 6 Record the host ID (serial number). Record only the string that appears after Serial=. 7 Contact your solutions provider and provide the host ID to obtain the license file. Installing the license 1 Open a Web browser, and then type the printer IP address in the address field. 2 From the Embedded Web Server, click Settings or Configuration. 3 Click Device Solutions > Solutions (esf), or click Embedded Solutions. 4 Under Installed Solutions, click Solution Composer Agent > License > Update License. 5 Make sure Local is selected, and then browse to locate the license file. 6 Click Update License. Properties for user prompts Multiple Choice properties The following are the settings available for the Multiple Choice prompt. Use Multiple Choice to prompt users to select from a list of options.
Appendix 25 Asterisks indicate required fields. To add a variable to any text field, click the text entry portion of the field, and then click { } on the Task Properties toolbar. You can also right click the text entry portion of the field, and then select Insert Variable. For a comprehensive list of all variables available in Solution Composer, see Variable definitions on page 47. General Prompt Type a prompt that will guide users in making a selection from the list of choices. This appears above the list and gives users context for the choices available in the list. For example, Select a department. Choices Click the ellipsis button next to the field to populate the list of choices that will be available for users to select from. In the Choices dialog, select Allow multiple selections to allow users to select more than one choice from the list. To add a choice to the list: 1 Click Add. A new choice appears in the list. 2 Configure the following fields: Default Select a check box to set a default choice for users. Order This is a numeric value that indicates where a choice will appear in the list. This field cannot be changed. Label Type the choice that users will see and select on the printer touch screen. Note: The text typed in the Label field does not wrap on the printer touch screen. Instead, the size of the text will shrink to fit the touch screen. Value Type the value associated with the user's choice. This is not an option that users will see. By default, the value is the same as the label, and the text you type in the Label field is automatically duplicated in the Value field as you type. You can change the value so that it can be used in a Selected Value List variable in another task. The Selected Value List variable will contain the value associated with the choice the user selected. For example, a company might have users who need to scan different types of documents and have them routed to a particular department based on the document type. In this scenario, you could type a department name in the Label field (for example, Human Resources), and then type the e mail address of a person in the department in the Value field. The e mail address would be included in the Selected Value List variable. The Selected Value List variable could then be used in a Scan to Email task to e mail scanned documents to the appropriate department based on the user s selection. That scenario might look something like this: a A user has an employment application that needs to be scanned and sent to Human Resources. b The user touches the icon for the solution and is prompted to select a department from a list of choices.
Appendix 26 c d 3 Click OK. The user chooses Human Resources from the list. If the Value field for the Human Resources label is populated with the e mail address of a person in Human Resources, then you can insert a Selected Value List variable in the To field of a Scan to Email task. The variable will contain the e mail address specified in the Value field, and the Scan to Email task will send the scanned document to this address. The Selected Value List variable can be found under the Multiple Choice prompt heading in the Variable Selection dialog for the Scan to Email To field. The user scans the employment application, and it is automatically routed to the appropriate person in Human Resources. Note: If users are allowed to select multiple choices, then the Selected Value List variable will contain all e mail addresses associated with the user s choices. Make sure the Selected value separator property for your Multiple Choice prompt is set to either Comma or Semicolon. This enables the list of e mail addresses to be processed correctly in a Scan to Email task. To delete a choice from the list: 1 Click the ellipsis button next to the Choices field. 2 Select a choice from the list. 3 Click Delete > OK. Selection Required Select this option to require users to make a selection before proceeding to the next task. Help Text Click the ellipsis button next to the field to type help text that will be available to users when they touch the question mark icon in the lower left corner of the printer touch screen. Note: The question mark icon appears only if you specify text in this field. Miscellaneous Selected value separator If the prompt is configured to allow multiple selections, then click the ellipsis button next to the field to choose how to separate the list of selections (comma, colon, semicolon, or custom) when the list is used in a variable. This is used with the Selected Text List, Selected Value List, and Selected Index List variables. If the Selected Value List variable contains multiple e mail addresses, then select Comma or Semicolon. This enables the list of e mail addresses to be processed correctly in a Scan to Email task. If the Selected Value List variable contains multiple fax numbers, then select Semicolon. Numeric Entry properties The following are the settings available for the Numeric Entry prompt. Use Numeric Entry to prompt users to enter a numerical value, such as a PIN. To add a variable to any text field, click the text entry portion of the field, and then click { } on the Task Properties toolbar. You can also right click the text entry portion of the field, and then select Insert Variable. For a comprehensive list of all variables available in Solution Composer, see Variable definitions on page 47. Where applicable, click Use Printer Setting to access the available choices for a setting or to type text for a setting. You can return to the default setting for the printer by clicking the setting value you entered, and then clicking on the Task Properties toolbar. You can also right-click the setting value you entered, and then select Use Printer Setting.