Jitterbit Command Line Interface para receitas do Citizen Integrator para Jitterbit Design Studio

Introdução

A Jitterbit Command Line Interface (jbcli) é uma ferramenta de linha de comando para interagir com receitas do Citizen Integrator. Uma vez conectado ao Harmony através do jbcli, é possível gerenciar seu próprio repositório de receitas baixando, validando, enviando, atualizando, gerando, implantando ou excluindo metadados de receitas e Jitterpaks do Design Studio.

As seções nesta página descrevem como instalar e usar o jbcli.

Instalar a Jitterbit Command Line Interface

Baixe e instale o ambiente de execução JavaScript Node.js v6.x ou superior em https://nodejs.org/en/download/.

1. Digite este comando em um prompt de comando para instalar o jbcli usando o Gerenciador de Pacotes Node (NPM):

   $ npm install -g jbcli
   

2. Use este comando para verificar se o jbcli foi instalado e está funcionando corretamente:

   $ jbcli version
   1.4.1
   

Usar comandos jbcli

Para usar o jbcli, execute seus comandos a partir de um prompt de comando. Este é o formato geral do comando, com texto entre sinais de menor e maior sendo substituído por valores, e texto dentro de colchetes sendo opcional, e o prompt de comando representado por $:

$ jbcli <entity> <action> [options]

Verificar versão

Verifica qual versão do jbcli você está executando. O número da versão será retornado, sendo a versão atual do jbcli 1.4.1.

$ jbcli version
<version>

Fazer login

Faz login no jbcli com suas credenciais do Harmony. A opção host necessária depende da região (uma das NA, EMEA ou APAC) com a qual sua organização está associada (veja Encontrar minha região). Uma mensagem confirmará a autenticação bem-sucedida.

Use a opção --password <myHarmonyPassword> para passar sua senha na linha de comando:

$ jbcli login --email <username> --password <password> --host <host>
Usuário <username> autenticado com sucesso em <host>.

NA

$ jbcli login --email <username> --host https://citizen.jitterbit.net
Senha:
Usuário <username> autenticado com sucesso em https://citizen.jitterbit.net.

EMEA

$ jbcli login --email <username> --host https://citizen.jitterbit.eu
Senha:
Usuário <username> autenticado com sucesso em https://citizen.jitterbit.eu.

APAC

$ jbcli login --email <username> --host https://citizen.jitterbit.cc
Senha:
Usuário <username> autenticado com sucesso em https://citizen.jitterbit.cc.

Fazer logout

Faz logout do jbcli. Uma mensagem confirmará o logout bem-sucedido.

$ jbcli logout
Usuário <myHarmonyUsername> desconectado.

Listar organizações do usuário

Lista as organizações das quais você é membro. Os IDs e nomes das organizações disponíveis para você serão retornados.

$ jbcli org list
[orgId1] orgName1
[orgId2] orgName2
...

Listar ambientes do usuário

Lista os Ambientes na organização atual. Os IDs e nomes dos ambientes disponíveis para você serão retornados.

$ jbcli env list
[envId1] envName1
[envId2] envName2
...

Obter propriedades

Obtém o valor atribuído a uma chave específica. A chave e seu valor serão retornados.

$ jbcli config get <key>
<key>: <assignment>

Este comando pode ser usado para ver qual organização ou ambiente é o padrão.

• Use a chave defaultOrgId para ver qual organização é padrão. O ID da organização padrão será retornado.

  $ jbcli config get defaultOrgId
  defaultOrgId: orgId
  

• Use a chave defaultEnvId para ver qual ambiente é padrão. O ID do ambiente padrão será retornado.

  $ jbcli config get defaultEnvId
  defaultEnvId: envId
  

Set properties

Define chaves e valores. As chaves e seus valores serão retornados.

jbcli config set <key1>=<assignment1> <key2>=<assignment2> ...
<key1>=<assignment1> set
<key2>=<assignment2> set
...

Por exemplo, este comando pode ser usado para substituir a organização ou ambiente padrão. Observe que as chaves defaultOrgId e defaultEnvId são somente leitura e não podem ser alteradas, pois são definidas pela conta Jitterbit de um usuário. No entanto, você pode definir a organização ou ambiente usados pelos comandos jcli e substituir os defaultOrgId e defaultEnvId usados ao interagir com receitas do Citizen Integrator através do jbcli.

• Para definir uma organização, use a chave orgId com o ID da organização desejada obtido em List user organizations. O ID da organização definida será retornado.

  $ jbcli config set orgId=<orgId>
  orgId:<orgId> set
  

• Para definir um ambiente, use a chave envId com o ID do ambiente desejado obtido em List user environments. O ID do ambiente definido será retornado.

  $ jbcli config set envId=<envId>
  envId:<envId> set
  

Se a organização e/ou ambiente não forem definidos através deste comando, o orgId e/ou envId serão definidos como defaultOrgId e defaultEnvId.

List all recipes

Liste todas as receitas do Citizen Integrator que estão disponíveis para você usar. Opcionalmente, você pode limitar a lista apenas àquelas receitas privadas para sua organização (mostradas entre colchetes). O ID, nome e autor de cada receita serão retornados.

Uma receita consiste em duas partes: um Jitterpak (JPK) do Design Studio e um arquivo de metadados JSON que fornece os passos que um usuário precisará seguir para configurar a receita usando o Citizen Integrator. (Veja Citizen Integrator - Configurar receita.)

$ jbcli recipe list [--private]
[id1] name1 by author1 (organization1)
* [id2] name2 by author2 (organization2)
...

Na lista de receitas que é retornada, as receitas que são públicas e disponíveis para todos os usuários serão precedidas por um asterisco (*). As receitas que são privadas e disponíveis apenas para aqueles dentro da sua organização não terão um asterisco.

Obter uma receita específica e salvar o Jitterpak localmente

Retorna os metadados JSON para uma receita específica do Citizen Integrator e (opcionalmente) salva o Jitterpak acompanhante em um local especificado.

$ jbcli recipe get <id> [--savejpk <location>]
-- recipe JSON --
Jitterpak salvo em <location>.

É possível salvar o Jitterpak acompanhante de uma receita localmente se você quiser referenciar ou usar um Jitterpak de uma receita existente. Se você já começou uma receita e um Jitterpak, mas decidiu que deseja realizar uma personalização avançada dentro do Design Studio, use isso para baixar o Jitterpak.

Para salvar os metadados da receita localmente, você pode copiá-los do prompt de comando e salvar como um arquivo JSON. Se você estiver criando uma nova receita e quiser começar com uma receita semelhante como exemplo, pode usar este comando para salvar os metadados JSON de uma receita.

Validar uma receita

Valida os metadados JSON para uma receita local do Citizen Integrator. Você deve usar este comando antes de fazer o upload de uma receita para garantir que ela seja válida.

jbcli recipe validate --recipe <recipeLocation>
Receita é válida.

Fazer upload de uma nova receita e Jitterpak

Faz o upload de uma nova receita do Citizen Integrator.

Você pode optar por fazer o upload de um novo Jitterpak e, opcionalmente, os metadados JSON (usando a opção --recipe). Para que uma receita específica funcione, você precisa ter tanto o Jitterpak quanto os metadados JSON carregados, mas eles não precisam ser carregados ao mesmo tempo. Por padrão, uma receita carregada é privada para sua organização.

jbcli recipe upload --jpk <jpkLocation> [--recipe <recipeLocation>]
Receita carregada, ID atribuído <id>, e pode ser encontrada em <location>

Atualizar uma receita existente e Jitterpak

Atualiza uma receita existente do Citizen Integrator.

jbcli recipe update <id> --jpk <jpkLocation> [--recipe <recipeLocation>]
Receita com ID <id> atualizada.

