The following lets you navigate and use DDU:
Section |
Home screen tabs |
Description |
---|---|---|
1 |
Add New |
Lets you create workflows. A workflow is a set of tasks that are performed on printers. Note: For information on creating workflows, see Creating deployment workflows . |
2 |
Browse |
Lets you browse workflows. |
3 |
Create CSV File |
Lets you discover printers, and then create .csv files for deploying workflows and creating packages from the Package Builder utility. Note: To obtain the eSF application and license packages from the Package Builder utility, go to https://cdp.lemark.com/package-builder/ . |
4 |
Export Device Data |
Lets you discover printers, and then export its certificate signing request (CSR), all device settings, shortcuts, logs, and reports information. |
5 |
Workflow panel |
Shows the list of created workflows. You can run, edit, or delete workflows from this panel. |
6 |
Deployment Name |
The name of the workflow. |
7 |
Deployment Description |
The description of the workflow. Note: This field is optional. |
Section |
Workflow tabs |
Description |
---|---|---|
1 |
Add Package |
Lets you add a custom package or a package from the Package Builder utility. Note: For more information, see Adding packages . |
2 |
Add Settings Files(.ucf) |
Lets you add .ucf settings files for deployment. When adding printer settings files, make sure that the printer is running on eSF version 4 or earlier. You can add eSF settings files to any supported printer model. Notes:
|
3 |
Add Certificates |
Lets you add printer certificates for deployment. Note: For more information, see Adding certificates . |
4 |
Add Configuration Files(.zip) |
Lets you add .zip configuration files for deployment to printers running on eSF version 4 or later. The configuration files can contain printer settings or eSF settings. Notes:
|
5 |
Add NPA files(*.npa) |
Lets you add .npa command files for deployment. Note: For more information, see Adding npa files (.npa) . |
6 |
Add License |
Lets you add printer licenses for deployment. Note: For more information, see Adding licenses . |
7 |
Add Firmware or Flash file(*.fls) |
Lets you add the following for deployment:
Note: For more information, see Adding a firmware or flash file . |
8 |
Add Task |
Lets you add the following tasks for deployment:
Note: For more information, see Adding tasks . |
9 |
Workflow panel |
Shows the list of created workflows. |
10 |
Deployment Name |
The name of the workflow. |
11 |
Deployment Description |
The description of the workflow. Note: This field is optional. |
12 |
Devices |
The printers added for the workflow. |
13 |
Edit Device List |
Lets you edit the printers added for the workflow. Note: For more information, see Adding printers . |
14 |
Advanced Settings |
Lets you configure the deployment and discovery settings. Note: For more information, see Configuring deployment and discovery settings using DDU . |
From DDU, click Add New .
Type the deployment name and description.
Click Edit Device List .
Do either of the following:
Select Add a device .
In the "Add a device" field, type the IP addresses or host names of the devices, and then click
.
Use the following formats to add IP addresses:
(wildcards for only the last two octets)
(single IP address)
(IP address range)
(host name)
(single full IPv6 address; wildcards are not supported)
Select CSV File .
Browse to the CSV input file.
If necessary, select Secured Device to prompt the user to type the authentication credentials used to access secured devices when deploying the workflow.
Click OK .
After a printer is added, DDU checks if the printer is online. If it is not, then a
error message appears.From DDU, do either of the following:
Click Add New > Add Package .
Click Add Package .
Select Package Builders Package or Custom Package .
If Package Builder Package is selected, then do the following:
Create a PkgBldrInput.csv file. For more information, see Creating CSV files .
Access the Package Builder application.
From the application, upload the PkgBldrInput.csv file.
Specify the location of the package file.
Click OK .
From DDU, do either of the following:
Click Add New > Add Settings Files(.ucf) .
Click Add Settings Files(.ucf) .
Select either of the following:
Settings file
Settings file (Scan to Network) —Add a settings file for Scan to Network.
Select either of the following:
Standard UCF File —Deploy a settings file with the same settings to printers.
Variable UCF File —Deploy a settings file with different settings to printers.
Do either of the following:
If Standard UCF File is selected, then in the Settings File field, specify the location of the updated settings file.
If Variable UCF File is selected, then do the following:
If you have already created the variable settings file based on the template manually, then in the Settings File field, specify its location. If you do not have a variable settings file, then click Create Template File to create the file using DDU.
If you have already created the lookup .csv file with different values for the variable setting names based on the template, then in the Lookup File field, specify its location. If you do not have a lookup .csv file, then click Create Lookup CSV File to create the file using DDU.
Notes:
Click OK .
Printer certificates are unique identifiers that are used to authenticate the following:
HTTPS
SSL
TLS
IPSec
802.11 connections
From DDU, do either of the following:
Click Add New > Add Certificates .
Click Add Certificates .
Do either of the following:
Click Add CA Certificate .
Specify the location of the certificate.
Click Add Signed Device Certificate .
Specify the directory of the signed certificate.
Click Add PKCS Certificate .
Specify the location of the certificate.
Type a friendly name for the certificate.
Type the password for the PKCS file.
Notes:
Click OK .
From DDU, do either of the following:
Click Add New > Add Configuration Files(.zip) .
Click Add Configuration Files(.zip) .
Select either of the following:
Standard Configuration File —Deploy a configuration file with the same settings to printers.
Variable Configuration File —Deploy a configuration file with different settings to printers.
Do either of the following:
If Standard Configuration File is selected, then in the Configuration File field, specify the location of the updated configuration file.
If Variable Configuration File is selected, then do the following:
If you have already created the variable settings file based on the template manually, then in the Settings File field, specify its location. If you do not have a variable settings file, then click Create Template File to create the file using DDU.
If you have already created the lookup .csv file with different values for the variable setting names based on the template, then in the Lookup File field, specify its location. If you do not have a lookup .csv file, then click Create Lookup CSV File to create the file using DDU.
Notes:
Click OK .
From DDU, do either of the following:
Click Add New > Add NPA Files(.npa) .
Click Add NPA Files(.npa) .
Do either of the following:
Click Select NPA File (*.npa) .
Specify the location of the file.
Select the NPA Port.
Click OK .
This feature lets you add licenses for eSF applications.
From DDU, do either of the following:
Click Add New > Add License .
Click Add License .
Select the license type.
Notes:
Specify the location of the license file.
Click OK .
Use this feature when deploying firmware files, application flash files, or engine codes and scanner codes.
From DDU, do either of the following:
Click Add New > Add Firmware or Flash Files(*.fls) .
Click Add Firmware or Flash Files(*.fls) .
Specify the location of the flash file.
Select one of the following:
Firmware File —Deploy a firmware flash file.
Notes:
Application file —Deploy application .fls files.
Others —Deploy engine codes, scanner codes, or other flash files. The Others option does not validate the flash file.
Click OK .
This feature lets you add multiple tasks to a workflow.
From DDU, do either of the following:
Click Add New > Add Task .
Click Add Task .
Do any of the following:
Select a task.
In the Application Id/Name menu, select an application.
If the application is not on the list, then do either of the following:
Using a text editor, open the app-id-version.txt file.
Type
, where is the friendly name, is the application ID, and are application versions separated by a comma.Save the file.
Notes:
In the Application Id/Name menu, type the application ID.
If necessary, in the Version menu, select or type the version of the application that you selected.
Click OK .
Select Reboot printer .
Select Remove Held Jobs .
Note: The Remove Held Jobs option is applicable to printers running on eSF version 4 or earlier.
Select Add Delay .
Specify the interval in milliseconds.
Select Update Device Certificate .
Select Delete Device Certificate .
Click OK .
Type the deployment name and description.
Click Save .
Notes:
A variable configuration file contains the variable setting names based on the template of the original settings file or configuration file.
From DDU, add a settings file or a configuration file.
Select Variable UCF File or Variable Configuration File .
Click Create Template File .
In the Base UCF Path or Base VCC Path field, specify the location of the settings file or configuration file of the standard configuration file.
Click
.
On the left panel, select a file, and then click >> . The properties and values of all settings available in the file are shown in the right panel.
In the right panel, select the settings. Selecting a setting updates its current value to a variable,
, where is the name of the setting. For example, if you selected WS_SCAN_ENABLED , then the automatically generated variable is .Notes:
If necessary, repeat steps 6 and 7 to select multiple files.
Select either of the following:
Save All Settings —Create a variable configuration file that contains all the settings.
Save Changes Only —Create a variable configuration file that contains only the settings that you have updated. For example, if you have updated only two settings, then only those settings are included in the configuration file. Other settings are not copied.
If necessary, specify the location where you want to save the new variable configuration file in Out Directory.
Notes:
Click Save .
A .csv file contains different values for the variable setting names based on the template.
Notes:
From DDU, add a settings file or a configuration file.
Select Variable UCF File or Variable Configuration File .
In the Settings File or Configuration File field, specify the location of the variable configuration file or create a template.
Click Create Lookup CSV File .
Depending on the identifier used when adding a printer, select either IP Address Header or Host Name Header .
Notes:
In the list, double-click on the fields to specify the values of the variable name for each printer.
If necessary, specify the location where you want to save the lookup .csv file in Out Directory.
Notes:
Click Save .
nvOemMfgLongName "Lexmark International" HTTPSENABLE TRUE LPDTIMEOUT 90 printTimeout "90"
nvOemMfgLongName $(variable_1) HTTPSENABLE $(variable_2) LPDTIMEOUT $(variable_3) printTimeout $(variable_4)
The lookup file contains the values of the variable names in the configuration file. These values are deployed to printers that are specified in the lookup file.
The file contains the values for each variable defined in the variable configuration file. These values are deployed to the printers defined in the lookup file.
The following lookup file deploys the configuration file to three printers and retains the current value of
for the third printer:IP_ADDRESS,variable_1,variable_2,variable_3,variable_4 192.168.1.1,"abc International",TRUE,60,"80" 192.168.1.2,"xyz International",FALSE,70,"60" 192.168.1.5,"mno International",FALSE,50,CUR_VAL
The first row contains the headers of the lookup file and the variable names defined in the variable configuration file. Use the same identifier when adding a printer. For example, if you used the printer IP address when adding a printer, then use the same when creating a lookup .csv file.
The succeeding rows are the printers where you want to deploy the configuration file and the values for each variable.
Notes:
A variable file contains the variable setting names based on the template of the original settings file or configuration file.
Using a text editor, open the .ucf file.
From the setting that you want to have a variable value, change its value to
, where is a unique variable name.Save the file.
Notes:
nvOemMfgLongName "Lexmark International" HTTPSENABLE TRUE LPDTIMEOUT 90 printTimeout "90"
nvOemMfgLongName $(variable_1) HTTPSENABLE $(variable_2) LPDTIMEOUT $(variable_3) printTimeout $(variable_4)
Extract the .xml or .ucf files in the bundle that you want to have variable settings.
Using a text editor, open the .xml or .ucf files.
From the setting that you want to have a variable value, change the value to
, where is a unique variable name.Save the file.
Compress the updated .xml or .ucf files in another bundle.
Notes:
The following are updated configuration files in a VCC configuration file bundle:
<?xml version="1.0" encoding="UTF-8"?> <bundle> <bundleInfo> <name> Exported Bundle </name> <description> Settings exported on Mon May 30 02:54:47 2016 : FW version 201604071044</description> </bundleInfo> <vcc:esfSettings xmlns:vcc="vcc"> <esfSetting src="esf_settings.xml" /> </vcc:esfSettings> ... <deviceSettings> <setting name="nvVNCEnabled">Off</setting> <setting name="mfp.general.settingsTimeout">${variable_1}</setting> <setting name="pcl.A4Width">198 mm</setting> <setting name="network.IPV6DHCPENABLE">${variable_2}</setting> <setting name="rgbColorReplace2.outputR">${variable_3}</setting> </deviceSettings> </bundle>
A .csv file contains different values for the variable setting names based on the template.
Using a spreadsheet, in the first row, type the headers.
Depending on the identifier used when adding a printer, use either HOSTNAME or IP_ADDRESS as the printer identifier.
Notes:
In the succeeding rows, type the printer host names or IP addresses, and the values of each variable for each printer.
IP_ADDRESS,variable_1,variable_2,variable_3,variable_4 192.168.1.1,"abc International",TRUE,60,"80" 192.168.1.2,"xyz International",FALSE,70,"60" 192.168.1.5,"mno International",FALSE,50,CUR_VAL
Notes:
Save the file.
Make sure that the values of the variable names are the same as the values in the original .ucf or .xml configuration files.
If the value of a setting contains a back slash, then type another back slash before the first. For example, if the value is
, then enter .Updating the new CSV file using a UTF text editor may result in an error.
Notes:
A CSV file is used for deploying and creating packages. It contains the details of the supported printers on the network.
From DDU, click Create CSV File .
In the IP/Hostname field, type the IP address or host name of the devices, and then click
.
Use the following formats to add IP addresses:
(wildcards for only the last two octets)
(single IP address)
(IP address range)
(host name)
(single full IPv6 address; wildcards are not supported)
If necessary, do the following:
To change the destination of the created CSV files, click Out Directory .
To configure device discovery settings, click Advanced Settings .
Click Discover .
The following files are created in Out Directory:
PkgBldrInput.csv —You can directly import this file to Package Builder for creating packages.
DduInput.csv —You can use this file in DDU for deployment.
Notes:
This feature lets you discover printers, and then export their certificate signing requests (CSR), all device settings, shortcuts, logs, and reports information.
From DDU, click Export Device Data .
Do any of the following:
Click Export Device CSR .
Add printers. For more information, see Adding printers .
From the Export Device CSR dialog, review the default path where the exported certificate files are stored.
Click Export .
Click Export All Device Settings .
Add printers. For more information, see Adding printers .
From the Export All Device Settings dialog, review the default path where the exported files are stored in .zip format.
Click Export .
Click Export Device Shortcuts .
Add printers. For more information, see Adding printers .
From the Export Device Shortcuts dialog, review the default path where the exported files are stored in .zip format.
Click Export .
Click Export All Device Reports .
Add printers. For more information, see Adding printers .
From the Export All Device Reports dialog, review the default path where the exported files are stored in .zip format.
Click Export .
Click Export Logs .
Add printers. For more information, see Adding printers .
From the Export Logs dialog, review the default path where the exported files are stored in .zip format.
Click Export .
From DDU, select a deployment workflow.
Click Edit .
Configure the items.
If necessary, click
to configure the deployment workflow settings.
Click Save .
Do either of the following:
To update the package, click Overwrite workflow .
To create another package, click Save as new workflow .
From DDU, select a deployment workflow.
Click
.
You can add printers without editing the deployment workflow. Printers added using this process do not overwrite the printers added when creating a workflow.
From the home screen, click
beside the deployment workflow.
Add printers. For more information, see Adding printers .
Notes:
From DDU, select a deployment workflow.
Click
.
If you are deploying a workflow on secured devices, then do the following:
Select the authentication method used to access the secured printer.
Basic Authentication —Use a user name, user name and password, or PIN when accessing the printer.
Kerberos
LDAP
LDAP + GSSAPI
Type your authentication credentials.
Click OK .
Notes:
Before you deploy to secured printers, make sure that the Firmware Updates access control is enabled. Do the following:
Access the Embedded Web Server.
Obtain the printer IP address. Do either of the following:
Locate the IP address on the printer home screen.
View the IP address in the Network Overview section or in the TCP/IP section of the Network/Ports menu.
Open a web browser, and then type the printer IP address.
From the Embedded Web Server, depending on your printer model, do either of the following:
For eSF version 5:
Click Settings > Security > Manage Groups/Permission > Edit Group > Access Controls > Device Management .
Select Firmware Updates .
Click Save .
For eSF version 4 or earlier:
Click Settings > Security > Security Setup > Access Controls > Management .
Set Firmware Updates to No Security .
Click Submit .
The status panel contains the following messaging structures:
ALL —Shows the following:
IP addresses and their executed tasks
Summary overview of the executed tasks
Failed tasks and error messages
Communication Errors —Shows the IP addresses with failed discovery tasks and their error messages.
Deployment Errors —Shows the IP addresses with failed deployment tasks and their error messages.
Successful Deployments —Shows the IP addresses with all successful tasks.
To change the default workflow logging settings, in the Advanced dialog, from the Logs section, configure either of the following:
Clear Logs Interval (Days) —Specify the number of days before logs that are older than the specified value are removed.
Notes:
Automatically Export Deployment Log —If set to
, then logs are automatically exported after the deployment of a workflow. If set to , then the status panel shows an option to export the deployment log.The workflow deployment logs are located in the % DDUAppFolder %\bin\logs folder, where DDUAppFolder is the location of the DDU folder.
where:
DeploymentLog is the name of the deployment log.
TIMESTAMP is the log time.
The workflow deployment logs (.csv) contain any of the following:
Successful deployments
Communication errors
Deployment errors
DDU uses the Apache Log4j TM software API to create the application and deployment logs. The configuration file for the logs can be found in DDUAppFolder \config\log4j-config.xml , where DDUAppFolder is the location of the DDU folder. For more information, see Configuring log settings .
By default, the log files are saved in the folder for the DDU executable files.
DDU creates the following logs:
Application log (ddu.log) —If set to DEBUG , then this log file helps developers track each request and response between the device and the computer. Threads of requests and responses are classified according to device IP addresses.
Deployment log —This log file helps users view device details and status of solutions and licenses being installed. The file also provides a message to confirm that deployment is successful. For easier sorting of device status, the log file is created in CSV format, with the IP address of the device as the first column.
Open the deployment.csv file. The log file can be found in DDUAppFolder \bin\log , where DDUAppFolder is the location of the DDU folder.
Filter the log file for errors.