--- sourceDocument: Criar ou modificar aplicações do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/application-development Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Criar ou modificar aplicações do Xanadu ft:clusterId : - cadev bundleId : - cadev workflow : - Creator --- # Criar um comando personalizado no ServiceNow CLI # Criar um comando personalizado no ServiceNow CLI {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 min. de leitura Gerencie sua aplicação personalizada na linha de comando criando comandos personalizados no ServiceNow CLI. ## Antes de Iniciar Função necessária: administrador ## Por Que e Quando Desempenhar Esta Tarefa Um comando ServiceNow CLI é mapeado para um endpoint REST com script na tabela Endpoint \[sn_cli_metadata_end_point\]. Você pode definir um endpoint REST com script para executar uma função em sua aplicação personalizada ou usar qualquer endpoint REST existente. Em seguida, mapeie um comando da CLI para executar a chamada REST. ## Procedimento 1. Disponibilize um endpoint REST para um comando ServiceNow CLI. 1. Navegar até CLI (Command Line Interface, interface de linha de comando)Endpoints. 2. Selecione Novo e preencha o formulário. {#create-command__table_lfj_mbj_n4b__entry__2} | Campo | Descrição | |-|-| | Caminho do recurso | Obrigatório. Caminho para o endpoint na instância para a qual um comando será mapeado. Pode ser o caminho para uma REST API de entrada ou uma REST API com script. Por exemplo, `api/now/table/{table}/{sysid}`. Para obter mais informações, consulte [REST APIs](https://www.servicenow.com/docs/access?context=api-rest&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) e [Scripted REST APIs](https://www.servicenow.com/docs/access?context=c_CustomWebServices&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)disponíveis. | | Método HTTP | Obrigatório. Método HTTP a ser usado quando o usuário executa o comando associado. | | Aplicação | Escopo da aplicação somente leitura para o endpoint. | [ ] {#create-command__table_lfj_mbj_n4b} {#create-command__substeps_hs4_mw3_n4b} 2. **Opcional:** Crie um grupo de comandos. Como alternativa, você pode adicionar seu novo comando a um grupo de comandos existente. 1. Navegar até CLI (Command Line Interface, interface de linha de comando)Grupos de comandos. 2. Selecione Novo e preencha o formulário. {#create-command__table_tyy_gdj_n4b__entry__2} | Campo | Descrição | |-|-| | Nome | Obrigatório. Nome do grupo de comando. | | Grupo primário | Grupo de comando primário. | | Grupo de referência | Grupo de comandos a ser referenciado. Por exemplo, você pode criar um novo grupo de comandos como um alias para um grupo de comandos existente. Quando o usuário chama um comando referenciado usando o novo grupo de comandos, o comando original é executado. Isso permite que você crie um grupo de comandos específico para sua aplicação personalizada que inclui comandos novos e existentes. | | Descrição resumida | Obrigatório. Descrição resumida do grupo de comandos. | | Descrição | Descrição do grupo de comandos usado como texto de ajuda quando o usuário executa o comando `--help` no grupo de comandos. | | Aplicação | Escopo da aplicação somente leitura para o grupo de comandos. | | Ativo | Quando selecionado, o grupo de comandos está ativo. | [ ] {#create-command__table_tyy_gdj_n4b} {#create-command__substeps_o3t_qbj_n4b} 3. Crie um comando. 1. Navegar até CLI (Command Line Interface, interface de linha de comando)Comandos. 2. Selecione Novo e preencha o formulário. {#create-command__table_o3q_qyg_m4b__entry__2} | Campo | Descrição | |-|-| | Nome | Obrigatório. Nome do comando. | | Grupo de comandos | Obrigatório. Grupo de comandos do qual o comando faz parte. | | Comando de referência | Comando a ser referenciado. Por exemplo, você pode criar um novo comando como um alias para um comando existente. Quando o usuário chama o novo comando, o comando original é executado. Isso permite que você crie um comando específico para sua aplicação personalizada que executa a funcionalidade existente. Nota: Um comando não pode fazer referência a um comando que faz referência a outro comando ou a um comando descendente, um comando ancestral ou um comando de retorno de chamada. | | endpoint da API | Obrigatório. Chamada de API a ser executada quando o usuário executa o comando. | | Descrição resumida | Obrigatório. Descrição resumida do comando. | | Aplicação | Escopo da aplicação somente leitura para o comando. | | Ativo | Quando selecionado, o comando está ativo. | | É um comando de retorno de chamada | Quando verdadeiro, designa o comando como um comando de retorno de chamada. Selecione esta opção para ocultar o comando do cliente da CLI e impedir que os usuários o chamem na linha de comando. Use este campo com a seção Retorno de chamada de um comando primário. O comando de retorno de chamada é executado quando o comando primário é concluído. | | Texto de ajuda || | Descrição | Descrição do comando usado como texto de ajuda quando o usuário executa o comando `--help`. | | Exemplos | Exemplos do comando usado como texto de ajuda quando o usuário executa o comando `--help`. | | Expressões || | Expressão que indica êxito | Expressão usada para avaliar a resposta do servidor e determinar se o comando foi bem-sucedido. Por exemplo, `result.code = 1`. | | Expressão de falha | Expressão usada para avaliar a resposta do servidor e determinar se o comando falhou. | | Mensagens || | Mensagem de sucesso | Mensagem exibida no cliente da CLI quando o comando é bem-sucedido. | | Mensagem de andamento | Mensagem exibida no cliente da CLI quando o comando está em andamento. | | Mensagem de falha | Mensagem exibida no cliente da CLI quando o comando falha. | | Retorno de chamada || | Expressão do retorno de chamada | Expressão usada para determinar se o comando de retorno de chamada deve ser executado. Por exemplo, você pode escrever uma expressão que verifica um processo de longa execução. Se a expressão produzir um determinado resultado, o retorno de chamada será executado. | | Comando de retorno de chamada | Comando a ser executado quando a Expressão de retorno de chamada for atendida. Deve ser um comando com o campo É comando de retorno de chamada selecionado. | | Intervalo do retorno de chamada | O intervalo entre as execuções do comando de retorno de chamada. Unidade: Milissegundos Padrão: 1.000 | | Máximo de novas tentativas | Número máximo de vezes que o comando de retorno de chamada é executado. Padrão: 10 | [ ] {#create-command__table_o3q_qyg_m4b} 3. Nas listas relacionadas a Argumentos de comando, crie todos os argumentos de comando necessários para o comando. Crie um argumento de comando para permitir que os usuários definam opções ao executar um comando. {#create-command__table_hg5_nnh_m4b__entry__2} | Campo | Descrição | |-|-| | Nome | Obrigatório. Nome do argumento do comando, por exemplo, `data`. | | Nome Curto | Nome curto do argumento do comando, por exemplo, `d`. | | Tipo de Dados | Obrigatório. Tipo de dados esperados para o argumento do comando. As opções incluem: * Cadeia de caracteres: permite que os usuários insiram uma cadeia de caracteres como entrada. * Inteiro: permite que os usuários insiram um número como entrada. * Booliano: permite que os usuários insiram `verdadeiro` ou `falso` como entrada. * Entrada de arquivo: permite que os usuários carreguem um arquivo como entrada. Mapeie este argumento para um tipo de parâmetro de corpo na lista relacionada Argumentos de endpoint de API na próxima etapa. Os usuários podem passar texto sem formatação, YAML, JSON ou outro tipo de arquivo aceito pela REST API. Quando o usuário envia um arquivo YAML, o cliente da CLI converte o arquivo para o formato JSON por padrão. Use o campo Ignorar pré-processamento para desabilitar esse comportamento. * Senha: permite que os usuários insiram uma senha com segurança como entrada. {#create-command__ul_uxr_q1w_y4b} Nota: Para tipos de dados de entrada de arquivo, o limite de tamanho do arquivo é de 10 MB por padrão. No entanto, você altera esse limite usando a propriedade do sistema glide.rest.scripted.max_inbound_content_length_mb. | | Ignorar pré-processamento | Defina este sinalizador para impedir que o cliente da CLI converta arquivos YAML em formato JSON antes de enviá-los na solicitação. Quando o Tipo de dados é definido como Entrada de arquivo e o usuário envia um arquivo YAML, o cliente da CLI converte o arquivo em JSON antes de executar o comando por padrão. Nota: Aplica-se somente quando o Tipo de dados está definido como Entrada de arquivo. | | Valor padrão | Valor padrão a ser usado quando o usuário não passa um valor. | | Descrição resumida | Obrigatório. Descrição resumida do argumento do comando. Usado como texto de ajuda quando o usuário executa o comando `--help`. | | Aplicação | Escopo da aplicação somente leitura para o argumento. | | Comando | Obrigatório. Comando ao qual o argumento se aplica. | | Obrigatório | Quando selecionado, o usuário deve fornecer um valor para o argumento ao executar o comando associado. | | Aviso | Aviso para solicitar informações do usuário. A CLI solicita informações quando o usuário não inclui um argumento necessário em um comando. | | Expressão de visibilidade | Expressão usada para determinar se a CLI deve solicitar o argumento. Normalmente usado para exibir um argumento com base no valor fornecido para um argumento anterior. | | Ordem | Ordem na qual solicitar o argumento. | [ ] {#create-command__table_hg5_nnh_m4b} 4. Nas listas relacionadas a Argumentos de endpoint de API, crie todos os argumentos de endpoint de API necessários para o comando. Mapeie argumentos de comando da lista relacionada Argumentos de comando para parâmetros em seu endpoint REST. {#create-command__table_jqf_qnh_m4b__entry__2} | Campo | Descrição | |-|-| | Nome | Obrigatório. Nome do argumento. | | Valor | Obrigatório. O valor do comando que você deseja passar para o endpoint REST. Você pode passar um valor estático ou uma expressão como `{flags.table}`. Use a variável global `sinalizadores` para acessar os argumentos do comando. | | Tipo de Parâmetro | Obrigatório. O tipo de parâmetro no endpoint REST para o qual você deseja passar o Valor. Por exemplo, se você selecionar Corpo, a CLI passará o valor do campo Valor para o corpo do endpoint REST. As opções incluem: * Corpo * Cabeçalho * Caminho * Consulta {#create-command__ul_xpw_d3c_n4b} | | Aplicação | Escopo da aplicação somente leitura para o argumento. | | Comando | Obrigatório. Comando ao qual o argumento se aplica. | [ ] {#create-command__table_jqf_qnh_m4b} 5. Nas listas relacionadas a Valores de retorno, crie todos os valores de retorno necessários para o comando. Crie valores de retorno para retornar somente determinadas chaves da resposta. {#create-command__table_b13_qnh_m4b__entry__2} | Campo | Descrição | |-|-| | Expressão do caminho | Obrigatório. Expressão que representa o caminho para a chave que você deseja retornar. | | Alias | Nome da variável para atribuir o valor de retorno. | | Aplicação | Escopo da aplicação somente leitura para o comando. | | Comando | Obrigatório. Comando ao qual o valor de retorno se aplica. | [ ] {#create-command__table_b13_qnh_m4b} {#create-command__substeps_hnv_pyg_m4b} ## Resultado Quando o usuário executa o comando ServiceNow CLI, o sistema executa a chamada de REST API associada e retorna o resultado para o ServiceNow CLI.