Skip to content Skip to main navigation Skip to footer

Pass Values to Send Fax Page with Custom Button

You can override and set default values of the fields on the Send Fax screen with a custom URL button. This may save you a few clicks so you don’t have to manually enter values for fields on the Sent Fax record. Configuring a custom button allows you to quickly create a new sent fax record with merged data from a specific record and relate it to that record.

Create Button

To create a custom button on the Contact object that would always set specific field values when faxing, you would configure the button as follows.

  1. Go to Setup and create a new Button on the base object the object from which you’d like to send the faxes. For this example, we would go to Contacts.
  2. Set Display Type to “Detail Page Button”.
  3. Set Behavior to “Display in existing window without sidebar”.
  4. Add your button code to the editor box.
    1. The Send Fax Lightning Component URL is: /lightning/cmp/efaxapp__SendFaxManually
    2. The url params should have “efaxapp” prefix, e.g., efaxapp__faxfield.
    1. The related fields like Account__c, Contact__c, Opportunity, Case__c… should be without the suffix “__c” (all fields in the Send Fax Custom Fields field set), e.g., Account__c should be efaxapp__Account. For more information about the Send Fax Custom fieldset, see “Modify Page Layouts” section of the Basic Configuration article.
  5. Add Button to base object’s page layout.
    1. Go to Setup>Object Manager.
    2. Select the object for your button.
    3. In the object’s menu on the left, select “Page Layout”.
    4. Select the page where you plan to add your button.
    5. In the object’s layout editor, select “Buttons” from the menu on the left side of the editor.
    6. Locate your new button, then drag it down to the “Customs Buttons” section of the object’s detail page layout.
    7. Click “Save”.

Overview of Button Variables

Listed below is an overview of variables that you could choose to put in your button code. All variables are optional and the order that you list the variables does not affect functionality.

FIELD NAMEDESCRIPTION
efaxapp__faxfromnumberThis is the number assigned to your org. You will be sending the fax from this number.
efaxapp__recipientidThis is the record that is related to the fax. For example, {!Contact}.
efaxapp__faxtoobjectThis is the base object of the record that is related to the fax. Expects the label name of the lookup field on the Sent Fax object. Indicates which lookup to use to get the related fax number field. For example, “Contact”.
efaxapp__faxtonumberfieldExpects API name of a phone type field on the related lookup object. For example, if you are faxing to a Contact and the field on Contact is called “Company_Fax__c” you would put “Company_Fax__c”.
efaxapp__faxtonumberExpects a fax number value. This is the fax number where you will send the fax.
efaxapp__coversheetPossible values are “None”, “Standard”, “External”, or the Document Action ID of the Document Action for a custom cover sheet template configured with Opero Documents. For example, if you have configured a Document Action for a cover sheet template based on the Sent Fax object and the Action ID is “GDT-000015”, that would be the value to merge.
efaxapp__subjectExpects text in order to set a subject.
efaxapp__commentsExpects text in order to set comments.
efaxapp__fileidExpects a Salesforce Id of a File.
If Coversheet=”None”, then this would be the value of the first file selected.
If Coversheet=”Standard”, “Custom”, or “External”, then leave this blank for the cover sheet.
efaxapp__fileid2Expects a Salesforce Id of a File to add in second position.
If Coversheet=”None”, then this would be the value of the second file selected.
If Coversheet=”Standard”, “Custom”, or “External”, then this would be the value of the first file selected.
efaxapp__fileid3…10Expects a Salesforce Id of a File to add in third thru tenth position.
If Coversheet=”None”, then this would be the value of the third thru tenth file selected.
If Coversheet=”Standard”, “Custom”, or “External”, then this would be the value of the second thru ninth file selected.
efaxapp__barcodepositionleftSpecifies the number of pixels from the left edge of the document in pixels. Expects an integer.
efaxapp__barcodepositiontopSpecifies the number of pixels from the top edge of the document in pixels. Expects an integer.
efaxapp__barcodesizewidthWidth of the barcode, in pixels. Expects an integer.
Best practice to determine barcode position values would be to first create a Sent Fax record manually, send it, and then look at the Sent Fax record to see the values of these three fields. You can copy the values and set them in your button code in order to ensure your preferred barcode position each time.
efaxapp__retURLBy default, the app will redirect to the new Sent Fax record after sending the fax or clicking “Cancel”. If desired, set this value to a Salesforce Id of a record you want to return to. Common use case would be to return to the original related record where you clicked the custom button, such as {!Account.Id}.
Additional Lookups and Custom FieldsYou can set any other lookup fields included with the app, any custom lookups, or any custom fields on the Sent Fax object.

How to Add Multiple Barcodes in Your Button Code

If you’d like to add more than one barcode parameter with your button, specify another barcode parameter after the previous value separated by a comma, e.g., barcodepositionleft=100, 70. Add up to 15 values. Note that efaxapp__barcodepositionleft, efaxapp__barcodepositiontop, and efaxapp__barcodepositionwidth should all have the same number of values.

Button Code

Listed below is button code with variables listed without any values. You can easily copy & paste the blank code to start with, then fill in values after the = sign on each variable that you wish to populate. All variables are optional and you can leave the variables in your url without any value after the = sign without any issues.


/lightning/cmp/efaxapp__SendFaxManually?
&efaxapp__id=
&efaxapp__faxfield=
&efaxapp__Account=
&efaxapp__Contact=
&efaxapp__Opportunity=
&efaxapp__faxtoobject=
&efaxapp__cover_sheet
&efaxapp__barcodepositionleft=
&efaxapp__barcodepositiontop=
&efaxapp__barcodesizewidth=
&efaxapp__retURL=
&efaxapp__fileid=
&efaxapp__fileid2=
&efaxapp__fileid3=
&efaxapp__fileid4=
&efaxapp__fileid5=
&efaxapp__fileid6=
&efaxapp__fileid7=
&efaxapp__fileid8=
&efaxapp__fileid9=
&efaxapp__fileid10=
&efaxapp__comments=
&efaxapp__subject=


Example Button – One Barcode

You can relate a Sent Fax record to any standard or custom object. This example button relates a Sent Fax record to a Contact record.


/lightning/cmp/efaxapp__SendFaxManually?
&efaxapp__id={!Record.Id}
&efaxapp__faxfield=Fax
&efaxapp__Account={!Account.Id}
&efaxapp__Contact={!Contact.Id}
&efaxapp__Opportunity={!Opportunity.Id}
&efaxapp__faxtoobject=efaxapp__Contact__c
&efaxapp__cover_sheet=GDT-000024
&efaxapp__barcodepositionleft=100
&efaxapp__barcodepositiontop=70
&efaxapp__barcodesizewidth=50
&efaxapp__retURL={!Contact.Id}
&efaxapp__fileid=0695d00000GukdKAAR
&efaxapp__fileid2=0695d00000IpUVXAA3
&efaxapp__fileid3=0685d00000DwHOLAA3
&efaxapp__comments=test comments
&efaxapp__subject=test subject

Example Button – Multiple Barcodes

This button is the same as above, with one exception: it adds three barcodes instead of one.

/lightning/cmp/efaxapp__SendFaxManually
/lightning/cmp/efaxapp__SendFaxManually?
&efaxapp__id={!Record.Id}
&efaxapp__faxfield=Fax
&efaxapp__Account={!Account.Id}
&efaxapp__Contact={!Contact.Id}
&efaxapp__Opportunity={!Opportunity.Id}
&efaxapp__faxtoobject=efaxapp__Contact__c
&efaxapp__cover_sheet=GDT-000024
&efaxapp__barcodepositionleft=100, 75, 90
&efaxapp__barcodepositiontop=70, 60, 65
&efaxapp__barcodesizewidth=50, 45, 66
&efaxapp__retURL={!Contact.Id}
&efaxapp__fileid=0695d00000GukdKAAR
&efaxapp__fileid2=0695d00000IpUVXAA3
&efaxapp__fileid3=0685d00000DwHOLAA3
&efaxapp__comments=test comments
&efaxapp__subject=test subject