instructure canvas real-time integration with sct configuring luminis to canvas integration summary

Download Instructure Canvas real-time integration with SCT Configuring Luminis to Canvas Integration Summary

Post on 23-May-2020

0 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

  • Instructure Canvas real-time integration with SCT Banner

    Instructure Canvas can leverage the real-time integration capabilities available in SCT Banner and the Luminis

    integration product. This integration works via a JMS HTTPClient bridge configured within a Luminis Message

    Broker IV installation.

    Prerequisites:

    1. Integration Technologies license with Luminis Message Broker (LMB)/Luminis Message Gateway (LMG)

    (versions 4.0) installed and running.

    2. Banner 8.x installed and running. Banner INTCOMP must be at 8.0.2 and requires a minimum of

    GENERAL 8.1 and STUDENT 8.1.

    3. Luminis Platform (4.x) is installed and running.

    4. Real-time data synchronization (LDI Events) between Banner and Luminis via Integration Technologies

    installed and running.

    Installation of the Luminis packages are detailed in documents included with the product.

    Familiarity with a cygwin/Linux/Solaris command line is preferred.

    Configuring Luminis to Canvas Integration Summary

    Table of Contents:

    1. Determine what account on the Canvas server you are going to integrate with Banner and note the account

    number.

    2. Create a user within the Canvas server account being integrated with Banner. This user should have an

    administrative role in the specific Canvas server account. A generic account should be created rather than using

    a specific person's account.

    3. Generate an ACCESS_TOKEN on the canvas server specific to the account that will be integrated.

    4. Create an event exchange topic in the Luminis Message Broker (LMB) server. This will be used as a holding

    area for live events going from Banner to Canvas. The topic that is needed is called com_sct_ldi_sis_LmsSync.

    If the LMB server is integrated with another LMS, this may already exist.

    5. Create a LMB user with password which will be used internally within the LMB/LMG server. After the user

    is created, grant rights for it to consume messages in the LmsSync topic.

    6. Create an event HTTPClient in the LMB server connected to the Canvas server. The HTTPClient configuration

    bridges between the Luminis JMS system and an external HTTP client.

    7. Obtain the Canvas server's public SSL Certificate and import into the $JAVA_HOME/lib/security/cacerts

    certificate store. If necessary, import the full server certificate SSL chain and/or import the certificates in other

    cacerts store files located on the server.

    8. Ensure connectivity between the Luminis Message Broker and Canvas servers. The Luminis Message Broker

    needs to be able to initiate a connection via SSL to the Canvas server, typically on port 443.

    9. Create the queues in the LMB server used for grade exchange. These are used as a holding area for the grade

  • exchange between Canvas and Banner. The two that are needed are com_sct_ldi_sis_UpdateRequest queue and

    com_sct_ldi_sis_UpdateReply queue. If another LMS is already configured for grade exchange, these names

    should be modified to include canvas and a second instance of the LMG GradeAdapter should be configured.

    10. Create a grade exchange HTTPClient in the LMB server.

    11. Deploy the grade exchange application to an Apache Tomcat server in the environment (Luminis IV is

    installed with a tomcat server, although a secondary one can be used).

    12. Ensure connectivity between the grade exchange and Canvas servers. The Canvas server needs to be able to

    initiate a connection to the tomcat server where the grade exchange application is installed via SSL, If the grade

    exchange application is installed on the LMB server, communication would typically be on port 7678.

    Appendix 1: canvas_mbldisetup script variables and detail

    Appendix 2: SSL certificate discussion (2048 bit SSL certificate not supported by default)

    Appendix 3: Miscellaneous hints and tips concerning LMB/LMG

  • 1. Determine what account on the Canvas server you are going to integrate with Banner and note the account

    number.

    -- Example: 13

    2. Create a user within the Canvas server account being integrated with Banner. This user should have an

    administrative role in the specific Canvas server account. A generic account should be created rather than using

    a specific person's account.

    -- Example: canvaslmb@myschool.edu

    3. Generate an ACCESS_TOKEN on the canvas server within a user account which has an admin role within

    Canvas. Generate a new token by going to your profile settings (upper right corner of your Canvas session,

    settings), scrolling to the bottom of the page and clicking the “+New Access Token”

  • -- Example: 1834~yrBwlKUXWtBmYtoynzei8RBs7LtBuXVb4RwJQ3zhSXdOaMoADtnetBNYS2UqBc6L

    Sections 4-6, 9 and 10 can be automated by running a canvas_mbldisetup script that can be provided on the

    Luminis Message Broker server.

    4. Create an event exchange topic in the Luminis Message Broker (LMB) server. This will be used as a holding

    area for live events going from Banner to Canvas. The topic that is needed is called com_sct_ldi_sis_LmsSync.

    If the LMB server is integrated with another LMS, this may already exist.

    The com_sct_ldi_sis_LmsSync topic receives live events from Banner via the Luminis Message Gateway event

    application. This includes new person objects and related changes and enrollment events. Events are passed to

    Canvas via the event HTTPClient we will configure in section six.

    4a. Log into the Luminis management interface:

  • 4b. Click on Destinations and the New Destination button. Put com_sct_ldi_sis_LmsSync as the Name, select

    Topic as the type and click the Create button. If you have previously been integrated with another LMS, this

  • topic will already exist and can be used by all systems.

    You should now see the LmsSync Topic in the Destinations page.

    5. Create a LMB user with password which will be used internally within the LMB/LMG server. After the user

    is created, grant rights for it to consume messages in the LmsSync topic.

  • 5a. On the LMB server, open a terminal window (cygwin for windows).

    Run the following command:

    mbtool add user -id= -desc= -credential=

    is the name of a user that will be created internally in the Luminis Message Broker. This can be

    anything that is unique in the system.

    -- Example: canvaslmb

    is a description assigned to the user

    -- Example: Canvas_LMB_User

    is the password for the new LMB user.

    -- Example: asofkljelisdlfileh

    -- Example: mbtool add user -id=canvaslmb -desc=Canvas_LMB_User -credential=asofkljelisdlfileh

    5b. Once the user is created, add rights to the LmsSync destination.

    mbtool update destaccess -policy=allow -entity=user -id= -access=consume

    -dest=com_sct_ldi_sis_LmsSync -type=topic -op=add

    is the same one created above.

    -- Example: mbtool update destaccess -policy=allow -entity=user -id=canvaslmb -access=consume

    -dest=com_sct_ldi_sis_LmsSync -type=topic -op=add

  • 5c. Verify that access has been properly added by checking in the Luminis management interface:

    Log into the Luminis management interface and select Connection Access Policy

  • The created above should be listed in the Normal column, Allow Users area. You may or may not

    have other users listed in this area. If the user is not listed, type the in the box next to the Add button

    and then click the Add button.

    Verify the LMB user you created is in the Allow Users box. From the front page, next select Destinations, select

    the radio button next to the com_sct_ldi_sis_LmsSync topic and click the Edit Access button.

  • The created above should be listed in the Consume column, Allow Users area. You may or may

    not have other users listed in this area. If the user is not listed, type the in the box next to the Add

    button and then click the Add button.

    6. Create an event HTTPClient in the Luminis Message Broker connected to the Canvas server.

    The HTTPClient configuration bridges between Luminis JMS system and an external HTTP client.

    Log into the LMB management interface and select Outgoing HTTP Clients.

  • Click on the New Client button.

    The outgoing HTTP Client uses information from sections one thru five.

    Name: The name of the HTTP Client within LMB.

    -- Example: Canvas_Ldi_Event_Receiver

  • Enable: true

    -- Set to true if this client is active.

    Stop Delivery on Error: true

    -- Set to true to ensure events queue from Banner if there is a communication error between the Luminis broker

    and the canvas server. The easiest way to resume Canvas consumption of messages is to set Enable to false, save

    and then reset Enable to true.

    Consume From: com_sct_ldi_sis_LmsSync (Topic)

    JMS Connection user Name: LMB user created in section five.

    -- Example: canvaslmb

    JMS Connection Password: LMB user password used in section five.

    -- Example: asofkljelisdlfileh

    Verify Password:

    JMS Message Selector: Lea

Recommended

View more >