{"id":40,"date":"2021-05-06T12:40:53","date_gmt":"2021-05-06T11:40:53","guid":{"rendered":"https:\/\/support.overnetdata.com\/?post_type=ht_kb&p=40"},"modified":"2024-02-16T14:26:01","modified_gmt":"2024-02-16T14:26:01","slug":"installing-edulink-agent","status":"publish","type":"ht_kb","link":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/","title":{"rendered":"Installing the Edulink Agent"},"content":{"rendered":"\n

This article is for technical support teams or those installing Edulink at the school level<\/strong>. If you are a parent trying to download the Edulink One App, please see the ‘Logging in to Edulink One’<\/a>. <\/p>\n\n\n\n

What is the Edulink Agent?<\/strong> <\/h3>\n\n\n\n

The Edulink Agent is a lightweight application that needs to be installed on a server at your school. This Agent acts as a connector between Edulink One and the other school servers such as your MIS, Active Directory and Cashless Catering.<\/p>\n\n\n\n

What do I need for installation?<\/strong><\/h3>\n\n\n\n
SIMS.net Installation<\/span><\/div>
Before you start the installation you will need:

-Access to a server running SIMS.net
-A copy of the Edulink One Agent installer
-A registration code
-Access to add a user account to SIMS.net
-Access to Active Directory (optional)<\/div><\/div><\/div>\n\n\n\n
Arbor Installation<\/span><\/div>
Before you start the installation you will need:

-Access to your Arbor site
-A copy of the Edulink One Agent Installer
-A registration code
-A code generated by the Edulink Agent
-Access to Active Directory (optional)<\/div><\/div><\/div>\n\n\n\n

How Do I Install Edulink One?<\/h2>\n\n\n\n
Installing the Edulink Agent on Your SIMS Server<\/span><\/div>
Log in as an administrator to your SIMS server.

Run the Edulink Agent installer that has been supplied to you. The server requires access to the internet to be able to complete installation.

You will need to enter a Registration Code<\/strong>. This should have been sent to you by Overnet Data (OND). If this is not the case, please contact them to request a code.



\"\"


Once you have registered a valid Registration Code, click Install.

If this is a new installation of Edulink Agent, the installer will be downloaded and will run.

Alternatively, if Edulink Agent is already installed, it will add the new connection settings for the Edulink supplier.





Once the installer has finished installing it will automatically start the Edulink Agent Service and Console. The Edulink Agent Console icon will appear in the system tray.

\"\"

If this is a new installation rather than an additional integrator connection, two configuration windows will automatically open.

You will need to create a new user for SIMS.net account with the username \u201cedulink\u201d. The username must match this exactly for security reasons.





To do this log in to SIMS.net and click on Focus\u2192 System Manager \u2192 Manage Users<\/strong>. Click on the New<\/strong> button located just below the Find User<\/strong> text.



Enter edulink <\/strong>as the surname and click continue. You will have to enter a forename for the account<\/em><\/strong>, make sure you take note of the password and click Save<\/strong>.<\/div><\/div><\/div>\n\n\n\n
Installing the Edulink Agent for Arbor<\/span><\/div>
Log in as an administrator to the server you plan to use for the installation.

Run the Edulink Agent installer that has been supplied to you. The server requires access to the internet to be able to complete installation.

You will need to enter a Registration Code<\/strong>. This should have been sent to you by Overnet Data (OND). If this is not the case, please contact them to request a code.

\"\"
Once you have registered a valid Registration Code, click Install.

If this is a new installation of Edulink Agent, the installer will be downloaded and will run.

Alternatively, if Edulink Agent is already installed, it will add the new connection settings for the Edulink supplier.




Once the installer has finished installing it will automatically start the Edulink Agent Service and Console. The Edulink Agent Console icon will appear in the system tray.

\"\"<\/div><\/div><\/div>\n\n\n\n

How Do I Configure the MIS?<\/h2>\n\n\n\n
Configuring your SIMS Connection<\/span><\/div>
In the MIS connection window, click on the Change Settings<\/strong> button at the bottom.
The Agent attempts to populate the settings from your SIMS “connect.ini” file, but if this fails, this will need to be done manually.

\"\"
Now enter the configuration settings to allow the Edulink SIMS Agent to connect to your SIMS installation:

Supplier<\/strong>: Select your supplier (ESS SIMS<\/strong>) from the dropdown menu. Once you have selected the supplier, this will grey out after you save your settings.
Server Address<\/strong> – Enter the SIMS SQL database server name and SQL server instance separated by a backslash (this may be pre-populated, but if you are unsure this information can be found in your SIMS connect.ini file).
Database Name<\/strong> – Enter the name of the SIMS database, e.g. SIMS.
Password <\/strong>– Enter the password for the \u201cedulink\u201d user account you created in SIMS.net.

\"\"
Override Proxy<\/strong>: Tick the override proxy field (if required) to open the address validation settings<\/a>.

\"\"Type in your Proxy Address<\/strong> and your Proxy Username<\/strong> (if required\u2014 note add xxx to the proxy username if you don’t have one), then fill in the other fields as necessary.

The Workers <\/strong>setting refers to the number of processes connecting into SIMS. This is usually prepopulated and the default is 5. It is recommended that you do not change this setting without consulting Overnet Data.

\"\"
Then, click Apply<\/strong>.

\"\"

In another window that opens, you will see the Status<\/strong> is showing as \u201cRequests Outstanding\u201d. This means we are requesting data from SIMS that you have not yet given the authorisation to receive.

\"\"
If the status differs from \u201cRequests Outstanding”, please check the Network Connection <\/strong>status is displaying as “OK”. If this is not the case, you may need to enter proxy details. To do this click on the Connection Settings<\/strong> button.

Tick the Connect Via Proxy <\/strong>checkbox and enter the proxy settings required for your school.

\"\"
If the Network Connection<\/strong> is still not displaying “OK”, please check your school’s filtering and firewall settings. If problems persist, and you do not manage this at your school, please contact your broadband or web filtering supplier.

\"\"
Click on the Access Settings<\/strong> button and this will display the information that your supplier has requested access to. From the Policy<\/strong> dropdown menu, you have 3 options:
Grant All Access Requested<\/strong> – This will allow the supplier access to any information they request now and in the future. This option should be used with great caution.
Manually Control Access<\/strong>(Recommended) <\/em>– This shows you the data that has been requested by the supplier. You need to manually authorise access to the fields requested. If the supplier requires additional fields in the future, you will need to authorise the new fields.
Block All Access<\/strong> – This means the supplier has no access to your data. 

\"\"
If you have chosen to Manually Control Access<\/strong>, you need to enable the product by clicking on the product toggle switch so it changes from off to ON<\/strong>. This will then display the fields requested by the supplier. Any items that have a yellow warning icon next to them are items you have not previously given access to the supplier.

\"\"
Once you have authorised access to the necessary fields, click Apply<\/strong>.
A popup will appear asking you to click Confirm<\/strong>. This grants the supplier access to the necessary fields before enabling any changes.

\"\"
You have now configured the access settings. If the connection status is not \u201cOK\u201d, please contact your MIS support provider.<\/div><\/div><\/div>\n\n\n\n
Configuring Your Arbor Connection<\/span><\/div>
In the MIS connection window, click on the Change Settings<\/strong> button.

\"\"
Select your Supplier<\/strong> (Arbor) from the dropdown menu. Once this has been done, the supplier field will grey out.
\"\"
Enter the server’s fully qualified domain name (Server FQDN<\/strong>).

\"\"
Next, copy the Edulink Code<\/strong> which you need to enter into the Edulink User Defined Field in Arbor.

\"\"
Open your Arbor MIS<\/strong> and click on ‘System<\/strong>‘ in the dropdown menu and then on User Defined Fields<\/strong>.

\"\"
\"\"
Once in the User Defined Fields screen, click the ‘Add User Defined Field<\/strong>‘ button.

\"\"
Select the ‘Short Text’ UDF format.

\"\"
Fill in the Related<\/strong> To<\/strong> field by selecting ‘Educational Institution’<\/strong> and then enter ‘Edulink’ <\/strong>as the field name. Lastly, click Create UDF<\/strong> to add this to your school details.

\"\"
Once you have created your UDF, go to the School <\/strong>dropdown menu in Arbor and select ‘School Details’<\/strong>.

\"\"
Locate the User Defined Field<\/strong>s section and click on the UDF called ‘Edulink’.

\"\"
Input the code you copied from the Edulink Agent in the Edulink <\/strong>field and click Save Changes<\/strong>.

\"\"
Edulink One is now connected to your Arbor MIS. <\/div><\/div><\/div>\n\n\n\n

How Do I Configure LDAP Authentication?<\/h2>\n\n\n\n

If you require LDAP authentication for your Active Directory through the Edulink One app, then select LDAP Connection<\/strong> in the system tray on the agent config.



\"This


Select Change Settings <\/strong>and configure the LDAP server address and user settings. The user must have write back privileges to your LDAP. Click Apply<\/strong>.






Once the LDAP connection has been established then configure the OUs.
Click on the Change OUs<\/strong> button.





Enable the Staff <\/strong>and Student <\/strong>tabs (also Parents<\/strong> if they have LDAP account) by ticking the \u201cEnabled\u201d boxes and select the relevant OUs where your users reside from the dropdown menu. Click on the Add<\/strong> button to add the OU.

Add the LDAP Field Name where the Agent will be storing the MIS ID. OND recommend using \u201cpager\u201d where possible. If this is in use, then you could use the \u201cOffice\u201d field called \u201cphysicalDeliveryOfficeName\u201d in the LDAP schema.
Note the field names are case sensitive.<\/strong>

This ID is used to match users in SIMS to users in LDAP. Once the match is made, we add the ID into LDAP.  

Finally, select which ID will be used from SIMS. (image here would be useful)

Staff can use the \u201cMIS Id\u201d and \u201cStaff Code\u201d or students \u201cMIS Id\u201d, \u201cAdmission Number\u201d, \u201cUPN\u201d and \u201cULN\u201d. By default, we use the \u201cMIS Id\u201d if not already populated. 

If the ID already exists in your LDAP, then select as appropriate.

Click the Apply<\/strong> button to save the changes.<\/p>\n\n\n\n

MIS Compatibility for LDAP<\/h3>\n\n\n\n
\"MIS<\/figure>\n\n\n\n

Using Google and Microsoft for Logins<\/h2>\n\n\n\n

If your school is not planning on using LDAP for the authentication method, you must ensure that you have inputted your school’s Office 365 or Google addresses as the Primary (if your MIS requires this) in your school’s MIS.

Once your Microsoft\/Google email addresses have been input into your MIS, you can then follow the instructions in this link <\/a>to help set up logins for these systems.

Your users can then log in following one of the methods outlined in Logging into Edulink One<\/a>.<\/p>\n\n\n\n

MIS Compatibility for Google and Microsoft<\/h3>\n\n\n\n
\"MIS<\/figure>\n\n\n\n


Your Edulink One is now installed and configured. <\/p>\n","protected":false},"excerpt":{"rendered":"

What is the Edulink Agent? The Edulink Agent is a lightweight application that needs to be installed on a server at your school. This Agent acts as a connector between Edulink One and the other school servers such as your MIS, Active Directory and Cashless Catering. What do I need…<\/p>\n","protected":false},"author":2,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"ht-kb-category":[17],"ht-kb-tag":[64,7],"acf":[],"yoast_head":"\nInstalling the Edulink Agent - Edulink One Knowledge Hub - Overnet Data Support<\/title>\n<meta name=\"description\" content=\"Get your school up and running with Edulink One. Use our step by step guide to help you with installing Edulink SIMS Agent.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Installing the Edulink Agent - Edulink One Knowledge Hub - Overnet Data Support\" \/>\n<meta property=\"og:description\" content=\"Get your school up and running with Edulink One. Use our step by step guide to help you with installing Edulink SIMS Agent.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/\" \/>\n<meta property=\"og:site_name\" content=\"Edulink One Knowledge Hub - Overnet Data Support\" \/>\n<meta property=\"article:modified_time\" content=\"2024-02-16T14:26:01+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/support.overnetdata.com\/wp-content\/uploads\/2021\/05\/Capture.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"15 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/\",\"url\":\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/\",\"name\":\"Installing the Edulink Agent - Edulink One Knowledge Hub - Overnet Data Support\",\"isPartOf\":{\"@id\":\"https:\/\/support.overnetdata.com\/#website\"},\"datePublished\":\"2021-05-06T11:40:53+00:00\",\"dateModified\":\"2024-02-16T14:26:01+00:00\",\"description\":\"Get your school up and running with Edulink One. Use our step by step guide to help you with installing Edulink SIMS Agent.\",\"breadcrumb\":{\"@id\":\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/support.overnetdata.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Installing the Edulink Agent\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/support.overnetdata.com\/#website\",\"url\":\"https:\/\/support.overnetdata.com\/\",\"name\":\"Edulink One Knowledge Hub - Overnet Data Support\",\"description\":\"Online user guide for Edulink One from Overnet Data's Support Team\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/support.overnetdata.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-GB\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Installing the Edulink Agent - Edulink One Knowledge Hub - Overnet Data Support","description":"Get your school up and running with Edulink One. Use our step by step guide to help you with installing Edulink SIMS Agent.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/","og_locale":"en_GB","og_type":"article","og_title":"Installing the Edulink Agent - Edulink One Knowledge Hub - Overnet Data Support","og_description":"Get your school up and running with Edulink One. Use our step by step guide to help you with installing Edulink SIMS Agent.","og_url":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/","og_site_name":"Edulink One Knowledge Hub - Overnet Data Support","article_modified_time":"2024-02-16T14:26:01+00:00","og_image":[{"url":"https:\/\/support.overnetdata.com\/wp-content\/uploads\/2021\/05\/Capture.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Estimated reading time":"15 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/","url":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/","name":"Installing the Edulink Agent - Edulink One Knowledge Hub - Overnet Data Support","isPartOf":{"@id":"https:\/\/support.overnetdata.com\/#website"},"datePublished":"2021-05-06T11:40:53+00:00","dateModified":"2024-02-16T14:26:01+00:00","description":"Get your school up and running with Edulink One. Use our step by step guide to help you with installing Edulink SIMS Agent.","breadcrumb":{"@id":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/support.overnetdata.com\/knowledge-base\/installing-edulink-agent\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/support.overnetdata.com\/"},{"@type":"ListItem","position":2,"name":"Installing the Edulink Agent"}]},{"@type":"WebSite","@id":"https:\/\/support.overnetdata.com\/#website","url":"https:\/\/support.overnetdata.com\/","name":"Edulink One Knowledge Hub - Overnet Data Support","description":"Online user guide for Edulink One from Overnet Data's Support Team","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/support.overnetdata.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-GB"}]}},"_links":{"self":[{"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/ht-kb\/40"}],"collection":[{"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/comments?post=40"}],"version-history":[{"count":103,"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/ht-kb\/40\/revisions"}],"predecessor-version":[{"id":15395,"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/ht-kb\/40\/revisions\/15395"}],"wp:attachment":[{"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/media?parent=40"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/ht-kb-category?post=40"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/support.overnetdata.com\/wp-json\/wp\/v2\/ht-kb-tag?post=40"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}