Report parameters


  • [device_id] - id of the device
  • [device_ip] - IP address of the device
  • [device_name] - name of the device within the OptimiDoc system
  • [device_location] - location of the device
  • [user_name] - name of the user who initiated the scan
  • [user_givenname] - user first name
  • [user_surname] -  user last name
  • [user_login] - login of the user who initiated the scan
  • [flow_name] - name of the scan flow
  • [files_count] - number of generated files
  • [pages_count] - overall number of pages from all documents
  • [status] - overall status - the worse status from all scanned documents
  • [files] - reports of all created files (see File parameters for more info)
  • [errors] - same as [files], but includes only reports of files with errors (see File parameters for more info). Note that it won't be a complete report, only the items in which the error occurred will be written out



File parameters


  • [status] - status of the file
  • [pages] - number of pages in the document
  • [file_name] - resulting file name
  • [zones] - reports of all zones (see Zone parameters for more info)
  • [destinations] - reports of all destinations (see Destination parameters for more info)



Zone and destination parameters


  • [status] - delivery status
  • [name] - name of the zone or destination
  • [message] - if no error occurred, the value inside the zone will be written out. If there was an error, the error message will be written out instead