Overview
Sharing lets people who are not members of your team play a lab. You share a lab from the Share menu in the lab editor. Instruqt admits each person under the terms you set, counts their plays, and lists them for you.
The Share menu
Section titled “The Share menu”Open a lab and click the Share icon in the header. The menu has two options.
| Option | What it does | Who it is for |
|---|---|---|
| Embeds | Creates links that admit anyone who opens them, without signing in. Each link comes with an iframe snippet for your own site. The badge shows how many embeds are active. | Documentation sites, partner portals, marketing pages, and anywhere else you want the lab to run inside your own page. |
| LTI integration | Connects the lab to a learning management system (LMS). Each launch from the LMS mints a play token that admits one learner. | Courses in an LMS (e.g. Canvas, Moodle) where learners are already signed in and grades flow back. |
See Embeds and Play tokens for each option. Your own backend can also mint play tokens through the API, to give one person a link to one lab. See Mint a play token with the API.
How access works
Section titled “How access works”Both options work the same way underneath. A person opens a share link. Instruqt admits them: it checks the link, records them as an end user of that share, and gives them a fixed set of terms. From then on, every start of the lab is a play against those terms.
The terms are:
| Term | Meaning |
|---|---|
| Access window | How long one end user keeps access, counted from the moment they first open the link. Each end user has their own window. |
| Plays per end user | How many times one end user may start the lab inside their window. Can be unlimited. |
| Lab version | The branch or tag every end user plays. Set on the share, not by the end user. |
| Expiry | The share’s own clock. After it passes, the link admits nobody new. End users already admitted keep the access they have. |
An end user is admitted once per share. Their window and play count are fixed at that moment. If you change the share’s settings later, the change applies only to end users admitted after it. You can adjust one end user’s plays or window from their row in the end users table.
Who an end user is depends on the share:
- Embed: the end user is the browser they used. If they clear their browser data or open the link in a different browser, they are a new end user with a fresh window and play count.
- Play token: the end user is the first person who opens the token’s link. From an LMS launch, that is the learner who is signed in to the LMS. Each launch mints a new token, so each launch makes a new end user.
What an end user sees
Section titled “What an end user sees”When an end user opens a share link, the player shows the lab’s title, description and outline, and a Start lab button. Nothing is counted until they click it. If they already have a session running, the button reads Resume lab and no new play is counted.
If Instruqt cannot admit them, or they have no plays left, the player shows a message that says why. See Plays and limits for each message.
What counts toward your team
Section titled “What counts toward your team”Every play through a share counts toward your team’s session limits, the same as any other lab session. A play cap on the share is what stops one link from running up your usage.
Team members who open a share link are admitted and counted like any other end user. In the end users table they show by name. To play a lab without taking an end user spot, open it from the lab editor instead.
