generate

A PDF is generated when the form is finalized or previewed.

steps

Sub-steps of PDF generation, main entry point : services.core.craft.tools.generate_files :

• grab all files from user session tools2.grab_context_from_storage_to_local_temp()
• (re)process dropped files process_dropped_files()
• template guess : script.template_get
• raw PDF generation : script.generate_pdf
• raw PDF post-generation : generate_pdf_post()
• metadata generation : script.generate_metadata
• metadata post-generation : generate_metadata_post()
• signature generation : script.generate_signature
• signature post-generation : generate_signature_post()
• store PDF in user session : session.store()

The function will return a generateStatus().

Callbacks :

generate_pdf()

The function must return a generatePDFStatus().

generate_metadata()

The function must return a generateMetadataStatus().

return GenerateStatus

The generate_files function should return an GenerateStatus. It will give to the client form some information on how the upload was proceed and what to do client-side.

Sample :

generated_pdf: invoice_FA63523.pdf
msg: "Your invoice #FA63523 has been generated"

.generated_pdf

Optional property. If not set the generated PDF is expected to be _output.pdf.

.msg

Optional property.

return GeneratePDFStatus

The generate_pdf function should return an GeneratePDFStatus. It will give some information on the PDF generation.

Sample :

generated_file: /tmp/GhU67et/mydocument.pdf
msg: "Your invoice #FA63523 has been generated"

.generated_file

The generated PDF path. The file must exist and be a valid PDF file.

Optional property. If not set the generated PDF is expected to be _output.pdf.

.filename

The visible filename. Any meaningfull filename should be provided. When downloading the file, this filename will be used.

At this exact time of processing, this filename does not point to an actual file.

Optional property.

Sample :

generated_file: /tmp/GhU67et/mydocument.pdf
filename: invoice_FA63523.pdf
msg: "Your invoice #FA63523 has been generated"

.msg

The message explaining to the user how the upload happened.

Optional property.

.metadata

Optional metadata status. Sometimes it is easier to collect metadata at the same time we generate the PDF. In this case just return the metadata property.

Optional property. If set the generate_metadata() callback will not be called !

.signatures

Optional

.delivery

Optional

return GenerateMetadataStatus

The genergenerate_metadataate_pdf() function should return a GeneratePDFStatus. It will give some information on the PDF generation.

Sample :

document_metadata:
    tier:
        id: GDT67678
        name: Duroux SA
    amount: 700.0
    orders:
        - id: "6767"
          amount: 200.0
        - id: "6768"
          amount: 100.0
        - id: "6769"
          amount: 400.0
document_xmp:
    CUST_REF: GDT67678
    TRACK_NUMBER: "8667-656-5656-002"
attached_files:
    - path: extract.xml
    - path: dashboard.xlsx
      name: Tableau_de_bord_20230223.xlsx
    - path: orders/order_6767.pdf
    - path: orders/order_6768.pdf
    - path: orders/order_6769.pdf

.document_metadata

A dict of the document metadata.

The $schema prop will be automatically added.

The document metadata will be stored as a meta.yaml attachment.

Mandatory property.

Sample :

document_metadata:
    tier:
        id: GDT67678
        name: Duroux SA
    amount: 700.0
    orders:
        - id: "6767"
          amount: 200.0
        - id: "6768"
          amount: 100.0
        - id: "6769"
          amount: 400.0

.document_xmp

Some document metadata that will be added as XMP tags.

Optional property.

Sample :

document_xmp:
    CUST_REF: GDT67678
    TRACK_NUMBER: "8667-656-5656-002"

.attached_files

List if file to attach to the PDF.

Optional property.

Sample :

attached_files:
    - path: extract.xml
    - path: dashboard.xlsx
      name: Tableau_de_bord_20230223.xlsx
    - path: orders/order_6767.pdf
    - path: orders/order_6768.pdf
    - path: orders/order_6769.pdf

path are local to the user session.