Specify the Accounting¶
In PLOSSYS 5, accounting information about the jobs processed by PLOSSYS 5 can be viewed. The accounting data of PLOSSYS 5 is administrated and visualized by means of SEAL Elastic Stack. For more information, refer to the SEAL Elastic Stack documentation.
In the context of the accounting, the Accounting
status is available for jobs.
The accounting data is written into the seal-plossys-accounting.log
log file of the seal-plossys-accounting
service. For the location of the log file, refer to Logging on Windows or Logging on Linux.
Activate accounting¶
The accounting is always activated. You cannot deactivate it.
By default, the keys from the following example are listed in the accounting data with PLOSSYS 5.
Example - default accounting keys
"metadata": {
"accounting": {
"metadata": {
"jobID": "123-abc",
"processID": "4712",
"jobState": "completed",
"sourceApplication": "PLOSSYS5",
"deviceModel": "LaserJet"
},
"principals": {
"printer": "printer1",
"account": "Department 42",
"endpoint": "socket://hp402:9100",
"userID": "john.doe"
},
"resources": {
"inputPages": [
{ "size": "ISOA4", "color": "monochrome", "count": 100 },
{ "size": "ISOA4", "color": "grayscale", "count": 1, "media": "glossy" },
{ "size": "ISOA4", "color": "color", "count": 100 }
],
"outputPages": [
{ "size": "ISOA4", "color": "monochrome", "count": 120 },
{ "size": "ISOA4", "color": "grayscale", "count": 1, "media": "glossy" },
{ "size": "ISOA4", "color": "color", "count": 100 }
]
}
}
}
Specify Additional Keys¶
Any job or printer key can be added to the accounting. Additionally, the following keys that are estimated by PLOSSYS 5 are available for the accounting:
job.completed.date
Date part of the completed time as human-readable string (YYYY-MM-DD)job.completed.time
Time part of the completed time as human-readable string (hh-mm-ss)job.completed.total
Processing duration in millisecondsjob.checkin.date
Date part of the checkin time as human-readable string (YYYY-MM-DD)job.checkin.time
Time part of the checkin time as human-readable string (hh-mm-ss)job.origPrinterName
Original printer namejob.hostname
Server name
This is how you add a key to the accounting:
-
In the configuration of the
seal-plossys-accounting
service, specify the additional keys with the following service key:ACCOUNTING
: Customer-specific additional keys for accounting specified as JSON object
Example - customized accounting configuration in Consul
{ "printerModel": "printer.type.model", "printerBrand": "printer.type.manufacturer", "server": "job.hostname", "completedDate": "job.completed.date", "completedTime": "job.completed.time", "totaltimeTaken": "job.completed.total", }
-
Restart the
seal-plossys-accounting
service. When configuring the key via Consul, theseal-plossys-accounting
service will be restarted automatically.plossys service start seal-plossys-accounting
Specify the Lifetime of Jobs in the Accounting
Status¶
-
In the configuration of the
seal-housekeeper
service, specify the lifetime with the following service key:JOB_LIFETIME_ACCOUNTING
: Time interval after which a job with theAccounting
status is deleted from the database
-
Restart the
seal-housekeeper
service. When configuring the key via Consul, theseal-housekeeper
service will be restarted automatically.