AssessmentCreation - Global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 4 min. de leitura
  • A classe AssessmentCreation fornece métodos que os administradores podem usar para gerar avaliações e pesquisas.

    Existem várias maneiras de chamar o método createAssessments. Você deve definir o parâmetro typeID em todos os casos para identificar um tipo de métrica ou definição de pesquisa.

    Alguns dos fatores que influenciam o comportamento do método incluem:
    • Se o destino é uma avaliação ou pesquisa
    • Se o tipo de programação de avaliação é sob demanda ou programado
    • Períodos de programação da pesquisa
    • Parâmetros fornecidos

    Por exemplo, quando o método é chamado apenas com o parâmetro typeID definido, o método pesquisa partes interessadas ou usuários de pesquisa para os quais enviar convites. Em contraste, quando o método é chamado com os parâmetros typeID e userID definidos, ele tenta enviar convites para os usuários especificados.

    AssessmentCreation - createAssessments (cadeia de caracteres typeID, cadeia de caracteres sourceRecordID, cadeia de caracteres userID)

    Cria uma ou mais avaliações ou pesquisas para o tipo de métrica ou definição de pesquisa especificado.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    ID do tipo Cadeia de caracteres O sys_id do tipo de métrica ou definição de pesquisa para o qual serão geradas avaliações ou pesquisas.
    sourceRecordID Cadeia de caracteres Um ou mais sys_ids de definição de pesquisa separados por vírgulas a serem incluídos nas avaliações geradas. Deve haver um registro avaliável associado ao tipo de métrica especificado para cada registro de origem. Se este parâmetro for deixado em branco, as avaliações geradas incluirão todos os registros avaliáveis para o tipo especificado. Este parâmetro é para uso somente com avaliações.
    userID Cadeia de caracteres Um ou mais sys_ids separados por vírgulas de usuários para os quais serão enviadas instâncias de avaliação ou pesquisa. Se este parâmetro for deixado em branco, as partes interessadas da avaliação ou os usuários da pesquisa receberão instâncias. Este parâmetro é necessário para avaliações sob demanda.
    Tabela 2. Retorna
    Tipo Descrição
    Cadeia de caracteres Se o método for bem-sucedido, ele retornará uma cadeia de caracteres separada por vírgulas, como 7a2ad2253784200044e0bfc8bcbe5de1, 10, b7e8b5d4c0a80169008b49e468920048 (ID da instância, número de instâncias, ID do grupo) com os seguintes valores:
    • instanceID: Sys_id da instância de avaliação ou pesquisa criada, se houver apenas um. Sys_id de uma das instâncias, se houver várias. Se houver várias instâncias, use o ID do grupo para recuperar dados.
    • #instances: número de instâncias de avaliação ou pesquisa criadas.
    • groupID: Sys_id do grupo de avaliação que contém as instâncias de avaliação ou pesquisa criadas.

    Se o método não for capaz de gerar avaliações ou pesquisas, ele retornará um dos códigos de erro.

    Códigos de Erros
    • isscheduled — Indica que o parâmetro userID ou sourceRecordID não deveria ter sido usado. Quando o valor typeID representa um tipo de métrica com o campo Tipo de programação definido como Programado, o parâmetro typeID é o único parâmetro que pode ser usado.
    • rascunho_state — Indica que o valor typeID é um tipo de métrica ou definição de pesquisa que não foi publicada. Publique o tipo de métrica ou a definição de pesquisa.
    • invalidtype — Indica que não há nenhum tipo de métrica existente que corresponda ao valor typeID.
    • inativo - indica que o valor typeID é um tipo de métrica ou definição de pesquisa que não está ativo. Navegue até o tipo de métrica ou definição de pesquisa e marque a caixa de seleção Ativo.
    • not_available — Indica que o valor typeID é um tipo de métrica ou definição de pesquisa que não tem métricas ou perguntas de pesquisa. Adicione pelo menos uma métrica ou pergunta de pesquisa.
    • notyet - indica que pelo menos um dos usuários no valor userID está atribuído a uma instância de pesquisa para a definição de pesquisa especificada, que ainda não expirou. O código de erro retorna a data de vencimento.
    • TEA — Indica que pelo menos um dos usuários no valor userID já está atribuído a uma instância de pesquisa para a pesquisa.
    • not_authorized — Indica que pelo menos um dos usuários no valor userID não está autorizado a participar da pesquisa. Verifique se uma das seguintes condições é verdadeira:
      • Não há usuários de pesquisa para a definição de pesquisa especificada.
      • Todos os usuários no valor userID são salvos como usuários de pesquisa para a definição de pesquisa especificada.
    • concluído - indica que o valor typeID é uma definição de pesquisa com o campo Período de programação definido como Somente uma vez e que pelo menos um dos usuários no valor userID já concluiu uma instância de pesquisa para essa definição de pesquisa.
    • nousers - indica que o parâmetro userID não foi usado e que uma das seguintes condições é verdadeira:
      • Não há partes interessadas associadas ao tipo de métrica especificado. Defina o parâmetro userID ou crie pelo menos uma parte interessada.
      • Não há usuários de pesquisa associados à definição de pesquisa especificada. Defina o parâmetro userID ou crie pelo menos um usuário de pesquisa.
    • nosources - indica que o valor typeID é um tipo de métrica com o campo Tipo de programação definido como Sob demanda e que nem o parâmetro userID nem sourceRecordID foi usado. Defina pelo menos um desses parâmetros.

    Este exemplo de código mostra como gerar uma instância de avaliação em um widget do portal de serviços. Este exemplo não funcionará se o Tipo de programação estiver definido como Sob demanda.

    (function() {
      var gdtSurvey = new GlideDateTime();
      if (gdtSurvey.getDayOfMonthUTC() == 23) {
        (new SNC.AssessmentCreation()).createAssessments('d902e09a075730101263f19d7c1ed03a', // Assessment metric type sys_id
          '4baec2fe07d3f0101263f19d7c1ed0a6', // Assessable record which is the source of the assessment
          gs.getUserID()); // Users ID to send the assessment instances to
      }
    })();

    Retornar resultados:

    bbf0b9b8072330101263f19d7c1ed00b,1,33f0f978072330101263f19d7c1ed05f