TMFTopicEventAPIUtilOOB - com escopo

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 20 min. de leitura

    • A inclusão de script TMFTopicEventAPIUtilOOB contém funções para lidar com solicitações de API aberta da Gestão de notificações de eventos que são acionadas por definições de gatilho externo para criar, atualizar e excluir eventos na tabela Evento [em_event].

    Esta inclusão de script contém a implementação padrão da API aberta da Gestão de notificações de eventos. Se você quiser mudar a funcionalidade padrão desta API, será necessário substituir as funções contidas nesta inclusão de script na inclusão de script TMFTopicEventAPIUtil.

    Esta inclusão de script é executada no namespace sn_ind_tmf642 e requer que o plug-in Telecommunications Alarm Management Open API (app-ind-tmfapi-alarm) seja ativado.

    Para obter informações adicionais sobre como substituir essas funções, consulte Guia do desenvolvedor da Open API da Gestão de notificações de eventos.

    Para obter informações adicionais sobre a API aberta da Gestão de notificações de eventos, consulte API aberta da Gestão de notificações de eventos.

    TMFTopicEventAPIUtilOOB – getAlarmChangeEventSchema()

    Retorna o esquema de carga usado ao processar um evento de mudança de alarme (ALARM_CHANGE_EVENT_SCHEMA).

    Esta função é chamada como parte do processo de chamada de ação de fluxo AlarmChangeEvent. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil e o esquema na inclusão de script TMFAlarmAPIConstants.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    Cadeia de caracteres Esquema definido em TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA. 
    // Schema validation
var schema = this.getAlarmChangeEventSchema();
var validationResults = this.schemaValidator.validateJSON(changeAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;

    TMFTopicEventAPIUtilOOB – getAlarmCreateEventSchema()

    Retorna o esquema de carga usado ao processar um evento de criação de alarme (ALARM_CREATE_EVENT_SCHEMA).

    Esta função é chamada como parte do processo de chamada de ação de fluxo AlarmCreateEvent. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil e o esquema na inclusão de script TMFAlarmAPIConstants.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres Esquema definido em TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA 
    // Schema validation
var schema = this.getAlarmCreateEventSchema();
var validationResults = this.schemaValidator.validateJSON(eventAlarmObject, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB – getAlarmDeleteEventSchema()

    Retorna o esquema de carga usado ao processar um evento de exclusão de alarme (ALARM_DELETE_EVENT_SCHEMA).

    Esta função é chamada como parte do processo de chamada de ação de fluxo AlarmDeleteEvent. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil e o esquema na inclusão de script TMFAlarmAPIConstants.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Cadeia de caracteres Esquema definido em TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA. 
    // Schema validation
var schema = this.getAlarmDeleteEventSchema();
var validationResults = this.schemaValidator.validateJSON(deleteAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - mapAlarmChangeObjectToEvent(alarmObject, GlideRecord newEventGr)

    Mapeia os parâmetros na carga da solicitação de mudança aprovada para campos no registro especificado na tabela Evento [em_event].

    Você pode personalizar mapeamentos de campo para adicionar dados à tabela Evento [em_event] ou alterar os mapeamentos de campo padrão. Para modificar mapeamentos, crie funções com nomes e parâmetros idênticos na inclusão de script TMFTopicEventAPIUtil para substituir os mapeamentos na inclusão de script TMFTopicEventAPIUtilOOB. Se você adicionar campos aos mapeamentos, esses campos também deverão ser adicionados ao esquema associado (TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA).

    Esta função é chamada como parte da função transformAndPersistChangeEvent().

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    objetoalarme Objeto A carga deve corresponder ao que está definido no esquema definido em TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
    newEventGr GlideRecord GlideRecord do registro a ser atualizado na tabela Evento [em_event].
    Tabela 8. Retorna
    Tipo Descrição
    Nenhum 
    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB – mapCreateAlarmObjectToEvent(Object alarmObject, GlideRecord eventGr)

    Mapeia os parâmetros na carga de solicitação de criação aprovada para campos no registro especificado na tabela Evento [em_event].

    Você pode personalizar mapeamentos de campo para adicionar dados à tabela Evento [em_event] ou alterar os mapeamentos de campo padrão. Para modificar mapeamentos, crie funções com nomes e parâmetros idênticos na inclusão de script TMFTopicEventAPIUtil para substituir os mapeamentos na inclusão de script TMFTopicEventAPIUtilOOB. Se você adicionar campos aos mapeamentos, esses campos também deverão ser adicionados ao esquema associado (TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA).

    Esta função é chamada como parte da função transformAndPersistAlarmCreateEvent().

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    objetoalarme Objeto A carga deve corresponder ao que está definido no esquema definido em TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
    eventGr GlideRecord GlideRecord do registro na tabela Evento [em_event].
    Tabela 10. Retorna
    Tipo Descrição
    Nenhum 
    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

    TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(Object additionalInfoObj, GlideRecord newEventGr)

    Mapeia os parâmetros na carga da solicitação de exclusão aprovada para campos no registro especificado na tabela Evento [em_event].

    Você pode personalizar mapeamentos de campo para adicionar dados à tabela Evento [em_event] ou alterar os mapeamentos de campo padrão. Para modificar mapeamentos, crie funções com nomes e parâmetros idênticos na inclusão de script TMFTopicEventAPIUtil para substituir os mapeamentos na inclusão de script TMFTopicEventAPIUtilOOB. Se você adicionar campos aos mapeamentos, esses campos também deverão ser adicionados ao esquema associado (TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA).

    Esta função é chamada como parte da função transformAndPersistDeleteEvent().

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    objetoalarme Objeto A carga deve corresponder ao que está definido no esquema definido em TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
    newEventGr GlideRecord GlideRecord do registro a ser usado para mapear os campos na carga útil para aqueles na tabela Evento [em_event].
    Tabela 12. Retorna
    Tipo Descrição
    Nenhum 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB – preparaEventAlarmRecordResponse(cadeia de caracteres msgKey Objeto alarmObject, Objeto responseObject)

    Gera o objeto de resposta após a criação ou atualização do evento, incluindo a limpeza de um evento.

    Esta função é chamada pelas funções processAlarmCreateEvent(), processChangeAlarm()e processDeleteAlarmEvent(). Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    msgKey Cadeia de caracteres Chave de mensagem Esta chave é gerada quando um evento é criado. Localizado no campo Chave de mensagem na tabela Eventos [em_event].
    objetoalarme Objeto Carga do evento a ser processada. O formato desta carga útil deve estar correlacionado ao tipo de evento que está sendo processado. Os esquemas para essas cargas úteis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar quaisquer problemas com a verificação do esquema de carga.
    Tipo de dados: objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Objeto Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Matriz Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Cadeia de caracteres Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Cadeia de caracteres Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    Tabela 14. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants. 
    processDeleteAlarm: function(additionalInfoObj, gr, deleteAlarmPayload, responseObject) {
var msgKey = this.transformAndPersistDeleteEvent(additionalInfoObj, gr);
var responsePayload = this.prepareEventAlarmRecordResponse(msgKey, deleteAlarmPayload, responseObject);
this._logger.logDebug("processDeleteAlarmEvent");
return responsePayload;
},

    TMFTopicEventAPIUtilOOB - processAlarmChangeEvent (objeto changeAlarmPayload)

    Inicia o processo de atualização de um registro na tabela Evento [em_event] quando eventType está definido como AlarmChangeNotification.

    Esta função é chamada pela ação de fluxo AlarmChangeEvent. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Carga de changeAlarm​ Objeto Carga de mudança de evento a ser processada. A carga útil deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
    Tabela 16. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(Object eventAlarmObject)

    Inicia o processo de criação de um registro na tabela Evento [em_event] quando eventType está definido como AlarmCreateNotification.

    Esta função é chamada pela ação de fluxo AlarmCreateEvent. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    eventAlarm​Object Objeto Carga de criação de evento a ser processada. A carga útil deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
    Tabela 18. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent (objeto deleteAlarmPayload)

    Inicia o processo de limpeza do evento de alarme na tabela Evento [em_event] quando eventType está definido como AlarmDeleteNotification.

    Esta função limpa o campo de estado e fecha o alarme de evento. Ele também atualiza todos os parâmetros na carga passada.

    Esta função é chamada pela ação de fluxo AlarmDeleteEvent. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    deleteAlarm​Carga Objeto Carga de exclusão de evento a ser processada. A carga útil deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
    Tabela 20. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(Object alarmObject)

    Transforma a carga de evento de criação passada usando os valores de mapeamento de evento de criação associados e armazena as informações na tabela Evento [em_event].

    Esta função é chamada pela função processAlarmCreateEvent() como parte da ação de fluxo. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    objetoalarme Objeto Carga a ser usada para criar um registro na tabela Evento [em_event]. A carga útil deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
    Tabela 22. Retorna
    Tipo Descrição
    Cadeia de caracteres ID exclusivo (chave de mensagem) do evento.

    Esta função só é chamada pela ação de fluxo AlarmCreateEvent, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(Object additionalInfoObj, GlideRecord actualGr)

    Transforma a carga do evento de mudança aprovada usando os valores de mapeamento de evento de mudança associados e armazena as informações atualizadas no GlideRecord passado na tabela Evento [em_event].

    Esta função é chamada pela função processAlarmChangeEvent() como parte da ação de fluxo. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    InfoObj​ adicional Objeto Carga a ser usada para atualizar os campos no registro especificado no parâmetro existingGr. A carga útil deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
    GR existente GlideRecord GlideRecord do registro de evento na tabela Evento [em_event] a ser atualizado.
    Tabela 24. Retorna
    Tipo Descrição
    Cadeia de caracteres ID exclusivo (chave de mensagem) do evento.

    Esta função só é chamada pela ação de fluxo AlarmChangeEvent, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(Object additionalInfoObj GlideRecord existenteGr)

    Transforma a carga do evento de exclusão (limpo) aprovado usando os valores de mapeamento de evento de exclusão associados e armazena as informações atualizadas no GlideRecord aprovado na tabela Evento [em_event].

    Esta função é chamada pela função >processAlarmDeleteEvent() como parte da ação de fluxo. Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    InfoObj​ adicional Objeto Carga a ser usada para atualizar os campos de evento limpos no registro especificado no parâmetro existingGr. A carga útil deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
    GR existente GlideRecord GlideRecord do registro de evento na tabela Evento [em_event] para a qual o alarme será limpo.
    Tabela 26. Retorna
    Tipo Descrição
    Cadeia de caracteres ID exclusivo (chave de mensagem) do evento.

    Esta função só é chamada pela ação de fluxo AlarmDeleteEvent, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - validarSubscription(objeto eventAlarmObject, objeto responseObject)

    Executa a validação na assinatura.

    Essa validação inclui verificar se a URL de retorno de chamada usada para fazer a notificação de evento e o eventType na carga útil estão registrados.

    Esta função é chamada pelas funções processAlarmCreateEvent(), processChangeAlarm()e processDeleteAlarmEvent(). Você pode mudar a funcionalidade desta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    eventAlarm​Object Objeto Carga do evento a ser validada. O formato desta carga útil deve estar correlacionado ao tipo de evento que está sendo processado. Os esquemas para essas cargas úteis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar quaisquer problemas com a verificação do esquema de carga.
    Tipo de dados: objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    responseObject.​responseError Objeto Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Matriz Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Cadeia de caracteres Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Cadeia de caracteres Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    Tabela 28. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.

    Esta função só é chamada pela ação de fluxo AlarmCHANGEEvent, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB -verifyAlarmChangeEventPayload(objeto changeAlarmPayload, objeto responseObject )

    Fornece a capacidade de definir a verificação adicional da carga do evento de mudança aprovada.

    Esta função é chamada pela função processAlarmChangeEvent() como parte da ação de fluxo. No momento, não há verificação de carga adicional fornecida para a carga de mudança. Você pode adicionar funcionalidade para esta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    Carga de changeAlarm​ Objeto Carga a ser verificada. A carga deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar quaisquer problemas com a verificação do esquema de carga.
    Tipo de dados: objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Objeto Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Matriz Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Cadeia de caracteres Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Cadeia de caracteres Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    Tabela 30. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
     // Apply customized validations if applicable, defaults to no error
var changePayloadResponse = this.verifyAlarmChangeEventPayload(changeAlarmPayload, this.responseObject);
if (!gs.nil(changePayloadResponse.responseError.errorMessage))
  return changePayloadResponse;

    TMFTopicEventAPIUtilOOB –verifyAlarmCreateEventPayload(Object alarmObject, Object responseObject)

    Fornece a capacidade de definir a verificação adicional da carga do evento de criação aprovada.

    Esta função é chamada pela função processAlarmCreateEvent() como parte da ação de fluxo. No momento, não há verificação de carga adicional fornecida para a carga de criação. Você pode adicionar funcionalidade para esta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    alarmePagamento Objeto Carga a ser verificada. A carga deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar quaisquer problemas com a verificação do esquema de carga.
    Tipo de dados: objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    responseObject.​responseError Objeto Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Matriz Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Cadeia de caracteres Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Cadeia de caracteres Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    Tabela 32. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    // Apply customized validations if applicable, defaults to no error
var creatPayloadResponse = this.verifyAlarmCreateEventPayload(eventAlarmObject, this.responseObject);
if (!gs.nil(creatPayloadResponse.responseError.errorMessage))
  return creatPayloadResponse;

    TMFTopicEventAPIUtilOOB -verifyDeleteEventPayload (objeto deleteAlarmPayload, objeto responseObject)

    Fornece a capacidade de definir a verificação adicional da carga do evento de exclusão aprovada.

    Esta função é chamada pela função processDeleteAlarmEvent() como parte da ação de fluxo. No momento, não há verificação de carga adicional fornecida para a carga de exclusão. Você pode adicionar funcionalidade para esta função substituindo a funcionalidade padrão na inclusão de script TMFTopicEventAPIUtil.

    Tabela 33. Parâmetros
    Nome Tipo Descrição
    deleteAlarm​Carga Objeto Carga a ser verificada. A carga deve corresponder ao esquema definido em TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar quaisquer problemas com a verificação do esquema de carga.
    Tipo de dados: objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    responseObject.​responseError Objeto Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Matriz Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Cadeia de caracteres Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Cadeia de caracteres Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    Tabela 34. Retorna
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​responseError Detalhes sobre qualquer erro ocorrido durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​details Quaisquer informações adicionais a serem passadas de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject.​responseError.​errorMessage Mensagem de erro que descreve o erro ocorrido. As mensagens de erro disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​responseError.​errorReason Motivo da falha do endpoint. Os motivos de erro disponíveis são definidos na inclusão de script TMFAlarmAPIConstants.
    responseObject.​status Status da chamada de função. As mensagens de status disponíveis são definidas na inclusão de script TMFAlarmAPIConstants.
    responseObject.​successResponse Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    // Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
  return deletePayloadResponse;