Converta uma aplicação com ServiceNow SDK

Converta uma aplicação com escopo existente para oferecer suporte ao desenvolvimento no código-fonte com o. ServiceNow SDK.

Antes de Iniciar

Use o. ServiceNow SDKpara autenticar em um ServiceNowinstância. Para obter mais informações, consulte Autenticando em um ServiceNowinstância com ServiceNow SDK.

Função necessária: administrador

Por Que e Quando Desempenhar Esta Tarefa

Aplicações com escopo existentes que não foram criadas com o. IDE da ServiceNowou ServiceNow SDKdeve ser convertido para dar suporte ao desenvolvimento no código-fonte. A conversão de uma aplicação adiciona os arquivos e diretórios necessários para desenvolvê-la no código-fonte. Você pode escolher se deseja converter metadados da aplicação existentes em ServiceNow Fluentcódigo. A aplicação não é alterada na instância até que você a compile e instale na instância.

Este procedimento usa o. ServiceNow SDKInterface de linha de comando (CLI). Em uma ferramenta de linha de comando, insira now-sdk --help para obter informações sobre os comandos disponíveis e opções globais. 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. Crie um diretório local para sua aplicação.
2. Em Visual Studio Code, abra o diretório.
3. No diretório da aplicação, abra uma janela de terminal integrada.
4. Converta uma aplicação com escopo existente de uma instância ou diretório local usando o. iniciar comando.

   Com o. --de parâmetro, forneça um sys_id de uma aplicação na instância ou um caminho para um diretório local que contém uma aplicação a ser convertida para oferecer suporte ao desenvolvimento no código-fonte.

   npx @servicenow/sdk init --from <sys_id or path>

   Por exemplo:

   npx @servicenow/sdk init --from aadfdd904748a6500ff14ee4316d4369

   Nota:

   Usando o. npx o comando instala o. ServiceNow SDKem seu diretório de aplicações em vez de globalmente.
5. No prompt, insira um nome para o pacote de aplicações usado no pacote.json arquivo.

   O nome do pacote deve aderir aos padrões de nomenclatura de pacote do Gerenciador de pacotes de nó (npm).

   No exemplo a seguir, uma aplicação é baixada da instância e convertida usando seu sys_id.

   $ npx @servicenow/sdk init --from aadfdd904748a6500ff14ee4316d4369
   [now-sdk] Bootstrapping a new ServiceNow application project...
   [now-sdk] Please provide the missing required fields:
   ? NPM package name:  example-app
   [now-sdk] Access Token has expired, refreshing token
   [now-sdk] Downloading application package for aadfdd904748a6500ff14ee4316d4369 from https://myinstance.service-now.com
   [now-sdk] Unzipping downloaded package...
   [now-sdk] Successfully downloaded and unzipped application aadfdd904748a6500ff14ee4316d4369
   [now-sdk] Summary of downloaded metadata files
   Metadata: 13 (Total: 13)
     Copied To Metadata Directory::
       1. dictionary/x_snc_example_app_mytable.xml
       2. package_inventory.csv
       3. sys_app_aadfdd904748a6500ff14ee4316d4369.xml
       4. update/sys_db_object_7030a5d04748a6500ff14ee4316d4338.xml
       5. update/sys_dictionary_x_snc_example_app_mytable_null.xml
       6. update/sys_documentation_x_snc_example_app_mytable__en.xml
   ... and 7 more
   
   [now-sdk] Successfully converted application.
   [now-sdk] Install the required dependencies with your preferred package manager before running "$now-sdk build".
             Ex: Run "npm install" if using npm.

   A aplicação está disponível localmente com a estrutura de aplicação padrão e oferece suporte ao desenvolvimento no código-fonte. Os metadados da aplicação existente são baixados em no metadados diretório. Para obter informações sobre a estrutura da aplicação, consulte Estrutura da aplicaçãoSeção do tópico Criando aplicações no código-fonte.

6. Instale as dependências de terceiros necessárias usando o gerenciador de pacotes preferido.
   Por exemplo, se você usar o Gerenciador de pacotes de nós (npm), execute instalação do npm .
7. Opcional: Transforme metadados da aplicação existente (XML) em ServiceNow Fluentcódigo usando transformação comando.

   Com o. --de Parâmetro, forneça um caminho para um diretório local ou arquivo que contém XML de metadados para transformar ServiceNow Fluentcódigo.

   now-sdk transform [--from <path>] [--directory <package path>] [--preview <flag>] [--auth <alias>]

   Dica:

   Você pode definir --preview parâmetro como verdadeiro para visualizar o transformado ServiceNow Fluentcódigo da linha de comando sem salvar as mudanças.
   Por exemplo:

   now-sdk transform --from metadata/update --auth devuser1

   Os metadados da aplicação são definidos em ServiceNow Fluentcódigo no origem/fluente/gerado e removido do diretório especificado.

   Nota:

   Um número limitado de tipos de metadados, como snapshots de metadados [sys_metadata_link] e ativos de UX [sys_ux_lib_asset], não pode ser representado como ServiceNow Fluente não são transformados. Esses tipos de metadados permanecem como arquivos XML de metadados no metadados diretório da sua aplicação.
8. Crie a aplicação com o. criar comando.

   now-sdk build

9. Opcional: Atualize a aplicação na instância com instalar comando.

   now-sdk install --auth <alias>

Resultado

A aplicação convertida é adicionada ao seu diretório local com os arquivos e diretórios necessários para suportar o desenvolvimento no código-fonte. Se você instalou a aplicação com sucesso, ela será atualizada na instância. Para obter mais informações sobre como instalar aplicações, consulte Crie e. instalar uma aplicação com ServiceNow SDK. Após instalar uma aplicação convertida, o. JSON do pacote o campo do registro da aplicação personalizada [sys_app] contém o caminho para pacote.json arquivo da aplicação.

Os novos metadados da aplicação adicionados após a conversão de uma aplicação são transformados automaticamente em código-fonte no origem/fluente/gerado quando você usa o. transformação comando. Se existirem metadados na aplicação local como XML e código-fonte, a versão XML terá precedência quando instalada na instância.

O que Fazer Depois

Em Visual Studio Code, comece a desenvolver sua aplicação no código-fonte com ServiceNow Fluent, Escrevendo módulos JavaScript personalizados ou adicionando bibliotecas de terceiros. Para obter mais informações, consulte Desenvolvendo aplicações com o. ServiceNow SDK.