Understanding the configuration file

The Local Printer Management Agent installer uses a configuration file (LTConfiguration.ini for Windows and llt.conf for Mac) to set up the service for the environment. Before installing the Local Printer Management Agent, make sure to update the configuration file with the appropriate settings.

For Windows

You can create the configuration file using the configuration tool (LTConfigUI.exe), which provides a GUI for configuring the Local Printer Management Agent settings.

[CLIENT_VERSION] section

Key

Values

VERSION

The version of the installation file. This value is provided by the system and must not be modified.


[INVENTORY REPORT] section

Key

Values

RUN

Set the value to ENABLED to run inventory reporting at the scheduled interval.

TASK_RUN_TIME

Set the schedule for running inventory reports.

Note: If the key requires an interval value, then the value must be greater than or equal to 60. For more information, see Valid interval values.

RUN_ON_STARTUP

Set the value to ENABLED to run inventory reporting when Local Tracker starts, in addition to scheduled inventory reporting.

ALERTS_TRIGGER_ON_DEMAND_REPORT

Set the value to ENABLED to send an inventory report when an alert occurs.


[JOB_REPORT] section

Key

Values

RUN

Set the value to ENABLED to run job metrics reporting.

INCLUDE_DOCUMENT_INFORMATION

If the value is DISABLED, then the name of the printer document is not included in job reports.

INCLUDE_USER_INFORMATION

If the value is DISABLED, then the user information is not included in job reports.

INCLUDE_NETWORK_PRINTERS

If the value is DISABLED, then the printing activity of network printers is not monitored.

INCLUDE_LOCAL_PRINTERS

If the value is DISABLED, then the printing activity of local printers (USB or DOT4) is not monitored.


[SERVER] section

Key

Values

BLACKOUT_TIME

The time of day when communication with the Fleet Tracker server is not allowed. This value is used together with [SERVER] BLACKOUT_DAYS. Use the format HHMM-HHMM, where HHMM is the 24-hour time format for the start and end of the blackout period.

For example, if the value is 1200-1400, then the blackout time starts at 12:00 p.m. and ends at 2:00 p.m. You can also set the value to DISABLED.

BLACKOUT_DAYS

The days of the week when communication with the Fleet Tracker servers is not allowed. This value can be used together with [SERVER] BLACKOUT_TIME. Use the numeric value that represents the day of the week, separated by commas.

For example, if the value is 1,3,5,7, then the blackout days are Sunday, Tuesday, Thursday, and Saturday. You can also set the value to DISABLED.

CS_COST_CENTER

The cost center associated with the user for the job.

CS_COMPANY_ID

A unique company ID.

CS_COMPANY_NAME

The company name.

PORT

The IP port number used for server communication.

  • 80—Use for nonsecure server communication.

  • 443—Use for secure server communication.

SECURE_CONNECTION

Set the value to ENABLED to secure the server communication. This value is used together with [SERVER] PORT.

TIMEOUT

The number of seconds that the Local Printer Management Agent waits for the Fleet Tracker server to respond.

SERVER_ADDRESS_CHANGE_PORT

A Local Tracker (UDP) port number that listens for server-generated “my address changed” packets.

The default value is 2723.

CS_SERVER_ADDRESS

The IP address of the server.

CS_JOB_REPORT_URI

The URI that handles the job reports.

CS_INVENTORY_REPORT_URI

The URI that handles the inventory reports.

CS_CONFIGURATION_URI

The URI that handles the configuration updates.

CS_SOFTWARE_UPDATE_URI

The URI that handles the software updates.


[REMOTE_CONFIGURATION] section

Key

Values

TASK_RUN_TIME

If the value is DISABLED, then the Local Tracker does not retrieve the configuration from the Fleet Tracker server. If the value contains a valid interval, then the Local Tracker retrieves the configuration from the Fleet Tracker server on the specified schedule. For more information, see Valid interval values.

RUN_ON_STARTUP

If the value is ENABLED, then the Local Tracker retrieves the configuration from the Fleet Tracker server when the Local Tracker starts.


[REMOTE_UPDATE] section

Key

Values

TASK_RUN_TIME

If the value is DISABLED, then the Local Tracker does not check for software updates on the Fleet Tracker server. If the value contains a valid interval, then the Local Tracker checks for a newer version of Local Printer Management Agent on the Fleet Tracker server. For more information, see Valid interval values.

RUN_ON_STARTUP

If the value is ENABLED, then the Local Tracker checks for a newer version of Local Printer Management Agent on the Fleet Tracker server when the Local Tracker starts. If a newer version is found, then it is downloaded from the Fleet Tracker server and installed on the Local Printer Management Agent client.


[SNMP] section

Key

Values

CS_COMMUNITY_NAME

The community name used in SNMP communications. For more information, see SNMP settings.

PORT

The port name used in SNMP communications. For more information, see SNMP settings.


[ALERT_POLLING] section

Key

Values

INTERVAL_MINUTES

Set the number of minutes before another polling event occurs.

Note: The task is disabled if you set it to an invalid value, such as a negative number, a zero, or a string. A warning for the invalid entry appears in the log.

TIMEOUT_SECONDS

Set the number of seconds before the alert status times out.


[PRIVACY_CONFIGURATION] section

Key

Values

PROTECT_SENSITIVE_INFO

If the value is ENABLED, then confidential information is not sent to the Fleet Tracker. Confidential printer information are the IP address, MAC address, and DNS host name. Confidential print job information are the document information and user ID.


Sample configuration file

[CLIENT_VERSION]
VERSION=1.0.0.1

[SERVER]
CS_COST_CENTER=Site Location
CS_COMPANY_NAME=My Company
CS_COMPANY_ID=My Company
CS_SERVER_ADDRESS=<ENTER_SERVER_ADDRESS_HERE>
PORT=443
SECURE_CONNECTION=ENABLED
TIMEOUT=30
BLACKOUT_DAYS=DISABLED
BLACKOUT_TIME=DISABLED
SERVER_ADDRESS_CHANGE_PORT=2723
CS_JOB_REPORT_URI=/jobs/v3/metrics
CS_INVENTORY_REPORT_URI=/inventory/v3/metrics
CS_CONFIGURATION_URI=/config/v2/win
CS_SOFTWARE_UPDATE_URI=/update/v2/

[JOB_REPORT]
RUN=DISABLED
INCLUDE_USER_INFORMATION=DISABLED
INCLUDE_DOCUMENT_INFORMATION=ENABLED
INCLUDE_NETWORK_PRINTERS=DISABLED
INCLUDE_LOCAL_PRINTERS=ENABLED
TASK_RUN_TIME=DAYS:1,2,3,4,5,6,7:START:0000:END:2359:INTERVAL:120
RUN_ON_STARTUP=DISABLED

[INVENTORY_REPORT]
ALERTS_TRIGGER_ON_DEMAND_REPORT=DISABLED
RUN=ENABLED
TASK_RUN_TIME=DAYS:1,2,3,4,5,6,7:START:0000:END:2359:INTERVAL:180
RUN_ON_STARTUP=ENABLED

[SNMP]
CS_COMMUNITY_NAME=
PORT=

[REMOTE_UPDATE]
TASK_RUN_TIME=DAYS:1,2,3,4,5,6,7:START:0000:END:2359:INTERVAL:1440
RUN_ON_STARTUP=ENABLED

[REMOTE_CONFIGURATION]
TASK_RUN_TIME=DAYS:1,2,3,4,5,6,7:START:0000:END:2359:INTERVAL:720
RUN_ON_STARTUP=ENABLED

[ALERT_POLLING]
INTERVAL_MINUTES=DISABLED	
TIMEOUT_SECONDS=5

[PRIVACY_CONFIGURATION]
PROTECT_SENSITIVE_INFO=DISABLED
Using LPMA Aggregator

The LPMA Aggregator feature of the Fleet Tracker server lets you create a single point of secure communication to the server for all Local Printer Management Agents using the Lexmark Remote Asset Manager. Update the configuration file with the Lexmark Remote Asset Manager information to roll up data to the Lexmark Remote Asset Manager.

[SERVER]
CS_SERVER_ADDRESS=<ENTER_LEXMARK_REMOTE_ASSET_MANAGER_SERVER_ADDRESS>
PORT=<ENTER_HTTP_PORT_OF_LEXMARK_REMOTE_ASSET_MANAGER_SERVER>
SECURE_CONNECTION=DISABLED

Notes:

For Macintosh

You can create the configuration file on a Windows computer using the configuration tool and transfer it to the Macintosh computer. You can also update the configuration file manually using a text editor.

[APPLICATION] section

Key

Values

VERSION

The version of the installation file. This value is provided by the system and must not be modified.

JobAgentID

A unique identifier for the application that collects direct-print data. It lets the server know which application submitted the jobs.

For example, LPMA-Mac.


[SERVER] section

Key

Values

IPAddress

The IP address of the server.

Port

The IP port number used for server communication.

  • 80—Use for nonsecure server communication.

  • 443—Use for secure server communication.

BroadcastPort

A Local Tracker (UDP) port number that listens for server-generated "my address changed" packets.

The default value is 2723.

SecureConnection

A flag that indicates the server connection type to use.

Set this value to true to use SSL connection. Set this value to false to use non-SSL connection.

The default value is true.

JobMetricURI

The URI that handles the job reports.

InventoryMetricURI

The URI that handles the inventory reports.

ClientUpdateURI

The URI that handles the client application updates.

ConfigUpdateURI

The URI that handles the configuration updates.


[SSL] section

Key

Values

CertificateFile

The file name of the certificate.

Set the certificate file permission to 755 and the certificate file owner to root:wheel.

Note: The server cannot configure this item.

CertificatePath

The path where the certificate is located.

SSLVerifyHost

A flag that indicates whether LPMA-Mac must verify the server host name.

Set the value to Yes or No.

SSLVerifyPeer

The flag identifier that determines if LPMA-Mac enables the server-certificate verification when using SSL connection.

Set the value to Yes or No.


[JOB_REPORTING] section

Key

Values

Enabled

Set the value to either of the following:

  • true—Job Data Post Submission messages can be generated depending on the values of the TrackLocalPrinters and TrackNetworkPrinters.

  • false—No Job Data Post Submission messages are generated.

TrackUserName

Set the value to either of the following:

  • true—The user name is included in Job Data Post Submission.

  • false—The user name is not included in Job Data Post Submission.

TrackDocumentName

Set the value to either of the following:

  • true—The application name, document name, and print job application name are included in Job Data Post Submission.

  • false—The application name, document name, and print job application name are not included in Job Data Post Submission.

TrackLocalPrinters

Set the value to either of the following:

  • true—Job Data Post Submission messages are generated when print jobs are sent to local printer queues.

  • false—No Job Data Post Submission messages are generated when print jobs are sent to local printer queues.

TrackNetworkPrinters

Set the value to either of the following:

  • true—Job Data Post Submission messages are generated when print jobs are sent to network printer queues.

  • false—No Job Data Post Submission messages are generated when print jobs are sent to network printer queues.

The default value is true.


[COMPANY] section

Key

Values

CompanyIDName

A unique company ID.

CompanyName

The company name.


[COSTCENTER] section

Key

Values

CostCenterIDName

The cost center associated with the user for the job.


[INVENTORY_REPORT] section

Key

Values

Enabled

Set the value to either of the following:

  • true—Inventory Data Post Submission messages are generated.

    Note: Make sure that valid values are set for the INVENTORY_REPORT keys.

  • false—No Inventory Data Post Submission messages generated.

The default value is true.

Days

The days of the week when Inventory Data Post Submission is sent to the server.

The valid range is 1 through 7, where 1 is Sunday and 7 is Saturday. Use commas to separate multiple days. For example, 1,3,5.

The default value is 1,2,3,4,5,6,7.

StartTime

The start of the time when Inventory Data Post Submission is sent to the server.

Use the hhmm format, where hh is hours, and mm is minutes. StartTime must be less than EndTime.

The default value is 0800.

EndTime

The end of the time when Inventory Data Post Submission is sent to the server.

Use the hhmm format, where hh is hours, and mm is minutes. EndTime must be greater than StartTime.

The default value is 1800.

ReportInterval

The time interval between the collection of the inventory report and the sending of the report to the server.

The value can be a number in minutes. For example, ReportInterval=1, where 1 is 1 minute. You can also set the value to HOURLY or DAILY.

The default value is HOURLY.


[BLACKOUT_PERIOD] section

Key

Values

Enabled

Set the value to either of the following:

  • true—Enable the Blackout Period functionality.

    Note: Make sure that valid values are set for the BLACKOUT_PERIOD keys.

  • false—Disable the Blackout Period functionality.

The default value is false.

BlackOutDays

The days of the week when no reports are sent to the server.

The valid range is 1 through 7, where 1 is Sunday and 7 is Saturday. Use commas to separate multiple days. For example, 1,3,5.

The default value is 1,3,5.

BlackOutStartTime

The start of the time when no reports are sent to the server.

Use the hhmm format, where hh is hours, and mm is minutes. BlackOutStartTime must be less than BlackOutEndTime.

The default value is 1045.

BlackOutEndTime

The end of the time when no reports are sent to the server.

Use the hhmm format, where hh is hours, and mm is minutes. BlackOutEndTime must be greater than BlackOutStartTime.

The default value is 1055.


[SOFTWARE_UPDATE] section

Key

Values

Enabled

Set the value to either of the following:

  • true—Enable software update.

    Note: Make sure that valid values are set for the SOFTWARE_UPDATE keys.

  • false—Disable software update.

The default value is true.

UpdateCheckTime

The server checks for updates at a specified time interval or schedule. For more information on the valid values, see Valid interval values.

The default value is DAILY:2300.

UpdateCheckDays

The server checks for updates on one or more days of the week.

The valid range is 1 through 7, where 1 is Sunday and 7 is Saturday. Use commas to separate multiple days. For example, 1,3,5. If there is no value, then Local Printer Management Agent does not check for updates.

