Shared Rides Lightning Edition User Guide. Quick Start Framework. Version Name: Spring 2017 Version Number: 2.4 Date: 20/01/17

Transcription

1 Shared Rides Lightning Edition User Guide Version Name: Spring 2017 Version Number: 2.4 Date: 20/01/17 Shared Rides Lightning Edition User Guide.pdf 1

2 Table of Content Introduction... 3 Disclaimer... 3 Copyright... 3 Overview... 3 Data Model... 4 Lightning Experience UI Instructions... 4 Installation... 4 Usage... 6 Create Locations for the start and end of routes... 6 Create the Routes... 7 Create an Event... 8 Offer a Shared Ride... 9 To be notified of rides being offered Accept a Ride Get Credit in the Dashboard Classic UI Instructions Installation Usage Create Locations for the start and end of routes Create the Routes Create an Event Offer a Shared Ride To be notified of rides being offered Get Credit in the Dashboard Mobile Version Possible enhancements Package Information Package Components Shared Rides Lightning Edition User Guide.pdf 2

3 Introduction Disclaimer This software is provided by Salesforce ``as is'' and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Salesforce be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. Copyright The logo is traffic light by grendelkhan from via Overview Shared Rides Quick Start App, written by Sam Garforth, is a Salesforce carpooling app to offer and accept shared rides via Chatter. You need to create the locations, then the routes between the locations, then create a shared ride to offer an instance of the route at a certain time. Optionally you can create an event and associate the shared ride with the event. The ride offer is automatically published to the Shared Rides chatter group from which subscribers can click through to accept the ride offer. When the ride is complete you can mark it as such and green mile credits will be given to the ride offerer. These points can be tracked on a dashboard. This app is intended as an example of what can be built of Salesforce App Cloud in both the Lightning Experience UI and the classic one. The initial part of this guide is focused on Lightning Experience. However the app still works in classic so the guide is repeated at the end in classic form for those that do not have Lightning Experience. Shared Rides Lightning Edition User Guide.pdf 3

4 Data Model Data Model Shared Rides App Users Shared Rides Chatter Group Events Dashboards Ride Givers Shared Rides Green Mile Points by Sharer Ride Receivers Routes Locations Lightning Experience UI Instructions Follow this section if you have the Lightning Experience UI, or jump to Classic UI Instructions on page 14 if you are using the classic UI. Installation This app uses mapping components which are not available in Developer Edition orgs. If your org is not Developer Edition, you might need to enable "Maps and Location Services" in Setup->Customize->Maps and Location -> Settings. Shared Rides Lightning Edition User Guide.pdf 4

5 Create a chatter group called Shared Rides Install the app in the org. Add the Shared Rides permission set to the relevant users. (Note that a Salesforce license is required, not a Chatter Free, Partner Community Login, or Customer Portal Manager Custom license). Give access to the record types for the pages if needed (not normally needed). Set up a mydomain so that the lightning components can be used. Shared Rides Lightning Edition User Guide.pdf 5

6 Usage Open up the Shared Rides app from the App Launcher. Initially locations and routes will need to be set up. These can also be set up for ad hoc journeys. Most of the time people will be travelling on the same routes and so they will only need to create the Shared Rides. Create Locations for the start and end of routes Click on the Locations tab. Click new Enter the location name in the Location Name field e.g. Salesforce Tower Enter the location in the Location field. This can be anything unique that Google Maps will recognise e.g. an address, postcode/zipcode, landmark, coordinates e.g. Salesforce Tower, London. Shared Rides Lightning Edition User Guide.pdf 6

7 When creating locations use save rather than save and new to allow the Google error checking to take place. Create the Routes Click on the Routes tab. Click new Give the route a name e.g. Salesforce Tower to Buckingham Palace Shared Rides Lightning Edition User Guide.pdf 7

8 Select the start location and destination from the predefined locations. Create an Event Optionally you may want to create an event which different people can offer shared rides to. Click on the Events tab. Click new Give the event a name e.g. Company AGM Select the Event Location. Shared Rides Lightning Edition User Guide.pdf 8

9 Click Save Offer a Shared Ride If you have created an Event you can go to the Related tab and create a new Shared Ride from there Shared Rides Lightning Edition User Guide.pdf 9

10 If you don t have an Event then just click on the Shared Rides tab and click new Give the ride a name e.g. Tower to Palace on Oct 1st Select the appropriate route. Choose a time and date when you are planning the journey to happen. Say how many spare seats you have. You can even create an event from this panel Shared Rides Lightning Edition User Guide.pdf 10

11 Click Save on the Create Shared Ride panel To be notified of rides being offered Join the Shared Rides chatter group Shared Rides Lightning Edition User Guide.pdf 11

12 And subscribe to it You will see chatter posts like this Shared Rides Lightning Edition User Guide.pdf 12

13 Accept a Ride When you see a ride that you want to accept, open up the relevant Shared Rides record, for example by clicking on the name of it in the chatter post and then click on the Accept Ride button Get Credit in the Dashboard Once the ride is completed mark it as such by editing the Ride Given field of the relevant Shared Ride object. Shared Rides Lightning Edition User Guide.pdf 13

14 You will be able to see this reflected in the Completed Rides by Sharer dashboard. Classic UI Instructions Follow this section if you do not have the Lightning Experience UI. Installation Create a chatter group called Shared Rides Install the app in the org Add the Shared Rides permission set to the relevant users. Give access to the record types for the pages if needed. Shared Rides Lightning Edition User Guide.pdf 14

15 Usage Open up the Shared Rides app. Initially locations and routes will need to be set up. These can also be set up for ad hoc journeys. Most of the time people will be travelling on the same routes and so they will only need to create the Shared Rides. Create Locations for the start and end of routes Click on the Locations tab. Click new Enter the location name in the Location Name field e.g. Salesforce Tower Enter the location in the Location field. This can be anything unique that Google Maps will recognise e.g. an address, postcode/zipcode, landmark, coordinates e.g. Salesforce Tower, London. Shared Rides Lightning Edition User Guide.pdf 15

16 When creating locations use save rather than save and new to allow the Google error checking to take place. Create the Routes Click on the Routes tab. Click new Give the route a name e.g. Salesforce Tower to Buckingham Palace Shared Rides Lightning Edition User Guide.pdf 16

17 Select the start location and destination from the predefined locations. Create an Event Optionally you may want to create an event which different people can offer shared rides to. Click on the Events tab. Click new Give the event a name e.g. Company AGM Shared Rides Lightning Edition User Guide.pdf 17

18 Select the Event Location. Click Save Offer a Shared Ride Click on the Shared Rides tab. Shared Rides Lightning Edition User Guide.pdf 18

19 Click new Give the ride a name e.g. Tower to Palace on Oct 1st Select the appropriate route. Choose a time and date when you are planning the journey to happen. Say how many spare seats you have. Leave the Ride Completed field empty for now. Leave the Ride Sharer field empty for now. Click Save Shared Rides Lightning Edition User Guide.pdf 19

20 To be notified of rides being offered Follow the Shared Rides chatter group Chatter Group Shared Rides Subscribe to the Shared Rides chatter group to be notified of rides offered Get Credit in the Dashboard Once the ride is completed mark it as such by editing the Ride Completed field of the relevant Shared Ride object. Green Miles Mark ride as complete Credit for miles given here Shared Rides Lightning Edition User Guide.pdf 20

21 You will be able to see this reflected in the Completed Rides by Sharer dashboard. Mobile Version This also works out of the box on a mobile using the Salesforce1 app. See these screenshots: Figure 1 - Salesforce 1 Menu including Shared Rides & Routes Figure 2 - Rides Offered in Chatter Figure 3 - List of Shared Rides Available Shared Rides Lightning Edition User Guide.pdf 21

22 Figure 4 - An Offered Ride Figure 5 - An Offered Ride Figure 6 - Acceptance Message after pressing Accept Ride button Figure 7 - An Event Figure 8 - Dashboard of Points for Giving Rides Possible enhancements Display the route using Google Maps in the Route object. Use location awareness to create locations. Request rides that have not been offered. Shared Rides Lightning Edition User Guide.pdf 22

23 Package Information Package name: Shared Rides Lightning Edition Description: Written by Sam Garforth Save travel cost by inviting fellow employees to share your ride to and from work You create the Locations, then the Routes between the Locations, then create a Shared Ride to offer an instance of the Route at a certain time. This is automatically published to the Shared Rides chatter group from which subscribers can click through to register for the ride. When the ride is complete you can mark it as such. You receive credit for having given a shared ride and this is published in a dashboard. See User Guide for detailed installation instructions. Don't forget to create the Shared Rides chatter group and assign the Shared Rides permission set to the users. Installation url: Description: Save travel cost by inviting fellow employees to share your ride to and from work Type: Unmanaged Package Components Objects (4) Component NameParent Object Component Type Event Custom Object Location Custom Object Route Custom Object Shared Ride Custom Object Tabs (4) Component NameParent Object Component Type Shared Ride Tab Location Tab Route Tab Event Tab Resources (33) Component Name Parent Object Component Type All Route List View request or offer Shared Ride Page Layout Unknown Passenger Count Shared Ride Record Type Location Layout Location Page Layout PSE_Images, Logos, Buttons Document Folder 2 Riders Layout Shared Ride Page Layout Initial Shared Ride Offering Shared Ride Page Layout Events Shared Ride List View Shared Rides Reports Report Folder Shared Rides Lightning Edition User Guide.pdf 23

