Interface de Linha de Comando do Jitterbit¶

Introdução¶

A interface de linha de comando do Jitterbit (jbcli) é uma ferramenta de linha de comandos para interagir com receitas do Citizen Integrator. Uma vez conectado ao Harmony através do jbcli, você pode gerenciar seu próprio repositório de receitas baixando, validação, upload, atualização, geração, implantação ou exclusão de metadados de receita e Jitterpaks do Design Studio.

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

Instalando a Interface de Linha de Comando do Jitterbit¶

Baixe e instale o ambiente de tempo 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 jbcli usando o Node.js Node Package Manager (NPM):

   $ npm install -g jbcli
   

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

   $ jbcli version
   1.4.1
   

Usando jbcli comandos¶

Usar jbcli, execute seus comandos a partir de um prompt de comando. Este é o formato de comando geral, com texto entre o ângulo colchetes sendo substituídos por valores e texto entre colchetes sendo opcional e o prompt de comando representado por $:

$ jbcli <entity> <action> [options]

Verifique a versão¶

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

$ jbcli version
<version>

Conecte-se¶

Faz login em jbcli com suas credenciais Harmony. O host opção necessária depende da região (um de NA, EMEA, ou APAC) ao qual sua organização está associada (consulte Encontrando minha região). Uma mensagem confirmará o sucesso autenticação.

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

$ jbcli login --email <username> --password <password> --host <host>
User <username> authenticated successfully into <host>.

NA

$ jbcli login --email <username> --host https://citizen.jitterbit.net
Password:
User <username> authenticated successfully into https://citizen.jitterbit.net.

EMEA

$ jbcli login --email <username> --host https://citizen.jitterbit.eu
Password:
User <username> authenticated successfully into https://citizen.jitterbit.eu.

APAC

$ jbcli login --email <username> --host https://citizen.jitterbit.cc
Password:
User <username> authenticated successfully into https://citizen.jitterbit.cc.

Sair¶

Desconecta você jbcli. Uma mensagem confirmará o logout bem-sucedido.

$ jbcli logout
User <myHarmonyUsername> logged out.

Listar organizações de usuários¶

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

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

Listar ambientes de usuário¶

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

$ 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á voltou.

  $ jbcli config get defaultOrgId
  defaultOrgId: orgId
  

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

  $ jbcli config get defaultEnvId
  defaultEnvId: envId
  

Definir propriedades¶

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 teclas defaultOrgId e defaultEnvId são somente leitura e não podem ser alterados, pois são definidos pelo Jitterbit de um usuário conta. No entanto, você pode definir a organização ou ambiente usado pelo jcli comandos e substituir o defaultOrgId e defaultEnvId usado ao interagir com as receitas do Citizen Integrator por meio do jbcli.

• Para definir uma organização, use a tecla orgId com o ID da organização desejada obtido de Listar organizações de usuários. O ID da organização definido será retornado.

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

• Para definir um ambiente, use a tecla envId com o ID do ambiente desejado obtido de Listar ambientes de usuário. 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 por meio deste comando, o orgId e/ou envId será padrão para o defaultOrgId e defaultEnvId.

Listar todas as receitas¶

Liste todas as receitas do Citizen Integrator que estão disponíveis para você usar. Opcionalmente, você pode limitar a lista apenas para aqueles 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 Design Studio Jitterpak (JPK) e um arquivo de metadados JSON que fornece as etapas a usuário precisará passar para configurar a receita usando o Citizen Integrator. (Ver Citizen Integrator - Configurar receita.)

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

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

Obtenha uma receita específica e salve o Jitterpak localmente¶

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

$ jbcli recipe get <id> [--savejpk <location>]
-- recipe JSON --
Jitterpak saved to <location>.

Você pode salvar localmente o Jitterpak que acompanha uma receita se quiser fazer referência ou usar um Jitterpak de um existente receita. Se você já iniciou uma receita e Jitterpak, mas decidiu que deseja executar uma personalização avançada dentro do Design Studio, use-o para baixar o arquivo Jitterpak.

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

Validar uma receita¶

Valida os metadados JSON para uma receita local do Citizen Integrator. Você deve usar este comando antes de enviar uma receita para garantir é válido.

jbcli recipe validate --recipe <recipeLocation>
Recipe is valid.

Carregar uma nova receita e Jitterpak¶

Carrega uma nova receita do Citizen Integrator.

Você pode optar por carregar um novo Jitterpak e, opcionalmente, os metadados JSON (usando o --recipe opção). Para receita específica para funcionar, você precisa ter os metadados Jitterpak e 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>]
Recipe uploaded, assigned ID <id>, and can be found at <location>

Atualizar uma Receita existente e Jitterpak¶

Atualiza uma receita de Citizen Integrator existente.

jbcli recipe update <id> --jpk <jpkLocation> [--recipe <recipeLocation>]
Recipe with ID <id> updated.

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

As 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 recarregue-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 implementada. Para excluir várias receitas, adicione IDs de receita separados por espaços. Os metadados Jitterpak e JSON serão excluídos.

jbcli recipe delete <id> [<id> ...]
Recipe with ID <id> [<id> ...] deleted.

As 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, poderá excluir todas as receitas que pertencem à sua organização.

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

Usado com um Jitterpak fornecido para gerar uma receita básica do Citizen Integrator que pode ser usada como um modelo de receita.

jbcli recipe generate --jpk <location> [--recipeonly | --cfgonly]
[Recipe saved to <location>.]
[Configure file saved to <location>.]

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

O arquivo de receita é um modelo de 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 Deploy a recipe espera, o que contém os valores reais dos campos que normalmente são expostos na interface da web do Citizen Integrator. Você espera-se que preencham o arquivo de configuração com valores e, em seguida, usem Implantar uma receita comando para implantar a receita.

Implantar uma receita¶

Implanta uma receita do Citizen Integrator. Você deve fornecer uma receita e um arquivo de configuração (consulte Gerar uma receita e/ou um arquivo de configuração). O ID da receita implantado será Ser devolvido.

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

jbcli recipe deploy <ID> --cfg <location>
Recipe deployed, 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 específico ambiente passando o ID do ambiente. A ID, o nome e o 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

Cancele a implantação e exclua uma receita implantada¶

Cancela a implementação e exclui uma receita do Citizen Integrator implementada. Para cancelar a implantação e excluir várias receitas, adicione IDs de receita separados por espaços. Os metadados Jitterpak e JSON serão excluídos.

jbcli deployed-recipe delete <id> [<id>...]
Deployed recipe with ID <id> [<id>...] deleted.

As 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, poderá excluir quaisquer receitas que pertencem à sua organização.