Student Information Systems
- General System Administrator
- All primary and additional identifiers must be unique for users, including for the same user.
- User data must be included in a zip file for import and synchronization purposes.
-
If you meet the “Could not parse file” error, try zipping XML files per their schema.
Background Information
Configuring an Integration Profile
- On the Integration Profile List page (Configuration > General > External Systems > Integration Profiles), select Add Integration Profile. The first page of the integration profile wizard appears.
Users Integration Profile Wizard – Page 1
- On the first page of the wizard, enter the following information.
- Enter a code and name for the profile you are defining.
- From the Integration type drop-down list, select Users.
- From the S/FTP connection type drop-down list, select the name of the FTP connection that you previously defined.
- Indicate the type of SIS with which you are integrating (for Ex Libris’ informational purposes). Note that this is mandatory.
- Optionally, enter a description of the integration you are configuring.
- Select Next. The second page of the wizard appears.
- On the second page of the wizard, enter the following information.
Users Integration Profile Fields Section Field Description Import
(used for the initial import of users. A record is not imported if a matching record is found. Manually run this once, or once per year. Afterwards, use the Synchronize section / job.)Active Whether the job is active. If the job is active, it runs according to the selected scheduling option. If it is inactive, it does not run. The job is called Users IMPORT using <integration profile name>.Record Type The type of user record to create in Rapido: Contact, Public, or Staff.
Each SIS profile loads one type of user (Staff or Public). To process a different user type, you need to define another SIS profile. 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. This means that all the users will be created in Rapido as public users. You can then use the user roles to differentiate between patrons and staff.
For more information on selecting the record type, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
Input File Path A subdirectory of the path specified when creating the secure FTP connection (required). For example, if you enter Rapido 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). User XSD Version Select 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. XSL Converter Select an XSL converter to process the Integration Profile XML files with XSL before placing them in the output location. 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. This enables you to preview how a user XML file should be structured. You can also view a sample XML file on https://developers.exlibrisgroup.com/alma/apis/xsd/external_sys_user.xsd.Synchronize
(used for ongoing synchronization of existing Rapido users. Rapido attempts to merge information if a matching record is found.)Active Whether the job is active. If the job is active, it runs according to the selected scheduling option. If it is inactive, it does not run. The job is called Users SYNCHRONIZE using <integration profile name>.Record Type The type of user record to create in Rapido: Contact, Public, or Staff.
Each SIS profile loads one type of user (Staff or Public). To process a different user type, you need to define another SIS profile. 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. This means that all the users are created in Rapido as public users. You can then use the user roles to differentiate between patrons and staff.
For more information on selecting the record type, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch.
Match ID Type The predefined unique identifier type in Rapido to use as the identifier with which you want to match existing Rapido users. For detailed information on match IDs, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch. Synchronization Type Swap all, which means that all existing user records are replaced by matching incoming user records. For detailed information on the synchronization workflow, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch. Unmatched Record Whether Rapido adds a new user record if it has failed to find a matching record, or rejects the incoming record if no match is found for it. By default, the records are added. Input File Path A subdirectory of the path specified when creating the secure FTP connection (required). 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). Schedule If 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. The available scheduling options differ depending on your data center.User XSD Version Version 1 or 2. Note that version 2 should be used. For detailed information about these versions, see https://developers.exlibrisgroup.com/alma/integrations/user-management/sis/synch. XSL Converter Select an XSL converter to process the Integration Profile XML files with XSL before placing them in the output location. Select Manage Converters to view and edit the converter. For details, see Integration XSL Converters. Export User By Conditions
(used to export users that should be blocked due to unpaid fines)Users exported include users with fines greater than the threshold and users with blocks, either based on the configured block types or all blocks if none are configured. If a user has fine greater than the threshold OR the user has a block, then the user will be exported.
Active Whether or not the job is active. If the job is active, it runs according to the selected scheduling option. If it is inactive, it does not run. The job is called Users EXPORT using <integration profile name>.User ID Type See the above explanation for Match ID type. User Groups The user group(s) to which the users that you want to export belong. If no value is specified, users belonging to any of the configured user groups are exported. Block Types The previously defined block types whose associated users you want to export. If no value is specified, users matching any of the configured block types are exported. Fine/Fee Age (days) The users (of the selected groups and with the selected block types) whose fines/fees are older than the stipulated number of days are exported. By default, this number is 0. Threshold Amount The users (of the selected groups and with the selected block types) whose fines/fees exceed the stipulated threshold are exported. By default, the threshold amount is 0. User with Active Loans Select this check box to include only users that have active loans. Active Loan Types When User with Active Loans is selected, this field appears. Users with active loans will be included in the export if the loan types match the loan types selected. Output File Path A subdirectory of the path specified when creating the S/FTP connection. 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). Schedule If 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. The available scheduling options differ depending on your data center.Export Users
(used to export old, inactive, or deleted users, or recently updated/created users - not for an ongoing full export of users)Active Whether the job is active. If the job is active, it runs according to the selected scheduling option. If it is inactive, it will not run. The job is called Users EXPORT_USERS using <integration profile name>.User Groups Select one or more user groups to identify the patron records to be considered for export. Days Since Creation Set a condition, in number of days, that identifies when to include a patron record in the export. This parameter indicates the number of days since the patron record was created in Rapido. The patron record that meets this criterion must also be a member of one of the user groups selected in the User Groups parameter in order for the patron record to be exported. For example, if you specify 10 here, patron records that were created in the past 10 days are included in the export.Days Since Update Set a condition, in number of days, that identifies when to include a patron record in the export. This parameter indicates the number of days since the patron record was updated in Rapido (see example in Days since creation). The patron record that meets this criterion must also be a member of one of the user groups selected in the User Groups parameter in order for the patron record to be exported. Days Since Deletion Set a condition, in number of days, that identifies when to include a patron record in the export. This parameter indicates the number of days since the patron record was deleted in Rapido (see example in Days since creation). The patron record that meets this criterion must also be a member of one of the user groups selected in the User Groups parameter in order for the patron record to be exported. Output File Path A subdirectory of the path specified when creating the secure FTP connection. For example, if you specified Alma in the Sub-directory field during secure FTP connection configuration and you enter SIS_Export in the Output File Path field, the files are exported to the Alma/SIS_Export directory (under the root FTP directory). Schedule If 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. The available scheduling options differ depending on your data center.User XSD Version Version 1 or 2. Note that version 2 should be used. 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!
Active Whether or not the function is active. If the function is active, a process accesses the student management system to fetch the user's information, if it exists. If the function is not active, the process does not run. The default is non-active. Base URL The host/port to which the API calls regarding the user changes are sent. Mandatory if the Online import action is Active. Note that this should be a REST API that has user information in the format described on the Developer Network. User Name User name for the HTTP basic authentication credentials. Optional. If left empty, the requests will be sent without credentials. Password Password for the HTTP basic authentication credentials. Optional. If left empty, the requests will be sent without credentials. - Select Save. The profile is saved. For information on the Contact Info tab when editing the profile, see Adding User Contact Information.
Manually Importing/Exporting SIS Information
In the Users SYNCHRONIZE, Rapido alerts only upon a fail rate of 5%. If the number of rejected users is less than 5% of the total number of processed users, the job is marked as Completed Successfully.