|
| 1 | +# Basic Report |
| 2 | + |
| 3 | +This example shows how you can use custom operations to generate a basic report on a document and attach that report to the document. |
| 4 | + |
| 5 | +The example uses [python-docx](https://python-docx.readthedocs.io/en/latest/) to generate a Word file. |
| 6 | +To install the library in your Function, you need to add it to the `requirements.txt`: |
| 7 | + |
| 8 | +```requirements.txt |
| 9 | +contactsoftware-functions |
| 10 | +python-docx |
| 11 | +``` |
| 12 | + |
| 13 | +```python |
| 14 | +import os |
| 15 | +import tempfile |
| 16 | +from datetime import datetime |
| 17 | + |
| 18 | +import requests |
| 19 | +from docx import Document as DocxDocument |
| 20 | + |
| 21 | +from csfunctions import MetaData, Service |
| 22 | +from csfunctions.events import CustomOperationDocumentEvent |
| 23 | +from csfunctions.objects import Document |
| 24 | + |
| 25 | + |
| 26 | +def simple_report(metadata: MetaData, event: CustomOperationDocumentEvent, service: Service): |
| 27 | + """ |
| 28 | + Generates a simple report for each document the custom operation is called on. |
| 29 | + The report contains basic information about the document and is saved as a new file |
| 30 | + named "myreport.docx" within the document. |
| 31 | + """ |
| 32 | + |
| 33 | + for document in event.data.documents: |
| 34 | + # generate a report for each document |
| 35 | + report = _create_report(document, metadata) |
| 36 | + |
| 37 | + temp_file_path = None |
| 38 | + try: |
| 39 | + # we need to use a tempfile, because the rest of the filesystem is read-only |
| 40 | + with tempfile.NamedTemporaryFile(suffix=".docx", delete=False) as tmp: |
| 41 | + temp_file_path = tmp.name |
| 42 | + report.save(temp_file_path) |
| 43 | + |
| 44 | + # check if the document already has a report file, so we can overwrite it |
| 45 | + file_name = "myreport.docx" |
| 46 | + existing_file = next((file for file in document.files if file.cdbf_name == file_name), None) |
| 47 | + |
| 48 | + with open(temp_file_path, "rb") as file_stream: |
| 49 | + if existing_file: |
| 50 | + # overwrite the existing report file |
| 51 | + # we set check_access to false to allow attaching reports to released documents |
| 52 | + service.file_upload.upload_file_content( |
| 53 | + file_object_id=existing_file.cdb_object_id, stream=file_stream, check_access=False |
| 54 | + ) |
| 55 | + else: |
| 56 | + # create a new one |
| 57 | + # we set check_access to false to allow attaching reports to released documents |
| 58 | + service.file_upload.upload_new_file( |
| 59 | + parent_object_id=document.cdb_object_id, # type: ignore |
| 60 | + filename=file_name, |
| 61 | + stream=file_stream, |
| 62 | + check_access=False, |
| 63 | + ) |
| 64 | + finally: |
| 65 | + if temp_file_path: |
| 66 | + # Clean up temp file |
| 67 | + os.unlink(temp_file_path) |
| 68 | + |
| 69 | + |
| 70 | +def _fetch_person_name(persno: str, metadata: MetaData) -> str | None: |
| 71 | + """Fetches the name of a person given their personnel number via GraphQL.""" |
| 72 | + graphql_url = str(metadata.db_service_url).rstrip("/") + "/graphql/v1" |
| 73 | + headers = {"Authorization": f"Bearer {metadata.service_token}"} |
| 74 | + |
| 75 | + query = f""" |
| 76 | + {{ |
| 77 | + persons(personalnummer: \"{persno}\", max_rows: 1) {{ |
| 78 | + name |
| 79 | + }} |
| 80 | + }} |
| 81 | + """ |
| 82 | + response = requests.post( |
| 83 | + graphql_url, |
| 84 | + headers=headers, |
| 85 | + json={"query": query}, |
| 86 | + ) |
| 87 | + response.raise_for_status() |
| 88 | + data = response.json() |
| 89 | + persons = data["data"]["persons"] |
| 90 | + if persons: |
| 91 | + return persons[0]["name"] |
| 92 | + return None |
| 93 | + |
| 94 | + |
| 95 | +def _create_report(document: Document, metadata: MetaData) -> DocxDocument: |
| 96 | + """Creates a simple Word report for the given document.""" |
| 97 | + doc = DocxDocument() |
| 98 | + |
| 99 | + doc.add_heading("Simple Report", 0) |
| 100 | + |
| 101 | + report_time_string = datetime.now().strftime("%Y-%m-%d %H:%M:%S") |
| 102 | + doc.add_paragraph(f"Report generated on: {report_time_string}") |
| 103 | + |
| 104 | + # add some basic information about the document |
| 105 | + doc.add_heading("Document Information", level=1) |
| 106 | + doc.add_paragraph(f"Document ID: {document.z_nummer}@{document.z_index}") |
| 107 | + doc.add_paragraph(f"Title: {document.titel}") |
| 108 | + doc.add_paragraph(f"Created On: {document.cdb_cdate}") |
| 109 | + |
| 110 | + # Fetch the name of the person who created the document via GraphQL |
| 111 | + person_name = _fetch_person_name(document.cdb_cpersno, metadata) |
| 112 | + doc.add_paragraph(f"Created By: {person_name or document.cdb_cpersno}") |
| 113 | + |
| 114 | + return doc |
| 115 | + |
| 116 | +``` |
0 commit comments