Sistemas de información al estudiante

Configure a user type of integration profile. Manually run and monitor an SIS synchronization.

Translatable
Para configurar un perfil de los Sistemas de información de estudiantes (SIS), se debe tener el siguiente rol:
  • Administrador general del sistema

Alma puede exportar/importar usuarios a/desde un Sistema de información de estudiantes (SIS)

Para importar usuarios, el SIS debe colocar un archivo zip que contenga un archivo XML con todos los usuarios en una ubicación S/FTP definida. Alma extrae el archivo, analiza la información y carga los usuarios (de tipo Externo) de acuerdo con los parámetros definidos en el perfil de integración del SIS.

  • Todos los identificadores primarios y adicionales deben ser únicos para los usuarios, incluso para el mismo usuario.
  • User data must be included in a zip file for import and synchronization purposes.
  • Si se le presenta el error “No se puede analizar fichero”, intente comprimir archivos XML para su esquema.

Es posible que desee exportar usuarios al SIS, por ejemplo, usuarios que deban dinero a la biblioteca o que tengan determinadas sanciones. Esto permite al SIS impedir que estos usuarios realicen determinadas actividades hasta que liquiden sus obligaciones pendientes con la biblioteca.

Información de contexto

For a detailed overview of user management in Alma, see https://developers.exlibrisgroup.com/alma/integrations/user-management. Nótese que su sistema de autenticación externa debe estar en funcionamiento antes de que se pueda comenzar la implementación de Alma.

For details on SIS integration, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis

For overview on user management and SIS integration, watch Creating and Updating User Records(5:06).

Configuring an Integration Profile

