---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OCRotaICalendarSNC - Global

# OCRotaICalendarSNC - Global {#ariaid-title1}

A inclusão de script OCRotaICalendarSNC fornece eventos no formato iCal para a rotação de um usuário específico.

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

Registros na tabela cmn_rota_resp_cache que têm uma data "De" anterior a hoje.
{#r_OCRICalSNC-cleanExpiredCache__table_a4p_3l3_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 2. Retorna]

{#r_OCRICalSNC-cleanExpiredCache__table_b4p_3l3_hx}

## OCRotaICalendarSNC -- createCalendarEvents (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj) {#ariaid-title3}

Retorna a lista de AJAXScheduleItems para o plantão do usuário.
{#r_OCRICalSNC-createCalEvent_S_S_S_O__table_cbl_mtg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupId | Cadeia de caracteres | O SYS ID do grupo. |
| rotaId | Cadeia de caracteres | O SYS ID da escala. |
| userId | Cadeia de caracteres | O SYS ID do usuário. |
| dateRangeObj | Objeto | Contém as datas de início e fim do conjunto de dados. |
[Tabela 3. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| AJAXScheduleItem | Lista Java de AJAXScheduleItems. |
[Tabela 4. Retorna]

{#r_OCRICalSNC-createCalEvent_S_S_S_O__table_dbl_mtg_hx}

## OCRotaICalendarSNC -- createCustomEvent (cadeia de caracteres groupName, objeto scheduleItemSpan, cadeia de caracteres calendarLink) {#ariaid-title4}

Cria um VEVENT com base no scheduleItemSpan fornecido.
{#r_OCRICalSNC-createCustomEvnt_S_O_S__table_xqv_s33_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupName | Cadeia de caracteres | Nome do grupo de plantão. |
| scheduleItemSpan | Objeto | Período de tempo para o período de plantão. |
| calendarLink | Cadeia de caracteres | Um link de volta para o calendário de plantão na instância. |
[Tabela 5. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Um VEVENT com base no scheduleItemSpan fornecido. |
[Tabela 6. Retorna]

{#r_OCRICalSNC-createCustomEvnt_S_O_S__table_yqv_s33_hx}

## OCRotaICalendarSNC -- createPlaceholderCalendar (GlideRecord rotaGR, objeto dateRangeObj, cadeia de caracteres calendarLink) {#ariaid-title5}

Cria um iCalendar formatado se o usuário não tiver nenhum plantão programado.
{#r_OCRICalSNC-createPCalendar_GR_O_S__table_zzb_nrg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| rotaGR | GlideRecord | O registro do glide cmn_rota. |
| dateRangeObj | Objeto | Contém as datas de início e fim do conjunto de dados. |
| calendarLink | Cadeia de caracteres | Um link para o calendário de plantão deste usuário. |
[Tabela 7. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | iCalendar formatado com um espaço reservado VEVENT. |
[Tabela 8. Retorna]

{#r_OCRICalSNC-createPCalendar_GR_O_S__table_a1c_nrg_hx}

## OCRotaICalendarSNC -- getCalendarEvents (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj, booliano useCache) {#ariaid-title6}

Retorna o iCalendar formatado para a rotação do usuário.
{#r_OCRICalSNC-gCalendarE_S_S_S_O_B__table_m3t_zpg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupId | Cadeia de caracteres | O SYS ID do grupo. |
| rotaId | Cadeia de caracteres | O SYS ID da escala. |
| userId | Cadeia de caracteres | O SYS ID do usuário. |
| dateRangeObj | Objeto | Contém as datas de início e fim do conjunto de dados. |
| usarCache | Booliano | Se verdadeiro, usa a tabela de cache cmn_rota_resp_cache. |
[Tabela 9. Parâmetros]

{#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}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | iCalendar formatado para a rotação do usuário. |
[Tabela 10. Retorna]

{#r_OCRICalSNC-gCalendarE_S_S_S_O_B__table_n3t_zpg_hx}

## OCRotaICalendarSNC -- getEventsFromTable (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj) {#ariaid-title7}

Retorna o iCalendar formatado para a rotação do usuário, se encontrado na tabela cmn_rota_resp_cache.
{#r_OCRICalSNC-getEventsFTble_S_S_S_O__table_k2m_qsg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupId | Cadeia de caracteres | O SYS ID do grupo. |
| rotaId | Cadeia de caracteres | O SYS ID da escala. |
| userId | Cadeia de caracteres | O SYS ID do usuário. |
| dateRangeObj | Objeto | Contém as datas de início e fim do conjunto de dados. |
[Tabela 11. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | iCalendar formatado para a rotação do usuário, se encontrado na tabela cmn_rota_resp_cache. |
[Tabela 12. Retorna]

{#r_OCRICalSNC-getEventsFTble_S_S_S_O__table_l2m_qsg_hx}

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

Verifica se o timeSpan fornecido cruza com um dos itens de período de escala.
{#r_OCRICalSNC-getIntrRotSpnItm_STS_A__table_ltr_d33_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| timeSpan | ScheduleTimeSpan | Um único período para o plantão do usuário. |
| rotaSpanItems | Matriz | Contém os períodos de plantão padrão do usuário. |
[Tabela 13. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Se o timeSpan fizer interseção com um dos itens de período de escala, retornará um objeto que contém o item de período de escala e o período com o qual ele faz a interseção. |
[Tabela 14. Retorna]

{#r_OCRICalSNC-getIntrRotSpnItm_STS_A__table_mtr_d33_hx}

## OCRotaICalendarSNC -- getMemberCalendarURL (cadeia de caracteres groupId, rotaId de objeto, cadeia de caracteres userId) {#ariaid-title9}

Cria o URL sujeito à assinatura para o iCalendar do usuário.
{#r_OCRICalSNC-getMemCalURL_S_O_S__table_t1c_sn3_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupId | Cadeia de caracteres | O SYS ID do grupo. |
| rotaId | Objeto | O SYS ID da escala. |
| userId | Cadeia de caracteres | O SYS ID do usuário. |
[Tabela 15. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O URL sujeito à assinatura para o iCalendar do usuário. |
[Tabela 16. Retorna]

{#r_OCRICalSNC-getMemCalURL_S_O_S__table_u1c_sn3_hx}

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

Retorna um URL para o calendário de plantão com base no registro de escala.
{#r_OCRICalSNC-getOnCallCalURL_GR__table_ytj_ql3_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| rotaGR | GlideRecord | Um registro cmn_rota. |
[Tabela 17. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | URL para o calendário de plantão com base no registro de escala. |
[Tabela 18. Retorna]

{#r_OCRICalSNC-getOnCallCalURL_GR__table_ztj_ql3_hx}

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

Retorna uma matriz de substituições do usuário (cobertura extra).
{#r_OCRICalSNC-handleOverrideMem_ASI__table_lvd_zxg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| scheduleItem | AJAXScheduleItem | Uma lista de AJAXScheduleItems. |
[Tabela 19. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Matriz | Uma matriz de substituições do usuário (cobertura extra). |
[Tabela 20. Retorna]

{#r_OCRICalSNC-handleOverrideMem_ASI__table_mvd_zxg_hx}

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

Retorna um objeto que contém a substituição do usuário (cobertura extra) e períodos excluídos.
{#r_OCRICalSNC-handleRotMem_Aj_O_O_A__table_kdm_wwg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| scheduleItem | AJAXSchedueItem | Uma lista de AJAXScheduleItems. |
| rotaSpanItems | Objeto | Contém os períodos de plantão padrão do usuário. |
| itensDefinição | Objeto | Contém os períodos de plantão padrão da escala. |
| repeatRotaSpanIdArr | Matriz | Uma matriz de SYS IDs de período de escala. |
[Tabela 21. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Contém a substituição do usuário (cobertura extra) e os períodos excluídos. |
[Tabela 22. Retorna]

{#r_OCRICalSNC-handleRotMem_Aj_O_O_A__table_ldm_wwg_hx}

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

Usado por regras de negócio nas tabelas cmn_rota_member, cmn_schedule_span e roster_schedule_span para atualizar a tabela cmn_rota_resp_cache.
{#r_OCRICalSNC-invalRotaRespCache_GR__table_uzk_wk3_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| rotaRespCacheGR | GlideRecord | Registro que foi atualizado. |
[Tabela 23. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 24. Retorna]

{#r_OCRICalSNC-invalRotaRespCache_GR__table_vzk_wk3_hx}

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

Verifica se o timeSpan fornecido corresponde a um dos rotaSpanItems.
{#r_OCRICalSNC-mthRotSpnRul_STS_A_A_O__table_zcb_syg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| timeSpan | ScheduleTimeSpan | Um único período para o plantão do usuário. |
| rotaSpanItems | Matriz | Contém os períodos de plantão padrão do usuário. |
| repeatRotaSpanIdArr | Matriz | Uma matriz de SYS IDs de período de escala. |
| sériesInícioHoras | Objeto | Hora de início dos períodos de rotação. |
[Tabela 25. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Retorna verdadeiro se o timeSpan corresponder a um dos rotaSpanItems. |
[Tabela 26. Retorna]

{#r_OCRICalSNC-mthRotSpnRul_STS_A_A_O__table_adb_syg_hx}

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

Usado pelo trabalho fixo para preencher os campos de assinatura de calendário no formulário cmn_rota
{#r_OCRICalSNC-populateCalSubsSetting__table_y5h_p43_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 27. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 28. Retorna]

{#r_OCRICalSNC-populateCalSubsSetting__table_z5h_p43_hx}

## OCRotaICalendarSNC -- processSeriesEvent (ScheduleItems de lista, matriz repeatRotaSpanIdArr, userId de cadeia de caracteres) {#ariaid-title16}

Retorna um objeto que contém as rotações do usuário.
{#r_OCRICalSNC-procesSeriesEvnt_L_A_S__table_y4m_yvg_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| scheduleItems | Lista | A rotação de plantão do usuário como uma lista AJAXScheduleItem. |
| repeatRotaSpanIdArr | Matriz | Uma matriz de sys_ids do registro de período de programação cmn_rota. |
| userId | Cadeia de caracteres | O SYS ID do usuário. |
[Tabela 29. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Contém as rotações do usuário. |
[Tabela 30. Retorna]

{#r_OCRICalSNC-procesSeriesEvnt_L_A_S__table_z4m_yvg_hx}

## OCRotaICalendarSNC -- saveCalendarEvents (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj, resultado de cadeia de caracteres) {#ariaid-title17}

Insere o iCalendar do usuário na tabela cmn_rota_resp_cache.
{#r_OCRICalSNC-saveCalEvnts_S_S_S_O_S__table_z4x_fk3_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupId | Cadeia de caracteres | O SYS ID do grupo. |
| rotaId | Cadeia de caracteres | O SYS ID da escala. |
| userId | Cadeia de caracteres | O SYS ID do usuário. |
| dateRangeObj | Objeto | Contém as datas de início e fim do conjunto de dados. |
| resultado | Cadeia de caracteres | O iCalendar do usuário. |
[Tabela 31. Parâmetros]

{#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}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 32. Retorna]

{#r_OCRICalSNC-saveCalEvnts_S_S_S_O_S__table_apx_fk3_hx}

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

Enfileira eventos para enviar um e-mail a todos os membros da rotação.
{#r_OCRICalSNC-sendCalendarURL_GR__table_zhc_f43_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| rotaGR | GlideRecord | Um registro cmn_rota. |
[Tabela 33. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 34. Retorna]

{#r_OCRICalSNC-sendCalendarURL_GR__table_a3c_f43_hx}

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

Retorna um objeto que contém todos os timeSpans que precisam ser excluídos do iCalendar do usuário.
{#r_OCRICalSNC-updExcptnLst_ASI_STS_A__table_fyt_nj3_hx__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| scheduleItem | AJAXScheduleItem | Um AJAXScheduleItem. |
| timeSpan | ScheduleTimeSpan | Período de plantão padrão de um único usuário. |
| rotaSpanItems | Matriz | Contém os períodos de plantão padrão do usuário. |
[Tabela 35. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém todos os timeSpans que precisam ser excluídos do iCalendar do usuário. |
[Tabela 36. Retorna]

{#r_OCRICalSNC-updExcptnLst_ASI_STS_A__table_gyt_nj3_hx}