Interfaz de Línea de Comandos de Jitterbit para recetas de Citizen Integrator para Jitterbit Design Studio

Introducción

La Interfaz de Línea de Comandos de Jitterbit (jbcli) es una herramienta de línea de comandos para interactuar con las recetas de Citizen Integrator. Una vez iniciado sesión en Harmony a través de jbcli, se puede gestionar su propio repositorio de recetas descargando, validando, subiendo, actualizando, generando, desplegando o eliminando metadatos de recetas y Jitterpaks de Design Studio.

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

Instalar la Interfaz de Línea de Comandos de Jitterbit

Descargue e instale el entorno de ejecución de JavaScript 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 Node.js (NPM):

   $ npm install -g jbcli
   

2. Use este comando para verificar que jbcli se haya instalado y esté funcionando correctamente:

   $ jbcli version
   1.4.1
   

Usar comandos de jbcli

Para usar jbcli, ejecute sus comandos desde un símbolo del sistema. Este es el formato general del comando, con texto entre ángulos reemplazado por valores, y texto dentro de corchetes cuadrados siendo opcional, y el símbolo del sistema representado por $:

$ jbcli <entity> <action> [options]

Comprobar versión

Verifica qué versión de jbcli estás ejecutando. Se devolverá el número de versión, siendo la versión actual de jbcli 1.4.1.

$ jbcli version
<version>

Iniciar sesión

Inicia sesión en jbcli con tus credenciales de Harmony. La opción host requerida depende de la región (una de NA, EMEA o APAC) con la que esté asociada tu organización (ver Encontrar mi región). Un mensaje confirmará la autenticación exitosa.

Utiliza la opción --password <myHarmonyPassword> para pasar tu contraseña en la línea de comandos:

$ jbcli login --email <username> --password <password> --host <host>
Usuario <username> autenticado exitosamente en <host>.

NA

$ jbcli login --email <username> --host https://citizen.jitterbit.net
Contraseña:
Usuario <username> autenticado exitosamente en https://citizen.jitterbit.net.

EMEA

$ jbcli login --email <username> --host https://citizen.jitterbit.eu
Contraseña:
Usuario <username> autenticado exitosamente en https://citizen.jitterbit.eu.

APAC

$ jbcli login --email <username> --host https://citizen.jitterbit.cc
Contraseña:
Usuario <username> autenticado exitosamente en https://citizen.jitterbit.cc.

Cerrar sesión

Cierra sesión de jbcli. Un mensaje confirmará el cierre de sesión exitoso.

$ jbcli logout
Usuario <myHarmonyUsername> cerrado sesión.

Listar organizaciones de usuario

Lista las organizaciones de las que eres miembro. Se devolverán los IDs y nombres de las organizaciones disponibles para ti.

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

Listar entornos de usuario

Lista los Entornos en la organización actual. Se devolverán los IDs y nombres de los entornos disponibles para ti.

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

Obtener propiedades

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

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

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

• Utiliza la clave defaultOrgId para ver qué organización es la predeterminada. Se devolverá el ID de la organización predeterminada.

  $ jbcli config get defaultOrgId
  defaultOrgId: orgId
  

• Utiliza la clave defaultEnvId para ver qué entorno es el predeterminado. Se devolverá el ID del entorno predeterminado.

  $ jbcli config get defaultEnvId
  defaultEnvId: envId
  

Set properties

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 utilizar para anular la organización o el entorno predeterminado. Ten en cuenta que las claves defaultOrgId y defaultEnvId son de solo lectura y no se pueden cambiar, ya que están definidas por la cuenta de Jitterbit de un usuario. Sin embargo, puedes establecer la organización o el entorno utilizados por los comandos jcli y anular el defaultOrgId y defaultEnvId utilizados al interactuar con las recetas de Citizen Integrator a través del jbcli.

• Para establecer una organización, utiliza la clave orgId con el ID de la organización deseada obtenido de List user organizations. Se devolverá el ID de la organización establecida.

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

• Para establecer un entorno, utiliza la clave envId con el ID del entorno deseado obtenido de List user environments. Se devolverá el ID del entorno establecido.

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

Si la organización y/o el entorno no se establecen a través de este comando, el orgId y/o envId se establecerán en el defaultOrgId y defaultEnvId.

List all recipes

Lista todas las recetas de Citizen Integrator que están disponibles para que las uses. Opcionalmente, puedes limitar la lista solo a aquellas recetas privadas de tu organización (mostradas entre corchetes). Se devolverán el ID, el nombre y el autor de cada receta.

Una receta consta de dos partes: un Jitterpak de Design Studio (JPK) y un archivo de metadatos JSON que proporciona los pasos que un usuario deberá seguir para configurar la receta utilizando 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 un asterisco.

Obtener una receta específica y guardar el Jitterpak localmente

