OS4X Enterprise text template

From OS4X
Jump to navigation Jump to search

Many OS4X Enterprise solutions (plugins like os4xplugin_transmission_pdf, email files, approve) use templates to dynamically generate text, often used as email. These templates contain variables, which are dynamically replaced. Variables are introduced by a "$" character. This way, XPath expressions are possible on the actual job state in plugins.

Common variables via XPath

  • Job number: $/OS4X_job/job_information/job_number
  • Job direction ("incoming" or "outgoing)": $/OS4X_job/job_information/job_direction
  • Job command: $/OS4X_job/job_information/job_comment
  • Sender:
    • Family name (i.e. "Koch"): $/OS4X_job/job_information/sender/surname
    • Name (i.e. "Harald"): $/OS4X_job/job_information/sender/name
    • Email address (i.e. "h.koch@c-works.de"): $/OS4X_job/job_information/sender/email_address
    • Department (i.e. "Development"): $/OS4X_job/job_information/sender/department
    • City (i.e. "Böblingen"): $/OS4X_job/job_information/sender/location
    • ZIP code (i.e. "71034"): $/OS4X_job/job_information/sender/zip_code
  • Recipient:
    • Family name (i.e. "Koch"): $/OS4X_job/job_information/recipient/surname
    • Name (i.e. "Harald"): $/OS4X_job/job_information/recipient/name
    • Email address (i.e. "h.koch@c-works.de"): $/OS4X_job/job_information/recipient/email_address
    • Department (i.e. "Development"): $/OS4X_job/job_information/recipient/department
    • City (i.e. "Böblingen"): $/OS4X_job/job_information/recipient/location
    • ZIP code (i.e. "71034"): $/OS4X_job/job_information/recipient/zip_code
    • Company long name: $/OS4X_job/job_information/recipient/partner_longname

Special variables

  • $JOBFILES_HTML: Generate a HTML list of all files contained in the job (with "ul" and "li" HTML tags)
  • $JOBFILES_TEXT: Generate a textual list of all files contained in the job (with "- " as a prefix before each filename)