.. _auto_reporter_save_worker: *SAVE REPORT* ============= Registers a file as a Report in the d3VIEW Reporter app, surfacing it under /user/reporters. Requires a name, description, and exactly one attachment source (uploaded file, existing attachment ID, or server-side path); optionally links the report to an originating record and triggers an approval-review share. Supports in-place update of an existing row (including draft auto-save) when a report_id is supplied. When to use ----------- Tagged: ``approval``, ``attachment``, ``auto-save``, ``d3layout``, ``draft``, ``gallery``, ``pptx``, ``report_registration``. Inputs ------ .. list-table:: :header-rows: 1 :widths: 20 20 20 20 20 20 * - Label - ID - Type - Default - Required - Description * - Report Name - name - string - — - ✓ - Display title of the report as it will appear in the Reporter app list; required, non-empty string. * - Description - description - string - — - ✓ - Free-text description summarising the report's content; required, non-empty string. * - Upload File - attachment_id - file - — - - File upload handle (filename string) or legacy numeric Attachment ID to register as the report's file; provide this or attachment_lookup_id or attachment_path — leave null if using one of the other two. * - Existing Attachment - attachment_lookup_id - remote_lookup - — - - Numeric ID of an existing Attachment row to link as the report file; takes resolution priority over attachment_path and attachment_id — leave null if uploading a new file or using a server path. * - Server File Path - attachment_path - string - — - - Absolute server-side filesystem path to a file that will be imported as a new Attachment owned by the active user; used when the file is already present on the server — leave null if using attachment_id or attachment_lookup_id. * - Tags - tags - string - — - - Comma-separated free-text tags used for search and filtering in the Reporter app; optional, leave empty if no tagging is needed. * - Source Type - parent_type - select - manual - - Category of the originating record that produced this report (e.g. 'workflow', 'simulation', 'workflowexec', 'simlytiks', or 'manual'); defaults to 'manual' when not linked to another record. * - Source ID - parent_id - integer - — - - Integer primary key of the originating record identified by parent_type; leave null when parent_type is 'manual' or no source record exists. * - Editable Layout (d3Layout JSON) - data - string - — - - JSON payload exported by the Reporter plugin's d3Layout editor; when present the report row becomes re-openable and editable in the Reporter UI rather than download-only — leave null for non-editable file-based reports. * - Origin - source - string - — - - Origin tag string (e.g. 'reporter', 'simlytiks', 'manual'); setting this to 'reporter' combined with a non-empty data field marks the row as editable in the Reporter UI — leave null to inherit default behaviour. * - Thumbnail (data URI) - thumbnail - string - — - - Base64 data-URI string (e.g. 'data:image/png;base64,…') used as the report's preview thumbnail in gallery views; leave null if no preview image is available. * - Gallery (data URI) - gallery - string - — - - Gallery grouping identifier used to organise reports into named collections in the UI; leave null if gallery grouping is not required. * - Send to user for approval - approver_user_id - remote_lookup - — - - Numeric user ID of the person who should receive an approval review-link share after the report is saved; triggers creation of a purpose='review' Sharing row and sets approval_status to 'in_review' — leave null to skip the approval workflow. Outputs ------- .. list-table:: :header-rows: 1 :widths: 20 20 20 20 * - Label - ID - Type - Description * - Report ID - report_id - integer - Integer primary key of the newly created or updated Report row in the Reporter app database. * - Attachment ID - attachment_id - integer - Integer primary key of the resolved or newly persisted Attachment row that backs this report file. * - Download Link - report_link - string - Direct download URL string for the report file, suitable for embedding in notifications or dashboard links. * - Approval Share ID - approval_share_id - integer - Integer primary key of the purpose='review' Sharing row created for the approver; null when approver_user_id was not supplied. * - Approval Review URL - approval_review_url - string - Full /reporter/review/ URL string sent to the approver, containing Approve/Reject action buttons; null when no approval share was created. * - Status - status - string - Final status string of the saved report row (e.g. 'draft' or 'published') as persisted in the database after the worker completes. Disciplines ----------- - platform.reporter .. raw:: html

Auto-generated from platform schema. Worker id: reporter_save_worker. Schema hash: 84b9a337262a. Hand-curated docs in workerexamples/ override this page when present.