Você pode optar por atualizar um Jitterpak existente e, opcionalmente, os metadados JSON (usando a opção --recipe). Para que uma receita específica funcione, é necessário ter tanto o Jitterpak quanto os metadados JSON carregados, mas eles não precisam ser carregados ao mesmo tempo. Por padrão, uma receita carregada é privada para sua organização.

Receitas fornecidas pela Jitterbit e disponibilizadas ao público não podem ser atualizadas ou editadas, exceto pela Jitterbit. Se você deseja editar uma receita pública existente, recupere o JSON e o Jitterpak, edite os arquivos localmente, e reenvie-os como sua nova receita usando o comando Carregar uma nova Receita e Jitterpak.

Excluir uma receita existente e Jitterpak

Exclui uma receita existente do Citizen Integrator que ainda não foi implantada. Para excluir várias receitas, adicione IDs de Receita adicionais separados por espaços. Tanto o Jitterpak quanto os metadados JSON serão excluídos.

jbcli recipe delete <id> [<id> ...]
Receita com ID <id> [<id> ...] excluída.

Receitas fornecidas pela Jitterbit e disponibilizadas ao público só podem ser excluídas pela Jitterbit. Você pode excluir apenas aquelas receitas que você criou. Se você for o administrador de uma organização, pode excluir qualquer receita que pertença à sua organização.

Gerar uma receita e/ou um arquivo de configuração

Usado com um Jitterpak fornecido para gerar um esqueleto de receita do Citizen Integrator que pode ser usado como um modelo de receita.

jbcli recipe generate --jpk <localização> [--recipeonly | --cfgonly]
[Receita salva em <localização>.]
[Arquivo de configuração salvo em <localização>.]

O comando resulta na criação de dois arquivos: <nome-do-projeto>-recipe.json e <nome-do-projeto>-configure.json. Para gerar apenas um desses arquivos, adicione a opção apropriada (--recipeonly ou --cfgonly).

O arquivo de receita é um modelo de uma receita que você pode abrir em um editor de texto para preencher campos como a descrição.

O arquivo de configuração é um modelo do arquivo que o comando Implantar uma receita espera, que contém os valores reais dos campos que normalmente são expostos na interface web do Citizen Integrator. Espera-se que você preencha o arquivo de configuração com valores e, em seguida, use o comando Implantar uma receita para implantar a receita.

Implantar uma receita

Implanta uma receita do Citizen Integrator. Você deve fornecer um arquivo de receita e um arquivo de configuração (veja Gerar uma receita e/ou um arquivo de configuração). O ID da Receita implantada será retornado.

Ao implantar uma receita, cada etapa de ação da receita será executada, semelhante ao processo de implantação da interface web do Citizen Integrator.

jbcli recipe deploy <ID> --cfg <localização>
Receita implantada, ID <id>.

Listar receitas implantadas

Lista as receitas implantadas do Citizen Integrator. Você pode mostrar todas as receitas implantadas ou (opcionalmente) limitar a lista a um ambiente específico passando o ID do ambiente. O ID, nome e autor de cada receita implantada serão retornados.

jbcli deployed-recipe list [--environment <envID>]
[id1] name1 by author1
[id2] name2 by author2
...

Listar Ambientes de Usuário

Desimplantar e excluir uma receita implantada

Desimplanta e exclui uma receita de Integrador Cidadão implantada. Para desimplantar e excluir várias receitas, adicione IDs de Receita adicionais separados por espaços. Tanto o Jitterpak quanto os metadados JSON serão excluídos.

jbcli deployed-recipe delete <id> [<id>...]
Receita implantada com ID <id> [<id>...] excluída.

Receitas fornecidas pela Jitterbit e disponibilizadas ao público só podem ser excluídas pela Jitterbit. Você pode excluir apenas aquelas receitas que criou. Se você for o administrador de uma organização, pode excluir qualquer receita que pertença à sua organização.