Devuelve los metadatos JSON para una receta específica de Citizen Integrator y (opcionalmente) guarda el Jitterpak adjunto en una ubicación especificada.

$ jbcli recipe get <id> [--savejpk <location>]
-- recipe JSON --
Jitterpak guardado en <location>.

Puedes guardar el Jitterpak adjunto de una receta localmente si deseas hacer referencia o usar un Jitterpak de una receta existente. Si ya has comenzado una receta y un Jitterpak, pero decides que deseas realizar una personalización avanzada dentro de Design Studio, utiliza esto para descargar el Jitterpak.

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

Validar una receta

Valida los metadatos JSON para una receta local de Citizen Integrator. Debes usar este comando antes de subir una receta para asegurarte de que sea válida.

jbcli recipe validate --recipe <recipeLocation>
La receta es válida.

Subir una nueva receta y Jitterpak

Sube una nueva receta de Citizen Integrator.

Puedes optar por subir un nuevo Jitterpak y, opcionalmente, los metadatos JSON (usando la opción --recipe). Para que una receta específica funcione, necesitas tener tanto el Jitterpak como los metadatos JSON subidos, pero no es necesario que se suban al mismo tiempo. Por defecto, una receta subida es privada para tu organización.

jbcli recipe upload --jpk <jpkLocation> [--recipe <recipeLocation>]
Receta subida, asignada ID <id>, y se puede encontrar en <location>

Actualizar una receta existente y Jitterpak

Actualiza una receta existente de Citizen Integrator.

jbcli recipe update <id> --jpk <jpkLocation> [--recipe <recipeLocation>]
Receta con ID <id> actualizada.

Se puede optar por actualizar un Jitterpak existente y, opcionalmente, los metadatos JSON (usando la opción --recipe). Para que una receta específica funcione, es necesario tener tanto el Jitterpak como los metadatos JSON subidos, pero no es necesario que se suban al mismo tiempo. Por defecto, una receta subida es privada para tu organización.

Las recetas proporcionadas por Jitterbit y disponibles para el público no pueden ser actualizadas o editadas excepto por Jitterbit. Si deseas editar una receta pública existente, recupera el JSON y Jitterpak, edita los archivos localmente, y vuelve a subirlos como tu propia nueva receta usando el comando Subir una nueva receta y Jitterpak.

Eliminar una receta existente y Jitterpak

Elimina una receta existente de Citizen Integrator que aún no ha sido desplegada. Para eliminar múltiples recetas, agrega IDs de Receta adicionales separados por espacios. Tanto el Jitterpak como los metadatos JSON serán eliminados.

jbcli recipe delete <id> [<id> ...]
Receta con ID <id> [<id> ...] eliminada.

Las recetas proporcionadas por Jitterbit y disponibles para el público solo pueden ser eliminadas por Jitterbit. Solo se pueden eliminar aquellas recetas que has creado. Si eres el administrador de una organización, puedes eliminar cualquier receta que pertenezca a tu organización.

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

Usado con un Jitterpak proporcionado para generar un esqueleto de receta de Citizen Integrator que se puede usar como plantilla de receta.

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

El comando resulta en la creación de dos archivos: <project-name>-recipe.json y <project-name>-configure.json. Para generar solo uno de estos archivos, agrega la opción apropiada (--recipeonly o --cfgonly).

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

El archivo de configuración es una plantilla del archivo que el comando Deploy a recipe espera, que contiene los valores reales de los campos que normalmente se exponen dentro de la interfaz web de Citizen Integrator. Se espera que completes el archivo de configuración con valores y luego uses el comando Deploy a recipe para desplegar la receta.

Deploy a recipe

Despliega una receta de Citizen Integrator. Debes proporcionar un archivo de receta y un archivo de configuración (ver Generate a recipe and/or a configure file). Se devolverá el ID de la receta desplegada.

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

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

List deployed recipes

Lista las recetas de Citizen Integrator desplegadas. Puedes mostrar todas las recetas desplegadas o (opcionalmente) limitar la lista a un entorno específico pasando el ID del entorno. Se devolverán el ID, el nombre y el autor de cada receta desplegada.

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

Listar Entornos de Usuario

Desimplementar y eliminar una receta desplegada

Desimplemente y elimina una receta de Citizen Integrator desplegada. Para desimplementar y eliminar múltiples recetas, agrega IDs de receta adicionales separados por espacios. Tanto el Jitterpak como los metadatos JSON serán eliminados.

jbcli deployed-recipe delete <id> [<id>...]
Receta desplegada con ID <id> [<id>...] eliminada.

Las recetas proporcionadas por Jitterbit y disponibles para el público solo pueden ser eliminadas por Jitterbit. Solo puedes eliminar aquellas recetas que has creado. Si eres el administrador de una organización, puedes eliminar cualquier receta que pertenezca a tu organización.