---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OCRotaICalendarSNC - Global

# OCRotaICalendarSNC - Global {#ariaid-title1}

L'include de script OCRotaICalendarSNC fournit des événements au format iCal pour la rotation d'un utilisateur spécifique.

## OCRotaICalendarSNC - cleanExpiredCache () {#ariaid-title2}

Enregistrements de la table cmn_rota_resp_cache dont la date de début est antérieure à aujourd'hui.
{#r_OCRICalSNC-cleanExpiredCache__table_a4p_3l3_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#r_OCRICalSNC-cleanExpiredCache__table_a4p_3l3_hx} {#r_OCRICalSNC-cleanExpiredCache__table_b4p_3l3_hx__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 2. Renvoie]

{#r_OCRICalSNC-cleanExpiredCache__table_b4p_3l3_hx}

## OCRotaICalendarSNC : createCalendarEvents (String groupId, String rotaId, String userId, Object dateRangeObj) {#ariaid-title3}

Renvoie la liste des AJAXScheduleItems pour l'astreinte de l'utilisateur.
{#r_OCRICalSNC-createCalEvent_S_S_S_O__table_cbl_mtg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupId | Chaîne | ID système du groupe. |
| rotaId | Chaîne | ID système de rotation. |
| userId | Chaîne | ID système de l'utilisateur. |
| dateRangeObj | Objet | Contient les dates de début et de fin de l'ensemble de données. |
[Tableau 3. Paramètres]

{#r_OCRICalSNC-createCalEvent_S_S_S_O__table_cbl_mtg_hx} {#r_OCRICalSNC-createCalEvent_S_S_S_O__table_dbl_mtg_hx__entry__2}

| Type | Description |
|-|-|
| AJAXScheduleItem (Élément AJAXSchedule) | Liste Java des AJAXScheduleItems. |
[Tableau 4. Renvoie]

{#r_OCRICalSNC-createCalEvent_S_S_S_O__table_dbl_mtg_hx}

## OCRotaICalendarSNC : createCustomEvent (String groupName, Object scheduleItemSpan, String calendarLink) {#ariaid-title4}

Crée un VEVENT en fonction du scheduleItemSpan fourni.
{#r_OCRICalSNC-createCustomEvnt_S_O_S__table_xqv_s33_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupName | Chaîne | Nom du groupe d'astreinte. |
| scheduleItemSpan (en anglais seulement) | Objet | Durée de la période d'astreinte. |
| calendarLink | Chaîne | Un lien vers le calendrier d'astreinte dans l'instance. |
[Tableau 5. Paramètres]

{#r_OCRICalSNC-createCustomEvnt_S_O_S__table_xqv_s33_hx} {#r_OCRICalSNC-createCustomEvnt_S_O_S__table_yqv_s33_hx__entry__2}

| Type | Description |
|-|-|
| Chaîne | VEVENT basé sur scheduleItemSpan fourni. |
[Tableau 6. Renvoie]

{#r_OCRICalSNC-createCustomEvnt_S_O_S__table_yqv_s33_hx}

## OCRotaICalendarSNC : createPlaceholderCalendar (GlideRecord, rotaGR, object, : dateRangeObj, String, calendarLink) {#ariaid-title5}

Crée un iAgenda formaté si l'utilisateur n'a pas d'astreinte à venir.
{#r_OCRICalSNC-createPCalendar_GR_O_S__table_zzb_nrg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| rotaGR | GlideRecord | L'enregistrement de glissement cmn_rota. |
| dateRangeObj | Objet | Contient les dates de début et de fin de l'ensemble de données. |
| calendarLink | Chaîne | Lien vers le calendrier d'astreinte de cet utilisateur. |
[Tableau 7. Paramètres]

{#r_OCRICalSNC-createPCalendar_GR_O_S__table_zzb_nrg_hx} {#r_OCRICalSNC-createPCalendar_GR_O_S__table_a1c_nrg_hx__entry__2}

| Type | Description |
|-|-|
| Chaîne | iCalendar formaté avec un espace réservé VEVENT. |
[Tableau 8. Renvoie]

{#r_OCRICalSNC-createPCalendar_GR_O_S__table_a1c_nrg_hx}

## OCRotaICalendarSNC -- getCalendarEvents (String groupId , String rotaId, String userId , Object dateRangeObj, Boolean useCache) {#ariaid-title6}

Renvoie l'iCalendar formaté pour la rotation de l'utilisateur.
{#r_OCRICalSNC-gCalendarE_S_S_S_O_B__table_m3t_zpg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupId | Chaîne | ID système du groupe. |
| rotaId | Chaîne | ID système de rotation. |
| userId | Chaîne | ID système de l'utilisateur. |
| dateRangeObj | Objet | Contient les dates de début et de fin de l'ensemble de données. |
| useCache (en anglais seulement) | Booléen | Si la valeur est vraie, utilise la table de cache cmn_rota_resp_cache. |
[Tableau 9. Paramètres]

{#r_OCRICalSNC-gCalendarE_S_S_S_O_B__table_m3t_zpg_hx} {#r_OCRICalSNC-gCalendarE_S_S_S_O_B__table_n3t_zpg_hx__entry__2}

| Type | Description |
|-|-|
| Chaîne | iCalendar formaté pour la rotation de l'utilisateur. |
[Tableau 10. Renvoie]

{#r_OCRICalSNC-gCalendarE_S_S_S_O_B__table_n3t_zpg_hx}

## OCRotaICalendarSNC : getEventsFromTable (chaîne groupId, chaîne rotaId, chaîne userId, objet dateRangeObj) {#ariaid-title7}

Renvoie l'iCalendar formaté pour la rotation de l'utilisateur s'il se trouve dans la table cmn_rota_resp_cache.
{#r_OCRICalSNC-getEventsFTble_S_S_S_O__table_k2m_qsg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupId | Chaîne | ID système du groupe. |
| rotaId | Chaîne | ID système de rotation. |
| userId | Chaîne | ID système de l'utilisateur. |
| dateRangeObj | Objet | Contient les dates de début et de fin de l'ensemble de données. |
[Tableau 11. Paramètres]

{#r_OCRICalSNC-getEventsFTble_S_S_S_O__table_k2m_qsg_hx} {#r_OCRICalSNC-getEventsFTble_S_S_S_O__table_l2m_qsg_hx__entry__2}

| Type | Description |
|-|-|
| Chaîne | iCalendar formaté pour la rotation de l'utilisateur s'il se trouve dans la table cmn_rota_resp_cache. |
[Tableau 12. Renvoie]

{#r_OCRICalSNC-getEventsFTble_S_S_S_O__table_l2m_qsg_hx}

## OCRotaICalendarSNC : getIntersectRotaSpanItem (ScheduleTimeSpan timeSpan, Array rotaSpanItems) {#ariaid-title8}

Vérifie si le timeSpan fourni intersecte l'un des éléments du parcours de rotation.
{#r_OCRICalSNC-getIntrRotSpnItm_STS_A__table_ltr_d33_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| intervalle de temps | ScheduleTimeSpan (Intervalle de temps d'exécution) | Un parcours unique pour l'astreinte de l'utilisateur. |
| éléments rotaSpan | Tableau | Contient les étendues d'astreinte standard de l'utilisateur. |
[Tableau 13. Paramètres]

{#r_OCRICalSNC-getIntrRotSpnItm_STS_A__table_ltr_d33_hx} {#r_OCRICalSNC-getIntrRotSpnItm_STS_A__table_mtr_d33_hx__entry__2}

| Type | Description |
|-|-|
| Objet | Si timeSpan intersecte l'un des éléments de parcours de rotation, renvoie un objet contenant l'élément de parcours de rotation et le parcours avec lequel il intersecte. |
[Tableau 14. Renvoie]

{#r_OCRICalSNC-getIntrRotSpnItm_STS_A__table_mtr_d33_hx}

## OCRotaICalendarSNC : getMemberCalendarURL (String groupId, Object rotaId, String userId) {#ariaid-title9}

Crée l'URL à abonnement possible pour l'iCalendar de l'utilisateur.
{#r_OCRICalSNC-getMemCalURL_S_O_S__table_t1c_sn3_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupId | Chaîne | ID système du groupe. |
| rotaId | Objet | ID système de rotation. |
| userId | Chaîne | ID système de l'utilisateur. |
[Tableau 15. Paramètres]

{#r_OCRICalSNC-getMemCalURL_S_O_S__table_t1c_sn3_hx} {#r_OCRICalSNC-getMemCalURL_S_O_S__table_u1c_sn3_hx__entry__2}

| Type | Description |
|-|-|
| Chaîne | URL à abonnement possible pour l'iCalendar de l'utilisateur. |
[Tableau 16. Renvoie]

{#r_OCRICalSNC-getMemCalURL_S_O_S__table_u1c_sn3_hx}

## OCRotaICalendarSNC : getOnCallCalendarURL (GlideRecord rotaGR) {#ariaid-title10}

Renvoie une URL au calendrier d'astreinte en fonction de l'enregistrement de rotation.
{#r_OCRICalSNC-getOnCallCalURL_GR__table_ytj_ql3_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| rotaGR | GlideRecord | Un enregistrement cmn_rota. |
[Tableau 17. Paramètres]

{#r_OCRICalSNC-getOnCallCalURL_GR__table_ytj_ql3_hx} {#r_OCRICalSNC-getOnCallCalURL_GR__table_ztj_ql3_hx__entry__2}

| Type | Description |
|-|-|
| Chaîne | URL du calendrier d'astreinte basé sur l'enregistrement de rotation. |
[Tableau 18. Renvoie]

{#r_OCRICalSNC-getOnCallCalURL_GR__table_ztj_ql3_hx}

## OCRotaICalendarSNC : handleOverrideMember (AJAXScheduleItem, scheduleItem) {#ariaid-title11}

Renvoie un tableau des remplacements de l'utilisateur (couverture supplémentaire).
{#r_OCRICalSNC-handleOverrideMem_ASI__table_lvd_zxg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| scheduleItem (en anglais seulement) | AJAXScheduleItem (Élément AJAXSchedule) | Une liste d'AJAXScheduleItems. |
[Tableau 19. Paramètres]

{#r_OCRICalSNC-handleOverrideMem_ASI__table_lvd_zxg_hx} {#r_OCRICalSNC-handleOverrideMem_ASI__table_mvd_zxg_hx__entry__2}

| Type | Description |
|-|-|
| Tableau | Tableau des remplacements de l'utilisateur (couverture supplémentaire). |
[Tableau 20. Renvoie]

{#r_OCRICalSNC-handleOverrideMem_ASI__table_mvd_zxg_hx}

## OCRotaICalendarSNC - handleRotaMember (AjaxSchedueItem, scheduleItem , Object rotaSpanItems, Object definitionItems, Array repeatRotaSpanIdArr) {#ariaid-title12}

Renvoie un objet contenant le remplacement de l'utilisateur (couverture supplémentaire) et les parcours exclus.
{#r_OCRICalSNC-handleRotMem_Aj_O_O_A__table_kdm_wwg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| scheduleItem (en anglais seulement) | AJAXSchedueItem (en anglais seulement) | Une liste d'AJAXScheduleItems. |
| éléments rotaSpan | Objet | Contient les étendues d'astreinte standard de l'utilisateur. |
| Éléments définitions | Objet | Contient les durées d'astreinte standard de la rotation. |
| repeatRotaSpanIdArr | Tableau | Tableau d'ID système de parcours de rotation. |
[Tableau 21. Paramètres]

{#r_OCRICalSNC-handleRotMem_Aj_O_O_A__table_kdm_wwg_hx} {#r_OCRICalSNC-handleRotMem_Aj_O_O_A__table_ldm_wwg_hx__entry__2}

| Type | Description |
|-|-|
| Objet | Contient le remplacement de l'utilisateur (couverture supplémentaire) et les étendues exclues. |
[Tableau 22. Renvoie]

{#r_OCRICalSNC-handleRotMem_Aj_O_O_A__table_ldm_wwg_hx}

## OCRotaICalendarSNC : invalidateRotaRespCache (GlideRecord rotaRespCacheGR) {#ariaid-title13}

Utilisé par les règles métier sur les tables cmn_rota_member, cmn_schedule_span et roster_schedule_span pour mettre à jour la table cmn_rota_resp_cache.
{#r_OCRICalSNC-invalRotaRespCache_GR__table_uzk_wk3_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| rotaRespCacheGR | GlideRecord | Enregistrement qui a été mis à jour. |
[Tableau 23. Paramètres]

{#r_OCRICalSNC-invalRotaRespCache_GR__table_uzk_wk3_hx} {#r_OCRICalSNC-invalRotaRespCache_GR__table_vzk_wk3_hx__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 24. Renvoie]

{#r_OCRICalSNC-invalRotaRespCache_GR__table_vzk_wk3_hx}

## OCRotaICalendarSNC - matchRotaSpanRule(ScheduleTimeSpan timeSpan, Array rotaSpanItems, Array repeatRotaSpanIdArr, Object seriesStartTimes) {#ariaid-title14}

Vérifie si le timeSpan fourni correspond à l'un des rotaSpanItems.
{#r_OCRICalSNC-mthRotSpnRul_STS_A_A_O__table_zcb_syg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| intervalle de temps | ScheduleTimeSpan (Intervalle de temps d'exécution) | Un parcours unique pour l'astreinte de l'utilisateur. |
| éléments rotaSpan | Tableau | Contient les étendues d'astreinte standard de l'utilisateur. |
| repeatRotaSpanIdArr | Tableau | Tableau d'ID système de parcours de rotation. |
| seriesStartTimes | Objet | Heure de début des travées de rotation. |
[Tableau 25. Paramètres]

{#r_OCRICalSNC-mthRotSpnRul_STS_A_A_O__table_zcb_syg_hx} {#r_OCRICalSNC-mthRotSpnRul_STS_A_A_O__table_adb_syg_hx__entry__2}

| Type | Description |
|-|-|
| Booléen | Renvoie la valeur true si timeSpan correspond à l'un des rotaSpanItems. |
[Tableau 26. Renvoie]

{#r_OCRICalSNC-mthRotSpnRul_STS_A_A_O__table_adb_syg_hx}

## OCRotaICalendarSNC : populateCalendarSubscriptionSettings () {#ariaid-title15}

Utilisé par la tâche fixe pour renseigner les champs d'abonnement au calendrier sur le formulaire cmn_rota
{#r_OCRICalSNC-populateCalSubsSetting__table_y5h_p43_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 27. Paramètres]

{#r_OCRICalSNC-populateCalSubsSetting__table_y5h_p43_hx} {#r_OCRICalSNC-populateCalSubsSetting__table_z5h_p43_hx__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 28. Renvoie]

{#r_OCRICalSNC-populateCalSubsSetting__table_z5h_p43_hx}

## OCRotaICalendarSNC - processSeriesEvent (List scheduleItems, Array repeatRotaSpanIdArr , String userId) {#ariaid-title16}

Renvoie un objet contenant les rotations de l'utilisateur.
{#r_OCRICalSNC-procesSeriesEvnt_L_A_S__table_y4m_yvg_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| Éléments de calendrier | Liste | La rotation d'astreinte de l'utilisateur sous forme de liste AJAXScheduleItem. |
| repeatRotaSpanIdArr | Tableau | Tableau des sys_ids d'enregistrement de parcours de calendrier cmn_rota. |
| userId | Chaîne | ID système de l'utilisateur. |
[Tableau 29. Paramètres]

{#r_OCRICalSNC-procesSeriesEvnt_L_A_S__table_y4m_yvg_hx} {#r_OCRICalSNC-procesSeriesEvnt_L_A_S__table_z4m_yvg_hx__entry__2}

| Type | Description |
|-|-|
| Objet | Contient les rotations de l'utilisateur. |
[Tableau 30. Renvoie]

{#r_OCRICalSNC-procesSeriesEvnt_L_A_S__table_z4m_yvg_hx}

## OCRotaICalendarSNC : saveCalendarEvents (String groupId, String rotaId, String userId, Object dateRangeObj, String result) {#ariaid-title17}

Insère l'iCalendar de l'utilisateur dans la table cmn_rota_resp_cache.
{#r_OCRICalSNC-saveCalEvnts_S_S_S_O_S__table_z4x_fk3_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupId | Chaîne | ID système du groupe. |
| rotaId | Chaîne | ID système de rotation. |
| userId | Chaîne | ID système de l'utilisateur. |
| dateRangeObj | Objet | Contient les dates de début et de fin de l'ensemble de données. |
| résultat | Chaîne | L'iCalendar de l'utilisateur |
[Tableau 31. Paramètres]

{#r_OCRICalSNC-saveCalEvnts_S_S_S_O_S__table_z4x_fk3_hx} {#r_OCRICalSNC-saveCalEvnts_S_S_S_O_S__table_apx_fk3_hx__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 32. Renvoie]

{#r_OCRICalSNC-saveCalEvnts_S_S_S_O_S__table_apx_fk3_hx}

## OCRotaICalendarSNC : sendCalendarURL (GlideRecord rotaGR) {#ariaid-title18}

Met en file d'attente les événements pour envoyer un e-mail à tous les membres de la rotation.
{#r_OCRICalSNC-sendCalendarURL_GR__table_zhc_f43_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| rotaGR | GlideRecord | Un enregistrement cmn_rota. |
[Tableau 33. Paramètres]

{#r_OCRICalSNC-sendCalendarURL_GR__table_zhc_f43_hx} {#r_OCRICalSNC-sendCalendarURL_GR__table_a3c_f43_hx__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 34. Renvoie]

{#r_OCRICalSNC-sendCalendarURL_GR__table_a3c_f43_hx}

## OCRotaICalendarSNC : updateExceptionList (AJAXScheduleItem, scheduleItem, ScheduleTimeSpan, timeSpan, Array, rotaSpanItems) {#ariaid-title19}

Renvoie un objet qui contient tous les intervalles de temps qui doivent être exclus de l'iCalendar de l'utilisateur.
{#r_OCRICalSNC-updExcptnLst_ASI_STS_A__table_fyt_nj3_hx__entry__3}

| Nom | Type | Description |
|-|-|-|
| scheduleItem (en anglais seulement) | AJAXScheduleItem (Élément AJAXSchedule) | Un AJAXScheduleItem. |
| intervalle de temps | ScheduleTimeSpan (Intervalle de temps d'exécution) | Durée d'astreinte standard d'un seul utilisateur. |
| éléments rotaSpan | Tableau | Contient les étendues d'astreinte standard de l'utilisateur. |
[Tableau 35. Paramètres]

{#r_OCRICalSNC-updExcptnLst_ASI_STS_A__table_fyt_nj3_hx} {#r_OCRICalSNC-updExcptnLst_ASI_STS_A__table_gyt_nj3_hx__entry__2}

| Type | Description |
|-|-|
| Objet | Objet contenant tous les intervalles de temps qui doivent être exclus de l'iCalendar de l'utilisateur. |
[Tableau 36. Renvoie]

{#r_OCRICalSNC-updExcptnLst_ASI_STS_A__table_gyt_nj3_hx}