Configuring aNewSpring within your System

Once your aNewSpring details have been established, the integration will need to be globally enabled and configured within your system to function.

TABLE OF CONTENTS

• Enabling the aNewSpring Plugin

• Entering aNewSpring Integration Information
• System Settings
• Notification Settings
• Preservability Settings
• Resulting
• Test Connection

  •  Next Steps: Course Setup

Enabling the aNewSpring Plugin

1. Under the Administration heading, select Preferences:
   
2. On the left-hand side, expand the Integration item and select Integrated Systems. This will open the Integrations Page, displaying any existing Integrated services/systems:
3. Click the [+] New button to start the process to implement a new integration:
   
4. The page that appears will display a range of Integrations available to set up, with search items and filters – such as the ability to view only LMS options. Locate the aNewSpring item that appears like so:
5. Press the Connect button will open a new page to enter your aNewSpring Integration Information.
    

Entering aNewSpring Integration Information

This page is comprised of four different sections that are used to drive communication with the aNewSpring LMS, and how users are to be resulted within your SMS based on their aNewSpring activity.

The first section targets your specific aNewSpring System Details:

The fields in this section require:

• System: Will be set as the default 'aNewSpring'
• Name: A custom name can be provided for this integration
• aNewSpring URL: The URL used for your aNewSpring LMS 
  • e.g https://<YourDetails>.anewspring.com/api 
• Token: The token created in the aNewSpring site setup  
• Enabled: Indicates if this integration is active. When unchecked this will disable the aNewSpring integration
• I am using aNewSpring Essentials: Check this box if you are using the aNewSpring essentials licensing model (This can be checked within aNewSpring under the Settings page, displayed under Environment Version) 

System Settings

This section has the following options:

• Tag: Select from pre-entered items to apply a Tag to any parties or courses if the integration has been enabled on their entity
• Disable enrolment notifications: Disable the sending of notifications for system enrolments
• Run outside transaction: If checked the integration will be run from a background job queue, rather than immediately and inside the web or API transaction. This will reduce load times, but means that the external site will not be updated immediately 
• Show on integration centre: If checked process information for the API will be visible in the integration centre

Notification Settings

This section controls who should receive an email notification from aNewSpring:

Each configured option includes:

• Notify student on account creation: Sends an email to the student when their account is first created
• Notify trainer on account creation: Sends an email to the trainer when their account is first created
• Notify student on new enrolment: Sends an email to the student for every enrolment into a course

Preservability Settings

aNewSpring offers two different methods when expiring a students access to a course:

Each configured option includes:

• Course Dates: This method will give a student access to the aNewSpring course within the entered Start and End dates of the course. Once outside of this timeframe, the student will lose access
• Expiry period: This method gives the student access for a set period of time after they first access the course.

Resulting

This section controls the way that a party records units are graded when pulling results from aNewSpring.

Each configured option includes:

• Outcome Type: Select the outcome types available within your system
• Commenced Outcome: The select 'Commenced outcome' will be applied when the first assignment is completed
• Passed Outcome: The selected 'Passed outcome' will be applied when all assignments are completed.
• Updatable Outcomes: Updatable outcomes control which outcomes can be updated with the configured 'Commenced outcome' or 'Passed outcome' when pulling results from aNewSpring. Blank outcomes can always be updated

Test Connection

Once a user has input their aNewSpring URL and Token they can click the Test Connection button to check if the connection with aNewSpring is working correctly. 

If everything is configured correctly, a Connection Successful message should display, like so:

Any outcome other than this one would suggest that the details entered are incorrect and will need to be reviewed.

When ready, press the Save button to record the integration details: