Custom Event Actions

Event actions let you add your own actions to everyday behaviors in the calendar. You can attach actions to clicking, saving, or deleting an event. As with button actions, actions can be performed by opening a URL or running JavaScript code. Unlike custom button actions--where users initiate the action by clicking a button--event actions are initiated by things users are already doing in the calendar: clicking on an item, saving an item, or deleting an item.

Uses for event actions

Event actions are used to change the way DayBack behaves. You might use one to prevent deletion of events in certain cases or to jump right to your own Salesforce page instead of editing an item in DayBack's popover. 

Think of event actions as "hijacking" DayBack's native behavior: in addition to <whatever DayBack does when you save an event> I want to do <this>.

Creating an event action

Creating a new action is pretty easy:

1

Log in to  admin settings and select the source you're interested in.

2

Scroll down past the Source Settings and Field Mapping until you see "Event Actions"

3

Click "Add New Event Action" and pick the event that should trigger the action.

4

Paste the code you'd like to execute where it says "URL or JavaScript". This is obviously the tricky part--writing the action itself. Don't hesitate to get in touch and ask for help. (Note that you can also drag JS files into the code editor in DayBack if you'd rather compose your JavaScript functions in your own editor.)

5

That's it.

Events that can trigger actions

On Event Create

• Actions here happen right when a new event is created on the calendar.
• This happens right before the popover is rendered, so you can modify the editEvent object to set field values as desired.
• "Prevent default action" would stop DayBack from creating a new event and rendering the event popover.
• See objects available in this context here.

On Event Click

• Actions set to this trigger will fire whenever a user clicks on an event in DayBack.
• They'll also fire as soon as a new event is created, so you can also think of this trigger as "on popover render"
• "Prevent default action" in this case prevents the popover from rendering. 
• See objects available in this context here.

On Event Hover

• Actions will fire whenever a user hovers over an event: most often used for tooltips
• There is no default hover behavior, so "Prevent default action" does nothing.
• See objects available in this context here.

On Field Change

• Actions here will fire when a value is selected for a field in the popover
• Supported fields are Calendar, Status, Resource, Contact, and Project, along with any custom field.
• Use the params.data object for details of what changed.
• "Prevent default action" will prevent the field from being updated in the popover unless action.callbacks.confirm() is called
• Fields can be updated within the popover using this action. See the load contact address example below.
• See objects available in this context here.

Before Event Save

• Actions here would happen before changes to an event are processed.
• This happens when users click "Save..." in the item's popover, or when they complete a drag operation in the calendar.
• This is the best trigger for when you need to mutate the event before it is saved.
• "Prevent default action" would stop DayBack from continuing to save the action, but you could end your event action with code to execute the save yourself. This is how the example below for preventing dragging from changing an event's time works.
• See objects available in this context here.

On Event Save

• The action is triggered after DayBack processes the changes but just before the changes are written to the data store.
• This happens after the Before Event Save trigger, after the event changes have been processed.
• "Prevent default action" would stop DayBack from writing the changes back to the data store, but you could end your event action with code to execute the save yourself. 
• This is useful for writing changes to an alternate place (cloning data to another data store), or mutating the data before it is sent to the data store. For example, if you want to prevent DayBack from trying to write back to a formula/calculated field.
• DayBack lets users undo their changes; your action can test for the undo property and behave differently when edits are reverted.
• See objects available in this context here.

On Event Delete

• The only way this action gets triggered is from the "Delete" button inside DayBack's popover.
• Like On Event Save, "Prevent default action" here would stop DayBack from writing the delete back to the data store (Google or Salesforce, for example).
• See objects available in this context here.

Note that "On Event Save" and "On Event Delete" actions can affect the "Saved" and "Deleted" notifications that pop up from the bottom of the screen to confirm an event. If you select "Prevent default action" to be "yes", DayBack will not show the success notification after your action because DayBack wouldn't know if your action saved or deleted the event after all. You can, however, call the notification in your own code. =) 

Examples

Here are some example actions to get you thinking about how you can customize your calendar. Please copy and paste these into your DayBack, and don't hesitate to reach out if you get stuck.

Remember that you have access to fields from your Salesforce item when your action executes. These fields are represented by "data tokens" where the fields you've mapped to your event can be wrapped in [[double brackets]] when used in your actions. You also have access to the state of your item before a user began editing it =) Learn more about data tokens, event attributes, and the functions available to your event actions here:  APIs: Resources for Custom and Event Actions.

Prevent Resource Conflicts in Salesforce

Force single selection for statuses and/or resources

Specify resources shown for each calendar with tags

Prevent popovers from displaying

Go right to the item on click

fbk.publish ( "dbk.navigate" , { "url" : "/[[Id]]" , "new" : false } )
		

Change the event's status if a checkbox is checked.

// Standard way of referring to Custom Fields by numerical ID:

editEvent['1234996543210-4152637485'] = meetingAttendedFlag;

// Example function call that looks up the numerical ID by your
// application's Store in Field name:

editEvent[getFieldIdByName('meetingAttendedFlag')] = meetingAttendedFlag;
		

Prevent dragging from changing an event's time

//Before Event Save
function noTimeChange() {
    //drag and drop or popover edit?
    if(event.beforeDrop) {
      if(event.allDay!==event.beforeDrop.allDay || !event.start.isSame(event.beforeDrop.start) || !event.end.isSame(event.beforeDrop.end)) {
        event.allDay = event.beforeDrop.allDay;
        event.start = event.beforeDrop.start.clone();
        event.end = event.beforeDrop.end.clone();
      }
  }
}
noTimeChange();
		

Add a default duration to an event

// Set default duraton

Initialize(editEvent, seedcodeCalendar);

function Initialize(editEvent, seedcodeCalendar) {
    editEvent.end = moment(editEvent.start).add(30, 'm'); // Default duration is 30 min
  
}
		

Prevent dragging from changing an event

//Revert changes if the event was dragged and dropped
if (event.beforeDrop) {
  action.callbacks.cancel();
}
else{
  action.callbacks.confirm();
}
		

Retrieve custom parameter from URL

//Gets the sessionID parameter from the URL and populates the additional field
function getSessionID() {
  'use strict';

  var sessionID = getUrlVars().sessionID;
  editEvent['1234996543210-4152637485'] = sessionID;
}

//Function to retrieve parameters from the URL
function getUrlVars() {
  'use strict';

    var vars = {};
    var parts = location.href.substring(0, location.href.indexOf('#/')).replace(/[?&]+([^=&]+)=([^&]*)/gi, function(m,key,value) {
        vars[key] = value;
    });
    return vars;
}

getSessionID();
		

Make past events read-only

Send an email when an event is set to a specified status

Add a default Event Contact for all events

Load Contact Address To Event Location

Disable All-Day Events

Assign the Logged In User as a New Event's Resource

//Add's the creator as a resource to new events

Initialize(editEvent, seedcodeCalendar);

function Initialize(editEvent, seedcodeCalendar) {
  editEvent.resource = [seedcodeCalendar.get('config').accountName];
}
		

Cascading Changes Through Linked Events

Confirm Appointments or Collect Information in a Form

Validate Data Entry

Check Resource Capacity

Warning when Creating in the Past

Looking up a Resource ID by Name (Salesforce)

Override Start Field when editing (Salesforce)

if ( $User.Id = OwnerId , If( IsAllDayEvent , DATETIMEVALUE(ActivityDate) , ActivityDateTime ) , DATETIMEVALUE('') )
		

Merge information to/from Google Calendar (Salesforce)

Push events to Google Calendar

Change Behaviors when Special Keys are pressed

Remove Attendees from Events when Duplicating (Google Calendar)

event.attendees = [];
		

Default Values for each Resource

Require Tags/Skills for an Event