Configuring Local Printer Management Agent for LPM

The Print Tracker (PT) component of Local Printer Management Agent (LPMA) must know certain information to run properly. For example, it must know where to send a job report. This information is stored in a configuration file called PTConfiguration.ini. This file is in the directory where the service is installed.

Note: LPMA is installed in the client system and not in the server.

The following is a sample configuration file:

Sample configuration file

[CLIENT_VERSION]
VERSION=1.0.0.1

[SERVER]
BLACKOUT_DAYS=DISABLED
BLACKOUT_TIME=DISABLED
CS_COST_CENTER=<cost_center>
CS_CLIENT_ID=<clientID>
CS_CLIENT_SECRET=<clientSecret>
CS_REPORT_URI=/api/2.0/jobs/directPrint/batch
CS_TOKEN_URI=/idm/oauth/token
REPORT_SERVER_ADDRESS=
REPORT_SERVER_PORT=9780
REPORT_SERVER_SECURE_CONNECTION=DISABLED
TOKEN_SERVER_ADDRESS=
TOKEN_SERVER_PORT=9783
TOKEN_SERVER_SECURE_CONNECTION=ENABLED 
TIMEOUT=30

[JOB_REPORT]
RUN=ENABLED
RUN_ON_STARTUP=ENABLED
TASK_RUN_TIME=INTERVAL:120
INCLUDE_LOCAL_PRINTERS=ENABLED
INCLUDE_NETWORK_PRINTERS=ENABLED

[SNMP]
INCLUDE_NETWORK_PRINTERS=ENABLED

Where:

<cost_center> is the cost center of the company.
The values for <clientID> and <clientSecret> can be taken from <install‑dir> \Lexmark\Solutions\apps\idm\WEB-INF\classes\idm-production-config.properties file, where <install‑dir> is the installation folder of LDD.

The general format of the configuration file is the following:

[SECTION_NAME]
key1=value1
key2=value2

...

Where:

[SECTION_NAME] is a descriptive name for the section.
<key1> and <key2> are names of configurable features that the LPMA service refers during its run.
<value1> and <value2> are values to their respective keys.

Notes:

If the value of a key is case‑sensitive, then that key must be prefixed with CS_.
If a key is not used, then its value must be <DISABLED>.

Settings and descriptions

The following tables describe features.


Section key	Usage/values
CS_COST_CENTER	A cost center associated with the user sending the print job.
CS_CLIENT_ID	The client ID of the company sending the report. This user account must be created on IDM server during the server setup, and must not have an administrator right.
CS_CLIENT_SECRET	The case-sensitive password that is associated with the generic user account created at IDM server. It must never change.
TOKEN_SERVER_ADDRESS	The IP address or host name of the IDM server.
TOKEN_SERVER_PORT	IDM Token Server Port number to communicate to the server. IDM uses SSL port 9783 or 443.
TOKEN_SERVER_SECURE_CONNECTION	If set to ENABLED, server communication is secure. This key value pair is used with [SERVER] TOKEN_SERVER_PORT.
CS_TOKEN_URI	The URI for obtaining a security token from the IDM server and its value must be /idm/oauth/token.
REPORT_SERVER_ADDRESS	The IP address or host name of the LPM Premise server.
REPORT_SERVER_PORT	The LPM Premise Server Port number to communicate to the server. LPM Premise uses SSL port 9783 or 443, and Non‑SSL port 9780.
REPORT_SERVER_SECURE_CONNECTION	If set to ENABLED, server communication is secure. This key-value pair is used with [SERVER] REPORT_SERVER_PORT.
CS_REPORT_URI	The URI for sending the reports to the LPM Premise server and its value must be /api/2.0/jobs/directPrint/batch.
TIMEOUT	A numerical value specifying communication timeout in seconds.
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, and 7, then the blackout days are Sunday, Tuesday, Thursday, and Saturday. You can also set the value to DISABLED.
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, 1200-1400 means that the blackout period starts at 12:00 p.m. and ends at 2:00 p.m.


Section key	Usage/values
VERSION	The current version of the Print Tracker component installed in the system.


Section key	Usage/values
RUN	If the value is ENABLED, then Print Tracker reports job metrics.
RUN_ON_STARTUP	If the value is ENABLED, then Print Tracker, on starting, sends stored job reports, in addition to scheduled job reporting.
TASK_RUN_TIME	The schedule for print job reporting. The default value is 2 hours. For more information on interval values, see Configuring Local Printer Management Agent for LPM
INCLUDE_LOCAL_PRINTERS	The user can enable or disable this key based on the document tracking requirement.
INCLUDE_NETWORK_PRINTERS	The user can enable or disable this key based on the document tracking requirement.


Section key	Usage/values
INCLUDE_NETWORK_PRINTERS	Applies if the user wants to monitor Network Print Queue(INCLUDE_NETWORK_PRINTERS=ENABLED). If the network printer uses a different community name other than "public," then the user can provide a custom value in CS_COMMUNITY_NAME field.

Valid interval values


Values	Description
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.

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