appSettings are required when any of the CLConnect integration options are used. There are some configurations that are optional, and/or

specific to one integration option; they are indicated below.

 


Within appSetting there are 12 different settings that can be configured.


Required Settings


These three settings are always required regardless of integration services enabled:

  • APIUsername
      • Your STS (secure token service) username set for CampusLogic
      • Used to hit CampusLogic services outside of the site
      • Example format: value="School_UserName"
  • APIPassword
      • Your STS(secure token service) password set for CampusLogic
      • Used to hit CampusLogic services outside of the site
      • Example format: value="password123!"
  • STSURL
      • The URL to use for CampusLogic STS(secure token service) 
      • The URL will vary based on environment (sandbox vs production)
      • Example formats are in the comments

    Optional Settings

    These seven settings are always optional regardless of integration services enabled:
  • IncomingAPIUsername
      • An required username for any incoming API calls
      • Currently the Event Notification integration option is the only option that uses this 
      • Used to validate inbound posts from CampusLogic with basic authentication
      • Can be set to anything of the client's choosing
      • Example format: value="School_UserName"
  • IncomingAPIPassword
      • An required password for any incoming API calls
      • Currently the Event Notification integration option is the only option that uses this 
      • Used to validate inbound posts from CampusLogic with basic authentication
      • Can be set to anything of the client's choosing
      • Example format: value="password123!"
  • PurgeReceivedEventsAfterDay
      • There is a RecievedEvents table in the local database, and this value indicates how often that table will be cleared out
      • Currently the Event Notification integration option is the only option that uses this 
      • Use any positive value
      • If left blank this value will default to 30
  • PurgeLogRecordsAfterDays
      • There is a log table in the local database, and this value indicates how often that table will be cleared out
      • All integration options use this log table
      • Use any positive value
      • If left blank this value will default to 30

  • PurgeNotificationLogRecordsAfterDays
      • There is a notification log table in the local database, and this value indicates how often that table will be cleared out
      • This is only needed if notifications are enabled for integration option errors
      • Use any positive value
      • If left blank this value will default to 30
  • BackgroundWorkerCount
  • BackgroundWorkerRetryAttempts
      • The amount of times a background job will retry before it fails
      • Currently the Event Notification integration option is the only option that uses this because all other integration options are recurring.
      • Use any positive integer or a 0 as the value
      • If left blank this will default to 10 attempts.
      • For more information on this setting see: http://docs.hangfire.io/en/latest/background-processing/dealing-with-exceptions.html
      • Below is the delay between attempts in seconds with an explanation as to the retry schedule



    Integration Option Specific Required Settings

    These two settings are required if their specific integration option is enabled:
    • SVWebAPIURL
      • Specific to all of the integration options except Award Letter Data Upload
      • The URL to use for the services that access Student Verification
      • This URL will vary based on environment(sandbox vs production)
      • Example format: value="https://api.studentverification.com:5443/"
    • AwardLetterWebAPIURL
      • Specific to the Award Letter Data Upload integration option
      • The URL to use for the services that access Award Letter
      • This URL will vary based on environment(sandbox vs production)
      • Example format: value="https://apiqa.awardletter.net:5443/"
      • NOTE: This URL is only needed if the automated award letter data upload is being used.