Integrate with ESSE3

To enable data transfer between DreamApply and ESSE3, perform the following tasks:

• Request the ESSE3 add-on
• Map programme data
• Indicate documents to be transferred
• Implement data retrieval
• Customize the welcome email template

Request the ESSE add-on

The ESSE3 integration functionality is available as an add-on provided at no charge. To activate the add-on and properly set up your DreamApply instance, contact the DreamApply team.

Provide the following information to the DreamApply team:

• The ESSE3 instance hostname.

• Credentials of the account to interact with the ESSE3 API: username and password. The account must have sufficient permissions to send PUT requests to the ESSE3 activation endpoint: /e3rest/api/anagrafica-service-v2/activation-url.

• Allow the following IP addresses for incoming connections to Esse3:

  • 35.181.22.130
  • 15.236.194.165
  • 185.39.10.121
  • 185.39.10.122
  • 185.39.10.123

  You can either allow these IP addresses one by one or allow the entire A record of eu3-prod.out.dreamapply.net (if supported by the firewall system in use).

To get a list of outgoing IP addresses, run the following command:

• MacOS/Linux
• Windows PowerShell

dig eu3-prod.out.dreamapply.net A

Resolve-DnsName -Name eu3-prod.out.dreamapply.net -Type A

As part of integration setup, the DreamApply team performs the following tasks:

• Activates the ESSE3 add-on
• Enables the monitoring report
• Adds the welcome email template
• Specifies account credentials to communicate with the ESSE3 instance

Map programme data

As part of the integration process, an institution must uniquely identify programmes added to the programme catalog in DreamApply and map them to corresponding programmes in ESSE3.

To map programmes accurately, work closely with Cineca as they have a thorough understanding of how your programme data is organized in ESSE3.

1. In the main menu, under My Institution, select Programmes.
2. To the right of the programme name, click the edit icon and select Edit details.
3. In the Esse3 code section, specify the following details:
   1. In the Programme of study code field, specify the code for the programme in ESSE3.
   2. In the Programme of study path code field, specify the code for the study path associated with the programme.
   3. In the Academic year field, specify the academic year for the programme.
   4. At the bottom of the form, click Save.

Indicate documents to be transferred

You can create tasks in DreamApply requiring applicants to upload their documents during the application process. ESSE3 can retrieve these documents along with other application data.

To indicate which task documents must be transferred to ESSE3, review and update tasks settings.

1. In the main menu, under Automation, select Task templates.
2. To the right of the task name, click the edit icon and select Edit details.
3. In the Documents section, select the These documents should be sent to Esse3 check box to ensure documents are transferred to ESSE3. Note that this field is only available after the ESSE3 add-on has been activated.
4. At the top of the form, click Save change.

Implement data retrieval

In DreamApply and ESSE3 integration, data retrieval is entirely managed on the client side. An institution must work closely with Cineca to arrange export of data from DreamApply. In particular, the institution and Cineca must identify and implement the data retrieval logic based on their specific requirements, including:

• Polling schedule: when and how frequently data must be retrieved
• Data fetching: the specific data points to be extracted (application data and documents)

DreamApply provides the DreamApply API for data retrieval. To authenticate and interact with the DreamApply API, it is required to issue an API key for ESSE3 with appropriate permissions. Please work with Cineca to ascertain the minimum required permissions.

Customize the welcome email template

DreamApply invites applicants to register in ESSE3 by sending an email with an activation link. By default, the email looks like this:

Dear applicant,
We have prepared for you an account in the Student Information System (ESSE3).
Please follow the link below to activate the account.
%link%

To create a personalized message for applicants, you can customize the email template.

1. In the main menu, under System, select Templates.
2. To the right of the esse3-invitation template, click the edit icon and select Edit details.
3. Update the email message. If necessary, you can use variables to create personalized messages. To do this, click Insert a marker and select a variable to be added.
4. At the top of the form, click Save changes.