Introducción
El conector de Box de Bizagi está disponible en el Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos de Bizagi a una cuenta de Box y usar sus servicios.
Para más información de las capacidades de este conector, visite nuestro Connectors Xchange.
|
Este Conector se desarrolló de acuerdo con los contenidos del API o información sobre los mismos suminstrada por Box. Bizagi no se hace responsable por errores derivados del llamado de los servicios del API, incongruencias en la documentación presentada por Box. Ni Bizagi ni sus filiales serán responsables de ofrecer cualquier tipo de garantía sobre los contenidos o errores derivados del llamado de los servicios del API. Bizagi y sus filiales no se harán responsables de las pérdidas, los costos o los daños en los que se incurra como consecuencia del acceso o el uso de los servicios del API de Box.
Este conector se encuentra actualmente en versión Beta. Úselo en ambientes de producción bajo su propio riesgo. |
Antes de iniciar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.El conector previamente instalado, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través del manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
3.Una cuenta en www.box.com.
4.Activar autenticación de 2 pasos.
5.Una aplicación de desarrollador registrada en Box y configurada de acuerdo a las necesidades del conector.
Activar autenticación de 2-pasos
Siga estos pasos para activar la autenticación de 2-pasos:
•Diríjase a https://app.box.com/account y busque la sección de autenticación
•Active el campo Require 2-step verification for unrecognized logins. Registre un celular para esta opción. A partir de ahora, cada que ingrese en un dispositivo no registrado en BOX, se le enviara un mensaje de texto de confirmación.
Crear una app registrada
Siga estos pasos para crear y registrar su app:
1.Diríjase a https://app.box.com/developers/console y haga clic en Create new app.
2.Elija la opción Enterprise Integration.
3.Seleccione la opcion OAuth 2.0 with JWT (server authentication) y haga clic en Next.
4.Dele un nombre a su app y haga clic en Create App.
Con esto la aplicación se creo exitosamente sin embargo se debe configurar para funcionar correctamente con el conector.
Configurar su aplicación
Las aplicaciones de Box tienen diversas opciones de autenticación que se deben configurar adecuadamente para poder usar este conector. Para esto siga estos pasos:
1.Diríjase a la configuración de su aplicación. Está se encuentra en https://app.box.com/developers/console/.
2.Encuentre la sección Application Access y seleccione la opción Enterprise. Haga clic en Save Changes.
3.Busque la sección Advance Features y active la opción Generate User Access Token. Haga clic en Save Changes.
4.Busque la sección Add and Manage Public Keys y haga clic en Generate a Public/Private Keypair.
Esta accion puede requerir una autenticación por mensaje de texto. Se descargar Un archivo JSON que contiene la mayoría de los parametros de autenticación. Guarde este archivo en un lugar seguro y al cual pueda acceder fácilmente.
5.Diríjase a https://app.box.com/master/settings/openbox y busque la sección Custom Application. Haga clic en Authorize New App
Se despliega una ventana que pide la clave API de la applicación (API key).
Esta clave la puede encontrar en https://app.box.com/developers/console/ en la sección OAuth 2.0 Credentials con el nombre de ClientID.
Autorize el acceso para la plicación para terminar las configuraciones necesarias para el conector .
Configurar el conector
Para configurar el conector siga los pasos descritos en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
Tenga en cuenta los siguientes parámetros de autenticación:
•Authentication method: Custom
•clientId: Número de Id del cliente. El valor de este campo se encuentra en el archivo JSON descargado previamente..
•clientSecret: Secreto del cliente. El valor de este campo se encuentra en el archivo JSON descargado previamente..
•appId: Número de Id de la app como se muestra en la sección de general en la consola del app. Puede ser el enterprise ID o el user ID..
•appType: Tipo del appId. Puede ser enterprise o user..
•publicKeyId: Número de Id de la llave publica. El valor de este campo se encuentra en el archivo JSON descargado previamente..
•privateKey: Llave privada del app. El valor de este campo se encuentra en el archivo JSON descargado previamente..
•passphrase: El valor de este campo se encuentra en el archivo JSON descargado previamente..
Usar el conector
Éste conector permite el uso desde Bizagi de varios métodos disponibles para el uso de los servicios de .
Para configurar el conector, por favor visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.
Al usar el conector, asegúrese de tener en cuenta, para los métodos disponibles, los siguientes detalles:
Get child folders (Obtener Subcarpetas)
Esta acción obtiene los elementos de una carpeta específica de tipo 'folder'.
Para configurar las entradas de esta acción tenga en cuenta:
• folderId (Requerido): ID de la carpeta. Este parametro debe ser de tipo String en su modelo de Bizagi.
• offset: indica el inicio de los elementos a traer. Si no se especifica, por defecto se toma 0. Más información: https://developer.box.com/reference#offset. Este parametro debe ser un número en su modelo de Bizagi.
• limit: indica la cantidad de elementos a traer. Si no se especifica, por defecto se toma 100.. Este parametro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el arreglo output con la colección correspondiente en Bizagi, vinculando los atributos de la entidad de la colección.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#get-a-folders-items.
Get folder items (Obtener los elementos de una carpeta)
Esta acción obtiene los elementos de una carpeta específica, estos pueden ser de tipo 'file' o 'folder'.
Para configurar las entradas de esta acción tenga en cuenta:
• folderId (Requerido): ID de la carpeta. Este parametro debe ser de tipo String en su modelo de Bizagi.
• offset: indica el inicio de los elementos a traer. Si no se especifica, por defecto se toma 0. Más información https://developer.box.com/reference#offset. Este parametro debe ser un número en su modelo de Bizagi.
• limit: indica la cantidad de elementos a traer. Si no se especifica, por defecto se toma 100.. Este parametro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el arreglo output con la colección correspondiente en Bizagi, vinculando los atributos de la entidad de la colección.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#get-a-folders-items.
Get file info (Obtener información de un Archivo)
Esta acción obtiene la información general de un archivo. Dentro de las salidas, el 'sharedLink' aparece vacío si este no ha sido creado.
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#files.
Get metadata of a file (Obtener Metadata de un archivo)
Esta acción obtiene la metadata que haya sido creada para un archivo especificado. Si no se ha creado metadata para dicho archivo, la lista de items será vacía.
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo al cual se le consultará la metadata. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#get-metadata.
Get versions (Obtener Versiones de un Archivo)
Esta acción obtiene las versiones de un archivo, excepto la versión actual. Si el archivo no tiene versiones, la lista será vacía.
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo al cual se le consultará las versiones. Este parametro debe ser de tipo String en su modelo de Bizagi.
• offset: indica el inicio de los elementos a traer. Si no se especifica, por defecto se toma 0. Más información https://developer.box.com/reference#offset. Este parametro debe ser un número en su modelo de Bizagi.
• limit: indica la cantidad de elementos a traer. Si no se especifica, por defecto se toma 100.. Este parametro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el arreglo output con la colección correspondiente en Bizagi, vinculando los atributos de la entidad de la colección.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#view-versions-of-a-file.
Upload file (Subir Archivo)
Esta acción permite subir un archivo a la carpeta específicada.
Para configurar las entradas de esta acción tenga en cuenta:
• fileName (Requerido): el nombre del archivo el cual quedará en Box. Este parametro debe ser de tipo String en su modelo de Bizagi.
• destinationPath (Requerido): el id de la carpeta donde quedará alojado. Para guardar archivos en la carpeta raíz definir este valor como: 0. Este parametro debe ser de tipo String en su modelo de Bizagi.
• fileContents (Requerido): el contenido del archivo en base64. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#upload-a-file.
Upload file version (Subir Version de un Archivo)
Esta acción permite subir una nueva versión de un archivo ya existente. Si se sube un archivo con diferente nombre, el nombre del archivo original no es actualizado. No suba una versión con diferente extensión, esto puede generar problemas al visualizar y descargar el archivo..
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo al cual se le subirá una nueva versión. Este parametro debe ser de tipo String en su modelo de Bizagi.
• fileName (Requerido): nombre del archivo a subir (este nombre no modifica el original del archivo en Box). Este parametro debe ser de tipo String en su modelo de Bizagi.
• fileContents (Requerido): el contenido del archivo en base64. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#upload-a-new-version-of-a-file-1.
Download file (Descargar Archivo)
Esta acción descarga un archivo de Box específico identificado por su ID, si no se especifica el 'versionId', se descarga el archivo con la versión actual.
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo a descargar. Este parametro debe ser de tipo String en su modelo de Bizagi.
• versionId: indica el ID de la versión del archivo a descargar. Puede ser opcional, si no se especifica se descarga la última versión del archivo.. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#download-a-file.
Create folder (Crear Carpeta)
Esta acción crea una carpeta en un lugar específico.
Para configurar las entradas de esta acción tenga en cuenta:
• name (Requerido): nombre de la carpeta que será creada. Restricciones: Longitud de 255 caracteres o menos, Nombres que contengan caracteres ASCII, Nombres que no contengan "/" o "\", Nombres como: "." o ".." no son permitidos. Este parametro debe ser de tipo String en su modelo de Bizagi.
• destinationPath (Requerido): el ID de la carpeta donde se creará. Para crearla en la carpeta raíz definir este valor como: 0. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#create-a-new-folder.
Create shared link (Crear Link para Compartir)
Esta acción crea un link para compartir un documento o carpeta.
Para configurar las entradas de esta acción tenga en cuenta:
• objectType (Requerido): puede ser (folders o files), indica el tipo de objecto al cual se le creará un link. Este parametro debe ser de tipo String en su modelo de Bizagi.
• objectId (Requerido): el ID de la carpeta o archivo. Este parametro debe ser de tipo String en su modelo de Bizagi.
• accessType (Requerido): indica el nivel de acceso, puede ser (company, open o collaborators). Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#create-or-update-shared-link.
Copy file (Copiar Archivo)
Esta acción copia un archivo específico en una carpeta específica.
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo el cual será copiado. Este parametro debe ser de tipo String en su modelo de Bizagi.
• destinationPath (Requerido): ID de la carpeta donde se copiará el archivo.. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#copy-a-file.
Copy folder (Copiar Carpeta)
Esta acción copia una carpeta y todo su contenido al lugar especificado.
Para configurar las entradas de esta acción tenga en cuenta:
• folderId (Requerido): ID de la carpeta que será copiada. Este parametro debe ser de tipo String en su modelo de Bizagi.
• destinationPath (Requerido): ID de la carpeta donde se copiará la carpeta.. Este parametro debe ser de tipo String en su modelo de Bizagi.
• newName: nombre para la carpeta copia, si no se especifica, el nombre por defecto viene de la carpeta original más un consecutivo. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#copy-a-folder.
Delete file (Borrar Archivo)
Esta acción elimina un archivo existente.
Para configurar las entradas de esta acción tenga en cuenta:
• fileId (Requerido): ID del archivo a ser eliminado. Este parametro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#delete-a-file.
Delete folder (Borrar Carpeta)
Esta acción elimina una carpeta. Puede elegir si borrar el contenido junto con la carpeta..
Para configurar las entradas de esta acción tenga en cuenta:
• folderId (Requerido): ID de la carpeta que será eliminada. Este parametro debe ser de tipo String en su modelo de Bizagi.
• recursive: indica si eliminar el contenido de la carpeta o no. true para eliminar todo su contenido, de lo contrario false. Si no se especifica dicha entrada el valor por defecto que se toma es false.. Este parametro debe ser de tipo boolean en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para mas información de este metodo diríjase a la documentacón oficial de Box - https://developer.box.com/reference#delete-a-folder.
Last Updated 10/28/2022 11:41:56 AM