Customizing SymphonyAPI Settings

SymphonyAPI authentication works similar to how PatronAPI authenticates users who interface into ILS/OPAC, except Symphony API is used to authenticate users into the SIRSI Symphony catalogs.

The SymphonyAPI settings are located in the ILLiad Customization Manager under Web Interface | Symphony.

SymphonyAPIAddressThe URL including the port number and the path to the API (i.e. symws) for the SymphonyAPI server make up the SymphonyAPIAddress. Normally, the key also has a port after it of 8080. An example value would be where is the SymphonyAPI server at your site. Also, the ILLiad server needs to have access to query the SymphonyAPI server. Most SymphonyAPI servers restrict access by ip address. Example:
SymphonyAPIExclusiveThis determines if SymphonyAPI is used to auto-clear users or restrict access to only those who pass all criteria in the SymphonyAPI server. This key should be set to No if customers not in the SymphonyAPI server should still be allowed to register and Yes to only allow customers who pass the SymphonyAPI authentication to register with ILLiad. Details on this are below. Example: Yes or No
SymphonyExpireDateOnly used if SymphonyAPIExculusive and ExpireDate are set to Yes. ILLiad will compare the Symphony expiration date of the user. If the current date is before the SymphonyExpireDate, then the user will not be blocked and unable to register for Symphony


The type of infomation retrieved from Symphony during a user lookup (e.g. the user's barcode or alternativeID)
SymphonyUserLookupFieldMaps ILLiad to the user look up field in Symphony. The lookup field default should be a key from the ILLiad User Table fieldname (e.g. SSN)
SymphonyAPIStandingBlockILLiad will check the Symphony Standing to verify if user is considered an unauthorized standing (default: BARRED,DELINQUENT)


Only used if SymphonyAPIExclusive is set to Yes and the SymphonyAPIStandingBlock produces a value in the default list. The user will be blocked if their Standing value matches an unauthorized standing (e.g. BARRED,DELINQUENT). The value can be customized
SymphonyAPIStaffUsernameThe staff username that connects to the API to establish an API session and perform a user lookup
SymphonyAPIStaffPasswordThe staff password associated with the staff username that connects to the API to establish an API session and perform a user lookup
SymphonyAPIClientIDYour library's specific ClientID provided by SIRSI/Symphony
SymphonyAPILibraryIDYour library ID associated with SIRSI/Symphony. Used to perform lookup in Symphony
AutoClearPreRegisteredUsersOnly used is SymphonyAPIExclusive is set to No. Clears users in the client automatically if set to Yes

Failed Authentication settings can be located under Web Interface | Status Lines.

SLSymphonyAPIConnectFailedUser was unable to authenticate through the SymphonyAPI
SLSymphonyAPIInvalidPatronStandingPatron's standing value does not match any defaults
SLSymohonyAPIPatronRecordExpiredThe current date is before the SymphonyExpireDate
SLSymphonyAPIUserNotFoundThe user does not have a registered account in Symphony or there is an error on the account

Note! The required custom keys for connecting to the SymphonyAPI are SymphonyAPIAddress, SymphonyAPIStaffUsername, SymphonyAPIStaffPassword, SymphonyAPIClientID, and SymphonyAPILibraryID.