UserCriteria - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura
  • A API UserCriteria fornece métodos para criar, modificar e excluir registros de critérios do usuário usando scripts.

    Para usar esta classe em uma aplicação com escopo, use o identificador de namespace sn_uc. O plug-in User Criteria Scoped API (ID: com.glideapp.user_criteria.scoped.api) deve ser habilitado para acessar esta API.

    UserCriteria - UserCriteria()

    Cria uma instância da classe UserCriteria.

    var uc = new sn_uc.UserCriteria();

    UserCriteria - UserCriteria(cadeia de caracteres sys_id)

    Cria uma instância da classe UserCriteria com o sys_id especificado.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    sys_id Cadeia de caracteres sys_id dos critérios do usuário.
    var uc = new sn_uc.UserCriteria("31bea3d53790200044e0bfc8bcbe5dec");

    UserCriteria - create(Object columnValues, booliano standardUpdate)

    Cria critérios do usuário com valores especificados na tabela user_criteria. Os valores especificados em columnValues substituem os valores fornecidos por meio de setters.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    columnValues Objeto Pares de chave e valor para uma coluna e seu valor.
    padrãoAtualizar Booliano Defina como verdadeiro para habilitar a execução de mecanismos e fluxos de trabalho.
    Tabela 3. Retornos
    Tipo Descrição
    Cadeia de caracteres sys_id dos critérios do usuário criados.
    var uc = new sn_uc.UserCriteria(); 
    uc.setCompanies("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89");
    uc.setActive(true); 
    uc.setUsers("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89");
    var UserCriteriaId = uc.create();
    gs.info(UserCriteriaId);

    Saída:

    41bea3d53790200044e0bfc8bcbe5dec

    Critérios de usuário - deleteRecord()

    Exclui os critérios do usuário atual.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 5. Retorna
    Tipo Descrição
    Booliano Se verdadeiro, os critérios do usuário serão excluídos.

    Se falso, nenhum critério do usuário foi encontrado para excluir.

    var uc = new sn_uc.UserCriteria("31bea3d53790200044e0bfc8bcbe5dec");
    uc.deleteRecord();

    Saída:

    true

    UserCriteria - read (colunas de cadeia de caracteres)

    Exibe o mapeamento dos pares de atributo e valor do item do catálogo.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    colunas Cadeia de caracteres Matriz de atributos de item do catálogo.
    Tabela 7. Retornos
    Tipo Descrição
    Objeto Mapeamento para os pares de atributo e valor do item do catálogo.
    var uc = new sn_uc.UserCriteria("7b8a6927ef732100438236caa5c0fb89");
    var obj = uc.read(["company","name"]);
    gs.info(JSON.stringify(obj));

    Saída:

    Script: {"name":"All ACME Corporation employees","company":"e7c1f3d53790200044e0bfc8bcbe5deb,227cdfb03710200044e0bfc8bcbe5d6b,86c1f3193790200044e0bfc8bcbe5d95,98c37b193790200044e0bfc8bcbe5dbe,81f95197ac1d55eb35432fd1e068385e,df7d53303710200044e0bfc8bcbe5dac,81fdf9ebac1d55eb4cb89f136a082555,4b7d13f03710200044e0bfc8bcbe5db6,81f87336ac1d55eb06002def816d139f,81fbfe03ac1d55eb286d832de58ae1fd,81fca4cbac1d55eb355b4b6db0e3c80f,187d13f03710200044e0bfc8bcbe5df2,81fd65ecac1d55eb42a426568fc87a63,31bea3d53790200044e0bfc8bcbe5dec,81f75fcaac1d55eb2b0781d6f2c3c260"}

    UserCriteria - setActive (booliano ativo)

    Especifica se os critérios do usuário estão ativos.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    ativo Booliano Se verdadeiro, os critérios do usuário estão ativos.

    Se falso, os critérios do usuário estão inativos.

    Tabela 9. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setActive(true); 
    

    UserCriteria - setAdvanced(booliano avançado)

    Especifica se os critérios do usuário têm um script avançado.

    Tabela 10. Parâmetros
    Nome Tipo Descrição
    avançado Booliano Se verdadeiro, os critérios do usuário têm um script avançado.

    Se falso, os critérios do usuário não terão um script avançado.

    Tabela 11. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setAdvanced(true); 
    

    UserCriteria - setCompanies(cadeia de caracteres empresas)

    Define a propriedade da empresa para os critérios do usuário.

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    empresas Cadeia de caracteres Lista separada por vírgulas dos sys_ids da empresa a serem definidos para os critérios do usuário.
    Tabela 13. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setCompanies("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 
    

    UserCriteria - setDepartments(cadeia de caracteres departamentos)

    Define a propriedade do departamento para os critérios do usuário.

    Tabela 14. Parâmetros
    Nome Tipo Descrição
    departamentos Cadeia de caracteres Lista separada por vírgulas dos sys_ids do departamento a serem definidos para os critérios do usuário.
    Tabela 15. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setDepartments("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 
    

    UserCriteria - setGroups(cadeias de caracteres grupos)

    Define a propriedade do grupo para os critérios do usuário.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    grupos Cadeia de caracteres Lista separada por vírgulas dos sys_ids do grupo a serem definidos para os critérios do usuário.
    Tabela 17. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setGroups("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 
    

    UserCriteria - setLocations(cadeia de caracteres locais)

    Define a propriedade de local para os critérios do usuário.

    Tabela 18. Parâmetros
    Nome Tipo Descrição
    locais Cadeia de caracteres Lista separada por vírgulas dos sys_ids de local a serem definidos para os critérios do usuário.
    Tabela 19. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setLocations("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 
    

    UserCriteria - setMatchAll(Boolean match_all)

    Define a propriedade match_all para os critérios do usuário.

    Tabela 20. Parâmetros
    Nome Tipo Descrição
    Nenhum(a) corresponder_a todos Se verdadeiro, todas as condições definidas como propriedades para os critérios do usuário devem ser atendidas.

    Se falso, pelo menos uma condição definida como uma propriedade para os critérios do usuário deverá ser atendida.

    Tabela 21. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setMatchAll(true); 
    

    UserCriteria - setName(cadeia de caracteres name)

    Define a propriedade de nome para os critérios do usuário.

    Tabela 22. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome dos critérios do usuário.
    Tabela 23. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setName("Property1"); 
    

    UserCriteria - setRoles(Funções de cadeia de caracteres)

    Define a propriedade de função para os critérios do usuário.

    Tabela 24. Parâmetros
    Nome Tipo Descrição
    funções Cadeia de caracteres Lista separada por vírgulas da função sys_ids a ser definida para os critérios do usuário.
    Tabela 25. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setRoles("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 
    

    UserCriteria - setScript(cadeia de caracteres script)

    Define o script para os critérios do usuário.

    Tabela 26. Parâmetros
    Nome Tipo Descrição
    script Cadeia de caracteres Script a ser definido para os critérios avançados do usuário.
    Tabela 27. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setScript("function scriptTest() {
      var retVal;
      if (gs.getUser().getRecord().getDisplayValue('department') == 'Product Management') {
          retVal = true;
      } else {
          retVal = false;
      }
      return retVal;
    }"); 
    

    Critérios de usuário - setUsers(cadeia de caracteres usuários)

    Define a propriedade do usuário para os critérios do usuário.

    Tabela 28. Parâmetros
    Nome Tipo Descrição
    usuários Cadeia de caracteres Lista separada por vírgulas dos sys_ids do usuário a serem definidos para os critérios do usuário.
    Tabela 29. Retornos
    Tipo Descrição
    vazio
    var uc = new sn_uc.UserCriteria();
    uc.setUsers("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 
    

    UserCriteria - update (objeto columnValues, motivo da cadeia de caracteres)

    Atualiza o item do catálogo atual com os valores especificados.

    Tabela 30. Parâmetros
    Nome Tipo Descrição
    columnValues Objeto Mapeamento para o nome da coluna e os pares de valores.
    motivo Cadeia de caracteres Motivo para atualizar o item do catálogo.
    Tabela 31. Retornos
    Tipo Descrição
    Cadeia de caracteres Retorna o sys_id dos critérios do usuário criados.
    var uc = new sn_uc.UserCriteria();
    uc.update("name": "Updated name", "The existing name is not relevant. Setting a relevant name"); 
    

    Saída:

    31bea3d53790200044e0bfc8bcbe5dec