Creating Adapters

Begin by navigating to a property within an organization. Once at the property page you can add a New adapter.

Enter details about this adapter including a description and unique short code (e.g. youtube_to_canvas_lti). The short code must be unique and will be incorporated into the adapter URL.

Once you've created your adapter you can start configuring it by clicking Build.

A new adapter will begin with two components, a Request (incoming) Handler and a Response (outgoing) Type. You can change the end-point by clicking on them.

To insert new components (e.g. Set, Copy, Require, etc.) press the Green Plus Button, select the type of component, enter the desired parameters, and hit Save.

You can return to Edit the component by clicking on it again. It can be removed by pressing the down arrow to the right of the component button and hitting Delete.

*Note: Adapters process transactions sequentially. Therefore the ordering of components matters in the overall transformation. For example if you first Copy user_id to username and then insert Keep username, all that will be left is username. However if you begin with Keep username and the perform Copy user_id to username, the user_id will no longer be present because the Keep didn't leave it available for copying.

Should you need to reorder the components, add the component in the correct position and delete the original.

When you're finished building your adapter click Done to the right of the adapter name. Remember to take your adapter out of debug mode when you are ready to start passing transactions on to the destination end-point.

Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk