RelayLog__c
  • 13 Jan 2025
  • 4 Minutes to read
  • Dark
    Light

RelayLog__c

  • Dark
    Light

Article summary

Available in Relay package version 1.25+

The RelayLog__c object contains log messages from the different modules of the Relay package. This table can become a valuable resource when troubleshooting. Especially when the Relay module is running as part of a background job, future, or trigger.

Field

Type

Description

CCID__c

Text(255)

Optional. Depending on the source of the log message, a CCID value may be provided.

ClientID__c

Text(100)

Required. The client id associated to the logged message.

Description__c

Text(255)

Required. A human readable description of the log message.

LogCode__c

Number(9.0)

Required. The code that uniquely identifies the message.

Module__c

Text(100)

Required. The Relay apex module that logged the message.

Param1__c

Text(255)

Optional. Depending on the logged message, this field may or may not contain a value.

Param2__c

Text(255)

Optional. Depending on the logged message, this field may or may not contain a value.

Param3__c

Text(255)

Optional. Depending on the logged message, this field may or may not contain a value.

Param4__c

Text(255)

Optional. Depending on the logged message, this field may or may not contain a value.

Param5__c

Text(255)

Optional. Depending on the logged message, this field may or may not contain a value.

Request__c

LongTextArea(10000)

Optional. Depending on the source of the logged message, this field may contain the request payload that was the source of the message.

Response__c

LongTextArea(2000)

Optional. Depending on the source of the logged message, this field may contain an response value for the made request.

SubModule__c

Text(100)

Optional. The Relay sub-module that logged the message.

Log Messages

The below section lists all of the possible messages that may be logged from the Relay Package. The below headers are in the format LogCode__c : Module__c : SubModule__c : Description__c. If there is no relevant sub module, then this portion of the header will be left off.

1001 : PullPDF : : Max retries reached

This message is logged when the Relay Pull PDF Action failed to download (pull) the PDF attachment from the Relay platform.

Field

Notes

Param1__c

n/a

Param2__c

Relay Power-up form ID.

Param3__c

Relay Power-up form submission ID.

Param4__c

Linked Entity ID

Param5__c

PDF title.

1002 : PullPDF : : Invalid submission ID

The submission Id provided to the Relay Pull PDF Action was invalid.

Field

Notes

Param1__c

n/a

Param2__c

The Relay Power-up form ID.

Param3__c

Relay Power-up Form submission ID.

Param4__c

Linked Entity ID

Param5__c

PDF title.

1008 : PullPDF : : Error downloading document

The Relay Pull PDF Action received an error when attempting to download the Relay Power-up PDF. Review the Param1__c and Response__c fields for more specific details on the error.

Field

Notes

Param1__c

The HTTP error code of the failed download.

Param2__c

The Relay Power-up form ID.

Param3__c

Relay Power-up Form submission ID.

Param4__c

Linked Entity ID

Param5__c

PDF title.

Response__c

The HTTP response body of the failed download.

1009 : PullPDF : : Exception

An exception occurred in the Relay Pull PDF Action. Review the Param1__c field for the actual exception message.

Field

Notes

Param1__c

The exception message.

Param2__c

The Relay Power-up form ID.

Param3__c

Relay Power-up Form submission ID.

Param4__c

Linked Entity ID

Param5__c

PDF title.

2001 : UpdateConsent : Sync : Failed to send batch consent changes

Field

Notes

Param1__c

The HTTP error code of the failed batch.

Request

The HTTP request body

Response

The HTTP response body

2002 : UpdateConsent : Async : Failed to send batch consent changes

Field

Notes

Param1__c

The HTTP error code of the failed batch.

Request

The HTTP request body

Response

The HTTP response body

3001 : RelayCallout : addCalloutToUrl: Missing Client ID

This message is logged when the Relay package has been configured for multi-client support and a callout is attempted without providing the specific client id.

When the Relay packaged is configured for multi-client support:

  • Ensure that all Relay LWC instance are configured with a specific Client ID. The client id parameter must be populated.

  • Ensure that all Relay Flow Actions that are being used are configured with a specific Client ID. The client id parameter must be populated.

Field

Notes

Param1__c

The URL of the HTTP callout that was attempted.

4001 : PullAttachmentAction : : Invalid submission ID

Field

Notes

Param1__c

n/a

Param2__c

The attachment index value that was submitted with the retrieval request.

Param3__c

The Relay Power-up form submission ID.

Param4__c

The Salesforce ID of the entity to link the document to.

Param5__c

The title of the Relay Power-up form.

Response__c

HTTP response body of the failed request.

4002 : PullAttachmentAction : : Invalid question ID

Field

Notes

Param1__c

n/a

Param2__c

The attachment index value that was submitted with the retrieval request.

Param3__c

The Relay Power-up form submission ID.

Param4__c

The Salesforce ID of the entity to link the document to.

Param5__c

The title of the Relay Power-up form.

Response__c

HTTP response body of the failed request.

4003 : PullAttachmentAction : : Invalid attachment ID

Field

Notes

Param1__c

n/a

Param2__c

The attachment index value that was submitted with the retrieval request.

Param3__c

The Relay Power-up form submission ID.

Param4__c

The Salesforce ID of the entity to link the document to.

Param5__c

The title of the Relay Power-up form.

Response__c

HTTP response body of the failed request.

4004 : PullAttachmentAction : : Error downloading document

There was an error attempting to download the Relay Power-up attachment. Please review the Param1__c field that contains the HTTP response code and the Response__c field that contains the HTTP response body. Both of which should provide more details on the failure.

Field

Notes

Param1__c

The returned HTTP status code.

Param2__c

The attachment index value that was submitted with the retrieval request.

Param3__c

The Relay Power-up form submission ID.

Param4__c

The Salesforce ID of the entity to link the document to.

Param5__c

The title of the Relay Power-up form.

Response__c

HTTP response body of the failed request.


Was this article helpful?


What's Next
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence