Question about environments in LTI configuration

Here is the xml configuration I am using:

This XML file does not appear to have any style information associated with it. The document tree is shown below.
xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0" xmlns:blti="http://www.imsglobal.org/xsd/imsbasiclti_v1p0" xmlns:lticm="http://www.imsglobal.org/xsd/imslticm_v1p0"xmlns:lticp="http://www.imsglobal.org/xsd/imslticp_v1p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd">
theTitle
theDescription
name="custom_fields">
name="canvas_account_id">$Canvas.account.id
name="canvas_account_name">$Canvas.account.name
name="canvas_account_sis_id">$Canvas.account.sisSourceId
name="canvas_api_domain">$Canvas.api.domain
name="canvas_shard_id">$Canvas.shard.id
name="canvas_membership_roles">$Canvas.membership.roles
name="canvas_root_account_id">$Canvas.root_account.id
name="canvas_global_root_account_id">$Canvas.root_account.global_id
name="canvas_user_id">$Canvas.user.id
name="canvas_user_login_id">$Canvas.user.loginId
name="canvas_masquerading_user_id">$Canvas.masqueradingUser.id
name="canvas_masquerading_user_user_id">$Canvas.masqueradingUser.userId
name="person_email_primary">$Person.email.primary
name="person_name_full">$Person.name.full
name="person_name_full">$Person.name.full
name="person_sourced_id">$Person.sourcedId
platform="canvas.instructure.com">
name="tool_id">theToolID
name="privacy_level">name_only
name="global_navigation">
name="text">theMenuItemText
name="url">theLaunchUrl
name="icon_url">theIconUrl
name="visibility">admins
name="enabled">true
name="oauth_compliant">true
name="environments">
name="launch_url">TheTestLaunchUrl?
name="domain">TheTestLaunchDomain?
name="test_launch_url">TheTestLaunchUrl
name="test_domain">TheTestLaunchDomain
name="beta_launch_url">TheBetaLaunchUrl
name="beta_domain">TheBetaDomain
identifierref="BLTI001_Bundle"/>
identifierref="BLTI001_Icon"/>

In regards to the "environments" section of the configuration, it seems like the placement does not work unless the "url" property is set under the global_navigation option. It also seems like something is wrong with the way I am setting up the environments section because it still uses the production launch on the test server. The documentation shows the same url for launch_url and test_launch_url.

Question 1: Can someone provide a working example of the environments section?

Question 2: Is the "launch_url" of the environments section supposed to be production or test?

EDIT:

I think this post confirms that I am close to setting it up correctly. It also suggests that the environments setting is only used when pushing production down to test or beta so that is probably why I am not seeing it work yet.

Question 3: Is there a way to force updating test from production or do I have to wait 3 weeks to test this out?

Find more posts tagged with

Accepted answers

All comments

MattHanes

Question 3: You'll probably have to ask your CSM if that's possible but the beta updates every week so you could just wait until this weekend.

unknown

Hi J B,

I just want to confirm that my conventional wisdom tells me to set the environments as this:

<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>options</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>environments<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>launch_url<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><A href="http://example.com/content" target="test_blank" rel="nofollow noopener noreferrer">http://example.com/content</A><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>domain<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>example.com<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>test_launch_url<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><A href="http://test.example.com/content" target="test_blank" rel="nofollow noopener noreferrer">http://test.example.com/content</A><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>test_domain<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>test.example.com<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>beta_launch_url<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><A href="http://beta.example.com/content" target="test_blank" rel="nofollow noopener noreferrer">http://beta.example.com/content</A><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>beta_domain<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>beta.example.com<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR /><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>options‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍</SPAN><SPAN class="punctuation token">></SPAN></SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

where the launch_url and domain should be the 'live' version of the tool, and the test_launch_url and test_domain is the 'test' version of the tool, yet the official Test Environment Setting Examples documentation shows the launch_url/domain differently:

<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>options</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>environments<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>launch_url<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><A href="http://test.example.com/content" target="test_blank" rel="nofollow noopener noreferrer">http://test.example.com/content</A><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>domain<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>test.example.com<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>test_launch_url<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><A href="http://test.example.com/content" target="test_blank" rel="nofollow noopener noreferrer">http://test.example.com/content</A><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>test_domain<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>test.example.com<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>beta_launch_url<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><A href="http://beta.example.com/content" target="test_blank" rel="nofollow noopener noreferrer">http://beta.example.com/content</A><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR />    <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN> <SPAN class="attr-name token">name</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>beta_domain<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>beta.example.com<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>property</SPAN><SPAN class="punctuation token">></SPAN></SPAN><BR /><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN><SPAN class="namespace token">lticm:</SPAN>options</SPAN><SPAN class="punctuation token">></SPAN></SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Should I be going with my conventional wisdom, or with what the documentation is suggesting? Is this a bug in the documentation?

agschmid

We've been using environment variables for a couple of years now, and this is how we got it to work:

In the XML file, the following line under needs to be removed (if present):

PRODUCTION_URL

The following needs to be added to XML files in order to use the environment variables:

URL_FOR_PRODUCTION_GOES_HERE

PRODUCTION_DOMAIN

URL_FOR_TEST_GOES_HERE

TEST_DOMAIN

URL_FOR_BETA_GOES_HERE

BETA_DOMAIN

Unanswered Questions

GraphQL - Is there a way to check if a course was cross listed, combined or merged?
Hello, I am trying to query a course ID to check if it was cross listed. Do you know what is the data field to get this information or what query or API endpoint to use? I tried to use nonxlist_course_id, but received error 'doesn't exist on type course'.
UI for weekly progression idea
UI for weekly progression idea that rest in the Schedule tab of the **K-12 UI** of Canvas it's incomplete and I really would not take it and push it into instance but I am going to post it here because in the past people like @James && @robotcars || @Steve_25 have had terrific input in the past... maybe w/their eyes and…
add `desc` or `asc` to a few api calls that are already sorted by date\time\index such as `due_at`
A case for this argument: I live in thee K-12 realm which means we have way too many assignments... which means that at times a simple last 10 assignments of a course question(last 10 date wise) will take us 300 assignments to answer Solution for this example in particular: I would love to make this modified version of an…
Integrate a React App (Not Canvas) to be Canvas LMS SSO.
Hey Community: I want to ask first if Canvas LMS as a Identity provider is only supported with SAML? What other protocols are supported? My use case is that I have a React App hosted on cloud provider (AWS) and SpringBoot as a backend (Service provider). I want to integrate Canvas SSO as a Identity provider (IdP). I…
Donot have valid data to test certain APIs
Hi , I’m working on validating the API test cases for CANVAS Api and need suitable test data to verify the 200 OK status code responses. I am using free for teachers version account. PFA Ecel sheet about the end points I am checking for.