Note: The value supersedes the DAILY value in UpdateCheckTime. For example, if UpdateCheckTime is set to DAILY:1030 and UpdateCheckDays is set to 1, then the checking of updates runs only on Mondays at 10:30 a.m.

The default value is 1,2,3,4,5,6,7.


[CONFIG_UPDATE] section

Key

Values

Enabled

Set the value to either of the following:

  • true—Enable configuration update.

    Note: Make sure that valid values are set for the CONFIG_UPDATE keys.

  • false—Disable configuration update.

The default value is true.

UpdateCheckTime

The server checks for updates at a specified time interval or schedule. For more information on the valid values, see Valid interval values.

The default value is INTERVAL:05.

UpdateCheckDays

The server checks for updates on one or more days of the week.

The valid range is 1 through 7, where 1 is Sunday and 7 is Saturday. Use commas to separate multiple days. For example, 1,3,5. If no value is indicated, then Local Printer Management Agent does not check for updates.

Note: The value supersedes the DAILY value in UpdateCheckTime. For example, if UpdateCheckTime is set to DAILY:1030 and UpdateCheckDays is set to 1, then the checking of updates runs only on Mondays at 10:30 a.m.

The default value is 1,2,3,4,5,6,7.


Sample configuration file

[APPLICATION]
Version=3.3
JobAgentID=LPMA-Mac

[SERVER]
IPAddress=0.0.0.0
Port=443
BroadcastPort=
SecureConnection=true
JobMetricURI=/jobs/v2/metrics
InventoryMetricURI=/inventory/v2/metrics
ClientUpdateURI=/update/v2/mac
ConfigUpdateURI=/config/v2/mac

[SSL]
CertificateFile=
CertificatePath=
SSLVerifyHost=No
SSLVerifyPeer=No

[JOB_REPORTING]
Enabled=false
TrackUserName=false
TrackDocumentName=true
TrackLocalPrinters=true
TrackNetworkPrinters=false

[COMPANY]
CompanyIDName=MyCompany
CompanyName=MyCompany

[COSTCENTER]
CostCenterIDName=Site Location


[INVENTORY_REPORT]
Enabled=true
Days=1,2,3,4,5,6,7
StartTime=0000
EndTime=2359
ReportInterval=180

[BLACKOUT_PERIOD]
Enabled=false
BlackOutDays=1
BlackOutStartTime=0000
BlackOutEndTime=2359

[SOFTWARE_UPDATE]
Enabled=true
UpdateCheckTime=1440
UpdateCheckDays=1,2,3,4,5,6,7

[CONFIG_UPDATE]
Enabled=true
UpdateCheckTime=720
UpdateCheckDays=1,2,3,4,5,6,7

Using LPMA Aggregator

The LPMA Aggregator feature of the Fleet Tracker server lets you create a single point of secure communication to the server for all Local Printer Management Agents using the Lexmark Remote Asset Manager. Update the configuration file with the Lexmark Remote Asset Manager information to roll up data to the Lexmark Remote Asset Manager.

[SERVER]
IPAddress=<ENTER_LEXMARK_REMOTE_ASSET_MANAGER_SERVER_ADDRESS>
Port=<ENTER_HTTP_PORT_OF_LEXMARK_REMOTE_ASSET_MANAGER_SERVER>
SecureConnection=false

Notes:

Valid interval values

Values

Description

Note: Make sure to use the 24-hour time format. Use commas to separate the items.

DISABLED

The task is disabled.

INTERVAL:mm

The task runs every time a specified number of minutes elapses. For example, if the key value is set to INTERVAL:30, then the task runs every 30 minutes.

HOURLY

The task runs every hour after the service starts. For example, if the service starts at 10:24, then the task runs at 11:24, 12:24, and so on.

DAILY:hhmm1,hhmm2,hhmm...

The task runs every day at specified times. For example, if the key value is DAILY:0830,1245,2100, then the task runs every day at 8:30 a.m., 12:45 p.m., and 9:00 p.m.

WEEKLY:dayofweek1,dayofweek2,dayofweek...:hhmm1,hhmm2,hhmm...

The task runs on one or more days of the week at specified times. For example, if the key value is set to WEEKLY:Sunday,Tuesday,Thursday:0830,1245,2100, then the task runs at 8:30 a.m., 12:45 p.m., and 9:00 p.m. on each of those days.


SNMP settings

The Local Printer Management Agent uses the SNMP protocol to retrieve information from network printers. The Local Printer Management Agent configuration file contains two items related to SNMP: the SNMP community name and the SNMP port.

[SNMP]
CS_COMMUNITY_NAME=
PORT=

The Local Printer Management Agent retrieves the SNMP community name associated with the port from the print spooler. However, some exceptions require you to change the values manually, such as the following cases: