This feature is only available on Lightning. It can be used:
- On Page Builder
- On Desktop
- In Flows (but not in Field Service Mobile Flow)
- In Salesforce Community
- In your own Lightning Component development
SharinPix Plan can be added on any Lightning record page. The administrator just need to drag and drop the component to the Record Layout and configure the component accordingly as follows:
|Plan Data Source Id
||String||Id of Record containing the field specified by Plan Data Field API Name from where the plan data is to be retrieved. Leave blank to use data from Background Image Album record.
|Plan Data Field API Name||planDataFieldApiName
||String||(Required) API name of field containing plan-related information. Current Record Id will be used if Plan Data Source Id is not specified. This field needs to be a Long Text Area.
|Background Image Album Field API Name
||String||API name of field containing the record ID for the image to be displayed, with respect to the Background Image Tag set. Defaults to Record Id.
|Background Image Tag
||String||Tag name to be used to identify an image from the album set by Background Image Album Field API Name or otherwise, the current record’s album.
|Height||height||Integer||The height of the component (in px). Default: 500
|Mode||mode||Picklist||Mode of the plan. Possible values are: readonly, geocode and edit
|SharinPix Plan Setting Name||settingName||String||SharinPix Plan Setting Name configured for this plan component. More information on how to configure the SharinPix Plan Setting below.
|Display Lookup Field
||String||Field API Name of the Lookup relationship to filter SharinPix Plan Items to be displayed based on record Id.
|Field Set Name||fieldSet||String||Field Set Name which will decide the fields to be displayed on the plan item record. Default field set will be used if left to blank. Only available in edit mode.
||String||(Optional) Component Id to identify the SharinPix Plan component (useful when more than 1 component is present on the same page)
SharinPix Plan Setting
SharinPix Plan Setting will be used to be able to determine the relationship between the object SharinPix Plan Item. The SharinPix Plan Item is the object which will save the annotations such as Marker, CircleMarker, Poloygon, Line, and Rectangle.
Before you create the SharinPix Plan Setting, you need to create the relationship between your main object and the SharinPix Plan Item. Create a field of type lookup on the SharinPix Plan Item object. Save the field api name as it will be used for the configuration later.
Steps to configure the SharinPix Plan Item:
- Go to Salesforce Setup
- Open Custom Metadata Types
- Click on Manage Records for SharinPix Plan Setting Custom metadata type
- Insert a label and name
- Insert your object api name
- Insert the field api name of the field recently created on the SharinPix Plan Item
Once the plan setting has been configured. Create a Permission Set and give access to the SharinPix Plan Item object and fields. Note: Create and Edit access is needed in order for the feature to work as expected.
Assign the permission set to the user who will be using this component.
Now open your Lightning Builder for a record page. Add the appropriate configurations based on your business rule.