Aeon Customization Keys

Follow

This page lists all the keys and tables available in the Aeon Customization Manager.

Contact Information

Contacts

LocalInfo Table See The Local Info Table for more information about this table.

System

Billing

AutoProcessZeroBalanceInvoices When set to yes, generating a $0 invoice will cause the Awaiting Order Approval and Awaiting Order Billing steps to be skipped, and the request will move directly to Awaiting Item Delivery.
CreditCardTransactionsDescription The description used when sending Credit Card Processing transactions,
PaymentProvider Specifies the payment provider used for credit card processing. Valid values are Authorize.net, PayPal, or SagePay.
PaymentProviderMerchantId The ID or login for your merchant account with your payment provider.
PaymentProviderResponseToken The identity token provided by your payment provider to authenticate responses if the provider uses different tokens for requests and responses.
PaymentProviderTestModeEnabled Determines if requests sent to your credit card payment provider use test mode.
PaymentProviderToken The identity token provided by your payment provider to authenticate requests.
PaymentProviderURL The URL used to communicate with your payment provider.

Electronic Delivery

DaysBeforeElectronicDeliveryCleanup Number of days before electronic delivery files are deleted from the server.

Email

EmailFromAddress The default from address for all emails sent from the system.
EmailFromName The default from name for all emails sent from the system.
EmailSecure Determines if SMTP server requires SSL.
EmailSMTPPort Port used for sending emails from System Manager service on the server. Defaults to port 25.
EmailSMTPServer SMTP server used for sending emails from System Manager service on the server.
SMTPPassword The password used for sending emails (using the System Manager service).
SMTPUserID The user id used for sending emails (using the System Manager service).

General

AddonDirectory Optionally specifies a central addon repository via UNC path or mapped drive. If present, Aeon will update its local addon directory with newer versions from this location.
CustomDropDown Table See The Custom Drop Down Table for more information about this table.
CustomFlags Table See The Custom Flags Table for more information about this table.
Customization Table See The Customization Table for more information about this table.
DocumentTypeOptions Pipe delimited list of possible document type values to choose in the client. These should match the values from submitted requests.
FutureRoutingDays The number of days prior to the scheduled date when future requests are moved to Awaiting Request Processing
ItemCheckoutSecurityPrompt Determines whether the staff user is prompted with a warning in the Client when checking out an item to someone who is not signed into a reading room.
PrintCallslipDocs Filename of the request pick slip printing template.
PrintDigitizationRequestDocs Filename of the print digitization request template document.
PrintDocumentsPath Default path for Word documents (for auto-opening).
PrintInvoiceDocs Filename of the print invoice template document.
PrintInvoiceStatementDocs Filename of the print invoice statement template document.
PrintRequestDocs Filename of the print request template document.
PrintSettingsPath Path to the file that contains the settings for print query sorting and filtering. If blank, this will default to the Aeon\Print directory under the user's My Documents folder.
PrintUserDocs Filename of the print user template document.
ReasonsForCancellation Table See The Reasons For Cancellation Table for more information about this table.
SendUserAddedToActivityEmail Whether or not an email should be sent to users when they are added to an activity.
SharedCustomSearchesPath The directory the client should check for saved custom search files.
SystemManagerAddonInterval The interval at which the System Manager should execute server addon scripts.
UserExpiration The default number of days to add to the current date when calculating a new user's expiration date. This key is used when no status specific UserExpiration key is found.
UserValidation Determines if the web verifies against the UserValidation table to pre-populate user information for new registrants.
WebCancelAfterProcess Whether or not users should be able to cancel a request after it has been processed.

Integration

SystemWebPlatformConfig The ID of the WebPlatformConfig record that defines the webservice URL and API key for your Aeon system.
WebPlatformConfig Table See The WebPlatformConfig Table for more information about this table.

Reference Requests

ReferenceRequestEmailAddress The default email address used in the "From" field for outgoing reference request emails.
ReferenceRequestEmailName The default name used in the "From" field for outgoing reference request emails.
ReferenceRequestImportActive Controls whether importing reference requests from email is enabled.
ReferenceRequestImportInterval How often, in seconds, System Manager should import reference request emails. The maximum frequency is every 30 seconds.
ReferenceRequestImportPassword The password used to login to the mail account from which reference requests will be imported.
ReferenceRequestImportPopHost The name of the POP mail server from which reference requests will be imported.
ReferenceRequestImportPopPort The port of the POP mail server from which reference requests will be imported.
ReferenceRequestImportUserID The user id used to login to the mail account from which reference requests will be imported.

Routing

RoutingOn Determines if the system should check against the Routing table for any alternate processing when changing transaction statuses.

System

AutoExpireUsers Determines if the system should automatically expire users. The system will set the cleared value of expired users to the value specified by the 'AutoExpireUsersClearedValue' key.
AutoExpireUsersClearedValue Cleared value that System Manager sets for expired users. This value is not used if the 'AutoExpireUsers' key is set to 'No'.
HelpWebURL URL to the web help index.
RenewedUsersClearedValue The cleared status for expired users is set to this key value after they review and update their user information. This value is not used unless the 'AutoExpireUsersClearedValue' key is set to 'EXP'.
ServerTimeZoneId A string that identifies the server's locale. This is used to ensure all client applications work with the same time zone as the server.

Versions

VersionClient The current version of the Aeon client.
VersionCustomizationManager The current version of the Aeon Customization Manager.
VersionDLL The current version of the Aeon web DLL.
VersionStaffManager The current version of the Aeon Staff Manager.
VersionSystemManager The current version of the Aeon System Manager.
VersionWebPlatform The current version of the Aeon web platform.

Web Interface

Authentication

DLLEmailNewUserTemplateName The name of the template to use when sending a new user registration email from the DLL.
DLLEmailPasswordResetTemplateName Template name for web password reset email sent to customer.
RemoteAuthSupport Yes/No value to determine if web authentication is getting a username from a remote system.
RemoteAuthUserVariable The variable passed if RemoteAuthSupport is set to Yes. This value contains the username that will be used by Aeon.
RemoteAuthWebLogoutURL The URL or local file to display when a user logs out of the Aeon web directory controlled by remote authentication.
RemoteAuthWebPath The local web path for the directory controlled by remote authentication. Only used if RemoteAuthSupport is set to Yes.
SendNewAuthConfirmationEmail Whether or not an email should be sent to users after remote auth registration.
SendNewUserConfirmationEmail Whether or not an email should be sent to users after registration.
UserValidation Table  
WebAuthType The type of authentication used for web users. This value may be LDAP, PatronAPI, AeonExclusive, Aeon or RemoteAuth.

Defaults

WebDefaultBillingCategory The default billing category for new customers.
WebDefaultCity The default city to display on the user registration page.
WebDefaultCountry The default country to display on the user registration page.
WebDefaultDepartment The default department to display on the user registration page.
WebDefaultNotifyGroup The default value for the Notification Method drop down on the user registration page.
WebDefaultState The default state to display on the user registration page.
WebDefaultStatus The default value for the Status drop down on the user registration page.
WebDefaultZip The default postal code to display on the user registration page.
WebLogoutURL This value can be a local page or a URL starting with http://
WebNotesFilter A comma-separated list of the note types from the Notes table that are filtered out of the Notes Information in the DLL view. Default value is Lender, System so Lender notes and System notes will not show to the end user.

EAD

GroupRequestsByLocation

When EAD requests are submitted, this key controls whether items that share a container are grouped into a single request. If set to No, each selected item will be treated as an individual request.

General
AutoUpdateExpiration Determines if the user's expiration date is updated anytime they update their user information.
SecondaryAddressActive Determines if the secondary address is used within the system (on the web).
StaffProxyWebURL Aeon URL used for staff proxies logging into the web as a patron. This is typically needed if using RemoteAuth because that web folder is protected.
WebURL The URL of the Aeon system. This value should have a trailing / but not have an HTML or DLL extension.

Innopac

InnopacPatronAPIAddress URL for Innopac PatronAPI server (that is normally appended with a port).
InnopacPatronAPIAutoClear Determines if new users are automatically cleared when validated through Innopac PatronAPI logon.
InnopacPatronAPIExclusive Determines if users should be allowed to register if not cleared via PatronAPI server. Exclusive means users must pass all PatronAPI requirements.
InnopacPatronAPIExpireDate Determines if the user must not be expired in PatronAPI server to use the system.
InnopacPatronAPIExpireDateFormat Value used to override Delphi ShortDateFormat. May be required for systems that operate in mixed date-format environments.
InnopacPatronAPIExpireDateRegExp String formatted date of expiration. Format may be overridden by InnopacPatronAPIExpireDateFormat.
InnopacPatronAPIField The field from the Users table used to validate against the record in the PatronAPI server.
InnopacPatronAPIFineAmountRegExp Resolves the fine amount to a (string) float.
InnopacPatronAPIFineBlock Determines if users should be denied access based off of fines for their patron types.
InnopacPatronAPIFineBlock0 The max number of fines (in dollars) allowed before blocking access for patron type of 0. These are sample entries and you may need to create more if you are using FineBlocks.
InnopacPatronAPIFineBlock1 The max number of fines (in dollars) allowed before blocking access for patron type of 1. These are sample entries and you may need to create more if you are using FineBlocks.
InnopacPatronAPIFineBlock2 The max number of fines (in dollars) allowed before blocking access for patron type of 2. These are sample entries and you may need to create more if you are using FineBlocks.
InnopacPatronAPIPatronTypeRegExp Resolves the patron type to a number. Actual value is a string.

Labels

WebFormValues Table  

LDAP

LDAPBindStyle Valid values are OneStep or TwoStep authentication.
LDAPInitialBindDN Used for TwoStep LDAP Authentication.
LDAPInitialBindPassword Used for TwoStep LDAP Authentication.
LDAPPortNo The port number to connect to for non-SSL LDAP authentication.
LDAPSearchFilter Determines the user's DN from the UserID given on the login form.
LDAPSearchPrefix The prefix before the Aeon username when building the string to bind against the LDAP server.
LDAPSearchScope Valid values are Base, One, and SubTree.
LDAPSearchSuffix The suffix after the Aeon username when building the string to bind against the LDAP server. If you need to attempt to bind against multiple directories, you can enter several suffixes separated by | characters.
LDAPSecureSSL Turn on LDAP Secure SSL option (only if using LDAP authentication).
LDAPSecureSSLPort Port for LDAP Secure SSL option (only if using LDAP authentication).
LDAPServerName The LDAP server name used for LDAP authentication.
LDAPVersion The version of LDAP to use. This defaults to 3.

Limits

RequestLimit The request limit of active requests for any user.  If set to 0, there is no request limit.
UserRequestLimit Determines if individual user request limits are checked before using system request limits.

OpenURL

OpenURLMapping Table See The OpenURL Mapping Table for more information about this table.

Password

WebUsePasswordHint Do you want to offer a password hint to customers who have forgotten their password?

Status Lines

SLActiveRequests Displays on page listing X most recent active requests.
SLActiveRequestsWithLimit Displays on page listing X most recent active requets.
SLActivityAssociateError The web status line that appears when a patron tries to view an activity they are not associated with.
SLBillingAccounterror Displays if a patron tries to assign a billing account that is not assigned to them or their researcher to a transaction.
SLBlocked The web status line that appears on the logon page when a user is blocked and attempts to log on.
SLChangeUserOpen The web status line that appears on the Change User Information form before making any changes.
SLDisavowed The web status line that is shown when a disavowed user tries to log in.
SLDuplicateRequest The web status line that appears when a duplicate request is submitted.
SLEADRequestsReceived The web status line that appears on the main menu after a user submits an EAD request.
SLEditRequest The web status line that appears on the edit request form before making any changes.
SLEditRequestDenied The web status line that appears on the detailed request form if a user attempts to edit a request that no longer allows it.
SLInvalidFieldLength The web status line that appears when a patron submits a value that would exceed the maximum number of characters for that field.
SLInvalidResetID The web status line that is shown when an invalid password reset token is used.
SLInvalidRSSID The web status line that is shown when an invalid ID is used to open an RSS feed.
SLInvalidScheduledDate The web status line that appears on the detailed request form if a user attempts to enter an invalid scheduled date.
SLLogon The web status line that appears on the logon2.html page if a user links directly to the aeon.dll file.
SLLogonError The web status line that appears when there is an error processing a user's logon.
SLLogout The web status line that appears on the logon page after a user successfully logs out of the system.
SLMainMenu The web status line that appears on the main menu after logging into the web.
SLMultipleRequestsCancelled The web status line that appears on the main menu after a user cancels multiple requests.
SLNotificationOwnersipError The web status line that appears when a patron navigates to a notification that they are not associated with.
SLPasswordChanged The web status line that appears after the user successfully changes his or her password.
SLPasswordCurrentIncorrect The web status line that appears on the Change Password form if the current password is not correct.
SLPasswordHint The web status line that appears on the logon page if the user enters an incorrect password for that username and WebUsePasswordHint is set to Yes.
SLPasswordIncorrect The web status line that appears on the logon page if the user enters an incorrect password for that username.
SLPasswordResetEmailConfirmation Displays after the email has been sent for a password reset.
SLPasswordResetEmailError Displays when there is an error building the password reset email.
SLPasswordsNotMatch The web status line that appears on the registration or change password page if the passwords do not match.
SLPatronAPIConnectFailed The web status line that appears on the logon page if the Patron API server cannot be reached.
SLPatronAPIFinesExceeded The web status line that appears on the logon page if the patron has exceeded the fines limit.
SLPatronAPIInvalidPatronType The web status line that appears on the logon page if the patron is blocked due to an invalid patron type.
SLPatronAPIPatronRecordExpired The web status line that appears on the logon page if the patron record has expired.
SLPatronAPIUserNotFound The web status line that appears on the logon page if the user is not found on the Patron API server.
SLPaymentConfirmed The web status line that appears on the Order Approvals page when a payment has been confirmed.
SLPaymentError The web status line that appears on the payment page when a payment could not be completed.
SLPDFDelete The web status line that appears after deleting an electronically delivered item.
SLPDFUndeleted The web status line that appears after undeleting an electronically delivered item.
SLRequestCancelDenied The web status line that appears on the detailed request form if the item cannot be cancelled.
SLRequestCancelled The web status line that appears on the main menu after a user cancels a request.
SLRequestCopy The web status line that appears on the main menu when a user requests a copy of an item that is checked out or on hold.
SLRequestLimitMet Displays if a customer attempts to fill out a request but has already reached the request limit.  Only appears if RequestLimit is set to something other than 0.
SLRequestReceived The web status line that appears on the main menu after a user successfully submits a new request.
SLRequestReceivedBillingExempt The web status line that appears on the main menu after a user successfully submits a new photoduplication request when their billing category is 'Exempt.'
SLRequestReceivedSkipEstimate The web status line that appears on the main menu after a user successfully submits a new request when the order estimate process is skipped.
SLRequestReceivedUserReview The web status line that appears on the main menu after a user submits a new request while selecting the keep in review option.
SLRequestReceivedWithEstimate The web status line that appears after submitting a photoduplication request unless skipping the estimate step.
SLRequestRemovedFromHold The web status line that appears on the main menu after a user removes a request from On Hold.
SLSessionInvalid The web status line that is shown when an invalid web session token is used.
SLSessionTimeout The web status line that is shown when an expired web session token is used.
SLShowActivities The web status line that appears when viewing the list of activities.
SLShowActivity The web status line that appears when viewing an activity.
SLShowCancelledDetail The web status line that is shown when displaying a request from the Cancelled Requests page.
SLShowChangePassword The web status line that appears on the Change Password form.
SLShowCheckedOutDetail The web status line that is shown when displaying a request from the Checked Out page.
SLShowCreditCard The web status line that appears when viewing the Credit Card Payment page.
SLShowDetail The web status line that is shown when displaying a request from the All Requests page.
SLShowDetailedInfo The web status line that appears on the main menu above the list of requests.
SLShowElectronicDelivery The web status line that appears when viewing the list of electronically delivered items.
SLShowElectronicDeliveryUndelete The web status line that appears when viewing the list of electronically delivered items that have been deleted.
SLShowHistoryDetail The web status line that is shown when displaying a request from the History Requests page.
SLShowNotifications The web status line that is shown when displaying the notifications page.
SLShowOrderBilling The web status line that appears when viewing the list of orders to approve.
SLShowOrderEstimates The web status line that appears when viewing the list of order estimates.
SLShowOutstandingDetail The web status line that is shown when displaying a request from the Outstanding Requests page.
SLShowRequest The web status line that appears on a new request form before submitting it.
SLShowSearchResults The web status line that is shown when displaying search results.
SLShowUserReview The web status line that appears when viewing the list of requests in review.
SLSubmitEstimateApproval The web status line that appears after submitting order estimates for processing.
SLSubmitOrderApproval The web status line that appears after approving orders.
SLSubmitUserReview The web status line that appears after submitting review requests for processing.
SLTransactionOwnershipError The web status line that appears when a patron tries to manipulate a transaction they do not own.
SLUsernameInUse The web status line that appears if a user chooses a username during registration that is already in use.
SLUsernameNotInDatabase The web status line that appears if a user types in a username that is not in the database.
SLViewingDetailedNotification The web status line that appears when viewing notification details.

System

WebDeliveryPath The local path on the web server for the electronically delivered files.
WebPath The local path on the web server for the web files.
WebSessionMinutes Number of minutes before web session times out

Validation

WebValidation Table The WebValidation table stores the fields that your users are required to populate on web forms including regular expressions governing each field validation and the error tags associated with them.

WebFormValidationLinks Table

This table describes the relationship between web forms and the validation rule sets that should be applied to submissions from that form.
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.