Batch Receipt Log Fields
Batch Receipt Log
Object API name: dryad__Batch_Receipt_Log__c
A Batch Receipt Log records one background job: creating receipts, creating .pdfs, merging, emailing, printing or building a preview report. It shows what the job is doing, how far it has got, and any errors. The app creates and updates logs automatically. Logs are numbered BRL-0001, BRL-0002 and so on. The Batch Receipt Logs and Background Jobs article explains how to use them.
How to read the field tables: the Field column shows the label you see on screen, with the field's API name (the name used by admins, reports and integrations) underneath it. The Data Type column uses Salesforce's own terms. A type that starts with "Formula" or "Roll-Up Summary" is calculated automatically and can't be edited.
Job
| Field | Data Type | Purpose |
|---|---|---|
Actiondryad__Action__c | Picklist | What the job does: "Create Receipts", "Create .pdfs", "Merge .pdfs", "Print Receipts", "Email Receipts" or "Preview Report". "Email .pdfs" appears only on logs from older versions. |
Statusdryad__Status__c | Picklist | "In Progress", "Complete", "Complete with Errors" or "Aborted". "Initializing", "Generating Receipts" and "Generating Files" appear only on logs from older versions. |
Job Iddryad__Job_Id__c | Text | System field: the Salesforce ID of the background job, saved as soon as the job is started. Used by the Abort Job button to stop the job, and to close the log if the job ends without finishing it. For a split .pdf job, it holds the first segment's job. |
Parent BRLdryad__Parent_BRL__c | Lookup (Batch Receipt Log) | The "Create Receipts" log of the same run. The run's .pdf, email, merge and preview logs point to it, so a run's steps can be followed from one log. |
Resultsdryad__Results__c | Long Text Area | Details of the job, such as error messages. Long results are cut short. |
Progress
| Field | Data Type | Purpose |
|---|---|---|
Records Targeteddryad__Records_Targeted__c | Number | The number of records the job set out to process. |
Records Processeddryad__Records_Processed__c | Number | The number of records processed successfully so far. For a .pdf job split into segments, the total of its segments. |
% Completedryad__Percent_Complete__c | Formula (Percent) | Records Processed divided by Records Targeted, or 0 when nothing is targeted. |
Segments Totaldryad__Segments_Total__c | Roll-Up Summary | .pdf jobs only: the number of segments the job was split into. |
Segments Opendryad__Segments_Open__c | Roll-Up Summary | .pdf jobs only: segments that are "Queued" or "In Progress". The log is finished when this reaches 0. |
Segment Records Processeddryad__Segment_Records_Processed__c | Roll-Up Summary | .pdf jobs only: the .pdfs created by all segments. |
Segment Records Faileddryad__Segment_Records_Failed__c | Roll-Up Summary | .pdf jobs only: the .pdfs the segments couldn't create. |
Emailing and Printing
| Field | Data Type | Purpose |
|---|---|---|
Emaildryad__Email__c | Lookup (Email) | Dryad Mailer only: the Email record of the send. |
Printeddryad__Printed__c | Checkbox | Merge logs only: ticked once the merged .pdf has been set as printed. |
Batch Receipt Log Segment
Object API name: dryad__Batch_Receipt_Log_Segment__c
A large "Create .pdfs" job is split into segments that run at the same time (see the .pdf Segments setting). Each segment is one background job and belongs to one Batch Receipt Log. Segments are numbered BRLS-000001 and so on, and are created and updated automatically.
| Field | Data Type | Purpose |
|---|---|---|
Batch Receipt Logdryad__Batch_Receipt_Log__c | Master-Detail (Batch Receipt Log) | The log the segment belongs to. If the log is deleted, its segments are deleted too. |
Statusdryad__Status__c | Picklist | "Queued", "In Progress", "Complete", "Complete with Errors" or "Aborted". |
Job Iddryad__Job_Id__c | Text (External ID) | The Salesforce ID of the segment's background job. Used to abort it and to close it if it ends without finishing. |
Records Targeteddryad__Records_Targeted__c | Number | The number of receipts given to this segment. |
Records Processeddryad__Records_Processed__c | Number | The .pdfs this segment created. |
Records Faileddryad__Records_Failed__c | Number | The receipts this segment couldn't create a .pdf for. |
Start Timedryad__Start_Time__c | Date/Time | When the segment started. |
End Timedryad__End_Time__c | Date/Time | When the segment finished or was closed. |
Resultsdryad__Results__c | Long Text Area | Error messages from the segment. |