...
NOTE: THESE PROCEDURES ARE IN DRAFT STATUS AND ARE SUBJECT TO CHANGE PRIOR TO GO-LIVE.
Background
Some campuses transfer export user fine/fee data to campus bursar systems. Creating an automated process allows for greater efficiency and provides the opportunity for integration of online payment through a campus payment processing system.
User fine and fee data is available to 3rd party systems through Alma's External Systems Integration Profile, the User API, and the Analytics API. The first option utilizes Alma's built-in export functionality to extract patron fine/fee data and S/FTP to a campus location. Fines and fees are exported via this method are considered closed in Alma, since they are handled by the campus bursar system.
The User API option can be used to retrieve and post user fine/fee data on a per user account basis. An important consideration before utilizing this method is the requirement that the GET/POST query include a user identifier. It does not appear possible at this time to retrieve multiple accounts where a fine/fee exists, through a single query.
Alma Analytics allows for the creation of reports that include all user accounts that have a fine/fee amount. Through the Alma Analytics API it's possible to retrieve the report data and save to a local campus server. However, the use of the Alma Analytics API method is constrained by the nightly transfer of data from Alma to the Oracle BI database.
Each method utilizes XML for the export file formatexports data in XML.
Import of user fine/fee payments to Alma is available only via the User API method. This may used with either the User API or Analytics API export method. Updates to user accounts are made on a per user basis. With PeopleSoft it is possible to utilize a reporting query or a query by an external script to retrieve fine/fee payment data for specific users.
...