A LIS endpoint describes how IPSIS obtains services and data from a SIS supporting the IMS Global LIS v2.0 messaging standard. For most LIS operations and LIS-supported SIS vendors, endpoint information is not part of its communication with IPSIS, and the endpoint must be configured manually.
Add an endpoint
- On the Configuration page, click the source system name that you want to configure the endpoint for.
- Click Add Endpoint.
- From the Endpoint Type drop-down list, select one of the following end-point types:
- Bulk endpoint - Defines the URL and credentials for where the SIS can be contacted by IPSIS to initiate and report bulk data exchanges. Without a bulk endpoint, an administrator cannot initiate a batch process from the Dashboard.
- Outcome endpoint - Defines the URL and credentials for where the SIS can be contacted by IPSIS to exchange learner grade information. An Outcome endpoint is needed by institutions wishing to export grades in either a push by IPSIS to the SIS or a pull by the SIS from the LMS (IPSIS).
- Outcome 2 endpoint - Needed for exporting (pushing) grades, and although it would typically have the same URL and credentials as the outcome endpoint, it may optionally have a different URL if the SIS requires IPSIS to call a different web service in the second stage of the grades exchange.
- Bulk File Download endpoint - Needed if credentials are required to download bulk files, and the credentials are not provided as part of the communication with the SIS.
- In the Address field, enter the URL where the SIS services the requests of the specified endpoint type.
- From the Authentication Type drop-down list, select an authentication type. Choose the authentication type required by the SIS endpoint.
- WS-Security - This option is a security extension designed to help secure web service communication using SOAP.
- Basic Auth - This option is a simple web-based authentication scheme that works by sending the username and password with each request to the SIS.
- Enter a username and password. These should match what is required by the SIS endpoint.
- From the Default Vocabulary drop-down list, select a vocabulary.
- From the Default Language drop-down list, select a language.
- Click Save.
Bulk endpoint configurations
The following bulk endpoint configurations are used by LIS 2.0 configurations to import SIS data into Brightspace and export grades to the SIS:
- SIS Reference Id
- Required by the SIS to identify Brightspace when sending bulk or grades messages
- Bulk Data Exchange
- Endpoint URL where the SIS listens for confirmation that a bulk job has completed
- Choose the Authentication Type and enter valid credentials:
- If the bulk request from the SIS does not contain the login credentials, the user can specify the partial or complete file path and retrieve credentials
When to configure Bulk File Download endpoints
You do need an endpoint of type Bulk File Download when downloading bulk files:
- Via FTP and the FTP site credentials are not provided in the bulk download message.
- Via HTTP or HTTPS and the web site requires Basic Authentication security access.
- Via HTTP or HTTPS from a PeopleSoft PeopleTools Java Servlet which requires PeopleSoft-specific user credentials, which are not provided in bulk download message.
You do not need a Bulk File Download endpoint when downloading bulk files:
- Via FTP and the URL and credentials are provided by the SIS in the bulk download message.
- Via HTTP or HTTPS and authentication credentials are not required to access the download file web site (anonymous authentication accepted); this might be because IP filtering has been setup to establish restricted server-to-server access.
Handlers for different bulk file download methods
IPSIS platform handlers do the job of initializing a connection and performing the actual bulk file download. Depending on how bulk files are to be downloaded, the appropriate set of handlers should be configured. Refer to the lists below and ensure the handlers are configured as noted for the D2L.IM.IPSIS.Bulk.Handlers.IBulkFileRetrieverHandler extension point.
FTP (credentials supplied in bulk download messages)
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverSetLocalPathToD2LTempHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverUriHandler
FTP (credentials missing from bulk download messages)
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverSetLocalPathToD2LTempHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverRetrieveAuthenticationCredientialsHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverUriHandler
HTTP or HTTPS without authentication (endpoint not defined)
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverSetLocalPathToD2LTempHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverUriHandler
HTTP or HTTPS with Basic Authentication
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverSetLocalPathToD2LTempHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverRetrieveAuthenticationCredientialsHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverUriHandler
HTTP or HTTPS with Basic Authentication from the PeopleSoft PeopleTools Java Servlet
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverSetLocalPathToD2LTempHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverRetrieveAuthenticationCredientialsHandler
- D2L.IM.IPSIS.Default.Bulk.Handlers.BulkFileRetrieverPeopleSoftHandler
Note: Credentials defined in the endpoint must match an appropriate PeopleSoft user.