Skip to main content

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​

FieldData TypePurpose
Action
dryad__Action__c
PicklistWhat 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.
Status
dryad__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 Id
dryad__Job_Id__c
TextSystem 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 BRL
dryad__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.
Results
dryad__Results__c
Long Text AreaDetails of the job, such as error messages. Long results are cut short.

Progress​

FieldData TypePurpose
Records Targeted
dryad__Records_Targeted__c
NumberThe number of records the job set out to process.
Records Processed
dryad__Records_Processed__c
NumberThe number of records processed successfully so far. For a .pdf job split into segments, the total of its segments.
% Complete
dryad__Percent_Complete__c
Formula (Percent)Records Processed divided by Records Targeted, or 0 when nothing is targeted.
Segments Total
dryad__Segments_Total__c
Roll-Up Summary.pdf jobs only: the number of segments the job was split into.
Segments Open
dryad__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 Processed
dryad__Segment_Records_Processed__c
Roll-Up Summary.pdf jobs only: the .pdfs created by all segments.
Segment Records Failed
dryad__Segment_Records_Failed__c
Roll-Up Summary.pdf jobs only: the .pdfs the segments couldn't create.

Emailing and Printing​

FieldData TypePurpose
Email
dryad__Email__c
Lookup (Email)Dryad Mailer only: the Email record of the send.
Printed
dryad__Printed__c
CheckboxMerge 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.

FieldData TypePurpose
Batch Receipt Log
dryad__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.
Status
dryad__Status__c
Picklist"Queued", "In Progress", "Complete", "Complete with Errors" or "Aborted".
Job Id
dryad__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 Targeted
dryad__Records_Targeted__c
NumberThe number of receipts given to this segment.
Records Processed
dryad__Records_Processed__c
NumberThe .pdfs this segment created.
Records Failed
dryad__Records_Failed__c
NumberThe receipts this segment couldn't create a .pdf for.
Start Time
dryad__Start_Time__c
Date/TimeWhen the segment started.
End Time
dryad__End_Time__c
Date/TimeWhen the segment finished or was closed.
Results
dryad__Results__c
Long Text AreaError messages from the segment.