Introducción
El conector de SharePoint online 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 SharePoint 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 suministrada por SharePoint. Bizagi no se hace responsable por errores derivados del llamado de los servicios del API, incongruencias en la documentación presentada por SharePoint. 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 SharePoint. |
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 https://products.office.com/sharepoint/collaboration.
4.Encuentre los siguientes parámetros de conexión de su servicio de SharePoint:
a.URL
b.Tenant name
c.Tenant ID
d.Resource ID
5.Cree una nueva aplicación y guarde los siguientes parámetros
a.Client ID
b.Client secret
6.Agregue los permisos necesarios a su aplicación de SharePoint
Autenticación
|
El proceso de autenticación solo puede ser realizado por un Usuario Administrador. |
Para comenzar a configurar el conector, debe configurar el acceso a Sharepoint. Puede hacerlo con Sharepoint EntraID. Para autenticarse, siga los siguientes pasos:
Abra Powershell y ejecute el siguiente script:
$app = Register-PnPAzureADApp -ApplicationName "Here the name of your application" -Store CurrentUser -Tenant yourtenant.onmicrosoft.com -Username "your-username" -Password (Read-Host -AsSecureString -Prompt "Enter Password") -CertificatePassword (Read-Host -AsSecureString -Prompt "Enter Certificate Password") -OutPath .\
$app.'AzureAppId/ClientId'
$app.'Certificate Thumbprint'
Después de ejecutar el script, se abrirá una pantalla de inicio de sesión y se le pedirá que ingrese la siguiente información:
1.Contraseña de usuario.
2.Contraseña del certificado.
3.Código de autenticación.
|
Tenga en cuenta que la información anterior se le proporcionará en la salida del script. |
Después de ejecutar el script en la misma ventana, obtendrá el ClientId y la Huella Digital del Certificado. Tenga en cuenta que debe guardar estos datos para configurar el conector.
Después de configurar la nueva aplicación EntraID, aparecerá la siguiente vista resumen:
|
El certificado de Sharepoint Entra ID (archivos .pfx y .cer) se almacena en la ruta donde se ejecutó el script anterior.
|
|
Para la configuración del conector necesita un archivo .pem, el cual se puede obtener convirtiendo el archivo .pfx que se almacena en la ruta donde se ejecuta el script. Puede usar un convertidor en línea como sslshopper.com.
El archivo .pem generado contiene la Clave Privada y el Certificado.
|
|
Luego, transforme el archivo de Clave Privada (key.pem) a base 64. Puede usar un codificador en línea como base64.guru.
|
URL y Tenant name
•URL: Es la URL que se usa para acceder a los servicios de SharePoint. Usualmente es de la forma https://[nombre-de-la-empresa].sharepoint.com pero puede usarse para sitios individuales.
•Tenant name: Nombre de su tenant en SharePoint. Es la sección antes de su URL que existe antes de la sharepoint.com.
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: El client id de su servicio de SharePoint.
•TENANTID: El tenant id de su servicio de SharePoint.
•CLIENT_SECRET: El client secret de su servicio de SharePoint.
•RESOURCEID: El resource id de su servicio de SharePoint.
•TENANT_NAME: El tenant name de su servicio de SharePoint.
•URL: La URL de su servicio de SharePoint.
Usar el conector
Éste conector permite el uso desde Bizagi de varios métodos disponibles para el uso de los servicios de SharePoint.
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:
Copy file (Copiar archivo)
Esta acción permite copiar un archivo a otro folder.
Para configurar las entradas de esta acción tenga en cuenta:
•file_path: Ruta completa con nombre y extensión del archivo a copiar
•destination_path: Nueva ruta de destino del archivo. Se debe incluir el nombre del archivo con su respectiva extensión. Se puede cambiar el nombre del archivo usando esta acción
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Create file (Crear archivo)
Esta acción permite cargar un archivo nuevo a SharePoint especificando ruta del folder.
|
Si existe un archivo con el mismo nombre y extensión, esta acción lo sobrescribirá |
Para configurar las entradas de esta acción tenga en cuenta:
•folder_path: Ruta de la carpeta en sharepoint para almacenar el archivo. Esta carpeta debe existir
•file_name: Nombre y extensión del archivo a crear
•file: Cadena de caracteres en base 64 del archivo a crear. El peso permitido del archivo depende de la configuración en 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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Delete a folder (Borrar carpeta)
Esta acción borra un folder. Si no existe el folder esta acción no lanza un error.
Para configurar las entradas de esta acción tenga en cuenta:
•folder_path: Ruta de la carpeta a borrar. No se puede borrar una carpeta si tiene archivos dentro de ella, se debe borrar el contenido de la carpeta para poder ejecutar esta acción.
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Create a folder (Crear carpeta)
Esta acción crea una carpeta en SharePoint.
|
Si existe una carpeta con el mismo nombre y dirección, no se genera una nueva carpeta y se retorna la información de la carpeta vieja. |
Para configurar las entradas de esta acción tenga en cuenta:
•folder_path: Ruta de la carpeta a crear. Debe incluir el nombre de la nueva carpeta al final
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Delete file (Borrar carpeta)
Esta acción borra un archivo especificando la ruta completa. Si no existe el archivo esta acción no lanza un error.
Para configurar las entradas de esta acción tenga en cuenta:
•file_fullpath: Ruta completa con nombre y extensión del archivo a borrar
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Get file content (Obtener contenido de un archivo)
Esta acción descarga un archivo.
Para configurar las entradas de esta acción tenga en cuenta:
•folder_path: Ruta de la carpeta que contiene el archivo a descargar
•file_name: Nombre y extensión del archivo a descargar
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Get files in folder (Obtener archivos de una carpeta)
Esta acción obtiene un listado de archivos contenidos en un folder.
Para configurar las entradas de esta acción tenga en cuenta:
•folder_path: Ruta de la carpeta
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Update a file (Actualiza un archivo)
Esta acción permite actualizar un archivo existente en SharePoint.
Para configurar las entradas de esta acción tenga en cuenta:
•folder_path: Ruta de la carpeta que contiene el archivo a actualizar
•file_name: Nombre y extensión del archivo a actualizar
•file: archivo en base64 a actualizar
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Get lists (Obtener lista)
Esta acción obtiene una lista completa de las listas disponibles en SharePoint.
Para configurar las entradas de esta acción tenga en cuenta:
•list_hidden: Especifica si de deben incluir las listas ocultas o no. Este parámetro debe ser de tipo boolean 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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Create a list (Crear lista)
Esta acción crea una lista en sharepoint.
Para configurar las entradas de esta acción tenga en cuenta:
•title: Título de la lista
•description: Descripción de la lista
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Update list by id (Actualizar lista)
Esta acción actualiza una lista por id.
Para configurar las entradas de esta acción tenga en cuenta:
•id: GUID de la lista a actualizar
•title: Título de la lista
•description: Descripción de la lista
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Create a custom field for a list by id (Crear campo personalizado)
Esta acción crea un campo personalizado para una lista proporcionando su id.
|
Esta acción puede generar campos personalizados duplicados en su lista |
Para configurar las entradas de esta acción tenga en cuenta:
•guid_list: GUID de la lista a la cual se va a agregar el campo perzonalizado
•title: Título del campo personalizado
•description: Descripción del campo personalizado
•is_required: Indica si el campo personalizado es requerido. Este parámetro debe ser de tipo boolean en su modelo de Bizagi.
•field_type: Tipo del campo personalizable
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543(v%3Doffice.15).
Get fields from a list (Obtener campos de una lista)
Esta acción obtiene los campos de una lista.
Para configurar las entradas de esta acción tenga en cuenta:
•list_name: Nombre de la lista
•list_hidden: Indica si se deben listar los campos ocultos. Este parámetro debe ser de tipo boolean 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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Delete a list (Borrar una lista)
Esta acción borra una lista de SharePoint. Si no existe la lista esta acción no lanza un error.
Para configurar las entradas de esta acción tenga en cuenta:
•guid: GUID de la lista a borrar
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Create list item (Crear un elemento de una lista)
Esta acción crea un elemento de lista.
|
Esta acción puede generar elementos duplicados en su lista |
Para configurar las entradas de esta acción tenga en cuenta:
•list_name: Nombre de la lista que va a contener el elemento nuevo
•list_itemName: Nombre del elemento de lista
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Get list items (Obtener elemento de una lista)
Esta acción obtiene la lista de elemento de una lista de SharePoint.
Para configurar las entradas de esta acción tenga en cuenta:
•lit_name: Nombre de la lista
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Update list item (Actualizar elemento de una lista)
Esta acción actualiza un elemento de una lista.
Para configurar las entradas de esta acción tenga en cuenta:
•list_itemId: Id interno manejado dentro de la lista
•list_itemName: Nuevo nombre para el elemento
•list_name: Nombre de la lista que contiene el elemento a actualizar
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Delete list item by id (Borrar elemento de una lista)
Esta acción borra un elemento especifico de una lista proporcionando su id.
Para configurar las entradas de esta acción tenga en cuenta:
•list_itemId: Id interno manejado dentro de la lista
•list_name: Nombre de la lista que contiene el elemento a actualizar
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Create a file attachment to a list item (Adjuntar archivo a una lista)
Esta acción adjunta un documento a un elemento de lista.
Para configurar las entradas de esta acción tenga en cuenta:
•list_name: Nombre de la lista
•item_id: id del elemento en la lista (no es su GUID)
•file: archivo en base 64
•file_name: nombre del archivo
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest.
Create list item with multiple fields (Crear elemento de una lista con muchos campos personalizados)
Esta acción crea un nuevo elemento a la lista enviando múltiples campos personalizados.
|
Esta acción puede generar elementos duplicados en su lista |
Para configurar las entradas de esta acción tenga en cuenta:
•list_name: Nombre de la lista
•custom_fields: Lista de objetos con el nombre del campo personalizado y su respectivo valor
•field_name: nombre del campo personalizado
•field_value: valor del campo personalizado
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543(v%3Doffice.15).
Get file metadata (Obtener los datos adicionales de un archivo)
Esta acción obtiene datos adicionales de un archivo.
Para configurar las entradas de esta acción tenga en cuenta:
•file_full_path: Ruta completa del archivo
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 más información de este método diríjase a la documentación oficial de SharePoint - https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest.
Troubleshooting
Después de configurar el conector de Sharepoint MS EntraID, puede encontrar los siguientes mensajes de error en el Portal de Trabajo:
Cuando el mensaje mostrado en la imagen aparece, usted debe revisar la ruta de la acción que se está ejecutando. Generalmente, la ruta para todas las conexiones de Sharepoint es: Documentos Compartidos/[Carpeta].
En caso de que el siguiente mensaje aparezca, adiocionalmente a la especificación de la ruta, usted debe asegurarse de que el CLIENTID, el CLIENT_SECRET y el RESOURCEID están configurados correctamente..
Last Updated 12/10/2024 2:53:45 PM