Interfaz de Línea de Comandos Jitterbit

Introducción

La interfaz de línea de comandos de Jitterbit (jbcli) es una herramienta de línea de comandos para interactuar con recetas de Citizen Integrator. Una vez iniciado sesión en Harmony a través del jbcli, puede administrar su propio repositorio de receta descargando, validar, cargar, actualizar, generar, desplegar o eliminar metadatos de receta y Design Studio Jitterpaks.

Las secciones de esta página describen cómo instalar y utilizar el jbcli.

Instalación de la Interfaz de Línea de Comandos de Jitterbit

Descargue e instale el ambiente de tiempo de ejecución JavaScript de Node.js v6.x o superior desde https://nodejs.org/en/download/.

1. Ingrese este comando en un símbolo del sistema para instalar jbcli utilizando el Administrador de paquetes de nodos (NPM) de Node.js:

   $ npm install -g jbcli
   

2. Utilice este comando para comprobar que jbcli se instaló y funciona correctamente:

   $ jbcli version
   1.4.1
   

Usando jbcli comandos

Usar jbcli, ejecute sus comandos desde un símbolo del sistema. Este es el formato de comando general, con texto entre ángulo los corchetes se reemplazan por valores, y el texto entre corchetes es opcional, y el símbolo del sistema representado por $:

$ jbcli <entity> <action> [options]

Verificar versión

Comprueba qué versión de jbcli estas corriendo. Se devolverá el número de versión, con la actual jbcli siendo la versión 1.4.1.

$ jbcli version
<version>

Acceso

Inicia sesión en jbcli con sus credenciales de Harmony. El host opción requerida depende de la región (uno de NA, EMEA, o APAC) con el que está asociada su organización (ver Encontrar mi región). Un mensaje confirmará el éxito autenticación.

Usa la opción --password <myHarmonyPassword> para pasar su contraseña en la línea 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.

Cerrar sesión

Te cierra la sesión jbcli. Un mensaje confirmará el cierre de sesión exitoso.

$ jbcli logout
User <myHarmonyUsername> logged out.

Listar organizaciones de usuarios

Enumera las organizaciones de las que es miembro. Los ID y nombres de las organizaciones disponibles a ti te será devuelto.

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

Listar ambientes de usuario

Enumera los ambientes de la organización actual. Los ID y los nombres de los ambientes disponibles. a ti te será devuelto.

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

Obtener propiedades

Obtiene el valor asignado a una clave específica. Se devolverá la clave y su valor.

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

Este comando se puede usar para ver qué organización o ambiente es el predeterminado.

• Usa la tecla defaultOrgId para ver qué organización es la predeterminada. El ID de la organización predeterminada será regresó.

  $ jbcli config get defaultOrgId
  defaultOrgId: orgId
  

• Usa la tecla defaultEnvId para ver qué ambiente es el predeterminado. El ID del ambiente predeterminado será regresó.

  $ jbcli config get defaultEnvId
  defaultEnvId: envId
  

Establecer propiedades

Establece claves y valores. Se devolverán las claves y sus valores.

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

Por ejemplo, este comando se puede usar para anular la organización o el ambiente predeterminado. Tenga en cuenta que las teclas defaultOrgId y defaultEnvId son de solo lectura y no se pueden cambiar, ya que están definidos por el Jitterbit de un usuario cuenta. Sin embargo, puede establecer la organización o el ambiente utilizado por el jcli comandos y anular el defaultOrgId y defaultEnvId utilizado al interactuar con las recetas de Citizen Integrator a través del jbcli.

• Para configurar una organización, utilice la tecla orgId con el ID de la organización deseada obtenido de Lista de organizaciones de usuarios. Se devolverá el ID de organización establecido.

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

• Para establecer un ambiente, utilice la tecla envId con el ID del ambiente deseado obtenido de Lista de ambientes de usuario. Se devolverá el ID de ambiente establecido.

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

Si la organización y/o el ambiente no se configuran a través de este comando, el orgId y/o envId por defecto a la defaultOrgId y defaultEnvId.

Listar todas las recetas

Enumere todas las recetas de Citizen Integrator que están disponibles para su uso. Opcionalmente, puede limitar la lista a solo aquellos recetas privadas de su organización (mostradas entre paréntesis). Se devolverá el ID, el nombre y el autor de cada receta.

Una receta consta de dos partes: un Design Studio Jitterpak (JPK) y un archivo de metadatos JSON que proporciona los pasos a el usuario deberá pasar para configurar la receta usando Citizen Integrator. (Ver Citizen Integrator - Configurar receta.)

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

En la lista de recetas que se devuelve, las recetas que son públicas y están disponibles para todos los usuarios estarán precedidas por un asterisco (*). Las recetas que son privadas y están disponibles solo para aquellos dentro de su organización no tendrán una asterisco.

Obtenga una receta específica y guarde el Jitterpak localmente

Devuelve los metadatos JSON para una receta específica de Citizen Integrator y (opcionalmente) guarda el Jitterpak que lo acompaña en un ubicación especificada.

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

Puede guardar localmente el Jitterpak que acompaña a una receta si desea hacer referencia o usar un Jitterpak de un receta Si ya comenzó una receta y Jitterpak, pero decide que desea realizar una personalización avanzada dentro de Design Studio, use esto para descargar el Jitterpak.

Para guardar los metadatos de la receta localmente, puede copiarlos desde el símbolo del sistema y guardarlos como un archivo JSON. Si usted está creando una nueva receta y desea comenzar con una receta similar como ejemplo, puede usar este comando para guardar una metadatos JSON de la receta.

Validar una receta

Valida los metadatos JSON para una receta local de Citizen Integrator. Debe usar este comando antes de cargar una receta para asegurarse es válido.

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

Subir una nueva receta y Jitterpak

Sube una nueva receta de Citizen Integrator.

Puede optar por cargar un nuevo Jitterpak y, opcionalmente, los metadatos JSON (usando el --recipe opción). Para receta específica para trabajar, debe tener los metadatos Jitterpak y JSON cargados, pero no es necesario que estén subido al mismo tiempo. De forma predeterminada, una receta cargada es privada para su organización.

jbcli recipe upload --jpk <jpkLocation> [--recipe <recipeLocation>]
Recipe uploaded, assigned ID <id>, and can be found at <location>

Actualizar una receta existente y Jitterpak

Actualiza una receta existente de Citizen Integrator.

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

Puede optar por actualizar un Jitterpak existente y, opcionalmente, los metadatos JSON (usando el --recipe opción). Para receta específica para trabajar, debe tener los metadatos Jitterpak y JSON cargados, pero no es necesario que estén subido al mismo tiempo. De forma predeterminada, una receta cargada es privada para su organización.

Las recetas proporcionadas por Jitterbit y puestas a disposición del público no pueden ser actualizadas ni editadas excepto por Jitterbit. Si desea editar una receta pública existente, recuperar el JSON y Jitterpak, edite los archivos localmente, y vuelva a cargarlos como su propia receta nueva usando el comando Cargar una nueva receta y Jitterpak.

Eliminar una receta existente y Jitterpak

Elimina una receta de Citizen Integrator existente que aún no se ha implementado. Para eliminar varias recetas, agregue más ID de receta separados por espacios. Se eliminarán los metadatos Jitterpak y JSON.

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

Las recetas proporcionadas por Jitterbit y puestas a disposición del público solo pueden ser eliminadas por Jitterbit. Solo puede eliminar esas recetas que has creado. Si es el administrador de una organización, puede eliminar cualquier receta que pertenecen a su organización.

Generar una receta y/o un archivo de configuración

Se usa con un Jitterpak provisto para generar una receta básica de Citizen Integrator que se puede usar como modelo de receta.

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

El comando da como resultado la creación de dos archivos: <project-name>-recipe.json y <project-name>-configure.json. A generar solo uno de estos archivos, agregue la opción apropiada (--recipeonly o --cfgonly).

El archivo de receta es una modelo de una receta que luego puede abrir en un editor de texto para completar campos como la descripción.

El archivo de configuración es una modelo del archivo que el comando Desplegar una receta espera, que contiene los valores reales de los campos que normalmente se exponen dentro de la interfaz web de Citizen Integrator. Tú se espera que llenen el archivo de configuración con valores y luego usen Desplegar una receta dominio para desplegar la receta.

Desplegar una receta

Implementa una receta de Citizen Integrator. Debe proporcionar una receta y un archivo de configuración (ver Generar una receta y/o un archivo de configuración). El ID de receta implementado se ser devuelto.

Al desplegar una receta, se ejecutará cada paso de acción de la receta, similar al proceso de despliegue del Interfaz web de Citizen Integrator.

jbcli recipe deploy <ID> --cfg <location>
Recipe deployed, ID <id>.

Lista de recetas implementadas

Enumera las recetas de Citizen Integrator implementadas. Puede mostrar todas las recetas implementadas o (opcionalmente) limitar la lista a una específica ambiente pasando el ID de ambiente. Se devolverá el ID, el nombre y el autor de cada receta implementada.

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

Listar ambientes de usuario

Anular la despliegue y eliminar una receta implementada

Anula la despliegue y elimina una receta de Citizen Integrator implementada. Para anular la despliegue y eliminar varias recetas, agregue más ID de receta separados por espacios. Se eliminarán los metadatos Jitterpak y JSON.

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

Las recetas proporcionadas por Jitterbit y puestas a disposición del público solo pueden ser eliminadas por Jitterbit. Solo puede eliminar esas recetas que has creado. Si es el administrador de una organización, puede eliminar cualquier receta que pertenecen a su organización.