OCRotationV2 - Global

OCRotationV2 is an extension of OCRotation, which is used by Fullcalendar.io and the DHTMLX On-Call Calendar. OCRotationV2 is used to get the schedule time span between two dates that are further filtered by groups, rotas, rosters, and users. You can also extend OCRotationV2 to add or modify behavior. This is part of On-Call Scheduling

OCRotationV2 - getGroups()

Get an array of groups that have active rotas.

Table 1. Parameters
Name Type Description
None
Table 2. Returns
Type Description
Array An array of group objects. Each contains the following attributes:
  • sys_id of the sys_user_group record
  • name of the sys_user_group record

OCRotationV2 - getRostersByRotas(String rotaSysIds)

Get an array of active rosters for a given rota ID.

Table 3. Parameters
Name Type Description
rotaSysIds String Comma separated list of rota sys_id (cmn_rota) values.
Table 4. Returns
Type Description
Array An array of rota objects. Each contains the following attributes:
  • sys_id of the cmn_rota_roster record
  • name of the cmn_rota_roster record
  • rota sys_id of the cmn_rota record

OCRotationV2 - getRotasByGroup(String groupSysIds)

Get an array of active rotas for a given group ID.

Table 5. Parameters
Name Type Description
groupSysIds String Comma separated list of group sys_id (sys_user_group) values.
Table 6. Returns
Type Description
Array An array of rota objects. Each contains the following attributes:
  • sys_id of the cmn_rota record
  • name of the cmn_rota record
  • group sys_id of the sys_user_group record

OCRotationV2 - getSpans()

Get the spans from the specified start date to the specified end date. If no start and end dates are provided, the start date defaults to a month before and the end date defaults to a month after the current time. You can also use the groups IDs, rota IDs, roster IDs, user IDs to further filter the spans.

Table 7. Parameters
Name Type Description
None
Table 8. Returns
Type Description
Array An array of spans. Each contains the following attributes: id, sys_id, table, rota_id, roster_id, user_id, text, description, color, textColor, start_date, end_date.
Get all spans for the default time period
var spans = new OCRotationV2().getSpans();
var firstSpanStartDate = spans[0].start_date; // get the first span's start date
Get all spans between 1st April 2014 and 5th June 2014
var spans = new OCRotationV2()
    .setStartDate("2014-04-01")
    .setEndDate("2014-06-05")
    .getSpans();
Get the Network group's spans for the default time period
var spans = new OCRotationV2()
     .setGroupIds("287ebd7da9fe198100f92cc8d1d2154e")
     .getSpans();
Get ITIL User's spans between 1st January 2014 and 31st January 2014
var spans = new OCRotationV2()
    .setStartDate("2014-01-01")
    .setEndDate("2014-01-31")
    .setUserIds("681b365ec0a80164000fb0b05854a0cd")
    .getSpans();