ServiceNow CLI do SDK

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 7 min. de leitura

    • Use a ServiceNow interface de linha de comando (CLI) do SDK para gerenciar mudanças entre uma aplicação local e a aplicação em uma instância.

    Na ferramenta de linha de comando do seu sistema, insira now-sdk para iniciar a CLI e retornar uma lista de comandos disponíveis ou now-sdk [command] para começar a usar o ServiceNow SDK.

    A CLI inclui os seguintes comandos e opções globais:

    Tabela 1. Opções globais
    Opção Descrição
    --versão Retornar a versão da CLI.
    --help, -h Retornar informações sobre comandos, subcomandos e parâmetros.

    autenticação

    Autentique com uma instância e armazene, atualize ou exiba as credenciais do usuário para acessar uma instância em seu sistema.

    O comando auth tem subcomandos salvar, limpar, exibire definir padrão e a seguinte estrutura:
    now-sdk auth [<subcommand>]

    Salvar

    Armazene credenciais nas chaves do dispositivo ou no gerenciador de credenciais do seu sistema. No prompt, forneça uma senha para autenticar com a instância.

    O subcomando de salvamento tem a seguinte estrutura:
    now-sdk auth save [<alias>] [--host <hostname>] [--username <username>] [--default]
    Tabela 2. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    alias Cadeia de caracteres Um identificador exclusivo para o host e as credenciais do usuário.

    O alias pode ser usado para autenticação com os comandos create, convert, fetche implant.

    		 —
    --host Cadeia de caracteres A instância de destino para acessar e na qual você implanta e busca aplicações. A instância deve estar na versão Washington DC. —
    --username Cadeia de caracteres Um nome de usuário para autenticação na instância. O usuário deve ter acesso de administrador. —
    Tabela 3. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --default, -d Booliano Opção para definir o alias como o alias padrão. falso

    Por exemplo:

    now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default

    limpar

    Remova as credenciais no conjunto de chaves do dispositivo ou no gerenciador de credenciais do seu sistema.

    O subcomando claro tem a seguinte estrutura: 
    now-sdk auth clear [<alias>]
    Tabela 4. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    alias Cadeia de caracteres Um identificador exclusivo para o host e as credenciais do usuário. todos
    Por exemplo:
    now-sdk auth clear devuser1

    lista

    Exiba as credenciais salvas nas chaves do dispositivo ou no gerenciador de credenciais do seu sistema. As senhas não são retornadas.

    O subcomando list tem a seguinte estrutura: 
    now-sdk auth list [<alias>]
    Tabela 5. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    alias Cadeia de caracteres Um identificador exclusivo para o host e as credenciais do usuário. todos
    Por exemplo:
    now-sdk auth list devuser1

    definir-padrão

    Defina as credenciais a serem usadas por comandos por padrão.

    O subcomando set-default tem a seguinte estrutura: 
    now-sdk auth set-default [<alias>]
    Tabela 6. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    alias Cadeia de caracteres Um identificador exclusivo para o host e as credenciais do usuário. —
    Por exemplo:
    now-sdk auth set-default devuser1

    criar

    Crie uma aplicação com escopo personalizado e, se especificado, implante-a em uma instância.

    O comando create tem a seguinte estrutura:
    now-sdk create <projectName> <scopeName> [<directory>] [--description <description>] [--sampleTable <flag>] [--offline <flag>] [--auth <alias>] [--open-browser <flag>] [--interactive <flag>]
    Tabela 7. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    projectName Cadeia de caracteres O nome da aplicação.

    O nome da aplicação deve aderir às convenções de nomenclatura de pacote do NPM.

    		 —
    scopeName Cadeia de caracteres O escopo da aplicação.

    O nome do escopo deve ser exclusivo na instância, comece com x_<prefix> e ter menos de 18 caracteres. Para obter mais informações, consulte Namespace identifier.

    		 —
    Tabela 8. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    diretório Cadeia de caracteres O diretório local no qual os diretórios e arquivos da aplicação serão criados. Diretório de trabalho atual
    --description Cadeia de caracteres Uma descrição resumida da sua aplicação. —
    --sampleTable Booliano Uma opção para criar uma tabela de amostra na aplicação.

    Se verdadeiro, a tabela de amostra (<scope>_to_do.xml) é criado no diretório .metadata.

    		 falso
    --offline, -o Booliano Uma opção para ignorar a implantação de uma aplicação na instância.

    Se for verdadeiro, o nome do escopo não será validado durante a criação. Portanto, você deve verificar se o nome do escopo é válido antes de implantar na sua instância.​

    Nota:
    Este parâmetro é ignorado quando o parâmetro de autenticação é definido.
    		 falso
    --auth, -a Cadeia de caracteres Um alias para as credenciais usarem para autenticação na instância. Se definido, o alias padrão.
    --open-browser, -b Booliano Uma opção para abrir o registro da aplicação (sys_app) no navegador padrão após a implantação bem-sucedida da aplicação.
    Nota:
    Este parâmetro é ignorado quando o parâmetro off -line é definido como verdadeiro.
    		 falso
    --interactive, -i Booliano Uma opção para responder a um conjunto orientado de sugestões para criar a aplicação. falso
    Por exemplo:
    now-sdk create example-app x_snc_example /path/to/app_folder --description example_app_description --sampleTable true --auth devuser1 --open-browser true

    converter

    Converta uma aplicação existente de uma instância para oferecer suporte a modificá-la localmente em Visual Studio Code e implantar mudanças de aplicação na instância com o ServiceNow SDK.

    A conversão de uma aplicação baixa os arquivos XML de metadados da aplicação e adiciona os arquivos e diretórios necessários para usar o SDK localmente. A aplicação não é alterada na instância. Para obter mais informações, consulte a seção Estrutura da aplicação ] do tópico ServiceNow do SDK.

    O comando de conversão tem a seguinte estrutura:
    now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--scopeId <app_scope_id>]
    Tabela 9. Parâmetros obrigatórios
    Parâmetro Tipo Descrição Valor padrão
    scopeName Cadeia de caracteres O escopo da aplicação existente.

    Para aplicações globais, use o nome da aplicação.

    		 —
    packageName Cadeia de caracteres Um nome para o pacote de aplicações usado no arquivo package.json.

    O nome do pacote deve estar em conformidade com as convenções de nomenclatura de pacote do NPM.

    		 —
    Tabela 10. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    diretório Cadeia de caracteres O diretório local no qual os diretórios e arquivos da aplicação serão criados. Diretório de trabalho atual
    --auth, -a Cadeia de caracteres Um alias para as credenciais usarem para autenticação na instância. Se definido, o alias padrão.
    --scopeId Cadeia de caracteres O sys_id da aplicação existente.
    Nota:
    Este parâmetro é necessário para converter aplicações globais.
    		 —

    Por exemplo:

    now-sdk convert x_snc_example example-app /path/to/app_folder --auth user1-dev --scopeId example_app_scope_id

    buscar

    Baixe metadados da aplicação de uma instância e atualize os arquivos XML de metadados em sua aplicação local para corresponder.

    O comando de busca tem a seguinte estrutura:
    now-sdk fetch [--directory <package path>] [--mode <fetch mode>] [--auth <alias>]
    Tabela 11. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --directory Cadeia de caracteres O caminho para sua aplicação. Diretório de trabalho atual
    --mode, -m Cadeia de caracteres Uma opção para quais metadados buscar.
    • complete: busque todos os metadados da aplicação.
    • incremental: busca somente mudanças nos metadados da aplicação desde a última busca.
    		 incremental
    --auth, -a Cadeia de caracteres Um alias para as credenciais usarem para autenticação na instância. Se definido, o alias padrão.
    Por exemplo: 
    now-sdk fetch --auth devuser1 --directory /path/to/package --mode incremental

    build

    Compile os arquivos de origem e gere um pacote implantável. As dependências da biblioteca de terceiros são convertidas em arquivos XML que podem ser instalados com a aplicação.

    O comando criar tem a seguinte estrutura:
    now-sdk build <source> [--debug <flag>] [--generate-deletes <flag>] [--lint <flag>] [--optimize <flag>]
    Tabela 12. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    origem Cadeia de caracteres O caminho para o arquivo package.json da sua aplicação.

    O package.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --depurar, -d Booliano Uma opção para retornar os logs de depuração gerados durante o processo de compilação. falso
    --generate-deletes Booliano Uma opção para gerar atualizações de registro de exclusão para arquivos removidos entre compilações. verdadeiro
    --lint Booliano Uma opção para limpar os arquivos de origem antes de criar. verdadeiro
    --optimize, -o Booliano Uma opção para otimizar o empacotamento reutilizando arquivos XML de dependência inalterados. verdadeiro
    Por exemplo:
    now-sdk build /path/to/package --debug true --generate-deletes true --lint true --optimize true

    implantar

    Implante uma aplicação em uma instância. Antes de usar o comando de implantação, você deve usar o comando criar para gerar um pacote implantável.

    O comando de implantação tem a seguinte estrutura:

    now-sdk deploy [--source <package path>] [--mode <deploy mode>] [--auth <alias>] [--open-browser <flag>]
    Tabela 13. Parâmetros opcionais
    Parâmetro Tipo Descrição Valor padrão
    --origem Cadeia de caracteres O caminho para o arquivo package.json da sua aplicação.

    O package.json deve estar no diretório base da sua aplicação.

    		 Diretório de trabalho atual
    --mode, -m Cadeia de caracteres Uma opção de como implantar a aplicação.
    • complete: implante a aplicação inteira.
    • reinstalar: desinstale e reinstale a aplicação na instância para garantir que os metadados na instância correspondam aos metadados no pacote de implantação.
      Aviso:
      Os metadados que estão na instância, mas não na aplicação local, são removidos.
    • incremental: implanta somente mudanças nos metadados da aplicação desde a última implantação.
    		 incremental
    --auth, -a Cadeia de caracteres Um alias para as credenciais usarem para autenticação na instância. Se definido, o alias padrão.
    --open-browser, b Booliano Uma opção para abrir o registro da aplicação (sys_app) no navegador padrão após a implantação bem-sucedida da aplicação. falso
    --info, -i Booliano Uma opção para retornar detalhes sobre a implantação mais recente desta aplicação, como o status e os registros atualizados. Quando este parâmetro é usado, a aplicação não é implantada. falso
    Por exemplo: 
    now-sdk deploy --auth devuser1 --source /path/to/package --mode incremental --open-browser true