To configure an integration profile to a Student Information Systems (SIS):
  1. On the Integration Profile List page (Configuration Menu > General > External Systems > Integration Profiles), select Add Integration Profile. Se abre la primera página del asistente de perfil de integración.

    users_integration_profile_1_ux_newUI.png

    Asistente del perfil de integración de usuarios - Página 1
  2. En la primera página del asistente, se debe introducir la siguiente información:
    1. Introducir un código y un nombre para el perfil que se está definiendo.
    2. From the Integration type drop-down list, select Users.
    3. From the S/FTP connection type drop-down list, select the name of the FTP connection that you previously defined.
    4. Indicate the type of SIS with which you are integrating (for Ex Libris' informational purposes). Téngase en cuenta que esto es obligatorio.
    5. De forma opcional, se puede introducir una descripción de la integración que se está configurando.
    6. Select Next. Aparecerá la segunda página del asistente.

      Integration Profile page_newUI.png

  3. En la segunda página del asistente, se debe introducir la siguiente información:
    Campos del perfil de integración de los usuarios
    SecciónCampoDescripción
    Import (used for the initial import of users. Un registro no se importa si se encuentra un registro coincidente. Ejecútelo manualmente una vez, o una vez al año. Afterwards, use the Synchronize section / job.)ActivasSi la tarea está activa, se ejecutará en función de la opción de programación seleccionada. Si está inactiva, no se ejecutará.

    The job is called Users IMPORT using <integration profile name>.

    Tipo de registro

    The type of user record to create in Alma:Contact,Public, or Staff.

    Cada perfil SIS carga un tipo de usuario (Personal o Público). Para procesar un tipo diferente de usuario, necesita definir otro perfil SIS. If your institution has more than one type of user in a single SIS, it is recommended that you define the Record type in the profile as Public. Esto significa que todos los usuarios se crearán en Alma como usuarios públicos. A continuación, puede usar los roles de usuario para diferenciar entre usuarios y personal.

    For more information on selecting the record type, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.

    Ruta de fichero de entradaUn subdirectorio de la ruta especificada cuando se crea la conexión FTP segura (obligatorio). For example, if you enter Alma in the Sub-directory field during secure FTP connection configuration (note that it is mandatory to specify a value in this field) and you enter SIS_import in the Input file path field, the SIS files are imported from the Alma/SIS_import directory (under the root FTP directory).
    Versión XSD de usuarioSelect version 1 or 2. Note that 2 should be used. For detailed information about these versions, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
    Convertidor XSLSeleccione un convertidor XSL para procesar los ficheros XML del Perfil de Integración con XSL, antes de colocarlos en la ubicación de salida. Select Manage Converters to view and edit the converter. For details, see Integration XSL Converters.
    Create Sample File (available when editing an existing profile)Select an existing user and select Create Sample File to create a new user XML file from an existing user. Esto permite obtener una vista previa de la forma en que se debe estructurar un fichero XML de usuario.
    You can also view a sample XML file on https://developers.exlibrisgroup.com/alma/apis/xsd/external_sys_user.xsd. Note that XML attributes are case-sensitive.
    Synchronize Used for ongoing synchronization of existing Alma users. Alma intenta fusionar la información si se encuentra un registro coincidente. Note that the mandatory fields in the User Registration Form also apply when creating new user accounts via this job, but not when updating existing accounts- see Managing Patron Services.ActivasSi la tarea está activa. Si la tarea está activa, se ejecutará en función de la opción de programación seleccionada. Si está inactiva, no se ejecutará.

    The job is called Users SYNCHRONIZE using <integration profile name>.

    Tipo de registro

    The type of user record to create in Alma:Contact,Public, or Staff.

    Cada perfil SIS carga un tipo de usuario (Personal o Público). Para procesar un tipo diferente de usuario, necesita definir otro perfil SIS. If your institution has more than one type of user in a single SIS, it is recommended that you define the Record type in the profile as Public. Esto significa que todos los usuarios se crearán en Alma como usuarios públicos. A continuación, puede usar los roles de usuario para diferenciar entre usuarios y personal.

    For more information on selecting the record type, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.

    Tipo de ID de CoincidenciaEl tipo de identificador único predefinido en Alma que se utiliza como el identificador con el se desea hacer coincidir usuarios existentes en Alma. For detailed information on match IDs, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
    Tipo de sincronizaciónSwap all, which means that all existing user records will be replaced by matching incoming user records. For detailed information on the synchronization workflow, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
    Registro sin coincidenciaAlma añade un nuevo registro de usuario si no ha podido encontrar un registro coincidente, o rechaza el registro entrante si no se encuentra ninguna coincidencia para él. Por defecto, los registros se añaden.
    Ruta de fichero de entradaUn subdirectorio de la ruta especificada cuando se crea la conexión FTP segura (obligatorio). For example, if you specified Alma in the Sub-directory field during secure FTP connection configuration (note that it is mandatory to specify a value in this field) and you enter SIS_import in the Input file path field, the SIS files are imported to the Alma/SIS_import directory (under the root FTP directory).
    ProgramaIf you select Not scheduled, the job runs only when you manually run it. For details, see the following sections Manually Importing/Exporting SIS Information and Manually Synchronizing SIS Information.

    Las opciones de programación disponibles varían en función del centro de datos.

    Versión XSD de usuarioVersión 1 o 2. Nótese que se debe utilizar la versión 2. For detailed information about these versions, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
    Convertidor XSLSeleccione un convertidor XSL para procesar los ficheros XML del Perfil de Integración con XSL, antes de colocarlos en la ubicación de salida. Select Manage Converters to view and edit the converter. For details, see Integration XSL Converters.
    Perfil de integración usado para (Esploro solamente)Aparece sólo si Esploro está habilitado para su institución.

    Seleccionar uno de los siguientes:

    • User and Researchers – If you include both user and researcher information in your file.
    • Users only – If you include only user information (no researcher fields) in your file.
    • Researchers only – If you wish to add or update only the researcher information of the user. Tenga en cuenta que cada usuario debe incluir el identificador primario de un usuario existente de Alma y que la otra información del usuario, si se incluye en el fichero, no será añadida ni actualizada por el cargador. You can load researcher identifiers as part of the Researchers Only option. For more information, see Adding Researchers.

    The synchronization is performed in swap all mode, which means that all of the existing information is replaced. Si el campo no existe en el fichero de entrada, se elimina del usuario o investigador existente. Therefore, the input file must always include all of the external information for the user or researcher, not only the updated fields.

    Seleccionar campos de investigador para el usuario (Esploro solamente)Aparece sólo si Esploro está habilitado para su institución.

    Seleccionar uno de los siguientes:

    • All Researcher Fields
    • Selected Researcher Fields – When selected, select one or more fields to update from the quick pick list that appears.
    Export User By Conditions (used to export users that should be blocked due to unpaid fines)

    Los usuarios exportados incluyen usuarios con multas superiores al umbral y usuarios con sanciones, ya sea en base a los tipos de sanción configurados o a todas las sanciones si no se configuró ninguna. Si un usuario tiene una multa mayor que el umbral O el usuario tiene una sanción, entonces se exportará el usuario.

    ActivasSi la tarea está activa o no. Si la tarea está activa, se ejecutará en función de la opción de programación seleccionada. Si está inactiva, no se ejecutará.

    The job is called Users EXPORT using <integration profile name>.

    Tipo de ID de usuarioSee the above explanation for Match ID type.
    Grupo de usuarioEl grupo/s de usuarios al que pertenecen los usuarios que se desean exportar. Si no se especifica ningún valor, se exportarán los usuarios que pertenezcan a cualquiera de los grupos de usuarios configurados.
    Tipos de sanciónThe previously defined block types (see Configuring Block Preferences) whose associated users you want to export. Si no se especifica ningún valor, se exportarán los usuarios que coincidan con cualquiera de los tipos de sanción configurados.
    Antigüedad de la Multa/Cuota (días)Se exportarán los usuarios (de los grupos seleccionados y con los tipos de bloque seleccionados) cuyas multas/cuotas sean más antiguas que el número de días estipulado. Por defecto, este número es 0.
    Cantidad umbralSe exportarán aquellos usuarios (de los grupos seleccionados y con los tipos de bloque seleccionados) cuyas multas/cuotas superen el umbral estipulado. Por defecto, la cantidad umbral es 0.
    Usuario con préstamos activosSeleccionar esta casilla para incluir solo a aquellos usuarios que tienen préstamos activos.
    Tipo de préstamo activoCuando se selecciona Usuario con préstamos activos, aparece este campo. Los usuarios con préstamos activos se incluirán en la exportación si los tipos de préstamo coinciden con los tipos de préstamo seleccionados.
    Ruta de fichero de salidaUn subdirectorio de la ruta especificada cuando se crea la conexión S/FTP. For example, if you specified Alma in the Sub-directory field during S/FTP connection configuration and you enter SIS_export in the Output file path field, the SIS files are exported to the Alma/SIS_export directory (under the root FTP directory).
    ProgramaIf you select Not scheduled, the job runs only when you manually run it. For details, see the following sections Manually Importing/Exporting SIS Information and Manually Synchronizing SIS Information.

    Las opciones de programación disponibles varían en función del centro de datos.

    Export Users (used to export old, inactive, or deleted users, or recently updated/created users - not for an ongoing full export of users)ActivasSi la tarea está activa. Si la tarea está activa, se ejecutará en función de la opción de programación seleccionada. Si está inactiva, no se ejecutará.

    The job is called Users EXPORT_USERS using <integration profile name>.

    Grupo de usuarioSeleccionar uno o más grupos de usuarios para identificar los registros de usuario que se tendrán en cuenta para la exportación.
    Días desde la creaciónEstablecer una condición, en número de días, que identifique cuándo incluir un registro de usuario en la exportación. Este parámetro indica el número de días desde que se creó el registro de usuario en Alma. El registro de usuario que cumpla este criterio también debe ser miembro de uno de los grupos de usuarios seleccionados en el parámetro Grupos de usuarios para que el registro de usuario se pueda exportar.

    Por ejemplo, si aquí se especifica 10, los registros de usuario que se crearon en los últimos 10 días se incluirán en la exportación.

    Días desde la actualizaciónEstablecer una condición, en número de días, que identifique cuándo incluir un registro de usuario en la exportación. This parameter indicates the number of days since the patron record was updated in Alma (see example in Days since creation). El registro de usuario que cumpla este criterio también debe ser miembro de uno de los grupos de usuarios seleccionados en el parámetro Grupos de usuarios para que el registro de usuario se pueda exportar.
    Días desde la supresiónEstablecer una condición, en número de días, que identifique cuándo incluir un registro de usuario en la exportación. This parameter indicates the number of days since the patron record was deleted in Alma (see example in Days since creation). El registro de usuario que cumpla este criterio también debe ser miembro de uno de los grupos de usuarios seleccionados en el parámetro Grupos de usuarios para que el registro de usuario se pueda exportar.
    Ruta de fichero de salidaUn subdirectorio de la ruta especificada cuando se crea la conexión FTP segura. Por ejemplo, si se especificó Alma en el campo Subdirectorio durante la configuración de la conexión FTP segura y se introduce SIS_Export en el campo Ruta del archivo de salida, los archivos se exportarán al directorio Alma/SIS_Export (en el directorio FTP raíz).
    ProgramaIf you select Not scheduled, the job runs only when you manually run it. For details, see the following sections Manually Importing/Exporting SIS Information and Manually Synchronizing SIS Information.

    Las opciones de programación disponibles varían en función del centro de datos.

    Versión XSD de usuarioVersión 1 o 2. Nótese que se debe utilizar la versión 2. For detailed information about these versions, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
    Online Import(Used to import users from a student management system)

    Not in use!

    ActivasSi la función está activa o no. Si la función está activa, un proceso accede al sistema de gestión de estudiantes para extraer la información del usuario, si esta existe. Si la función no está activa, el proceso no se ejecutará. El valor por defecto es no activo.
    Base URLSe enviará el servidor/puerto al que llama la API en lo relativo a los cambios de usuario. Obligatorio si la acción Importar online está en estado Activo. Note that this should be a REST API which has user information in the format described on the Developer Network.
    Nombre de usuarioNombre de usuario para las credenciales de autenticación básica de HTTP. Opcional. Si se deja vacío, las solicitudes se enviarán sin credenciales.
    ContraseñaContraseña para las credenciales de autenticación básica de HTTP. Opcional. Si se deja vacío, las solicitudes se enviarán sin credenciales.
  4. Select Save. El perfil se guardará.
  5. When editing the profile, the Contact Info tab appears. Note that the contact details entered on this tab are for information purposes only (see Adding User Contact Information). Users can also be configured to receive email notifications that are sent after a scheduled job runs. Se pueden configurar las notificaciones que se enviarán a los usuarios de Alma o las direcciones de correo electrónico introducidas de forma manual. For information, see Configuring Email Notifications for Scheduled Jobs.
Cuando se ejecuta la tarea Exportar Usuarios basada en el perfil de integración que ha creado, el proceso de exportación crea un fichero XML en el formato que utilizan las acciones Importar y Sincronizar (véanse las secciones Importar y Sincronizar definidas en la sección Acciones de la pestaña Acciones del perfil de integración que haya guardado). Se puede utilizar un archivo XSL para modificar el formato. The XSL file is available and customizable in Customize Letters (see Configuring Alma Letters).

Manually Importing/Exporting SIS Information

Para ejecutar y supervisar manualmente una importación/exportación del SIS:

When editing the profile, in the Import/Export section of the Actions tab, ensure that the Active radio button is selected and select Run.

La tarea se ejecutará tan pronto como Alma pueda suministrarla. Un fichero que se importa se marca para que no se ejecute de nuevo. Si las notificaciones por correo electrónico están habilitadas en Alma, recibirá una notificación por correo electrónico de una importación y Alma enviará notificaciones de una exportación al SIS.

To view the status of the job, the number of files processed, and other data, select Job history in the row actions list for the appropriate User profile on the Integration Profile List page.

The status Completed Successfully does not mean that all files were imported or exported successfully. Más bien significa que la tarea se ha completado sin ningún error.

If you import a user whose primary identifier matches a primary identifier of one of the existing users, a User rejected on identifier event is generated.

En la sincronización de los usuarios, Alma alerta solo ante una tasa de falla de 5 %. Si el número de usuarios rechazados es inferior al 5 % del número total de usuarios procesados, la tarea se marcará como "Terminada con éxito".

Sincronizar manualmente información del SIS

Para ejecutar y supervisar manualmente una sincronización del SIS:

When editing the profile, in the Synchronize section of the Actions tab, select Run.

La tarea de sincronización se ejecutará tan pronto como Alma pueda suministrarla. El fichero que se ha sincronizado se marca para que no se ejecute de nuevo. Si las notificaciones por correo electrónico están habilitadas en Alma, recibirá una notificación por correo electrónico.

To view the status of the job, the number of files processed, and other data, select Job history in the row actions list for the appropriate User profile on the Integration Profile List page.

The status Completed Successfully does not mean that all files were synchronized successfully. Más bien significa que la tarea se ha completado sin ningún error.

Si hay más de un fichero para ser importado a Alma para la sincronización, los ficheros son leídos en el orden en el que están almacenados en el fichero zip. Si un usuario aparece más de una vez en los ficheros, la primera instancia del usuario será procesada. Todos los registros duplicados del usuario restantes fallarán.

For more information on the synchronization process, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.