24 Route Layout Route Page Layout Space for One Passenger Shared Ride Record Type Accept Ride Shared Ride Action Shared Rides by Sharer Report Event Layout Event Page Layout All Shared Ride List View X _e087aa720d_m Asset File 1 Rider Layout Shared Ride Page Layout Requested Ride Shared Ride Page Layout All Location List View Accept Ride Shared Ride Button or Link 3 Riders Layout Shared Ride Page Layout Completed Rides by Sharer Dashboard Request or offer Shared Ride Record Type Space for Three Passengers Shared Ride Record Type Shared Rides Dashboards Dashboard Folder Space for Four Passengers Shared Ride Record Type List of Rides Shared Ride Page Layout Space for Two Passengers Shared Ride Record Type All Event List View Requested Ride Shared Ride Record Type Ride Share Logo Document Shared Ride Layout Shared Ride Page Layout NewEvent2 Global Action Pages (6) Component Name Parent Object Component Type PSE_Location Visualforce Page PSE_Route Visualforce Page PSE_Event Visualforce Page PSE_Shared Ride Visualforce Page Location_Record_Page Lightning Page AcceptRide Lightning Component Bundle Apps (2) Component NameParent Object Component Type Shared Rides App Shared Rides App Workflow (20) Component Name Set Number of Spaces to 4 Set Number of Spaces to 2 Set Number of Spaces to 3 Set Number of Spaces to 1 Four Spaces Three Spaces Set Integer Number of Spaces to 2 Set Integer Number of Spaces to 1 Set Integer Number of Spaces to 4 Set Integer Number of Spaces to 3 Two Spaces Parent ObjectComponent Type Shared Ride Workflow Field Update Shared Ride Workflow Field Update Shared Ride Workflow Field Update Shared Ride Workflow Field Update Shared Ride Workflow Rule Shared Ride Workflow Rule Shared Ride Workflow Field Update Shared Ride Workflow Field Update Shared Ride Workflow Field Update Shared Ride Workflow Field Update Shared Ride Workflow Rule Shared Rides Lightning Edition User Guide.pdf 24

25 One Space Shared Ride Workflow Rule Set Full Shared Ride Workflow Field Update Set Full3 Shared Ride Workflow Field Update Set Full4 Shared Ride Workflow Field Update Set Full2 Shared Ride Workflow Field Update Update Record Type for Four Spaces Shared Ride Workflow Field Update Update Record Type for Two Spaces Shared Ride Workflow Field Update Update Record Type for One Space Shared Ride Workflow Field Update Update Record Type for Three SpacesShared Ride Workflow Field Update Code (6) Component Name Parent Object Component Type AcceptRideApexController Apex Class PSE_PostToChatter Shared Ride Apex Trigger PSE_routecontrollerTests Apex Class PSE_TestAcceptRide Apex Class PSE_TestDistance Apex Class PSE_RouteRemoter Apex Class Permission Sets (1) Component NameParent Object Component Type Shared Rides Permission Set Fields (22) Component Name Parent ObjectComponent Type Ride Sharer 3 Shared Ride Custom Field Departure Time Shared Ride Custom Field Offer/Request Shared Ride Custom Field Full Shared Ride Custom Field Total Number of spaces integershared Ride Custom Field Start Location Route Custom Field Miles Route Custom Field Event Geolocation Event Custom Field Number of spaces remaining Shared Ride Custom Field Location Location Custom Field Total number of spaces Shared Ride Custom Field Destination Route Custom Field Green Mileage Points Shared Ride Custom Field Ride Sharer 2 Shared Ride Custom Field Route Shared Ride Custom Field Event Shared Ride Custom Field Geolocation Location Custom Field Ride Sharer 1 Shared Ride Custom Field Ride Given Shared Ride Custom Field Event Date Event Custom Field Ride Sharer 4 Shared Ride Custom Field Event Location Event Custom Field Shared Rides Lightning Edition User Guide.pdf 25