Criar uma aplicação com ServiceNow SDK

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura
  • Crie uma aplicação com escopo para desenvolver no código de origem com o ServiceNow SDK.

    Antes de Iniciar

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Este procedimento usa a ServiceNow SDK interface de linha de comando (CLI). Em uma ferramenta de linha de comando, insira now-sdk --help para obter informações sobre os comandos e opções globais disponíveis. Para obter informações adicionais sobre um comando e seus parâmetros, insira o comando e --help ou -h. Por exemplo, now-sdk auth --help. Para obter mais informações sobre a CLI, consulte ServiceNow SDK CLI.

    Procedimento

    1. No diretório em que você deseja adicionar uma aplicação, abra uma ferramenta de linha de comando no sistema.
    2. Crie uma aplicação seguindo um conjunto orientado de avisos com o comando create :
      now-sdk create
      Nota:
      Se você preferir especificar parâmetros manualmente com o comando create, defina o parâmetro --interactive como falso e forneça os parâmetros de nome de escopo e de aplicação necessários. Para obter mais informações, consulte o comando create no tópico ServiceNow SDK CLI.
    3. Responda à seguinte série de avisos.
      Tabela 1. Avisos interativos para o comando de criação
      Aviso Descrição
      Conectar-se a uma instância Uma opção para autenticar em uma instância e validar se o escopo da aplicação fornecido é válido durante a criação da aplicação.
      • Sim: o nome do escopo é validado antes que a aplicação seja criada localmente.
      • Não: o nome do escopo não é validado durante a criação, portanto, você deve verificar se o nome do escopo é válido antes de implantar na instância.
      Credenciais da instância Uma opção para criar ou selecionar credenciais para autenticação em uma instância. Para adicionar credenciais, conclua as seguintes etapas:
      1. Selecione Adicionar novas credenciais.
      2. Responda à seguinte série de avisos:
        • Host de destino para implantação da aplicação :<instance URL>
        • O nome de usuário a ser autenticado com a instância :<username>
        • A senha para autenticar com a instância :<password>
        • Alias para estas credenciais :<alias>

      Se você já configurou as credenciais, poderá selecioná-las na lista de aliases existentes e instâncias associadas.

      Nome da aplicação da ServiceNow Um nome para a aplicação.
      Nome do pacote do NPM Um nome para o pacote de aplicações usado no arquivo package.json.

      O nome do pacote deve aderir aos padrões de nomenclatura de pacote do NPM.

      Descrição associada a sys_app Uma descrição resumida da sua aplicação.
      Nome do escopo O escopo da aplicação.

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

      Modelo de projeto Uma opção para especificar se deve ser usado JavaScript ou TypeScript em módulos. Esta opção determina a configuração dos arquivos package.json e now.config.json e adiciona um arquivo tsconfig.json para projetos TypeScript.
      • JavaScript: a aplicação está configurada para criar arquivos .js do diretório src/server em módulos.
      • TypeScript: a aplicação está configurada para criar arquivos .ts do diretório src/server em módulos.
      Estrutura de projeto de módulo Fluente ou JS? O tipo de aplicação, que determina a configuração da aplicação padrão.
      • Fluente: a configuração da aplicação padrão é definida para usar ServiceNow Fluent, módulos JavaScript e bibliotecas de terceiros.
      • Módulo: a configuração da aplicação padrão é definida para usar somente módulos JavaScript e bibliotecas de terceiros.
      Adicionar uma tabela de amostra à aplicação? Uma opção para criar uma tabela de amostra na aplicação.
      • Sim: uma tabela de amostra chamada<scope> _to_do foi criado.
      • Não: uma tabela de amostra não é criada na aplicação.
      Implantar aplicação imediatamente? Uma opção para implantar a aplicação na instância imediatamente após a criação.
      • Sim: a aplicação será implantada na instância se for criada com sucesso. Se você estiver off-line, a aplicação não será implantada.
      • Não: a aplicação é criada localmente, mas não implantada na instância. Você deve criar e implantar a aplicação na instância posteriormente. Para obter mais informações, consulte Criar e implantar uma aplicação com o ServiceNow SDK.
      $ now-sdk create
      [now-sdk] Bootstrapping a new ServiceNow application project...
      ==========================================
      
      Create nowSDK Application
      
      ==========================================
      
      ? Connect to an instance (helps ensure the created app is valid)?  yes
      [now-sdk] Listing all credentials: 
      ? Instance credentials:  Add new credentials
      ? Target host for application deployment https://<instance>.service-now.com
      [now-sdk] Authenticating to instance "https://<instance>.service-now.com".
      ? The username to authenticate with the instance admin
      ? The password to authenticate with the instance
      [now-sdk] Attempting to log into instance https://<instance>.service-now.com as admin.
      [now-sdk] Successfully authenticated to instance https://<instance>.service-now.com.
      [now-sdk] Storing credentials for instance "https://<instance>.service-now.com" with alias undefined.
      ? Alias for these credentials devuser2
      [now-sdk] Successfully stored credentials for instance "https://<instance>.service-now.com" with alias undefined.
      ? Name of ServiceNow Application:  My Example App
      ? NPM package name:  my-example-app
      ? Description associated with sys_app:  A custom ServiceNow application
      ? Scope name:  x_snc_myexapp
      ? Project template:  Javascript
      ? Fluent or JS Module project structure?  Fluent
      ? Add a sample table to the application?  yes
      ? Deploy application immediately?  yes

    Resultado

    Uma aplicação com escopo com a estrutura de aplicação padrão está disponível localmente. Para obter informações sobre a estrutura da aplicação, consulte a seção Estrutura da aplicação do tópico Criando aplicações no código de origem.

    Se a aplicação for criada e implantada na instância, a CLI retornará o URL para a aplicação, como https://myinstance.service-now.com/sys_app.do?sys_id=<sysID> .

    O que Fazer Depois

    Em Visual Studio Code, comece a desenvolver sua aplicação em código de origem com ServiceNow Fluent, escrevendo módulos JavaScript personalizados ou adicionando bibliotecas de terceiros.