# Welcome! Welcome to the Shift iQ documentation portal. This is your home base for everything you need to understand, use, and integrate with **Shift iQ**. Whether you're just getting started or you are a seasoned power user, this portal is designed to help you navigate our platform with confidence. ### What you’ll find here * **Guides** – Set up your environment and go from zero to production smoothly. * **API References** – Explore detailed, up-to-date API docs with real examples. * **How-To Articles** – Solve common use cases and follow best practices. * **Release Notes** – Stay informed on new features, improvements, and fixes. * **Integration Guides** – Connect with third-party tools and systems seamlessly. * **Troubleshooting & FAQs** – Get help fast with curated tips and answers. ### Tips for success * Use the **search bar** at the top to quickly find what you need. * Bookmark important pages for easy access later. * Check out the “What’s New” section for the latest updates. ### Need help? If you're stuck or have questions, we’re here for you. Reach out to our support team or join the community forum to get help and share insights. *** **Welcome aboard!** 🌟 # Version 26.1 is live The current version (26.1) was released to Production on February 18, 2026. The next upcoming version (26.2) is scheduled for release to: * **Sandbox** on **April 8, 2026** for review and testing * **Production** on **April 15, 2026** for live use Do you have an idea for a new feature you'd like to see a future release? Let us work with you to get it quoted, scheduled, and developed. Contact your Shift iQ account manager or send an email to # Help Center Welcome to the help center. We have compiled a list of common questions and answers to help you find tips, insights, and troubleshooting advice. Browse topics. Ask questions. Find answers. {% hint style="info" %} Can't find what you’re looking for? Contact our team at space.vars.support\_email and we'll get back to you. {% endhint %} ## Popular topics * [Newsletters](/help/messages/authoring-messages/create-new-message) * [User account self-registration](/help/contacts/adding-new-contacts/user-self-registration) * [Class registration](/help/events/overview) ## Popular apps/toolkits
ContactsFind help on how to add new users and groups, manage user accounts, and edit permission lists./pages/Ayrff5f2npugvPEpHwI5
AssessmentsFind help on how to create question banks, set specifications, add questions to forms, and review and test assessments./pages/HmRbPMODzen64axTHJN9
SurveysFind help on how to create, edit and configure surveys, view responses, and generate reports./pages/m6Yx6vf3sbjIDrtoJu1X
MessagesFind help on how to create, edit and configure messages, format message contents and schedule mailouts./pages/CAlD1jYUJMqKenhjqb9J
CoursesFind help on how to create, edit and configure a course, add content, preview and publish a course./pages/72HT6WxEIOyFl6aIxDbA
StandardsUse standards to build detailed competency frameworks that can be tied to courses and assessments to drive adaptive competency-based training./pages/IO1GrIYLhdWBRh4dc7vw
## Answers to frequently asked questions * [How do I add a new contact?](/help/contacts/adding-new-contacts) * [Can I bulk upload contacts?](/help/contacts/adding-new-contacts/upload-contacts) * [How do I reset a user's password?](/help/contacts/editing-contacts/password-resets) * [How do I create a new survey?](/help/surveys/create-survey) * [Can I add videos and hyperlinks to a survey?](/help/surveys/question-configuration/add-videos-hyperlinks) * [How do I create a course?](/help/courses/overview) * [How do I work with Markdown content in Shift iQ?](/help/messages/authoring-messages/markdown-reference) * [How do I search standards?](/help/standards/edit-standards/searching-standards) * [How do I create a new competency framework?](/help/standards/create-standards) * [How do I create a new notification/newsletter?](/help/messages/overview) # Accessing your sandbox How to access your system outside the live production environment The **sandbox** environment is a safe, isolated space where users can explore features, test changes, and practice tasks without affecting real data or the live system. It's commonly used for demonstrations, training, experimentation, and staging for new upcoming versions. To access your sandbox environment, follow these steps: 1. Visit the Shift iQ website at [www.shiftiq.com](https://www.shiftiq.com/) 2. Click the Sign In link at the top of the page. 3. On the Sign In form, scroll to the bottom of the page. 4. You'll see an information message that reads, "You are signing in to the Production environment." 5. Below this, you'll see links to the other environments available to your organization. Typically, this includes Development and Sandbox. 6. Click the link for the Sandbox environment. 7. Copy the URL from your web browser's address bar. For example:
Signin environments
# Working with Markdown Markdown is a simple way to format text using plain characters, instead of relying on buttons or complex editors. It is commonly used in documentation, emails, chat systems, and websites because it is easy to read and write. With Markdown, you can quickly add structure and formatting such as: ### 1. Headings To create a heading, add number signs (`#`) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three (`

`), use three number signs (e.g., `### My Header`). | Markdown | HTML | Rendered Output | | ------------------------ | -------------------------- | --------------------------------------------- | | `# Heading level 1` | `

Heading level 1

` |

Heading level 1

| | `## Heading level 2` | `

Heading level 2

` |

Heading level 2

| | `### Heading level 3` | `

Heading level 3

` |

Heading level 3

| | `#### Heading level 4` | `

Heading level 4

` | **Heading level 4** | | `##### Heading level 5` | `
Heading level 5
` | **Heading level 5** | | `###### Heading level 6` | `
Heading level 6
` | **Heading level 6** | #### 2. Bold To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters. | Markdown | HTML | Rendered Output | | ---------------------------- | ----------------------------------------- | -------------------------- | | `I just love **bold text**.` | `I just love bold text.` | I just love **bold text**. | | `I just love __bold text__.` | `I just love bold text.` | I just love **bold text**. | | `Love **is** bold` | `Loveisbold` | Love **is** bold | #### 3. Italic To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters. | Markdown | HTML | Rendered Output | | -------------------------------------- | --------------------------------------------- | ------------------------------------ | | `Italicized text is the *cat's meow*.` | `Italicized text is the cat's meow.` | Italicized text is the *cat’s meow*. | | `Italicized text is the _cat's meow_.` | `Italicized text is the cat's meow.` | Italicized text is the *cat’s meow*. | | `A *cat* meow` | `A cat meow` | A *cat* meow | #### 4. Ordered Lists To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one. | Markdown | HTML | Rendered Output | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | |

1. First item
2. Second item
3. Third item
4. Fourth item

|

\


    \
  1. First item\

    2. \
  2. Second item\

    3. \
  3. Third item\

    4. \
  4. Fourth item\

    5. \

|
  1. First item
  2. Second item
  3. Third item
  4. Fourth item
| |

1. First item
2. Second item
3. Third item
1. Indented item
2. Indented item
4. Fourth item

|

\


    \
  1. First item\

    2. \
  2. Second item\

    3. \
  3. Third item
    \

      \
    1. Indented item\

      2. \
    2. Indented item\

      3. \

    \

    4. \
  4. Fourth item\

    5. \

|
  1. First item
  2. Second item

  3. Third item

    1. Indented item
    2. Indented item
  4. Fourth item
| #### 5. Unordered Lists To create an unordered list, add dashes (`-`), asterisks (`*`), or plus signs (`+`) in front of line items. Indent one or more items to create a nested list. | Markdown | HTML | Rendered Output | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | |

\* First item
\* Second item
\* Third item
\* Fourth item

|

\

| | |

\* First item
\* Second item
\* Third item
\* Indented item
\* Indented item
\* Fourth item

|

\

| | #### 6. Table to content Tables can be created within an Assessment Question, Answer Options. To add columns to the Assessment Question, use the below template/formula: Column 1 | Column 2 | Column 3 | Column 4 \--|--|--|-- Column 1 | Column 2 | Column 3 | Column 4\ Column 1 | Column 2 | Column 3 | Column 4\ Column 1 | Column 2 | Column 3 | Column 4\ Column 1 | Column 2 | Column 3 | Column 4\ Column 1 | Column 2 | Column 3 | Column 4 It will display as: | Column 1 | Column 2 | Column 3 | Column 4 | | -------- | -------- | -------- | -------- | | Column 1 | Column 2 | Column 3 | Column 4 | | Column 1 | Column 2 | Column 3 | Column 4 | | Column 1 | Column 2 | Column 3 | Column 4 | | Column 1 | Column 2 | Column 3 | Column 4 | | Column 1 | Column 2 | Column 3 | Column 4 | #### 7. Changing Font Color or Text The HTML code needs to be added around the text as follows: ``` add text here ``` You can change the color by typing the color name (e.g. `black`, `red`, `blue`) or adding the HTML color code (e.g. `#060606`, `#F90F0F`, `#0F0FF9`) after `color:` — for example, `color: blue` or `color: #060606`.
#### 8. Changing Font Color and Size The HTML code needs to be added around the text as follows: ``` insert text ``` Instead of adding the Name of the Font (e.g. Green, Yellow, Blue, etc.) you are able to add the [HTML Color Code](https://html-color.codes/) (e.g. `#24ffff`, `#ff2424`, `#ffff24`, etc.). #### 9. Superscript and Subscript Superscripts can be written by surrounding a text by ^ characters; subscripts can be written by surrounding the subscripted text by \~ characters * X2 is created using X^2^ OR X\2\ * 10-18 is created as 10^-18^ OR 10\-18\ * H2O is created H\~2\~0 OR H\2\0 * Footnote 1† / Footnote 2‡ is created Footnote 1^†^ and Footnote 2^‡^ #### 10. Adding Images You are able to drag and drop a picture from file into the body of the content. Accounts are configured with a file size limit of 1MB per image. If the file size is bigger than 1MB, please decrease the size of your file before uploading it, or contact your administrator to upgrade the settings for your account. The recommended maximum size for an upload image is 800x800 pixels. If a size of your image is bigger 800x800 pixels, the system will automatically scale the image for you. You might want to resize your own images before you upload them. When you added the picture to the content, it will display in a URL format: !\[agriculture-1.jpg]\() In the content you will only see the image, but if you launch the content in the portal, it will display the image. Agriculture 1 File types supported: .png, .gif, .jpg, .jpeg #### 11. Adding Links You are able to add web links or email addresses in the text of your content. When you select Create Link in the content editor, the system will create the outline needed for the link **\[]\(http\://)**. Between the square brackets, add the text you want to be displayed. Copy and Paste or type the webpage you want the user to be directed to. Example of what the link will look like: \ \[Shift iQ]\(; In your page content, the link will display as [Shift iQ](http://www.shiftiq.com/). The user can click on the text and will be directed to the webpage you added. You are able to configure the link with an email address instead. You can either add a email address between the square brackets or text. Instead of adding a website, you remove the http\:// and add [mailto:add email address.](mailto:support@insite.com.) The full link will be \[Click Here to Email]\(mailto:) or \[]\(mailto:). The text will display as [Click Here to Email](mailto:support@shiftiq.com) or #### 12. Adding a Link that opens in a new Browser Window If you require the link you are inserting to open on in a new browser window, you can us the following link: * \text to display\ An example of the full link will be: * \Shift iQ\ * The text will display as [Shift iQ](http://www.shiftiq.com/) and when you click on the text it will open the web page in a new browser window. # Additional Markdown Documentatio This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. \ \ Nearly all Markdown applications support the basic syntax outlined in the original Markdown design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible. [https://www.markdownguide.org/basic-syntax/]() The basic syntax outlined in the original Markdown design document added many of the elements needed on a day-to-day basis, but it wasn’t enough for some people. That’s where extended syntax comes in. Several individuals and organizations took it upon themselves to extend the basic syntax by adding additional elements like tables, code blocks, syntax highlighting, URL auto-linking, and footnotes. These elements can be enabled by using a lightweight markup language that builds upon the basic Markdown syntax, or by adding an extension to a compatible Markdown processor.\[ \\ \ ]\() # Overview Build quizzes through high-stakes exams, tie them to a competency framework, and analyze results with item-level reporting The Assessments toolkit contains everything you need to assess your learners on any topic. It can be used to build everything from simple quizzes to high stakes exams tied to a competency framework. Results can be thoroughly analyzed with in-depth reporting and comparisons on question difficulty. Choose what level of feedback is offered to the learner after their attempt; ranging from no score given to detailed feedback on each question response and which competencies they've successfully proven. # Creating Banks and Question Sets Question Banks are used to organize collections of related questions that are to be used together on an exam form. Question Banks are used to organize collections of related questions that are to be used together on an exam form. They may be organized by competency, standard, topic, occupation, course, program or any grouping that best reflects your assessment needs. # How to use the Assessment Toolkit Creating an Assessment Form involves a structured approach. Creating an Assessment Form involves a structured approach. Below, you’ll find a summary of the steps to follow in order to create your Assessment Form. This workflow will guide you through adding questions to your question bank, creating a clear specification for your assessment, and then using that specification to build a well-organized and effective Assessment Form. ### Step 1. [Create a Bank and Add Questions to it](/help/assessments/create-bank) * **Develop or Gather Questions:** Start by creating or gathering all the potential questions you might want to include in the assessment. These could be based on a specific topic, skill, or criteria that the assessment is targeting. * **Question Types:** Include various question types (e.g., Multiple Choice, Multiple Correct, True/False, Composed Response, or Likert scale). * **Scoring System:** Specify the scoring system for each question (e.g., 1 point for a correct answer, 0 points for an incorrect answer, etc.). * **Organize the Questions:** It’s helpful to organize questions into Sets based on the skills they assess. * **Tagging:** Tag questions with relevant keywords, such as competency code (e.g., A1, B2). This makes it easier to when building a specifications for your bank. ### Step 2. [Create a Specification](/help/assessments/specifications-forms) * **Choose your Specification Type:** * **Dynamic:** A form with this specification does not have a fixed set of questions. If two learners start an attempt on this type of form, then each learner may be presented with a different set of questions and/or questions in a different sequence. * **Static:** A form with this specification has a fixed set of questions in a fixed sequence, which is determined by the author of the form. Every learner who starts an attempt on form with a Static specification sees exactly the same set of questions in exactly the same sequence. * **Total Number of Questions:** How many questions will be included in the assessment? * **Set the Filter Type:** Select how you want to filter questions for the Assessment Form. * **Include All Questions:** Include all of the questions in the set. * **Question Tag Filter:** Filter the questions in the set so that only those with matching tags are included. * **Set your Question limit per Set:** Specify how many questions from each Set in your question bank you want to add to your Form. * **Weighting of Questions:** If some questions are more important than others, decide how to weight them (e.g., certain questions might be worth more points or more time to answer). * **Specify Conditions for Success:** Define the thresholds or criteria for passing or success in the assessment. For instance, what score or percentage constitutes a passing grade? ### Step 3. [Create Your Assessment Form](https://github.com/InSite/docs/blob/master/help/assessments/specifications-forms/creating-a-form/README.md) * **Select Questions from the Question Bank:** Depending on the specification you created in step 2, choose questions from the question bank that match the required criteria. * **Set the Time Limit:** How much time will be given to complete the assessment, if applicable. * **Set Attempt Limit:** This is the maximum number of times each person is permitted attempt this exam. * **Include Instructions:** Provide clear instructions at the start of the assessment form. * **Publish the Form** # Creating a new bank Question Banks are used to organize collections of related questions that are to be used together on an exam form. Question Banks are used to organize collections of related questions that are to be used together on an exam form. They may be organized by competency, standard, topic, occupation, course, program or any grouping that best reflects your assessment needs. Select **Assessments** Toolkit on the portal homepage and then select the **Banks** Counter. At the top of the **Search Banks** page, click on **Add New Bank**. ![add-bank.png](https://e02.insite.com/files/sites/e02/create-new-bank/add-bank.png) From the dropdown menu at the top of the page you are able to select one of the following options: * **One new bank:** Create a brand new Assessment Bank from the beginning. * **Duplicate copy of existing bank:** If you have an existing Assessment Bank you wan to use as your framework, you can duplicate the existing bank. * **Upload one new bank from file:** Assessment banks can by uploaded by using a JSON File If you selected to create **One new bank**, complete the following fields: 1. **Bank Type:** In the Bank Type Field, Advanced is preselected as this is the only option currently available. 2. **Add Bank Title (Required Field):** A descriptive user-friendly title for the bank. 3. **Add Bank Name (Required Field):** A short name that identifies the bank internally for filing purposes. 4. **Select the Level Type (Optional):** Certificate of Qualification, Endorsement Exam, Foundation Exam, Interprovincial Standard Exam, Standard Level Exam. 5. **Edition (Required Field):** The edition of this bank (e.g. Year and Month). 6. Select **Save**. If you selected to create a **Duplicate copy** of existing bank, complete the following fields: 1. **Bank:** Select the Bank from the dropdown list that you want to duplicate. 2. **Bank Type:** In the Bank Type Field, Advanced is preselected as this is the only option currently available. 3. **Add Bank Title (Required Field):** A descriptive user-friendly title for the bank. 4. **Add Bank Name (Required Field):** A short name that identifies the bank internally for filing purposes. 5. **Select the Level Type (Optional):** Certificate of Qualification, Endorsement Exam, Foundation Exam, Interprovincial Standard Exam, Standard Level Exam. 6. **Edition (Required Field):** The edition of this bank (e.g. Year and Month). 7. Select **Save**. If you selected to **Upload one new bank from file**, complete the following fields: 1. Click on the **Magnifying Glass** icon next to the **Select and Upload Bank JSON File** field and select the JSON file. 2. Once file is selected, it the content of the JSON file will be displayed in the **Uploaded JSON** field. 3. Select the **Save** button for the Assessment Bank to be uploaded and created. ![upload-json-file-2.png](https://e02.insite.com/files/sites/e02/create-new-bank/upload-json-file-2.png) The Bank has now been created and details for the bank will be displayed under the Bank tab of the Assessment. Changes can be made to editable fields on this page. * **Standards:** The formal standard evaluated by questions in the bank * **Bank Name:** The name that uniquely identifies the bank for internal filing purposes * **Level:** The type and number for a discrete skill level * **Edition:** The edition of this bank (e.g. Year and Month) * **Bank Title:** The descriptive title for the bank * **Summary:** The purpose or executive summary for the bank # Adding Questions Questions in an Assessment Bank must belong to a set in the Bank, and the Bank must contain at least one set before questions can be added. Questions in an Assessment Bank must belong to a **set** in the Bank, and the Bank must contain **at least one set** before questions can be added. A Bank can contain **multiple sets** with multiple questions in each set. Sets are typically used to organize questions in a bank by competency **Area** of a **Standard Framework**, but can also be used to organize questions in other ways, if desired. **Creating a Set:** * Click on the Questions tab, then click on the Add button on the right hand side of the screen. * Select Set to create the first question set. * Add your Set Name (This name uniquely identifies this question set within the bank) and click the Save button. * The question set has now been created and details for the set will be displayed. **Creating Questions in a Set:** * Click on the Add button and select Question. * Select a [**Question Type**](https://github.com/InSite/docs/blob/master/help/assessments/create-bank/question-types/README.md) * Input the Question text, including uploading any [**images**](https://github.com/InSite/docs/blob/master/help/assessments/editing-forms/editing-images/README.md) * Input any text and/or images for each of the Question Answer Options. * Point Values and Cut Scores may be provided for each answer. * Additional answer options can be added by clicking on the **Add new option** button. * Click the **Save** button to save your changes. The question has now been created will be displayed. [**Changes**](https://github.com/InSite/docs/blob/master/help/assessments/editing-forms/edit-questions/README.md) can be made to the question by selecting the **Edit** icon. Continue adding questions and sets as needed to populate the bank. # Choosing Question Types Shift iQ allows for a wide variety of assessment question types, including multiple choice, true/false, multiple correct, composed response Shift iQ allows for a wide variety of assessment question types, including multiple choice, true/false, multiple correct, composed response (voice recording or typed essay), drag-and-drop reordering, matching, hotspot and Likert. * **Multiple Choice:** Allows the learner to select one correct answer from multiple options, such as Multiple Choice and True/False questions. * **Multiple Correct:** Allows the learner to select multiple answers from multiple options. There are various calculation methods for Multiple Correct question types: * **All or Nothing** This should be used when the total score being awarded for that question will not be split between options. If the candidate does not select all the correct options, the candidate will not get any points. When selecting the **All or Nothing** calculation method, the total points awarded for the question (1 point) is divided equally to all answer options (correct and incorrect). When a learner answers the question, and they select the correct answer options (B and D in the screenshot), they will receive 0.25 for each correct answer and they will also receive 0.25 for not selecting the 2 incorrect answers (A and C in the screenshot). The total points awarded for their answer will be 1 point. ![all-or-nothing.png](https://e02.insite.com/files/sites/e02/question-types/all-or-nothing.png) If the learner selects a correct and incorrect answer (example A and B) or select the correct answers and incorrect answer (example A, B and D), no points will be awarded to the learner for the question.
* **Equally Weighted** This should be used when all the options are correct, the points awarded to the question will be divided equally among all the options. When selecting the **Equally Weighted** calculation method, the total points awarded for the question (1 point) is divided equally to all answer options (correct and incorrect). When a learner answers the question, and they select the correct answer options (A, B and C in the screenshot), they will receive 0.25 for each correct answer and they will also receive 0.25 for not selecting the the incorrect answer (D in the screenshot). The total points that will be awarded for their answer will be 1 point. ![equally-weighted.png](https://e02.insite.com/files/sites/e02/question-types/equally-weighted.png) If the learner selects correct and incorrect answers (example A, B and D) or select all the correct answers and the incorrect answer (example A, B, C and D), points will only be awarded to the correct answers selected. No points will be given for the incorrect answer selected. *E.g. Learner selects A, B and D, points will be awarded for A and B, scoring the learner 0.50 for their answer, no score awarded for D.*
* **Correct Minus Incorrect** This option should be used where points will be deducted where the candidate selects a wrong option. When selecting the **Correct Minus Incorrect** calculation method, the total points awarded for the question (1 point) is divided equally to all answer options (correct and incorrect). When a learner answers the question, and they select the correct answer options (A, B and C in the screenshot), they will receive 0.25 for each correct answer and they will also receive 0.25 for not selecting the the incorrect answer (D in the screenshot). The total points that will be awarded for their answer will be 1 point.\ ![correct-minus-incorrect.png](https://e02.insite.com/files/sites/e02/question-types/correct-minus-incorrect.png) If the learner selects correct and incorrect answers (example A, B and D) or select all the correct answers and the incorrect answer (example A, B, C and D), points will be awarded to the correct answers selected MINUS the incorrect answer selected.
* **Limited Correct** With this option, the candidate is limited to the number of options that can be selected. If there are 2 correct answers, the candidate will only be able to select 2 answers. When selecting the **Limited Correct** calculation method, the total points awarded for the question (1 point) is divided equally between the correct answer options. When a learner answers the question, and they select the correct answer options (A and B in the screenshot), they will receive 0.50 for each correct answer. The total points that will be awarded for their answer will be 1 point. ![limited-correct.png](https://e02.insite.com/files/sites/e02/question-types/limited-correct.png) If the learner selects a correct and incorrect answer (example A and C), points will only be awarded for the correct answer selected and no points for the incorrect answer. Total score awarded to the learner will be 0.50.
* **Composed Response:** Allows the learner to submit a written response. * **Composed Voice:** Learners can capture their verbal response to a question. This question type is associated with a scoring Rubric and is graded manually by an administrator / instructor. Configuration options include: * Limit Number of Attempts * Limit Response Time (Seconds)
* **Composed Essay:** Learners can capture their response by typing their answer in the text box field below the question. This question type is associated with a scoring Rubric and is graded manually by an administrator / instructor.
* **Multiple True/False:** Allows the learner to select True/False in response to a series of statements. Calculation Methods include: * All or Nothing * Equally Weighted * Correct Minus Incorrect * Limited Correct
* **Matching:** Allows the learner to select the correct matching response for a given prompt. Calculation Methods include: * All or Nothing * Equally Weighted * Correct Minus Incorrect * Limited Correct
* **Likert Question Type:** This is a dynamic question type often included on surveys to assess variables such as sentiment, satisfaction, quality, or likelihood. For standardized exams, this question type can be used for third party assessment purposes or where answers options are not binary in nature.
* **Hotspot Question Type:** Any image can be uploaded for use with this question type. Configuration Options Include: * Pin Limits * Shapes Shown vs. Hidden * Image Selection Area - Rectangle or Circle
* **Ordering Question Type:** Top and Bottom Labels can be added to provide additional context to learners. Any number of correct answer options (solutions) can be configured. # Download and Uploading Assessment Banks Select the Assessment Toolkit from the Admin Home Page. ## Downloading an Assessment Bank to a JSON file Select the **Assessment** Toolkit from the Admin Home Page. Select the **Banks** counter. Search for the **Bank** you want to duplicate and select the bank in the **Results** panel. Click on the **Bank Name** to open the Assessment. When the Assessment bank is open, click on the **Download JSON** button. You will be redirected to the Download confirmation page. Review the information and click on **Download** button. The **JSON** file will be downloaded to the **Download** folder on your computer. ## Uploading an Assessment Bank from a JSON file Select the **Assessment** Toolkit from the Admin Home Page At the top of the page, select **Add New Bank**. Select **Upload one new bank from file** from the dropdown menu at the top of the page. Click on the magnifying glass icon (:search:) next to the **Select and Upload Bank JSON File** field and select the downloaded **JSON** file you want to upload. Click the **Save** button. # Create Tables within Assessment Questions and Answers Options Columns can be created within an Assessment Question and the Answer Options.\\ Columns can be created within an Assessment Question and the Answer Options.\ To add columns to the Assessment Question, use the below template/formula:\ Column 1 | Column 2 | Column 3 | Column 4--|--|--|--Column 1 | Column 2 | Column 3 | Column 4Column 1 | Column 2 | Column 3 | Column 4Column 1 | Column 2 | Column 3 | Column 4Column 1 | Column 2 | Column 3 | Column 4Column 1 | Column 2 | Column 3 | Column 4\ \*\*\*\ Question will display as follow:\ ![Assessment questions table](https://e02.insite.com/files/sites/e02/create-tables/assessment-questions-table.png)\ \ To add columns in the Answer Options, use the | symbol to create the columns.\ \ Example:\ A. 1|in.B. 10|in.C. 5|in.D. 15|in.\ ![Assessment questions table 1](https://e02.insite.com/files/sites/e02/create-tables/assessment-questions-table-1.png)\ \ In the Settings Panel when editing a question, below Option Layout, select Table from the drop down menu. Click on the Add New Column button to create the columns. Select the Alignment (Left, Right or Center) and add the column Style. Select Save after changes were made.\ Style Options: * no-left-pad * no-right-pad
* small-right-pad
* small-left-pad
* x-wide\
![Assessment questions table 4](https://e02.insite.com/files/sites/e02/create-tables/assessment-questions-table-4.png)\ \ \ The Answer Options will display as follow:\ ![Assessment questions table 5](https://e02.insite.com/files/sites/e02/create-tables/assessment-questions-table-5.png)\ \ \ Names can be added to the columns in the Answer Options by adding the headings in the Name field under Option Layout.
\ It will display the headings as follow:\ \ \ \ To create wider columns, add the Style option x-wide\ \ \ It will display the columns as follow:\ \
# Downloading Assessment Sets (\*.md) Select the Assessment Toolkit from the Admin Home Page. #### Downloading Assessment Sets (\*.md) Select the **Assessment** Toolkit from the Admin Home Page. Select the **Banks** counter. Search for the **Bank** you where you want to download the **Set** and select the bank on the **Results** tab. Once Assessment bank is selected, click on the **Question** tab. Click on the Download button and select **# Shift iQ Markdown Outline (\*.md)** The **Markdown (\*.md)** file will be downloaded to the **Download** folder on your computer.
# Upload Assessment Sets Select the Assessment Toolkit from the Admin Home Page. ## Uploading Assessment Sets in Markdown (.md/.txt) Select the **Assessment** Toolkit from the Admin Home Page. Select the **Banks** counter. Search for the **Bank** you where you want to upload the **Set** and select the bank in the **Results** tab. Once Assessment bank is selected, click on the **Question** tab. Click on the **Add** button and select **Set**. Add the **Question Set** name in the **Set Name** field. Under **Upload Question Items** select **Shift iQ Markdown** in the **File Format** field. In the **Upload Shift iQ Markdown** field click on the **Folder** icon (:folder-open:) and select the **Markdown** file you want to upload. The file format can be a Text file (*.txt) or a Markdown file (*.md). * *Download an example here:* [***Shift iQ Markdown Sample***](https://e02.insite.com/files/web/a226650b-be69-431c-b584-af9e010c5d8f/set-upload-example.txt) Click on the **Upload** icon (:upload:) to your \*.txt or \*.md file. After uploading your file, you will see a preview of the questions being uploaded. If it is not the correct question you uploaded, click the **Clear Questions** button to select another file. To save your upload, click the **Save** button. *Note: When uploading questions only Question Type = Multiple Choice can be created.*
## Uploading Assessment Sets using LXR Merge Select the **Assessment** Toolkit from the Admin Home Page. Select the **Banks** counter. Search for the **Bank** you where you want to upload the **Set** and select the bank in the **Results** tab. Once Assessment bank is selected, click on the **Question** tab. Click on the **Add** button and select **Set**. Add the **Question Set** name in the **Set Name** field. Under **Upload Question Items** select **LXR Merge** in the **File Format** field. In the **Upload Shift iQ Markdown** field click on the **Folder** icon (:folder-open:) and select the **LXR Merge** file (\*.lxrmerge) you want to upload. * *Download an example here:* [***LXR Merge Fromat Sample***](https://e02.insite.com/files/web/1b3db2ff-e94a-460e-81e7-b103011be3d0/lxr-merge-2.txt) Click on the **Upload** icon (:upload:) upload your \*.lxrmerge file. After uploading your file, you will see a preview of the questions being uploaded. If it is not the correct question you uploaded, click the **Clear Questions** button to select another file. To save your upload, click the **Save** button.
# Set Question Settings, Rationale and Prerequisites/Triggers ### Question Settings \
#### :sliders-h:Settings For reporting purposes, administrator can add different Settings to an Assessment Question. **Classification** * **Code** - This is a unique code assigned for internal filing and/or reference. * **Tag** - Assign any number of tags to this question for searching and filtering. * **Taxonomy** - Refer to the Trades Taxonomy for details. * Know, Do or Solve * **Difficulty** - The estimated difficulty for this question. * Very Easy, Easy, Moderate, Hard or Very Hard * **Like Item Group** - Use the Like Item Group (LIG) to assign this question to a collection of similar questions, where mutual exclusivity in an exam is needed. * **Reference** - The source material for this question (e.g. industry regulation or code book reference). **Administration** * **Condition** - The current condition of this item in your question bank. * Copy, Edit, New, Purge, Surplus or Unassigned * **Current Flag** - Assign a flags to this question for special attention. **Calculating and Scoring** * **Maximum Possible Points** - The maximum number of possible points awarded for an answer to this question. * **Cut Score (%)** - The average of the cut scores for correct answers. Incorrect answers have a cut score of zero. **Randomization and Display** * **List or Shuffle** - List options in the sequence they are input or in random order. * **Option Layout** - List options in a single column or in a multi-column table. **Question Set** * **Question Set** - The Set to which the question is assigned. * **Competency** - The competency evaluated by this question. **Tags** - If Competency Tags are available, you can assign these tags to the Assessment Questions.\
#### :books:Question Rationale Administrators can add Rationale to Question Options. Rational can be added for: * **All Answers** - Provide feedback to a candidate regardless of the answer submitted. * **Correct Answers** - Provide feedback to a candidate who answers the question **correctly**. * **Incorrect Answers** - Provide feedback to a candidate who answers the question **incorrectly**. * **Description** - Provide a description of the purpose or key feature of this question.
\ \#### :bolt:Question Prerequisites/Triggers **Course Activity Prerequisites** When an Assessment is linked to a Course, Prerequisites can be set to release specific lessons within the course, based on the answers they provide in the Assessment. To add a Prerequisites, click on the **New Prerequisite** button. Under the **Learner Answer** heading: * Select Correct or Incorrect Under the **Unlocks Course Activity** heading: * Select the lesson you want to unlock based on the Correct/Incorrect answer the learner provided. Click **Save**\
#### :comments:Question Comments \
#### :scroll:Glossary Terms # How to Print a Question Bank/Assessment Form to PDF \_See below the steps to generate a PDF document that lists all the questions in an Assessment Bank, including comments by administrators.\_ ## How to Print a Question Bank to PDF *See below the steps to generate a PDF document that lists all the questions in an Assessment Bank, including comments by administrators.* On the **Admin Home** page, select the **Assessments** toolkit and then click the **Banks** counter. Select the **Criteria** tab and search for the **Bank Name** or **Bank Title** and click the **Search** button. In the **Results** tab, click on the **Bank Name** of the **Assessment** you want to open. Under the **Bank** tab, click on the **Print** button. Under **Settings** (Print Settings) check the boxes “**Include Images**” and “**Include Admin Comments**”. At the bottom of the Print Form page, there are 3 print options available: * **Print Images** - A PDF download containing all the Images in the Assessment Bank. * All Images * Addendum Images * **Print Form (internal)** - A PDF download containing all the Questions in the Bank, including administrator comments. * **Print Form (compact)** - A PDF download containing all the answers to the Questions in the Bank.
## How to Print an Assessment Form to PDF *See below the steps to generate a PDF document that lists all the questions in an Assessment Form, including comments by administrators.* On the **Admin Home** page, select the **Assessments** toolkit and then click the **Banks** counter. Select the **Criteria** tab and search for the **Bank Name** or **Bank Title** and click the **Search** button. In the **Results** tab, click on the **Bank Name** of the **Assessment** you want to open. Select the **Form** tab, click the arrow next to the **Action** button and select **Print**. ![print-bank.png](https://e02.insite.com/files/sites/e02/print-bank-pdf/print-bank.png) Under **Print Options** (Print Settings) check the boxes “**Include Images**” and “**Include Admin Comments**”. At the bottom of the Print Form page, there are 4 print options available: * **Print Form** - A PDF download containing all the Questions in the Form. * **Print Addendum** - A PDF download containing all the Addendums attached to the Assessment Form. * **Print Form (internal)** - A PDF download containing all the questions in the Form, including administrator comments. * **Print Form (compact)** - A PDF download containing all the answers to the Questions in the Form. **Important Note:** The Print Form button will be disabled if the Form created does not contain any Sections (Sets). # Reordering Questions and Sets After Questions are created in a Set, administrators are able to reorder those questions if needed. #### Reordering Questions After Questions are created in a Set, administrators are able to reorder those questions if needed. * Under the Question tab, click on the Reorder button on the top left of the page. * When you move your curser over the questions you will see a hand (:hand-paper:) icon. Click and drag the selected question into the required position. * Once all the reorder is completed, click the Save button. #### Reordering Question Sets (in an Assessment Form) Question Sets in an Assessment Form can be can be reordered so the sets appear in a specific order for each form. * Create your Assessment From and select the Sets and Question you want included in the Form. * Click on the Forms tab and click on teh Reorder button. * Select the Section tab. * On the right, click on the arrows under the Section Number heading (:sort-down:). * When you move your curser over the Question Sets you will see a hand (:hand-paper:) icon. Click and drag the selected Question Set into the required position. * Click the Save button. # Creating Exam Specifications & Forms Specifications and Forms are used to control the organization and availability of exams to learners Specifications and Forms are used to control the organization and availability of exams to learners # Using Specifications Every Bank will contain at least ONE Specification. Specifications provide the rules that determine which questions will be contained on an exam Form. Every Bank will contain at least ONE Specification. Specifications provide the rules that determine which questions will be contained on an exam Form. The same Specification may be used for multiple Forms, or there may be a different specification for each Form. ![specification.png](https://e02.insite.com/files/sites/global/using-specifications/specification.png) ![specification-2.png](https://e02.insite.com/files/sites/global/9844/specification-2.png) **Important Note when using Filter Type in Specifications:** The **Set Weight** stores the value entered by an administrator in **GAC %** column on **Workshop** page and helps calculate the values for the **Pivot Table Filter**, and then the **Pivot Table Filter** will determine the set number of questions on the form. In other words, the **Set Weight** only makes sense when the **Filter Type** in the Specification is set to **Filter with Pivot Table**. The **Set Weight** is not used in question filtering, even when **Filter Type** is **Filter with Pivot Table**. The **Pivot Table Filter** only applies to the questions filter while the **Set Weight** is only used to store the value that was used to calculate the **Pivot Table Filter** values. The value in the **Question Limit** only affects the set of form questions when the **Filter Type** is set to **Include All Questions**. **Set Weight** is not applicable and has no effect on the creation, delivery, or marking of the form if the **Filter Type** is set to **Include All Questions**. # Creating a Specification Static Specifications can be used to generate exam Forms. This allows administrators to specific which questions should be on the Assessment Form. **Static Specifications can be used to generate exam Forms. This allows administrators to specific which questions should be on the Assessment Form.** * Select **Add** under the Specifications panel. * Choose **Static** as the **Specification Type** * Specification Types: * Static (Fixed identically for all attempts): A form with this specification has a fixed set of questions in a fixed sequence, which is determined by the author of the form. Every learner who starts an attempt on form with a Static specification sees exactly the same set of questions in exactly the same sequence. * Dynamic ( Generated randomly per attempt): A form with this specification does not have a fixed set of questions. If two learners start an attempt on this type of form, then each learner may be presented with a different set of questions and/or questions in a different sequence. * Create a **Specification Name** * Select an optional **Consequence Type** (high, medium, low). Indicates the stakes for exam forms following this specification. * Enter an **From Limit** on the maximum number of forms that can be generated based on this specification. * Enter an **Question Item Limit** on the maximum number of questions allowed on each exam. * Select the Disclosure Type (None, Partial, Full). This selection affects the information learners receive about their performance on the exam when it’s submitted. Full is best practice for exams with multiple forms and randomized questions. For non-randomized exams; not a good idea for full disclosure, use partial. * Enter a **Passing Score (%)**, the minimum score required to pass the exam. * Enter an **Weight on Success (%)** - If the student/candidate passes the exam, what weight is applied to the submission score? * Enter an **Weight on Failure (%)** - If the student/candidate fails the exam, what weight is applied to the submission score? * Select one or more **Question Sets** you would like to include. * Click **Save** # Applying Specification Criteria Once the Specification has been created, you can apply filtering criteria to refine which questions are displayed on the exam Form. **Once the Specification has been created, you can apply filtering criteria to refine which questions are displayed on the exam Form. Filtering criteria can be applied to all questions or to each question set in the bank.** * Navigate to the **Specification Panel** and click on **Add Criteria**. * Select the **Question Set** to which this criteria applies. Questions that match the criteria here will become available to include on forms. * Select the **Filter Type**: * **Include All Questions:** All questions from the question set will be included in the form, up to the question item limit indicated (Ex. A set with 12 questions and a limit of 6 would select 6 questions from this set) * **Question Tag Filter:** Tags applied to questions in the bank can be used to refine the questions selected.(Ex “t1:1” means select one question with the tag “t1” from this set) * **Pivot Table Filter.** This feature will allow for questions to be selected across several criteria (Ex. Questions that are aligned to a particular competency AND of a certain difficulty) * Configure **Question Set Weight**. The desired weighting for the question set to which this criterion applies, within the overall specification. The sum of all question set weights for the criteria in a specification must equal 1 (i.e. 100 percent). * Configure **Question Item Limit**. The maximum number of question items allowed on an exam form from this question set. * Click on **Save** **Important Note:** The **Set Weight** stores the value entered by an administrator in **GAC %** column on **Workshop** page and helps calculate the values for the **Pivot Table Filter**, and then the **Pivot Table Filter** will determine the set number of questions on the form. In other words, the **Set Weight** only makes sense when the **Filter Type** in the Specification is set to **Filter with Pivot Table**. The **Set Weight** is not used in question filtering, even when **Filter Type** is **Filter with Pivot Table**. The **Pivot Table Filter** only applies to the questions filter while the **Set Weight** is only used to store the value that was used to calculate the **Pivot Table Filter** values. The value in the **Question Limit** only affects the set of form questions when the **Filter Type** is set to **Include All Questions**. **Set Weight** is not applicable and has no effect on the creation, delivery, or marking of the form if the **Filter Type** is set to **Include All Questions**. Once the **Specification** has been completed, proceed to creating a **Form**. **Specification**: Set of rules that questions adhere to. **Form**: How the questions are displayed. # Creating a Form Each Specification can have one or more Forms. Forms are used to deliver the actual questions during the exam and control the availability of the exam. **Each Specification can have one or more Forms. Forms are used to deliver the actual questions during the exam and control the availability of the exam.** * Under the **Specification** tab select the **Specification** that you want to create the Form for. * Click on the **Add** button and select **Form** * Add a **Form Name** (This is the internal name used to uniquely identify this exam form for filing purposes) * Add a **Code** (This is the form's catalog code. It defaults to N/A. Can be left as is unless a specific identifier is desired) * Add a **Source** (Reference to the source of the content and/or configuration for this form. Can enter one if available.) - *Optional* * Add **Origin** (Identifies the originating platform and/or record for this form. When this property is used, it should ideally contain a fully qualified URL or API path.) - *Optional* * Add a **Time Limit** (This is the number of minutes allowed for each attempt on the exam. Enter time limit in minutes) * Select the **Criteria** (Sets) you want included in the Form. * Under **Like Item Groups**, select if you want the questions to be **Mutually Exclusive** or **Not Mutually Exclusive** to the Form you are creating. * Click the **Next** button. * All the questions that will be included in the form will be listed under **Preview Questions**. * Click the **Save** button to create the Form. # Adding Questions to a Form Under the Forms tab click on the Add button and select Questions or Add Existing Questions * Under the **Forms** tab click on the **Add** button and select **Questions** or **Add Existing Questions** * Below **Question Items** use the checkboxes to select available question to add. * Click **Save** needs more details, maybe links to adding attachments, edit questions, other content? # Adding Reference Materials to a Form Administrators can add Reference Materials for Online Sessions (Acronyms, Formulas and/or a Document). Administrators can add **Reference Materials for Online Sessions** (Acronyms, Formulas and/or a Document). These materials will appear to the Assessment taker at the top of the Assessment Attemp page. By clicking on the different icons at the top of the page, it will open the uploaded files. ![acronymformula.png](https://e02.insite.com/files/sites/e02/reference-materials/acronymformula.png) Documents: :download:Acronyms: :table:Formulas::square-root-alt: #### Uploading the File * Search for the **Assessment Bank** where you want to add the reference materials. * After opening the **Assessment Bank**, click on the **Attachments** tab and then the **Add Attachment** button. * Click on the magnifying glass icon (:search:) and select the file you want to upload. * For images, the file needs to be in a **.png** format. * For documents, the file needs to be in a **.pdf** format. * On the Add Attachment page, update the **Title** and **File Name**. * If uploading **Acronyms**, update the **Title** and **File Name** to **Acronyms**. * If uploading **Formulas**, update the **Title** and **File Name** to **Formulas**. * You are also able to update image Dimensions: * Image Resolution (DPI) * Actual Dimensions (pixels) * Target Online Dimensions (pixels) * Target Paper Dimensions (pixels) * Palette (Color/Black and White) * Click the **Save** button
#### Adding the File to the From * After uploading the file to the **Assessment Bank**, select the **Form** the file need to be attached to. * Under the **Forms** tab, click on the **Addendum** tab. * Click on the Pencil icon (:pencil:) next to the Attachments heading. * Move the uploaded Document/Image from the **Attachments** column to the **Addendum** column. You can move the files by either dragging and dropping the file (by clicking on the **Arrows** icon :arrows-alt:) or by clicking on the move icon (:share:). ![addendum.png](https://e02.insite.com/files/sites/e02/reference-materials/addendum.png) * Click the **Save** button. * The files will now appear under the **Addendum** tab of the **From**. # Creating Tabs in an Assessment Form Please note: Tabs can only be enabled if the Specification Type is set to Static. Tabs cannot be enabled if the Specification Type is set to Dynamic.\* *Please note: Tabs can only be enabled if the Specification Type is set to Static. Tabs cannot be enabled if the Specification Type is set to Dynamic.* When an Assessment Form is created, question on the form can be presented in 2 ways to a learner: 1. **All questions in the Form is displayed on one page (default behaviour):** This is ideal for shorter forms or when you want to give the learner the full context at once. It works well for simpler assessments where the questions are not overwhelming and where learners are expected to move quickly through the form. 2. **Each set in the Form is displayed as a tab in the Form:** This is better suited for longer or more complex forms where content can be logically grouped into sets. It's a good option when you want to guide the learner through a more structured flow, especially if different sets of questions require different kinds of thinking or concentration (e.g., different topics or formats like multiple-choice vs. essays). **Creating Tabs in an Assessment Form** 1. **Create Sets and Questions in the Assessment Bank** Begin by setting up your sets and questions in the **Assessment Bank**. Each set will contain a group of related questions. 2. **Create the Specification** Next, create a **Specification**. This is where you define the structure of your assessment form by adding the sets you want to include. 3. **Add Sets to the Specification** In the **Specification**, you’ll select the Sets that you want included in the assessment form. These sets will become sections within the form. 4. **Enable Sections as Tabs** After creating the **Specification**, go to the **Specifications** tab and then select the **Specification** you just created. In the **Configuration** section, look for the **Sections as Tabs** option. Toggle the slider to enable this feature. *When you enable Sections as Tabs, each section of your form (based on the sets you've added) will appear as a tab at the top of the form. This makes the form more organized and navigable, especially if it contains multiple sections.* ![section-as-tabs.png](https://e02.insite.com/files/sites/e02/creating-tabs/section-as-tabs.png) 1. **Allow Tab Navigation (Optional)** As an administrator, you have the option to control how users navigate between tabs. If Tab Navigation is **enabled**, both Next and Previous buttons will appear, allowing users to freely move between sections/tabs. If Tab Navigation is **disabled**, only the Next button will be visible and only forward progression through the assessment is allowed. *When Tab Navigation is disabled, then an addition setting can be selected to display a **Single Question per Tab**. If **Single Question per Tab** enabled then only one question is displayed on the current tab at a time.* 1. **Add the Title for each Tab** The Administrator needs to set the **Title** for each **Tab** that is appearing on the Assessment Form. If a **Title** is not added, it will display as "Untitled" * After configuring the tabs, go to the **Forms** tab, then click on the **Section** tab. * Next to the **Title** heading, under the **Content** Heading, click on the pencil icon (:pencil-alt:). * Enter the desired title that you want the learner to see on the assessment form for that specific tab. * Click on the **Save** button to save your changes. * Repeat these steps for each tab in the assessment form to set individual titles. # Adding Timers to Tabs When Sections as Tabs is enabled and Tab Navigation is disabled, you can set timers for individual sections (tabs) within the assessment form. When **Sections as Tabs** is enabled and **Tab Navigation** is disabled, you can set timers for individual sections (tabs) within the assessment form. This allows you to control the time learners can spend on different parts of the assessment. There are the two options available for configuring timers: 1. **Enable Timer for Some Tabs** This option allows you to set a timer for specific tabs within the assessment form. It’s useful if you want to give learners a break in between sections, such as during an extended exam where you allow them time to rest or stretch their legs. If this option is selected, the **Break Timer** should only be enabled for the specific tabs where you want to add a timer (e.g., between sections). This could be a short break to allow learners to relax before continuing the assessment. 2. **Enable Timer for All Tabs** When you enable the Tab Time Limit for all tabs, you will need to specify a time limit for each individual tab within the form. This ensures that each section has a defined time duration, and learners must complete each section within the specified time frame. For example, if your assessment has 4 sections and you want learners to spend 15 minutes on each section, you would set a 15-minute time limit for each tab. The system will automatically calculate the total time allowed to complete the entire assessment based on the time limits set for each tab. For instance, if you set a 15-minute time limit for each of four sections, the total time allowed for the whole assessment will be 60 minutes. When timers are enabled for all tabs, the Break Timer will automatically be available for each tab. **Please Note:** When **Enable Timer for All Tabs** is selected, then you are not able to add Accommodations for an exam. **Steps to Set Timers for Tabs** 1. Go to the **Specification** tab and click on the edit pencil icon next to **Form Limit**. 2. Ensure that **Sections as Tabs** is **enabled** and make sure that **Tab Navigation** is **disabled**. 3. In the **Tab Time Limit** field, select one of the following: * **Enable Timer for Some Tabs**: Set timers for specific tabs where needed. * **Enable Timer for All Tabs**: Set time limits for each tab across the entire assessment. 4. Click **Save** to apply the changes. 5. Click on the **Forms** tab and select the form for which you enabled the **Tab Time Limit**. 6. Click on the **Section** tab. 7. Click on the edit pencil icon next to the **Warning on Next Tab** field, found under the **Configuration** heading. 8. In the **Configuration** card, configure the following settings: * **Warning on Next Tab:** Set a warning that notifies learners when time is running out for a specific section. * **Break Timer:** Enable the break timer for tabs where breaks are required. * **Time Limit (minutes):** Set the time limit for each individual tab. * **Timer Type**: Choose if the timer should be **Enforced** or if it is **Optional**. * If **Enforced**, then learner will not be able to navigate to the next tab until the timer runs out. * If **Optional**, then learner can choose to leave the break tab before the timer runs out. 9. Click the **Save** button. # Editing Assessment Questions and Forms Review, publish, test, and update assessment forms after the question bank is built Once a question bank exists, the editing-forms section covers the work that turns a draft bank into a usable, published assessment: reviewing the form, testing it, publishing it, and updating questions and form contents over time. ## In this section * [Review exam Form details prior to publishing](/help/assessments/editing-forms/review-exam-form) * [Advanced question searches](/help/assessments/editing-forms/search-for-questions) * [How to publish an assessment form](/help/assessments/editing-forms/publish-exam-form) * [How to test an Exam Form](/help/assessments/editing-forms/test-exam-form) * [Pre-Publish an Assessment Form](/help/assessments/editing-forms/pre-publish-exam-form) * [Edit Assessment Questions](/help/assessments/editing-forms/edit-questions) * [Manually Analyze Assessment Attempts](/help/assessments/editing-forms/analyze-exam-attempts) * [Working with Images in Assessments](/help/assessments/editing-forms/editing-images) * [Creating a New Version of a Question](/help/assessments/editing-forms/creating-a-new-version-of-a-question) * [How to Add/Remove Questions from an Assessment Form](/help/assessments/editing-forms/how-to-add-remove-questions-from-a-assessment-form) # Review exam Form details prior to publishing Open the Assessment you wish to Review. Open the **Assessment** you wish to Review. Under the **Forms** Tab, you can review the following: * **Questions** Tab: Ensure the exam form contains the correct question items. * **Section** Tab Settings: You can add a Title and Summary to your Form page. The information content you add here will appear at the top of the Assessment Form. * **Form** Tab Settings: Review Invigilation settings including Kiosk Mode, Date Settings, Time Limit and Attempt Limit. * **Content** Tab: Edit the Title and Summary of the Form. You can also specify if a Diagram book or Reference Materials for Online Sessions is included in the From. * **Addendum** * **Summaries** Tab: Provides the summaries of the Taxonomies, Standards (GAC), Standards (Competency), Difficulties and Tags assigned to the Form. # Advanced question searches Admins can perform advanced searches in the Questions tab by using advanced search syntax. Admins can perform advanced searches in the **Questions** tab by using advanced search syntax. (The syntax here follows the same convention that Google uses for its advanced search.) Under the **Question** tab, in the filter field at the top of the page, add the **parameter:value** and click the filter button. The results will bring up all questions in the bank with the entered **parameter:value**. If "**parameter**" is not included in the filter field, then the **Parameter="keyword"** is assumed. | Available Parameters | Corresponding Question properties | | -------------------- | --------------------------------- | | code | Code | | tag | Tag | | taxonomy | Taxonomy | | difficulty | Difficulty | | lig | LikeItemGroup | | reference | Reference | # How to publish an assessment form 1\. Navigate to the Exam Form in the Form Tab. 1. Navigate to the Exam Form in the **Form** Tab. 2. Select the **Form** tab. 3. Click on **Action** button and select **Publish**. 4. Select the **Publication** settings for the Assessment Form being Published: * **Candidate Feedback** - Allow exam candidates to submit feedback on the questions in this exam. (**Required Field**) * **Instructor Rationale** - Show (to candidates) the rationale behind the questions in this exam for correct and/or incorrect answers. * Set **Access** for the Exam: * As part of a **Training Program** - The exam is delivered in the context of a specific e-learning module. * As a **Standalone** Assessment - The exam is delivered directly to candidates. * If **Standalone** is selected, select which group(s) should have access to this exam (Note: If the group does not currently exist, a new Permission List should be created ([**Create a New Group and Adding People to the Group**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/adding-new-group/README.md)). 5. Enter **Tile Tag** (The text to be used for the program tile on the portal home page) and **Icon Choice** (The [FontAwesome](https://fontawesome.com/icons?d=gallery) icon to be used for the program tile on the portal home page). 6. After all setting for the Assessment Form has been selected, click the **Publish** button. # How to test an Exam Form After an Form was created for an exam, an Administrator can test the Form by Publishing or Pre-Publishing the Form. After an Form was created for an exam, an Administrator can test the Form by **Publishing** or **Pre-Publishing** the Form. #### Publish the Form Publish the Form as a **Standalone** Form, with permissions so only the Administrator can see the From on the Portal. (See [How to publish an exam Form](https://github.com/InSite/docs/blob/master/ui/help/portal/assessments/editing-forms/publish-exam-form/README.md)) From the portal start the exam and review the following to ensure they are as desired. **On the Start Page:** * Instructions; * Time limit for the exam **When attempt is started** * The **Learner Feedback** icon (:comment:) and functionality, if selected. If so, ensure question feedback is working by posting a comment, and using Review Feedback to check. * Check **Bookmark** functionality (:bookmark:). * Exam countdown **Timer** (If enabled). **Complete and submit your attempt to review:** * Scores are disclosed as desired. * Additional attempts for the exam are available as desired. * If Assessment Attempt is locked after the allocated time has run out.
#### Pre-Publish the Form An Administrator can Pre-Publish an Assessment Form for **testing** purposes. You will be able to complete the Assessment Form and submit your attempt. * In the **Question Bank**, select the **Forms** tab. * If you have multiple Assessment Forms for the same Assessment Bank, select the From you want to Pre-Publish from the dropdown list at the top of the Form page. * Click on **Action** button and select **Prepublish**. * On the **Pre-Publish** page, you will see a URL on the right side, under the **Start an exam attempt** heading. Click on this URL to start your attempt. * This Pre-Publish URL is intended for use by administrators only, to review and test the Assessment Form. It should NOT be shared with actual Assessment takers. To publish an Assessment FROM for non-admin testing, please see [**How to publish an exam Form**](https://github.com/InSite/docs/blob/master/ui/help/portal/assessments/editing-forms/publish-exam-form/README.md). **Important Notes:** * The Pre-Publish URL is for **Administrator Access Only**. This link is strictly for administrative testing and review of the assessment form. Distribution to, or use by, actual assessment takers is NOT advised. Any assessment attempts completed using this link are considered to be tests and are NOT recorded by the system. * The system does not keep attempts for Forms that has an **Publication Status = Drafted**. If an attempt is submitted, while the form has an **Publication Status = Drafted**, the last thing the learner's session does is clean up after itself by deleting the attempt. There will be no record of the Pre-Published attempt. If you want to have a record of a Published attempt, then you should publish the Assessment Form as a Standalone Assessment on the Portal. (See [How to publish an exam Form](https://github.com/InSite/docs/blob/master/ui/help/portal/assessments/editing-forms/publish-exam-form/README.md) # Pre-Publish an Assessment Form An Administrator can Pre-Publish an Assessment Form for testing purposes. You will be able to complete the Assessment Form and submit your attempt. An Administrator can Pre-Publish an Assessment Form for **testing** purposes. You will be able to complete the Assessment Form and submit your attempt. Pre-Publishing an Assessment: * In the **Question Bank**, select the **Forms** tab. * If you have multiple Assessment Forms for the same Assessment Bank, select the From you want to Pre-Publish from the dropdown list at the top of the Form page. * Click on **Action** button and select **Prepublish**. * On the **Pre-Publish** page, you will see a URL on the right side, under the **Start an exam attempt** heading. Click on the URL to start your attempt.
#### Important Notes * The Pre-Publish URL is for **Administrator Access Only**. This link is strictly for administrative testing and review of the assessment form. Distribution to, or use by, actual assessment takers is NOT advised. Any assessment attempts completed using this link are considered to be tests and are NOT recorded by the system. * The system does not keep attempts for Forms that has an **Publication Status = Drafted**. If an attempt is submitted, while the form has an **Publication Status = Drafted**, the last thing the learner's session does is clean up after itself by deleting the attempt. There will be no record of the Pre-Published attempt. If you want to have a record of a Published attempt, then you should publish the Assessment Form as a Standalone Assessment on the Portal. (See [How to publish an exam Form](https://github.com/InSite/docs/blob/master/ui/help/portal/assessments/editing-forms/publish-exam-form/README.md)) # Edit Assessment Questions Depending on the Organization setting, Administrators are able to edit existing Assessment questions. Depending on the Organization setting, Administrators are able to edit existing Assessment questions. When editing questions that have already been published to a Form, a warning message will appear at the top of the page. ![edit-assessment-questions-1-0.png](https://e02.insite.com/files/sites/e02/edit-questions/edit-assessment-questions-1-0.png) This warning message is to advise admins that there are existing exam forms using the question and how many submissions have been received for the question they are about to edit. If a change is made to the question, and it can potentially affect previous submissions, you will be directed to the Regrade Attempts screen after making your changes. Depending on the change that was made to the question, an Admin can choose if they want to regrade the question or update the question without regrading. **Example:** If the incorrect option was setup as the correct answer, and a admin corrects the mistake, they can choose if the fix should be applied to previous attempts or not by selecting one of the Regrade Options provided ![edit-assessment-questions.png](https://e02.insite.com/files/sites/e02/edit-questions/edit-assessment-questions.png) Any questions being edited will be available for learners who have not started a exam. If changes are made to a question, while a exam is in progress, the change will not be available to the learners. Additional information about question configuration settings can be found here # Manually Analyze Assessment Attempts How the system analyzes an assessment attempt automatically and how to trigger the analysis manually **When an Assessment Attempt is submitted, the system automatically Analyzes a users attempt. During the Analyze process, the following occurs:** 1. Sets final score, i.e. Pass or Fail. 2. Sets attempt tag from Venue Location Name (if being used). 3. Updates comments in Assessment from Attempt (if comments for learners are enabled). 4. Saves scores to the gradebook (if an Gradebook is attached to the Assessment Bank and Form). Assessment Attempts with Composed Essay question types need to be Graded by an administrator after the user submits their Assessment Attempt. After grading the Composed Essay questions, the administrator needs to click the Analyze button to instruct the system to go through Analyze steps mentioned above. When doing a **Force Complete** for an uncompleted Assessment Attempt, an Administrator can click the Analyze button to instruct the system to go through the analyze process. # Working with Images in Assessments There are two easy ways to add an image to an assessment question: There are two easy ways to add an image to an assessment question: **1. Drag and Drop the Image** While creating or editing an assessment question, you can simply drag the image from your computer and drop it directly into the content field. It’s a quick and convenient way to add images without needing to navigate away from the page. **2. Upload Image to the Assessment Bank** Alternatively, you can upload the image to the Assessment Bank first. Once uploaded, you can easily select the image from the bank and attach it to the specific question. This method helps keep all your images organized in one place and provides you with additional management options, like tracking usage and image versions. *Note: The maximum size of an image that can be uploaded is 1 MB. If you require a bigger image to be uploaded, please contact your Shift iQ account representative.* **How to Upload an Image to the Assessment Bank** * In the Assessment Bank, click on the Attachments tab, then click the Add Attachment button. * Next to the File field, click on the magnifying glass icon and select the image you want to upload. * Options for the Image: * Title: You can edit the title of the image. This title will be visible to the user if they click on the image during their assessment attempt. * Condition: Choose from the following options: * Duplicate: If the image is a copy of an existing one. * Edit: If the image is a version that has been edited. * New: If the image is newly uploaded. * Purge: If the image is no longer needed and should be removed. * Surplus: If the image is extra or not in active use. * Unassigned: If the image hasn’t been assigned to any specific content yet. * Actual Dimensions: This shows the original size of the image. * Target Online Dimensions: Here, you can specify the size at which the image should display to the learner online. * Target Paper Dimensions: If you’re printing the assessment form for an exam, set the image size for its appearance in the printed version. * Palette: Specify the color scheme of the image (e.g., Color, Black and White). This process helps ensure that the image is uploaded properly and formatted for different viewing scenarios. **Editing or Changing an Uploaded Image** * Under the Attachments tab, click on the edit pencil icon next to the image's Asset number. * You can edit the following details: * Title * Condition * Target Online Dimensions * Target Paper Dimensions * Palette * if the incorrect image was uploaded, you can replace it by clicking on the magnifying glass icon next to the Replace with File field and selecting the correct image. Keep in mind that replacing the image will remove the original image that was uploaded. * Alternatively, you can create a new version of the image without losing the original by clicking the Arrow icon :arrow-alt-up:under the **Current Version** heading and then uploading the new image. This way, the original image will remain intact, and the new version will be added to the image history. **Deleting an Image** If the incorrect image was uploaded, you can delete it by clicking on the trash can icon next to the image's Asset number. After clicking the icon, you will be redirected to the Delete Confirmation page, where you will need to confirm if you want to proceed with the deletion. If there are multiple versions of the image, you will be prompted to choose whether you want to delete just the current version or all versions of the image. Please Note: Deleting an image is a permanent change that cannot be undone. The image will be deleted from all forms, queries, and reports. **View the Image History** Any changes made to an image by an administrator are recorded in the system. To view the history of an image, click on the History icon :history:below the image. This will display a record of who made changes and what changes were made. **Image Usage Report** Each image you upload into the system keeps a record of where it’s being used. Specifically, it tracks which questions the image appears in and the date when it was added. This allows you to easily see how and when the image is being utilized across assessments, helping you stay organized and keep track of your content efficiently. **Scan Images** The **Scan Images** button is designed to help manage and organize images associated with questions in a question bank. After migrating questions from an one bank to another, the image links associated with the questions might still point to the old bank, which can cause issues if those links are broken or if you need to update the images independently. When clicking the **Scan Images** button: * You can quickly find any questions with image links that are still referencing the old bank. * If the image **exists** as an attachment in the new bank, it gets a **green checkmark** (:check-circle:). * If the image **doesn’t exist** as an attachment, it gets a **red exclamation** (:exclamation-circle:). * Convert the image links to Attachments by clicking on the **Add Attachments** icon (:plus-circle:). The images will be copied or migrated into the new Bank as an Assessment Attachment. * You will then be able to modify, update, or manage the images without impacting the old bank or its assets. # Creating a New Version of a Question After creating questions for a bank, you may need to update or revise the questions or answer options while still keeping the original question data After creating questions for a bank, you may need to update or revise the questions or answer options while still keeping the original question data and any associated attempts intact. 1. Open the question you want to create a new version of and click the edit pencil next to the question. 2. On the right side of the page, click on the little arrow below the **Current Version** heading.
Image (6)
3. The Publication Status of the question will update to **Drafted (In Development)**. 4. You can now edit the Question Text and Answer Options as needed. The original Question and Answer Options will remain as is. After you updated the new version of that question: * If a form has a **Specification Type = Static**, the question will *not* update automatically across the forms where it’s used. You’ll need to manually remove the old question and add the updated one. See [How to Add/Remove Questions from a Assessment Form](/help/assessments/editing-forms/how-to-add-remove-questions-from-a-assessment-form) * If a form has a **Specification Type = Dynamic**, the question *is* automatically updated everywhere it’s used, and those updates become immediately available to learners. # How to Add/Remove Questions from a Assessment Form 1\. Open the Assessment Form and click the Action button. 1. Open the **Assessment Form** and click the **Action** button. 2. Select **Unpublish**. 3. Click the **trash can** icon next to the question you want to remove. You’ll be redirected to the **Delete Confirmation** page. 4. On the right side of the page, in the **Impact** card, select the form you want to remove the question from. * This will remove the question *from the form only,* the original question will remain in the Question Bank. * If you select the checkbox next to the Bank Asset, it will delete the questions from both the Bank and the Form, including all aggregate attempt data.
Image (1)
1. After making your selection, click **Delete**. 2. Click the **Add** button and choose **Question** (or **Existing Question**). 3. Select the checkbox next to the question you want to add to the form. 4. If you need the questions in a specific order, click the **arrow** icon and drag and drop the question into the desired position.
Image (2)
1. Click **Save**. 2. Click the **Action** button again and select **Publish**. 3. Choose the publication options (such as Learner/Assessor Feedback, Instructor Rationale, and Access) and click **Save**. 4. The form with the updated question(s) is now published and available for users to submit attempts.. # Safe Exam Browser (SEB) Safe Exam Browser is a web browser environment to carry out e-assessments safely. Safe Exam Browser is a web browser environment to carry out e-assessments safely. The software turns any computer temporarily into a secure workstation. It controls access to resources like system functions, other websites and applications and prevents unauthorized resources being used during an exam. To download Safe Exam Browser please visit [**https://safeexambrowser.org/download\_en.html**](https://safeexambrowser.org/download_en.html) *Please Note: Safe Exam Browser is an open source software that was not developed by InSite Information Systems. Support is familiar with its basic functionality and we can answer some questions, but for most requests we advise using the Safe Exam Browser help documentation found here* [*https://safeexambrowser.org/windows/win\_usermanual\_en.html*](https://safeexambrowser.org/windows/win_usermanual_en.html) # Organization Checklist for SEB errors Before reporting an exam issue to Shift iQ support, gather the below information:\
Before reporting an exam issue to Shift iQ support, gather the below information:
1. Provide detailed description of the issue that is happening. 2. Confirm if the venue tested the internet connection on the device that is having the issue.\ If the issue is only happening to ONE person in the class, it is an indication that it is a possible venue issue and not a Shift iQ issue. If there was an issue with Shift iQ, it will affect ALL candidates and not just one candidate. 3. Ask for the Venue’s IP Address. The Venue can open and provide their IPv4 address.\ ![Myipaddress](https://e02.insite.com/files/sites/e02/seb-error-checklist/myipaddress.png)\
4. Confirm the version of SEB that venue is using.\ The current supported versions of SEB: SEB 3.3.2 up to SEB 3.7.0\ This can change, and updates can be found here: \ Venues can see their version installed on the exam login page.\ ![Seb version](https://e02.insite.com/files/sites/e02/seb-error-checklist/seb-version.png)\
5. Shift iQ records the SEB version used by a user after they login to their exam.\ An administrator can view the SEB versions in the following places:\ i. If using Exam Events, open the event and click on the Grades tab, under the Exam Events Tab. The SEB version will be displayed below the learner's name under the Exam Candidate column.\ ii. In Assessment Attempts, the SEB version will be displayed below the learner's name under the Exam Candidate column. # Moving Assessment Banks (and retain Competency mapping) We've implemented the ability to move Assessment Banks from one Organization to another, and ratain the original Competency mapping. We've implemented the ability to move Assessment Banks from one Organization to another, and ratain the original Competency mapping. **Download the question bank** 1. In the exporting organization, download the question bank by clicking on the **Download JSON** button in the **Assessment Bank**. **Download the framework and the file with hooks in it** 1. Go to the Standards search screen in the organization from which you are exporting the framework. 2. Change your search results to search for all Standard Types, by selecting the blank option from the dropdown list. 3. Under the **Settings** heading, change the column visibility so that you can only see the Hook and Title columns. 4. Click the Search button. You will get more than you need, but it does not matter because the hooks will be unique. 5. Click on the Download tab and download all the search results. 6. In the *.csv /*.xlsx download, change the order of the columns so that **Standard Identifier** is in **Column A** and **Standard Hook** is in **Column B**. 7. Delete the 1st row in the spreadsheet and save your changes. 8. Now you can proceed to download the Competency Framework you want. **Upload the framework** *DON’T UPLOAD YOUR FRAMEWORK TO THE ORIGINAL ORGANIZATION ACCOUNT.* 1. In the new organization, open the **Standards** toolkit and then click on **Add New Standard** at the top of the page. 2. Select **Upload one new standard from a file** from the dropdown list. 3. Select the \*.json file for the Competency Framework you downloaded and upload it normally. The hooks will automatically be uploaded. **Upload the bank** 1. In the new organization, open the **Assessment** toolkit and then the **Banks** tile. 2. Click on the **Add New Bank** link at the top of the page and select **Upload one new bank from a file** link from the dropdown list. 3. Select the \*.json file for the **Assessment Bank** you downloaded. 4. In the **Standard Hooks** box, paste the first 2 columns (Standard Identifier, Standard Hook) of the spreadsheet that maps the hooks with the standards identifiers 5. Click the **Save**. # Single-Question Quizzes Short, single-question assessments used for typing speed, data entry, and similar skills checks Single-question quizzes are short assessments built around a single, specialized question type. They are used for typing speed checks, data entry drills, and other quick skill measurements. ## In this section * [Typing Speed Quiz](/help/assessments/single-question-quizzes/typing-speed-quiz) * [Data Entry Quiz](/help/assessments/single-question-quizzes/data-entry-quiz) * [View Single-Question Quiz Attempts](/help/assessments/single-question-quizzes/single-question-attempts) # Typing Speed Quiz The Typing Speed quiz is an assessment designed to measure how fast and accurately someone can type. The Typing Speed quiz is an assessment designed to measure how fast and accurately someone can type. The test typically involves typing a set of words or a passage of text within a specific time frame (usually measured in seconds or minutes). The goal is to assess the user's words per minute (WPM) rate and their accuracy. **Creating a Typing Speed quiz** * On the Admin Home screen, select the **Assessment** toolkit. * Click on the **Typing Speed** tile under the **Single-Question Quizzes** section. * Click on the **Add New Quiz** link located at the top of the page. * On the New Quiz page, fill in the required fields: * **Quiz Name** * Enter a descriptive name for the quiz (e.g., "Typing Speed Test 1 Minute"). * **Time Limit (seconds)** * Set the time limit for how long learners will have to complete the test (e.g., 60 seconds). * **Attempt Limit** * Set how many times learners can attempt the quiz (e.g., 1 attempt). * Optional Fields for setting a required performance threshold: * **Maximum Possible Points:** * Set the maximum number of points the quiz can be worth. * **Points Required to Pass** * Set the number of points needed to pass the quiz. * **Passing Score (%)** * Set the percentage needed to pass (e.g., 80%). * **Passing WPM** * Set the minimum Words Per Minute (WPM) needed to pass. * **Passing KPH** * Set the minimum Keystrokes Per Hour (KPH), if relevant. * **Passing Accuracy (%)** * Set the required accuracy percentage (e.g., 95%). * In the **Quiz Text** card, add the text you want the learner to type in the content box. This could be a sentence, paragraph, or set of words. * Click **Save**. If you're allowing multiple attempts on the Typing Speed quiz, you can add different text for each attempt by clicking the **Add New Item** button. The system will randomize the text, giving learners a new passage each time they take the quiz. For example: **Attempt 1 -> Text A:** "The quick brown fox jumps over the lazy dog." **Attempt 2 -> Text B:** "Pack my box with five dozen liquor jugs." **Editing a Typing Speed quiz** **Deleting a Typing Speed quiz** # Data Entry Quiz Configure, deliver, and review the data-entry single-question quiz > **Draft** — this page is a stub. Detailed steps to be authored by a subject-matter expert. This page will cover: * What the data-entry quiz measures and the question format it uses. * How to create a data-entry quiz. * How to assign it to a learner or class. * How to view attempts and results. # View Single-Question Quiz Attempts View and review attempts learners have made on single-question quizzes > **Draft** — this page is a stub. Detailed steps to be authored by a subject-matter expert. This page will cover: * Where to find single-question quiz attempts. * What information is recorded for each attempt. * How to filter, search, and export attempt data. # Overview The Contacts toolkit is where you can create and edit all the contacts and groups that exist for your organization. The **Contacts** toolkit is where you can create and edit all the contacts and groups that exist for your organization. Contacts can be Users (your customers), who only have access to a portal, or Administrators (your coworkers), who have access to create and edit content for your Users. Permissions are also controlled here, using Group membership. Contacts can have Membership in multiple Groups; allowing for intricate relationship management and reporting. # Adding New Contacts From the Admin Home Page, select Contacts toolkit. From the Admin Home Page, select **Contacts** toolkit. In the **Counters** panel, click on **People** counter. Click on **Add New Person** link to create/add a new contact (Top of the page). Provide Basic Details for the new contact person. The following fields are **Required Fields:** * First Name * Last Name * Email Select the checkbox next to **User Access Granted** to grant access to the user you are adding. An **Temporary Password** will automatically be generated for the user to use for their first login. A user will be required to change this password the first time they sign in. Select the permission list to which you want to assign this new user account. Click **Save** to save the new contact. Once a new user has been added, an **Welcome Email** will automatically be sent to the user with their **Login Name** and **Temporary Password**. The user will be required to update their password when they login for the first time. If the user does not receive the **Welcome Email**, you can resend the **Welcome Email** to the user by searching for the user (see [**Searching Contacts**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/editing-contacts/searching-contacts/README.md)) and click on **System Access** tab. Click on the **Send Email** button and select Welcome. On the Send Email screen, select the Shift iQ Alerts (Mailgun) sender and review the information in the content field. You are able to make changes to the content if needed, then click the **Next** button. You will be redirected to the Confirm screen to review the message that will be sent to the user. Click **Confirm** to send the message. ***Please Note: If the contact record was created 72 hours prior to sending the Welcome Email, you would need to do a*** [***Password Reset***](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/editing-contacts/password-resets/README.md) ***before sending the Welcome Email.*** # Upload Contacts This feature is generally used to upload multiple NEW contacts records into your Contact toolkit. This feature is generally used to upload multiple **NEW** contacts records into your **Contact** toolkit. **Use with Caution if you want to update existing Contact records.** If any of the information in your upload spreadsheet does not match the information on a record in the system for that unique login name/email address, it will overwrite the existing information. For example, if the name in the system for user "" is Robert Doe and the spreadsheet says Bob Doe, Bob will overwrite Robert. To bulk upload contacts: 1. Create a **CSV UTF-8 (comma delimited) (.csv)** file with at least the **first name**, **last name** and **email address** of the contacts you want to add. You can upload additional information as well, if desired, such as addresses, phone numbers, account numbers, etc., and you can save an existing Excel or other spreadsheet as a CSV UTF-8 file as well. Make sure your columns have header names that can be mapped to the upload screen. ![spreadsheet-example.png](https://e02.insite.com/files/sites/global/9795/spreadsheet-example.png) 1. Go into **Contacts** toolkit and below the People counter, select **Upload Contact People**. 2. Select the **CSV UTF-8 (comma delimited) (.csv)** file with the contact details of the users you would like to add. Your upload file must be a spreadsheet saved as a **CSV UTF-8 (comma delimited) (.csv)** file. 3. *Optional:* the contacts you are uploading can all be attached to a specific group if desired. Select an existing group or input the name of a new group. ![csv-file-upload.png](https://e02.insite.com/files/sites/global/9795/csv-file-upload.png) 1. If you want all the uploaded users to have system access, check the box **Approve login credentials for all uploaded contacts**. They will then be able to sign in to the system with the same permissions as the group listed in step 4. If no group is chosen, they will only have portal access and any portal tiles that have no privacy settings turned on. Note that uploaded contacts do not automatically receive a welcome email informing them of their temporary initial password. 2. Click **Next** 3. Choose the fields into which you want to upload your contact data. ***Required Fields:*** * **Unique Identifier Type** (usually LoginName) * **Unique Identifier** (usually Email, must be unique in the upload file) * **Login Name** (usually Email, must be unique in the upload file) * **First Name** * **LastName** * **Email** Map additional column names (addresses, phone numbers, account numbers, etc.) in your **CSV UTF-8 (comma delimited) (.csv)** spreadsheet to the desired fields in the **Upload Contacts** form. 1. Select **Upload and Save Changes**. If there are any duplicate email addresses in your upload spreadsheet, or if an email address is already in use in our system for a user in another tenant account, you will get error messages. Update or remove those records from your **CSV UTF-8 (comma delimited) (.csv)** spreadsheet, save and close it, and repeat steps 3-7. If there are no errors, the upload will proceed, and when finished will display the first 3 and last 3 records uploaded/updated from the spreadsheet. # User Self-Registration If your organization would like to allow users to create their own accounts and access some content without a manual approval step, we can configure If your organization would like to allow users to create their own accounts and access some content without a manual approval step, we can configure your account to do so. The user journey would be as follows: 1. The User creates their own account using the New Users tab of the login screen, adding their own email, first name, last name and password. The User is immediately granted access to your portal and any content (tiles) that have no privacy settings. The User also receives an automated system **alert**, indicating their account has been registered and approved. 2. If your organization is configured with a choice of groups a user can join (subscribe to), and the user toggles one of those groups when creating their account, they also immediately become members of that group, and can see whatever portal tiles that group has access to. The group can be configured to send **notifications** to the user (welcoming them to your account, explaining what they can access and possible next steps) and/or to your administrators (notifying them of the new user). These optional **notification** emails are hooked up in the **group** itself. (**Note:** you can provide a link to register for a specific group or program by using a link that includes the group name: \[your organization].insite.com/ui/lobby/register?group=\[group name]) 3. If the group the user joins is configured with a mandatory **survey** (application form), they will be prompted to complete and submit a response upon creating their account. The survey can also be configured to send a **notification** to the user when they have submitted a response (thank you for applying, your response will be reviewed, etc.) and/or to your administrators (notifying them they have an application to review). These optional **notification** emails are hooked up in the **survey** itself. 4. Once the **survey response** (application) has been reviewed by an admin; the admin can remove the user from the “applicant” group and add them to another group that has access to additional or different portal tiles. Once again, the groups can be configured to send **notifications** to the user (you have been approved for x group, log in now to see additional content) and/or to other internal staff (a new learner has joined x group). These optional **notification** emails are hooked up to each group a user might be placed in. All notifications must be created and configured in the **Messages** Toolkit, prior to being hooked up where needed. **Do not** add any subscribers to any notifications going to users. **Do** add subscribers to any notifications going to admins, as desired for each one. We suggest you use the internal name of the message to distinguish between them: Notification to User on completion of application, Notification to User welcoming them to x group, Notification to admin that an application has been completed, etc. # Adding access to bulk upload contacts Any organization's admins can upload NEW contacts with the bulk upload tool. Any organization's admins can upload **NEW** contacts with the bulk upload tool. However, this tool can also be used by those with permission to **bulk update** existing contacts. Typically, bulk updating should be done by Platform Administrators, or well-trained super admins, to prevent overwriting information that should be kept. Here's how our Support team can give the latter access: 1. Create a separate role group such as "Access to Contacts Upload" and just add the admins who should have access and know how to use it properly. 2. While logged in to the tenant account, click on **Settings**, then **Actions**. Set filter for action url of **admin/contacts/people/upload/update** and open that action. 3. In the **Authorization** panel, add the group that should have permissions to bulk upload, and save. 4. Admins will need to log out and back in before permissions will be applied to their accounts. # Creating and Managing Groups Users are able to lookup specific groups that were created by going to the Contacts Toolkit on the Admin Home Page, and selecting Groups under Users are able to lookup specific groups that were created by going to the **Contacts** Toolkit on the Admin Home Page, and selecting **Groups** under **Counters** panel. Groups can be looked up using different search **Criteria** like Groups Name, Group Type (Employer, List, Organisation, Role, Venue) or Group Label. The information used to create the group will determine the **Criteria** used to search for a group. **Settings:** You can also adjust the ‘settings’ and add or modify existing filters for the search criteria section to create a **New Saved Filter** **Filter:** You can specify one filter for each search operation, but the filter itself can include multiple fields, multiple criteria **Clear:** The filters should be cleared, as your new search term maybe for something entirely different from the original search query. # Create a New Group and Adding People to the Group Select the Contact toolkit on the Admin Home Page and select the Groups counter below the Contact Group heading. ## Create a New Group Select the **Contact** toolkit on the **Admin Home Page** and select the **Groups** counter below the **Contact Group** heading. Click on the **Add New Group** link at the top of the page to create new Group. Provide basic details for the new group: * Add **Group Name** (Required): The name of the group should be unique and descriptive. * Choose Group **Type (Department, District, Employer, List, Role, Team or Venue)**(Required): Group type determines the features available for using and managing it in the system. * Add Group **Tag** (Optional): You can tag contact groups to make them easier to find. * Click **Save** Additional fields that can be edited after **Group** has been created: * **Description:** Comment or note to describe the purpose of the group. * **Group Code:** Alphanumeric code that uniquely identifies this contact group. * **Group Category:** Classification or tag for this group * **Group Status:** The current status of this group. * **Parent (Hierarchy) / Parent (Functional):** You can select another group as the container for this contact group. This is optional, and it allows you to nest groups into subgroups. * **Capacity:** The maximum number of people permitted in this group. * **Group Options:** Automatically add new users to this group / Allow users to subscribe/unsubscribe themselves After creating the **Group Type: Employer, District or Venue**, navigate to the **Address** panel in the group and add the **Physical, Shipping and Billing Address** (if required by Organization). Click **Save** when address has been added.
## Adding People to a Group In the **Group**, click on the **People** tab and then on the **Add People** button. You can add people by searching for the people you want to add or in bulk by adding email addresses: * **Searching for People:** You can search for people to add to the group by **Contact Name** or **Email**. After searching for the person you want to add, click the checkbox next to the person's name and then click on the **Add** button. If there is more than one person in your search results that you want to add, you are able to select multiple checkboxes. * **Bulk:** Select **By Email Address List** from the dropdown list under the **Add People to Group** heading. Copy and paste the email addresses of users that you want to add to the group and click on the **Add** button. *Please note, these users need to already have a contact record in the system to be added to the group.*
## Allow User Self-Registration To allow **User Self Registration**, after creating the group, go into the **Group** and under the **Group** tab select the checkbox next to **Allow users to subscribe/unsubscribe themselves**. By selecting the checkbox, the system adds a toggle for the group on the new user registration screen. Users are able to select the group when creating their new account on the [**New User** registration page.](https://github.com/InSite/docs/blob/master/ui/lobby/register/README.md) ![self-register.png](https://e02.insite.com/files/sites/global/portal-permissions/self-register.png)
## How to Create a link for New User Registration page with slider pre-selected An Global Admin can create a link, to provide to Organizations, so if a user needs to select a Role during registration the Role will be pre-select when users create an account. Example: https\://**Organization**.insite.com/ui/lobby/register?group=**GROUP NAME** **Using InSite as an example**: Organization: insite | Group Name: Help Documentation **HINT:** If you put in the group name as is, the system will replace each space with the characters %20. You can avoid this by using a + character instead of the spaces in your link. (GROUP+NAME / GROUP%20NAME) **URL:** On the New User registration page, the Help Documentation field will be preselected. # Editing or Deleting Groups Note that some of the options below are only available to admins with Write and Delete access.\* *Note that some of the options below are only available to admins with Write and Delete access.* On the **Admin Home Page**, select **Contacts** Toolkit. Select **Groups** counter under **Contact Groups** heading. Search for the group you would would like to **Edit** or **Delete**. To edit, click on the **Edit** icon (Pencil icon :pencil-alt:) and to delete click on the **Delete** icon (Trash Can icon :trash-alt:). A group can also be deleted by selecting the group you would like delete and click on the **Delete** button at the bottom of the page. *If changes were made in a group, please remember to **Save** your changes* # Editing Contacts This screen contains all of the information related to each contact in Shift iQ. This screen contains all of the information related to each contact in Shift iQ. Find and update personal details, employment info, addresses, any related uploaded documents, internal comments, a history of changes to the contact record, and more on the **Persons** tab. Use the **Memberships** tab to see and edit the groups they belong to and other relationships. The **Records** tab contains links to a variety of assets the contact may have generated. Grant and control access on the **System Access** tab. **Deleting a Contact Record:** Deleting contact records should be used with **caution**. Deleting a contact will remove the link to all of their activity in the system and is typically only done with duplicate records that have never logged in. If it is someone who has had activity but left your organization, it is better to Archive the user and remove their access to the system using the Sign In tab. **Edit:** Make changes to any of the fields in the Person panel and click **Save**. **New:** You can ‘create another contact’ using the ‘New’ button **View Change History:** To view the change history of a specific user or contact **Report:** To get record of contacts detailed data (Note that some of the options below are only available to admins with Write and Delete access.)
#### Phone Number Auto-Configuration parameters When an telephone number is added to a users Contact Record, Shift iQ automatically configures the phone number based on the number of digits added: * If you save the record with **10 digits** in any of the phone fields, our system adds brackets around the first 3 digits, adds a space after the second bracket and adds a dash before the last four digits. **Example:** 1234567890 ![phone-number-1.png](https://e02.insite.com/files/web/a53ae6fb-9834-4fd4-960b-b09300e40d6f/phone-number-1.png) * If you put **11 digits** and save, it removes whatever the first digit is, adds brackets around the first 3 digits, adds a space after the second bracket and adds a dash before the last four digits. **Example:** 12345678901 ![phone-number-2.png](https://e02.insite.com/files/web/a53ae6fb-9834-4fd4-960b-b09300e40d6f/phone-number-2.png) * If you put **periods** or **dashes** in between **10 or 11 digits**, our system removes those dots or dashes, adds brackets around the first 3 digits, adds a space after the second bracket and adds a dash before the last four digits. **Example:** 123-456-7890 / 1234-567-8901 ![phone-number-1.png](https://e02.insite.com/files/web/a53ae6fb-9834-4fd4-960b-b09300e40d6f/phone-number-1.png) ![phone-number-2.png](https://e02.insite.com/files/web/a53ae6fb-9834-4fd4-960b-b09300e40d6f/phone-number-2.png) * BUT if you put **more** than **11 digits** in any of the number fields, our system converts it to a straight number, no characters. **Example:** 1234567890123 ![phone-number-3.png](https://e02.insite.com/files/web/a53ae6fb-9834-4fd4-960b-b09300e40d6f/phone-number-3.png) # Adding Impersonate Permission To add Impersonation permissions, please contact an Shift iQ administrator by submitting a Support Ticket or emailing support\@shiftiq.com. To add Impersonation permissions, please contact an Shift iQ administrator by submitting a [**Support Ticket**](https://insite.atlassian.net/servicedesk/customer/portal/3) or emailing [**support@shiftiq.com**](mailto:support@shiftiq.com). ***Administrator Note**: When adding the **Impersonate** permission for an administrative user, it can only be added when you are logged into the Organization account that requires this permission.* Log into the **Organization** account that the **Impersonate** permission needs to be added to On the **Admin Home Page**, select **Settings** Toolkit Select the **Actions** counter and under the Criteria tab search for **Action URL = impersonate** Click on the Action URL (**ui/portal/identity/impersonate**) ![impersonate-permission.png](https://e02.insite.com/files/sites/global/impersonate-permissions/impersonate-permission.png) Under the **Permissions** tab, select **Add Permission** ![impersonate-permission1.png](https://e02.insite.com/files/sites/global/impersonate-permissions/impersonate-permission1.png) Select the **Group** within the **Organization** that you would like to give this permission to and select **Save** # Password Resets Method 1 - User resets their own Users can also reset their own passwords by clicking the Reset my password button on the initial login window. ## There are 2 methods of resetting a user's password
**Method 1 - User resets their own** Users can also reset their own passwords by clicking the **Reset my password** button on the initial login window. The system will ask them to enter the email address associated with their account and click **Continue**. It will then send them a link to a **Reset Password** screen where they can set their own new password.
**Method 2 - Admin resets Password on behalf of user** From the Admin Home page, search for the user you would like to reset the password for ([**Searching Contacts**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/searching-contacts/README.md)). Select the **System Access** tab and under the **Sign In** tab click on the **Reset Password** button (on the top right of the card). The **Reset Password** dialogue box will appear with a system generated password; you can accept this OR overwrite both fields with one you've created. Click on **Save** in the **Reset Password** dialogue box. Next click on the **Send Email** button and select **Welcome**. On the **Send Email** screen, select the **Shift iQ Alerts (Mailgun)** sender and review the information in the content field. You are able to make changes to the content if needed, then click the **Next** button. You will be redirected to the **Confirm** screen to review the message that will be sent to the user. Click **Confirm** to send the message. The Welcome Email will include the user's **Login Name (Email)**, new **Temporary Password** and **Login** link. The user will be prompted to change the password on the first login. Exit out of the contact record without saving; by doing so the system will reset the password expiry date for the record to the current date and time, which is what forces the user to change their **Temporary Password** upon logging in. ![reset-password.png](https://e02.insite.com/files/sites/global/9856/reset-password.png) ***Note:*** There may be some situations where you don't wish to have the password expire when resetting it (i.e., test users); in this case you can set a desired expiry date and then save the contact record. Be aware that for unexpired passwords, the user will not be prompted to change it when logging in. **Passwords must have a minimum of 8 characters, use at least one uppercase letter, one lower case letter, one number and one symbol.** # Searching Contacts You can view as little or as much information as you want on the search results page such as: You can view as little or as much information as you want on the search results page such as: **Criteria:** First Name, Last Name, Match Exact Spelling or Similar Pronunciation, Contact Code, Comments **Email:** Email Address, Email Enabled or Disabled, Email Validity **Employment:** District, Employer, Job Title **Status:** Membership Status, User Status, Password Status, Archive Status, Multi-Tenancy, Tenant Role **Address:** Address Type, Country, Province, City **Groups:** Group Name, Include/ Exclude Group **Time Stamps:** Created After, Created Before, Modified After, Modified Before **Settings:** You can also adjust the ‘settings’ and add or modify existing filters for the search criteria section to create a **New Saved Filter** **Filter:** You can specify one filter for each search operation, but the filter itself can include multiple fields, multiple criteria **Clear:** The filters should be cleared, as your new search term maybe for something entirely different from the original search query. ## Download a List of Contacts Go into **Contacts** toolkit and under the **Downloads** panel you are able to download your contact list. The download function will download all information of the contacts, not just the columns visible in the search results. You are able to customize your download by selecting which columns you want visible. Downloads are available in **.xlsx** or **.csv** formats. # Review and Edit a Contact The Person Edit screen is one of the most frequently used screens in Shift iQ. The Person Edit screen is one of the most frequently used screens in Shift iQ. It provides access to all information and activity related to a contact in one place. Whenever a contact’s name appears as a hyperlink, clicking it will take you directly to this screen. Information can be both viewed and updated on this screen. Under the :user-alt: **Person** tab: * **Details**: the key details of a contact record, including name, email, gender, birthday, employment details, phone numbers and more; use the **Send Email** button to send correspondence directly to the contact; use the **More Info** button to access additional details about the contact; use the **History** button to view changes that have been made in the past to the contact record. * **Other**: additional details about the contact, such as preferred language, time zone, honorific; also any custom fields your organization may be using, and any responses to survey questions with a Respondant Attribute that doesn't match an existing field in the contact record. * **Documents**: view and manage any attachments uploaded to a contact record, either directly, or through a survey response, workflow case or their jobs candidate portfolio. * **Addresses**: view and manage home, work, shipping and billing addresses for the contact (note that home address fields can be populated by a survey response using the **Respondant Attribute** fields; the other addresses can be copied from the **Employed By/Belongs To** group on the Details tab, if that Employer group has them). * **Comments**: add and view comments regarding the contact (only visible to administrators with access to this screen, not visible to contacts with portal access only). Under the :users: **Memberships** tab: * :users: **Groups**: view and manage all of the groups memberships a contact has, including their membership function and expiry. * :question: **Referrals**: view and manage additional details about Employer relationships (contact Support to configure this for your organization). * :network-wired: **People**: view and manage hierarchical relationships to Managers, Supervisors and Validators for the contact. Under the :spell-check: **Records** tab: * :spell-check: **Gradebooks**: view and manage any Gradebook progress for the contact. * :book-open: **Logbooks**: view and manage any Logbooks and entries the contact has access to. * :id-card: **Registrations**: view and manage any event registrations the contact has. * :trophy: **Achievements**: view and manage any achievements that have been issued to the contact. * :check-square: **Survey**: view and manage any survey responses started or submitted by the contact. Under the :cogs: **System Access** Tab: * :user-lock: **Sign In**: view and manage the contact's access to Shift iQ, such as: * grant or revoke access to the system * assign a contact to the correct **Role(s)** to ensure they can only access the screens they should (please advise Support when new Administrators are added to admin roles) * **reset** a contact's password manually, if required * **impersonate** a contact to see what they are seeing (contact Support to configure this for your organization if you don't see the **Impersonate** button on this screen) * view and manage a contact's Multi-Factor Authentication settings * **archive** a contact record that is no longer active in Shift iQ * **Authentications**: view the contact's login history, including which browser they used and from which IP address. # Understanding Permissions and Roles Managing a contact's Roles and Permissions is a key part of an Administrator's job in Shift iQ. Here are some things to keep in mind when doing so. Managing a contact's Roles and Permissions is a key part of an Administrator's job in Shift iQ. Here are some things to keep in mind when doing so. * Groups with the group type of **Role** are the only ones that can be configured with permissions to access any options on the **Admin** side of Shift iQ. They are also the ones that appear on the **System Access** tab * Every new contact # Access Control and Roles Settings Find the User you want to add/remove/review Access Control or Role Settings (see Searching Contacts). Find the User you want to add/remove/review Access Control or Role Settings (see [**Searching Contacts**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/searching-contacts/README.md)). Click on the **System Access** tab and then under the **Sign In** tab you can review the **User Credentials**, **Access Control** and **Roles** assigned to a user. **Credentials:** **Password Expiry:** We HIGHLY recommend that you set user’s passwords to expire every 6 months at a maximum. If a user’s password expires, they will be required to enter a new password the next time they log in. **Licensed:** The Licensed checkbox shows whether or not the user has agreed to the terms and conditions of use (pop-up box that appears with first login) **Impersonate the User:** 1. Login under an admin account, search for the user you would like to impersonate. 2. Click on the **System Access** tab and then under the **Sign In** tab you can click on the **Impersonate User** button. 3. The session will be automatically routed to being logged in as that user whom you would like to impersonate. 4. Once you’re done checking for functionality and access of the user, you have to **Stop Impersonating** the user, by clicking on your name in the Menu bar. **Reset Password:** 1. Login under an admin account, search for the user that is requesting a password reset. 2. Click on the **System Access** tab and then under the **Sign In** tab click on the **Reset Password** button. 3. This will autogenerate the password and its confirmation. **Save** the Password and communicate the new password to the user. **Access Control:** **Access Granted:** The Approved checkbox turns that person’s account on **Two Step authentication:** Two-step verification is a process that involves two authentication methods performed one after the other to verify that someone or something requesting access is who or what they are declared to be. 1. **Optional:** Allow user to choose between enabling, disabling multi-factor authentication. 2. **Mandatory:** Forces user to activate multi-factor authentication upon next successful login. 3. **Current MFA Mode:** Displays the current MFA selected. **Roles:** Every Organization is responsible for ‘cataloging users’ within a system so that everyone who has access to it can be properly authenticated *It is important for better access control that the roles of identities are clear and allow easy identification of the individual who wants to access them.* # Archive Users If a user is no longer needed, or requests to remove their personal information, you are able to archive the user from the system. ## Archive a User If a user is no longer needed, or requests to remove their personal information, you are able to archive the user from the system. If you’d prefer to keep the user records, just change the **First name**, **Last Name** and **Email/Login Name** to something generic like: **First Name**: Removed **Last Name**: User **Email/Login Name**: 1. On the **Person** tab: disable their email addresses and remove any personal information they may have added, including home addresses and uploaded documents. Optional: Add a comment to their record indicating at whose direction they are being archived. Click **Save**. 2. On the **Memberships** tab, remove them from all group memberships they have. Click **Save**. 3. On the **System Access** tab, **Sign In** sub-tab, uncheck the **System Access** box, any Roles they are still in, and their acceptance of the **Terms and Conditions**. Set their **Archive Status** to Archived. Click **Save**. You are also able to delete contact records, but this is only recommended for test users that are no longer needed. Prior to deleting these users, we recommend deleting any of the user's records such as Survey responses, Assessment attempts, Invoices, Registrations, Gradebooks, Achievements, etc.; any test data that is also no longer needed. If the contact is deleted without do this, some records will remain but will appear as having been completed by an unknown user.
## Archive Multiple Contacts **NOTE:** Only admins with access to bulk update contacts can do this. Contact to get access or provide Support with the list to update for you. Create a **CSV UTF-8 (comma delimited) (\*.csv)** file containing all the contacts you want to archive. The file should contain the following columns: * **First Name** * **Last Name** * **Email** * **Archive Status** (For each row, indicate the contact is **Archived**) ![archived-user-bulk.png](https://e02.insite.com/files/sites/global/archive-users/archived-user-bulk.png) Go into **Contacts** toolkit and under the **Contact People** heading, select **Upload Contact People** Select the **CSV UTF-8 (comma delimited) (\*.csv)** file with the contact details of the users you would like to archive. Your upload file must be a spreadsheet saved as a **CSV UTF-8 (comma delimited) (\*.csv)** Click **Next** Choose the fields into which you want to upload your contact data. There are **required fields** that need to be completed for the update to be successful: * Unique Identifier Type (Usually Email) * Unique Identifier (Usually Email) * Email * First Name * LastName * Archived Status Select **Upload and Save Changes**
# Overview Build courses with lessons, surveys, assessments, images, videos, and SCORM packages, with content paths driven by learner permissions Create engaging content for your learners. Courses can contain lessons, surveys, assessments, pictures, videos, SCORM packages and more. Additional or alternative content can be triggered based on permission settings. # Creating and Editing Courses Select the Courses Toolkit on the Admin Home Page and then select Courses counter at the top of the page. Select the **Courses** Toolkit on the **Admin Home Page** and then select **Courses** counter at the top of the page. Click on **Add New Course** link at the top of the page. In the **Course-Creation Tool** field, select one of the following option from the dropdown list: **One new course:** Used to create a new course. **Upload one new course shell from a file:** Used to upload the shell from an existing course. Add the **Course Name**. Select **Save**. # How to Add and Remove Units, Modules and Lessons in a Course Click on the Plus icon next to the Module where you want to add the New Lesson. ## Adding a new Lesson to a course Click on the **Plus** icon next to the **Module** where you want to add the **New Lesson**. Select the **Activity Type** you want to add in the New Lesson * New Lesson * Add **Lesson Name**. * Click **Save** button. * New Assessment * Add Assessment Name * Select if you are **Adding New Form** or **Selecting Existing Form** * If you **Add New Form**, add the **Number of Multiple-Choice Question** and **Passing Score**. * If **Selecting Existing Form**, select the **Assessment From** from the dropdown list and set **Passing Score**. * Click **Save** button. * New Survey * Select the **Survey Form** you want to attach to the Lesson. * Click **Save** button. * New Document * Add the **Document Name** * Click **Save** button. * New Link * Add **Link Name**. * Select the **Link Type** * External Web Page * Internal Web Page * SCORM Course * Add the **Link URL** and select if you want to URL to\*\* Open in a new window or tab\*\* * Click **Save** button. * New Video * Add **Video Name** * Add **Video URL** * Select **Video Target** * Opens in a new window or tab * Opens in the same window as it was clicked * Opens in teh full body of the window * Opens in an embedded frame * Click **Save** button. * New Interaction * Add Interaction Name * Click **Save** button.
## Adding a New Module to a course Click on the **Plus** icon next to **New Module** and select the what **Activity Type** you want as the first lesson in the course. Add the **Module Name** and the required information for the **Activity Type** you selected. Click the **Save** button.
## Adding a New Unit to a course If you want to add multiple units to your course, ensure that **Multiple Units** are **Enabled**. You can enable multiple units by navigating to the **Course Setup** tab and then under the **Course Details** tab select **Enabled** under **Multiple Units** and click **Save**. Click on the **Plus** icon next to **New Unit** and select the what **Activity Type** you want as the first lesson under the Module in the New Unit. Add the **Unit Name**, **Module Name** and the required information for the **Activity Type** you selected. Click the **Save** button.
# Publishing a Course to your Learner Portal There are 2 ways to Publish a course to the portal: There are 2 ways to Publish a course to the portal: 1. From the Course itself; 2. From the Sites toolkit. **1. Publish a Course to the Portal, from the Course:** * In the Course, click on the **Course Setup** tab, then the **Publication** tab. * Select the Site URL in the **Web Portal** field (organization.insite.com / organization.shiftiq.com). * Select the **Web Folder** (page) where you want to publish the course to. * Click on the plus icon (:plus-circle:) next to the **Web Page** field. This will generate the URl (Course Slug (URL Segment)) for the Course. * The **Web Page Status** field will appear with a **Published** checkbox. This box will be selected by default and the Course will be Published. If you wish to Unpublish the Course, unselect teh checkbox. * Click the **Save** button. **2. Publish a Course from the Sites toolkit:** Courses remain visible to administrators only, unless they are **published** to the Portal. The Portal is where your users will access your **Courses**. * In a new browser tab, open the **Sites** toolkit. Navigate to the page where you would like to add the course to. * Under the **Page Setup** tab, click on the **Settings** tab. Click on the Pencil icon next to the **Layout (Content Control)** field. * Below the **Update Content** heading, select Course from the dropdown menu below **Layout (Content Control)**, then select the **Course** you want to publish on the portal from the dropdown menu. * Click **Save** * The course will be **published** on the portal for users to complete. ![course-on-portal.png](https://e02.insite.com/files/sites/global/publish-course/course-on-portal.png) # Setting Prerequisites By setting Prerequisites in a course, Learners must satisfy these prerequisites before the activity is available to start. By setting **Prerequisites** in a course, Learners must satisfy these prerequisites before the activity is available to start. **Prerequisites** that can be selected: * **Activity Completed** * Select the Lesson you require the Learner to complete before the activity is available to start. * **Assessment Passes** * Select the Assessment Form the user needs to pass before the activity is available to start. * **Assessment Failed** * Select the Assessment Form the user needs to pass before the activity is available to start. * **Assessment Scored** * Select the Assessment Form and set score range the user needs to achieve before the activity is available to start. * **Question Answered Correctly** * Select the Question Bank and Question the learner needs answer correctly before the activity is available to start. * **Question Answered Incorrectly** * Select the Question Bank and Question the learner needs answer incorrectly before the activity is available to start. * **Grade Item Passed** * **Grade Item Failed** # Setting up Course Notifications Administrators can setup Course Stalled Notifications and Course Completed Notifications. Administrators can setup **Course Stalled Notifications** and **Course Completed Notifications**. **Course Stalled Notifications** Course stalled notifications can be sent to **Learners** and **Administrators**. * **To Learner** Send a notification to the learner to remind them that they started the course and seem to have stalled. * **To Administrator** Send a notification to the Administrator to advise that a learner started the course and seems to have stalled. * **Send Notification After Days** Set the number of days that a learner has **not** accessed the course before the stalled notifications are sent. * **Max Notification Count** Set the maximum amount of notifications to be sent to learners when they have stalled.
**Message Variables for Course Stalled Notifications:** * $AppUrl * $CourseName * $CourseStarted * $LearnerIdentifier * $LearnerFirstName * $LearnerLastName
**Course Completed Notifications** Course completion notifications can be sent to **Learners** and **Administrators** * **To Learner** Send a notification to the learner to confirm that they completed the course. * **To Administrator** Send a notification to the administrator to advise that the learner completed the course. **Message Variables for Course Completed Notifications:** * $AppUrl * $CourseName * $CourseStarted * $LearnerIdentifier * $LearnerFirstName * $LearnerLastName
# Adding Hyperlinks and Videos Imbed videos\ Upload your video to a Vimeo (or other cloud-based hosting account. Copy the imbed link directly from there and paste it into the content panel of the survey. The video will integrate seamlessly.\ \ Insert links to internal files\ 1\. Upload the file to the Files toolkit\ 2\. Copy the download URL off the file and paste it into the content\ \ Insert hyperlinks
You are able to add web links or email addresses in the text of your content. When you select Create Link, the system will create the outline needed for the link \[]\(http\://). Between the square brackets, add the text you want to be displayed. Copy and Paste or type the webpage you want the user to be directed to. Example of what the link will look like: \[Shift iQ]\(). In your page content, the link will display as [Shift iQ](http://www.shiftiq.com/). The user can click on the text and will be directed to the webpage you added. You are able to configure the link with an email address instead. You can either add a email address between the square brackets or text. Instead of adding a website, you remove the http\:// and add [mailto:add email address.](mailto:support@shiftiq.com.) The full link will be \[Click Here to Email]\(mailto:) or \[]\(mailto:). The text will display as [Click Here to Email](mailto:support@shiftiq.com) or #### Open Link in New Browser Window If you require the link you are inserting to open on in a new browser window, you can us the following link:\ \text to display\ An example of the full link will be:\ \Shift iQ\\ The text will display as [Shift iQ](http://www.shiftiq.com/) and when you click on the text it will open the web page in a new browser window. \ [Markdown](https://github.com/InSite/docs/blob/master/ui/help/portal/sites/edit-site-contents/markdown/README.md)\ We recommend that content be entered in Markdown. This allows for consistent delivery across all varieties of hardware and software platforms. It also facilitates translation of the survey. You may use HTML tags when necessary, but try to limit their use.
(Also See: [Markdown References](https://github.com/InSite/docs/blob/master/ui/help/portal/messages/authoring-messages/markdown-reference/README.md)) # Changing font color of the Course How to change the content font color for an entire Course: How to change the content font color for an entire Course: * In the Course, select the Course Setup tab * Under the Style tab, add the following text in the Cascading Style Sheet (CSS) Rules field:\ \ \\
* You can change the color by typing the color name (e.g. black, red, blue) or adding the HTML color code (e.g. #060606, #F90F0F, #0F0FF9) behind color:\ Example: color: blue / color: #060606
* Click Save. ![Coursefontcolor](https://e02.insite.com/files/sites/global/change-font-color/coursefontcolor.png)\ \ Please note: Adding this code to the Course Style will change the color for all content in the Course. However, if there are Assessments or Surveys attached to the Course the font color for those items will not change as those are pulling data from a different toolkit. # Adding Privacy Settings to a Course Privacy settings can be applied to a course to restrict access to specific users or groups, ensuring that only authorized individuals can view Privacy settings can be applied to a course to restrict access to specific users or groups, ensuring that only authorized individuals can view or participate in the course content. * In the Course click on the **Course Setup** tab, then the **Privacy Settings** tab. * Click on the **Plus** icon (:plus-circle:) under the **Groups** heading. * Search for the **Group** that you want to add and click the **Add** button. * Only users added into the selected Group(s) will be able to access this course once it has been published to the Portal. * Click the **Save** button. # Adding a Course Image An image can be added for the Course tile, when the Course is Published to the Portal. An image can be added for the Course tile, when the Course is Published to the Portal. * Click on the **Course Setup** tab and then the **Publication** tab. * Next to the **Upload New Course Image** field, click on the magnifying glass icon (:search:). * Select the image you want to use for the **Course** tile. * Click the **Save** button. # Add a Course to a Catalog From the Course home page (/ui/admin/courses/home): From the Course home page (/ui/admin/courses/home): 1. Create Catalogs Names 2. Create Categories 3. Open the Course you want to add to the Catalog 4. Click on the Course Setup tab, then click on the Publication tab. 5. In the Catalog Settings card select the Catalog you want to add the Course to, then select the Category for the course. 6. For Categories to appear, your course must be connected to a gradebook. If no Gradebook is attached, click on the Records tab and attach the Gradebook. # Adding and Editing Lesson Content Add and edit lesson content: text, images, links, videos, and Microsoft Word imports Lesson content is built up block by block: text, images, links, embedded videos, and lessons imported from Microsoft Word. This section covers each of those. ## In this section * [Add Course Content](/help/courses/add-content/add-course-content) * [Adding Images](/help/courses/add-content/adding-images) * [Adding Links](/help/courses/add-content/adding-links) * [Adding an Embedded Video](/help/courses/add-content/embedding-video) * [Add New Lesson From Microsoft Word](/help/courses/add-content/lesson-from-word) # Add Course Content With your course outline now created, content can be added for each lesson. With your course outline now created, content can be added for each lesson. Click on the **Pencil** icon next to the **Lesson** you want to add content to. On the right side of the page, the **Lesson Content** tab will be pre-selected. You can update the **Title**, **Summary** and **Body Text** of that lesson. Once you have made the required updates, click the **Save** button. Under the **Activity Setup** tab you can set your **Prerequisite** for the lesson. If a prerequisite is set, learners must satisfy these prerequisites before the activity is available to start in the course. Select a **Requirement** that learners must satisfy before the activity is considered complete. **Activity Type** lists the different lesson types you can have in a course. You can select a different lesson type by selecting the field next to the type name. * **Lesson:** A standard lesson where learners can go through content and materials. * **Assessment:** A quiz or test to assess the learner's knowledge. * **Survey:** A survey that collects feedback or information from learners. * **Document:** A downloadable file or resource, such as a PDF. * **Link:** A clickable link that directs learners to an external website. * **Video:** A video lesson or content that you can embed for learners to watch. * **Single-Question Quiz:** A single-question quiz could be used for either a speed typing test or a data capturing test. * For a speed typing test, the question could be about typing a sentence or a set of characters as quickly and accurately as possible, with the test measuring typing speed or accuracy. * For a data capturing test, the question could involve entering specific information (like text, numbers, or selections) from a given dataset, testing the learner's ability to accurately capture or transcribe data. In the **Activity Name** field, you can update or rename the lesson. You have the option to make lessons adaptive by selecting **Adaptive** under **Activity Settings**. When **Adaptive** is selected, the lesson will be hidden in the course until the lesson is unlocked.. Click **Save** button after all changes were made. # Adding Images You are able to drag and drop a picture from file into the body of the content.\\ You are able to drag and drop a picture from file into the body of the content.\ \ Accounts are configured with a file size limit of 1MB per image. If the file size is bigger than 1MB, please decrease the size of your file before uploading it, or contact your administrator to upgrade the settings for your account.\ \ The recommended maximum size for an upload image is 800x800 pixels. If a size of your image is bigger 800x800 pixels, the system will automatically scale the image for you. You might want to resize your own images before you upload them.\ \ When you added the picture to the content, it will display in a URL format:\ e.g. !\[agriculture-1.jpg]\() In the Course you will be able to see the picture you uploaded. ![Agriculture 1](https://e02.insite.com/files/sites/global/adding-images-or-videos/agriculture-1.jpg)
File types supported: .png, .gif, .jpg, .jpeg
# Adding Links You are able to add web links or email addresses in the text of your content. You are able to add web links or email addresses in the text of your content. When you select Create Link, the system will create the outline needed for the link \[]\(http\://). Between the square brackets, add the text you want to be displayed. Copy and Paste or type the webpage you want the user to be directed to. Example of what the link will look like: \[Shift iQ]\(). In your page content, the link will display as [Shift iQ](http://www.shiftiq.com/). The user can click on the text and will be directed to the webpage you added. You are able to configure the link with an email address instead. You can either add a email address between the square brackets or text. Instead of adding a website, you remove the http\:// and add [mailto:add email address.](mailto:support@insite.com.) The full link will be \[Click Here to Email]\(mailto:) or \[]\(mailto:). The text will display as [Click Here to Email](mailto:support@shiftiq.com) or #### Open Link in New Browser Window If you require the link you are inserting to open on in a new browser window, you can us the following link:\ \text to display\ An example of the full link will be:\ \Shift iQ\\ The text will display as [Shift iQ](http://www.shiftiq.com/) and when you click on the text it will open the web page in a new browser window. # Adding an Embedded Video To embed a video on a Course, you will need to upload the video to either Vimeo or You Tube. To embed a video on a Course, you will need to upload the video to either **Vimeo** or **You Tube**. After video is uploaded, select **Share**, this will give you an **Embed** link. ![video-upload.png](https://e02.insite.com/files/sites/global/adding-video/video-upload.png) Copy and past the link into the body of the course content to add the video and click **Save** ![video-upload-1.png](https://e02.insite.com/files/sites/global/adding-video/video-upload-1.png) If you do not have a **Vimeo** or **You Tube** account to upload the video, we can provide this service. Once uploaded, we will share the Embed link with you; please email . # Add New Lesson From Microsoft Word We are working on a new feature that will simplify the process of converting a Microsoft Word document into a Shift iQ lesson, using a utility We are working on a new feature that will simplify the process of converting a Microsoft Word document into a Shift iQ lesson, using a utility called Pandoc. Attached is a simple prototype for a new Microsoft Word document template that content authors can use to take advantage of this new functionality. [**Microsoft Word Template**](https://e02.insite.com/files/sites/global/new-lesson-microsoft-word/e-learning-module-template.docx) # Working with SCORM and Shift iQ Courses Upload SCORM packages, configure SCORM Cloud, and embed SCORM lessons in Shift iQ courses SCORM packages can be uploaded to Shift iQ and embedded inside courses, including multi-lingual variants. This section covers uploading packages, configuring the SCORM Cloud connection, embedding them, and supporting multiple languages. ## In this section * [How to Upload a SCORM Course to SCORM](/help/courses/scorm-courses/upload-scorm-course) * [SCORM Cloud connection settings](/help/courses/scorm-courses/scorm-settings) * [Embedding a SCORM package in your Shift iQ Course](/help/courses/scorm-courses/adding-scorm-courses) * [Uploading SCORM with different Languages](/help/courses/scorm-courses/scorm-multi-lingual) # How to Upload a SCORM Course to SCORM Login to \https\://cloud.scorm.com/sc/guest/SignInForm\ Login to [**https://cloud.scorm.com/sc/guest/SignInForm**](https://cloud.scorm.com/sc/guest/SignInForm) Select the **Tenant (Realm)** you want to upload a **SCORM** course for. ![scorm-5.png](https://e02.insite.com/files/sites/global/upload-scorm-course/scorm-5.png) Click on **Add Content** (Top Right Corner) and select **Import a SCORM, AICC, xAPI or cmi5 package**. ![scorm-6.png](https://e02.insite.com/files/sites/global/upload-scorm-course/scorm-6.png) Specify a **Course ID** for the file you are uploading (e.g. Planning-for-Your-Future-V1), then choose the **SCORM** or **xAPI** file you wish to upload by clicking on **Browse**. Once file has been selected, click **Import Course**. ![scorm-7.png](https://e02.insite.com/files/sites/global/upload-scorm-course/scorm-7.png) Once the course has been uploaded, you are able to change the Launch behaviour in **Course Properties**. After your changes has been made, click **Save**. ![scorm-8.png](https://e02.insite.com/files/sites/global/upload-scorm-course/scorm-8.png) The **Course ID** (e.g. Planning-for-Your-Future-V1) is what you use as: * [**Hook / Integration Code in Courses V1**](https://e02.insite.com/help/portal/global-admins/adding-scorm-course/adding-scorm-course-to-courses-v1) * [**SCORM Course ID in Courses V2**](https://e02.insite.com/help/portal/global-admins/adding-scorm-course/adding-scorm-courses) # SCORM Cloud connection settings First, find the SCORM Cloud AppId for the tenant. This is in the SCORM Cloud control panel here: First, find the SCORM Cloud AppId for the tenant. This is in the SCORM Cloud control panel here: ![scorm-2.png](https://e02.insite.com/files/sites/global/scorm-settings/scorm-2.png) Next, find the Secret Key assigned to the SCORM Cloud App by clicking on **Details**. You’ll find this here: ![scorm-3.png](https://e02.insite.com/files/sites/global/scorm-settings/scorm-3.png) Finally, use the AppId and the Secret Key for your UserName and Password settings here: ![scorm-4.png](https://e02.insite.com/files/sites/global/scorm-settings/scorm-4.png) # Embedding a SCORM package in your Shift iQ Course When adding a SCORM course to Sandbox or Development, if you select SCORM Course for the Link Type then it is set to Preview mode by default and When adding a SCORM course to **Sandbox** or **Development**, if you select **SCORM Course** for the **Link Type** then it is set to **Preview** mode by default and the **Launch SCORM Course in Preview mode** is selected by default. ![scorm.png](https://e02.insite.com/files/sites/global/adding-scorm-courses/scorm.png) When you are working in **Production**, if you select **SCORM Course** for the **Link Type**, then the SCORM launches in **“Normal”** mode by default and the **Launch SCORM Course in Preview mode** is not selected. # Uploading SCORM with different Languages Login to \https\://cloud.scorm.com/sc/guest/SignInForm\ Login to [**https://cloud.scorm.com/sc/guest/SignInForm**](https://cloud.scorm.com/sc/guest/SignInForm) Select the **Organization (Realm)** you want to upload a **SCORM** course for. ![scorm-realm.png](https://e02.insite.com/files/sites/e02/scorm-multi-lingual/scorm-realm.png) Click on **Add Content** (Top Right Corner) and select **Import a SCORM, AICC, xAPI or cmi5 package**. ![scorm-upload.png](https://e02.insite.com/files/sites/e02/scorm-multi-lingual/scorm-upload.png) Specify a **Course ID** for the file you are uploading. Add the language code behind the Course ID you are adding, e.g. ***Planning-for-Your-Future-V1-en*** (for English) OR ***Planning-for-Your-Future-V1-fr*** (for French) OR ***Planning-for-Your-Future-V1-es*** (for Spanish). Choose the **SCORM** or **xAPI** file you wish to upload by clicking on **Browse**. Once file has been selected, click **Import Course**. ![scorm-file.png](https://e02.insite.com/files/sites/e02/scorm-multi-lingual/scorm-file.png) Once the course has been uploaded, you are able to change the Launch behaviour in **Course Properties**. After your changes has been made, click **Save**. ![scorm-8.png](https://e02.insite.com/files/sites/global/upload-scorm-course/scorm-8.png) The **Course ID** (e.g. Planning-for-Your-Future-V1) is what you use as the [**SCORM Course ID**](https://e02.insite.com/portals/portal/courses/scorm-courses/adding-scorm-courses) # Overview Schedule classes and exam events, manage rosters and seating, and publish registration tiles to learner portals The **Events** toolkit is where you schedule classes and exam events for your learners and manage the registrations attached to them. Use the pages in this section to: * Schedule a new exam event — see [Schedule a New Exam Event](/help/events/schedule-exam). * Schedule a new class with content, settings, and seating — see [Schedule a New Class](/help/events/schedule-new-class). * Use a class as an exam delivery container — see [Using Classes for Exam setup](/help/events/classes-for-exams). * Understand the learner view of registration — see [What Learners see on the Class Registration Portal Page](/help/events/class-registration). # Schedule a New Exam Event Schedule new exam events from the Events toolkit An exam event is a scheduled assessment delivered to a roster of learners. From the **Admin Home Page**, open the **Events** toolkit to schedule a new one. ## In this section * [Create a New Exam Event](/help/events/schedule-exam/create-a-new-exam-event) # Create a New Exam Event Select the Events toolkit on the Admin Home Page. Select the **Events** toolkit on the **Admin Home Page**. Select **Schedule a New Exam Event** in the **Administration Tool**s panel. * Select the **Exam Type** you want to create * Class * Individual (Accommodated) * Individual (Not Accommodated) * Sitting * Select **Exam Format** * Online * Paper * **Class/Session Code** (The reference number for related training programs) * **Billing Code** (If you require billing codes to be added, please contact your InSite Account Representative to assist. * Add the **Start Date and Time** for the Event * Add the **Exam Candidate Limit (Capacity)** * Select the **Venue** for the Exam Event (The training provider, organization, or agency hosting the event) * If the Exam Event will be in a specific **Building and Room**, add the physical location within the venue where the event occurs. Click **Save** # Schedule a New Class Create, configure, publish, and manage class events end-to-end A class is a scheduled event with registrations, content, settings, and a publication state. This section walks through creating a new class and configuring every aspect of it — registrations, gradebooks, seating, content, privacy, publication, and statuses. ## In this section * [How to Create a New Class](/help/events/schedule-new-class/create-class) * [Add and Edit Class Information](/help/events/schedule-new-class/class-information) * [Manually Adding/Removing Registrations](/help/events/schedule-new-class/adding-registrations) * [Assign Gradebook to Class](/help/events/schedule-new-class/assign-gradebook) * [Add Seating to a Class](/help/events/schedule-new-class/add-seating-to-class) * [Adding Content](/help/events/schedule-new-class/adding-content) * [Class Privacy](/help/events/schedule-new-class/class-privacy) * [Class Settings](/help/events/schedule-new-class/class-settings) * [Publish Class Registration](/help/events/schedule-new-class/publish-class-registration) * [Adding Class Registration Tile on Portal Page](/help/events/schedule-new-class/add-registration-tile) * [Class Statuses](/help/events/schedule-new-class/class-statuses) # How to Create a New Class From the Admin Home Screen select the Event Toolkit ## Create a New Class * From the **Admin Home Screen** select the **Event** Toolkit * Under the **Classes** heading, select the **Classes** counter. * At the top of the page, click on **Add New Class** On the **Schedule a New Class** page: * Select the **Achievement** that will be granted for this class (See [**Creating New Achievement**](https://github.com/InSite/docs/blob/master/ui/help/portal/records/achievements/define-achievement/README.md) if the required Achievement is not on the list). * Create a **Class Title** (The descriptive title for this class.) * Schedule the Class **Start and End Date/Time** (The start and end date and time for this class event.) * Add the Location of the Class by selecting the **Venue** (See [**Adding New Group**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/group-management/adding-new-group/README.md) if the required **Venue** is not on the list) * Add a **Class Summary** * Select **Save**
**Note:** A class can also be created by duplicating an existing class, or by uploading a JSON file. ## Duplicating an Existing Class ### Option 1: From the Classes search screen, click on **Add New Class** On the **Schedule a New Class** page: * Below the **New Class** heading, select **Duplicate copy of an existing class** from the dropdown list. * Select the **Class** you want to duplicate. * Under **Class Title**, add the new title for the duplicated Class. * Select if you want to copy the Gradebook as well by selecting **Yes** or **No** below **Copy Gradebook**. * Update the **Start and End Date/Time** for the **Class**. * Select **Save**
### Option 2: While Editing an existing class, click on the Duplicate button * On the **Class Setup** tab click on the **Duplicate** button. * Under **Class Title**, add the new title for the duplicated Class. * Select if you want to copy the Gradebook as well by selecting **Yes** or **No** below **Copy Gradebook**. * Update the **Start and End Date/Time** for the **Class**. * Select **Save**
## Downloading and Uploading a JSON file * From the **Admin Home Screen** select the **Event** Toolkit * Under the **Classes** heading, select the **Classes** counter. * **Search** for the existing **Class** that you want to download the \***.JSON** file for. * Under the **Class Setup** tab, click on the **Download JSON** button. * Select the **Download** button to start the download of the \***.JSON** file. * Once the file download is completed, click on **Classes** in the breadcrumb trail at the top of the page. * At the top of the page, click on **Add New Class** On the **Schedule a New Class** page: * Below the **New Class** heading, select **Upload one new class from a file** from the dropdown list. * Next to the **Select and Upload Class JSON File** field, click on the **magnifying glass** icon and select the saved \***.JSON** file. * Click **Save**. # Add and Edit Class Information Under the Registration tab, Administrators are able to manually Add Registrations to a class and download different class Reports. ## Registrations Tab Under the **Registration** tab, Administrators are able to manually **Add Registrations** to a class and download different class **Reports**. * **Adding Registrants** * Under the **Registration** tab, click on the **Add Registration(s)** button. * Select the **Seat** for the registrant, enter the **Registration Fee** amount, select **Billing Customer** and **Employer** if Employer or a third party is paying for the seat. * Select the user you want to add to the Class and click **Add** button.
* **Edit Registration** * Click on the Pencil icon next to the users registration. * On the **Edit Registration** page, you are able to update the following information: * Hours Worked to Date (if required) * Approval status (The current status of the Participant at the time of this registration.) * Attendance status (The current status of this record in the registration process or workflow.) * Comments (Additional information that is specific to this registration.) * Seat * Registration Fee amount * Billing Customer * Employer * Click **Save** after changes were made to the users registration.
* **Download Reports** * Reports available for Classes: * Registration Report (\*.pdf / \*.xlsx) * Detailed Registration Report (\*.pdf / \*.xlsx) * Attendee List (\*.pdf / \*.xlsx) * Scores Report (\*.pdf / \*.xlsx) * Most Improved Report (\*.xlsx)
### Gradebooks Tab Under the **Gradebooks** tab in a Class, admins can create a New Gradebook by clicking on the **New Gradebook** button or select and existing Gradebook by clicking on the **Find Gradebook** button. * Create **New Gradebook** * Click on the **New Gradebook** button. * Create a **Title** for the new Gradebook, select **Period** (optional) and select the **Achievement**. * Choose if you want to include only Scores in the Gradebook or Standards (Competencies) as well. If Standards is included, select the Competency Framework you want to attached to the Gradebook. * Select **Save**
* Add **Existing Gradebook** * Click on the **Find Gradebook** button. * From the dropdown list, select the existing Gradebook you want to assign to the class. * Click on the Plus Icon next to the dropdown list. You can **remove** the Gradebook from the Class by clicking on the **Trash Can** icon next to the Gradebook attached to the Class.
## Seats Tab Under the **Seats** panel, select **Add Seat** * Add a **Seat Name** (title for the seat) * Add **Seat Description** * Set **Seat Price** * Free * Single Price * Multiple Price Levels (Example: members pay less than non-members) * Add the seat name in the Price Name field; * Add the seat cost in the Price Amount field; * Select the Group Status you are creating the seat for and click the Add Price button. * Repeat the above steps to create all the required seats for the Class. * Choose whether **Taxes** apply for this seat. * Add **Seat Agreement** (Terms & Conditions that a users needs to Agree to before moving forward with class booking) * Select **Save**
## Content Tab Under the **Content** tab, you are able to add or edit the following Class details: * **Title** * **Summary** * **Description** * **Materials** * **Instructions** * Contact and Support * Accommodation * Additional * Cancellation and Refund * Registration Completion
## Class Setup Tab After a **Class** is created, the following information can be added or edited under the **Class Setup** tab: * **Identification** * **Achievement:** Achievement that contains the Program you want to evaluate with this class. * **Event Title:** The descriptive title for this class. * **Event Identifier:** A globally unique identifier for this class. * **Source:** The background source or external reference code for this class.
* **Schedule Information** * **Event Start:** The start date and time for this class event. * **Event End:** The end date and time for this class Event. * **Duration:** Duration of this class event. * **Credit Hours:** The number of credit hours associated with completion of the class.
* **Publication** * **Status:** The business process for managing classes has several steps; this is the current step in the process. * **Registration Start:** The date and time when registration for this event is open, after which new registrations are permitted. * **Registration Deadline:** The date and time when registration for this event is closed, after which no new registrations are permitted.
* **Location Information** * **Venue:** The Venue where the class is taking place.
* **Attendance** * **Capacity**: Set the capacity limit for the class. Enter the **Minimal Capacity** (Optional) and **Maximum Capacity** number of registrants required to attend a class. If there is no minimum number of registrants required, you can leave the **Minimal Capacity** section blank and only add the maximum number of registrants that can attend the class. * **Waitlisting:** Enable or Disable the ability to allow Waitlisting for a class.
* **Contacts** * **Instructors:** Add instructors for the Class by clicking on the **Assign Instructors** button. * Search for the **Instructors** by **Name, Email** or **Group**. * Select the **Instructor** and click **Add**
# Manually Adding/Removing Registrations Under the Registration tab, Administrators are able to manually Add Registrations to a class and download different class Reports. Under the **Registration** tab, Administrators are able to manually **Add Registrations** to a class and download different class **Reports**. * **Adding Registrants** * Under the **Registration** tab, click on the **Add Registration(s)** button. * Select the **Seat** for the registrant, enter the **Registration Fee** amount, select **Billing Customer** and **Employer** if Employer or a third party is paying for the seat. * Select the user you want to add to the Class and click **Add** button.
* **Edit Registration** * Click on the Pencil icon next to the users registration. * On the **Edit Registration** page, you are able to update the following information: * Hours Worked to Date (if required) * Approval status (The current status of the Participant at the time of this registration.) * Attendance status (The current status of this record in the registration process or workflow.) * Comments (Additional information that is specific to this registration.) * Seat * Registration Fee amount * Billing Customer * Employer * Click **Save** after changes were made to the users registration.
* **Download Reports** * Reports available for Classes: * Registration Report (\*.pdf / \*.xlsx) * Detailed Registration Report (\*.pdf / \*.xlsx) * Attendee List (\*.pdf / \*.xlsx) * Scores Report (\*.pdf / \*.xlsx) * Most Improved Report (\*.xlsx)
# Assign Gradebook to Class Navigate to the Gradebooks tab in the Class you created. Navigate to the **Gradebooks** tab in the **Class** you created. An administrator can select to either create a **New Gradebook** or **Find Gradebook** to attach an existing Gradebook. #### New Gradebook * Click on the **New Gradebook** button. * Select if you want to: * Create the One new gradebook * Create a **Title** for the Gradebook. * The **Class** you are creating the Gradebook in wil automatically be assigned to the new Gradebook. * Set **Period** if required. * Assign the **Achievement** to the Gradebook * Select **Save** * Duplicate copy af an existing gradebook * Select the Gradebook you want to duplicate. * Create a **Title** for the Gradebook. * The **Class** you are creating the Gradebook in wil automatically be assigned to the new Gradebook. * Set **Period** if required. * Assign the **Achievement** to the Gradebook * Select **Save** * Upload one new gradebook from file * Select the \*.json file of the Gradebook you want to upload. * Select **Save** #### Find Gradebook * Click on the **Find Gradebook** button. * From the dropdown list, select the **Gradebook** you want to attach to the **Class**. * Click the Plus icon (:plus-circle:) to add the **Gradebook** You can remove the Gradebook from the Class by clicking on the Trash Can icon next to the Gradebook attached to the Class. ***Note: Once users in a Class as been added to the Gradebook, and they have Scores in the Gradebook, you are not able to remove the Gradebook from the Class.*** # Add Seating to a Class Under the Seats panel, select Add Seat ## Seat Creation Under the **Seats** panel, select **Add Seat** * Add a **Seat Name** (title for the seat) * Add **Seat Description** * Set **Seat Price** * Free * Single Price * Multiple Price Levels (Example: members pay less than non-members, see below) * Choose whether **Taxes** apply for this seat. * Add **Seat Agreement** (Terms & Conditions that a users needs to Agree to before moving forward with class booking) * Select **Save** ## Seats with Multiple Price Levels When creating seats for a Class, different price levels can be created for different users in your Organization (Example: Members pay less than non-members). Only users that are in the Employer group, with the Group Status specified in the seat setup, will be able to see the seat price being created. Under **Seat Price**, select the **Multiple Price Levels** option, and add the following information: * **Price Name:** The name of the seat, this will be visible to the user when registering for a class. * **Price Amount:** The cost of the seat. * **Group Status:** Select the Group Status you are creating the seat for. * The **Group Status** field is linked to the Group Status added to an **Employer** group. If none of your **Employer** groups have a **Group Status** set, there will be **no** options availabel to select in this field during seat creation. * Please see [**Create a New Group**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/group-management/adding-new-group/README.md) for instruction on how to create a new Employer group. * Click the **Add Price** button to save your changes. * Repeat the above steps to create all different levels of seats required for the Class. Click the **Save** button once all the required seats have been created. # Adding Content Content can be added to a class to provide users with a description or additional information about the class they are registering for. Content can be added to a class to provide users with a description or additional information about the class they are registering for. Under the **Content** tab, you are able to add or edit the following Class details: * **Title**: Name of the Class. * **Summary**: Short description of the class. * **Description**: Provided an overview of the class and requirements to register. * **Materials**: Any additional documentation or instruments a learner will require for the class. * **Instructions** * Contact and Support * Accommodation * Additional Information * Cancellation and Refund * Registration Completion
# Class Privacy Groups in the Contacts toolkit can be used to set access permissions for the Classes published on the Portal. **Groups** in the Contacts toolkit can be used to set access permissions for the **Classes** published on the **Portal**. If no Groups have been created or new groups are required, it can be added in the Contacts toolkit, using Groups (See [**Create a New Group**](https://github.com/InSite/docs/blob/master/ui/help/portal/contacts/group-management/adding-new-group/README.md)). Under the Privacy tab click on the Pencil Icon (:pencil-alt:) next to the Groups field. In the **Filter** card, select the **Group Type** (**Department**, **District**, **Employer**, **List**, **Role**, **Team**, **Venue**) and then in the **Update Groups** card select the groups that are allowed to the see the Class on the Portal. Click the **Save** button to save your changes. *Note: You are able to give permissions to different Group Types for the same Folder/Page. e.g. A combination of Groups withing a Role and within a List can be added to the permission list of a Folder/Page.* # Class Settings After a Class is created, the following information can be added or edited under the Class Setup tab: After a **Class** is created, the following information can be added or edited under the **Class Setup** tab: * **Identification** * **Achievement:** Achievement that contains the Program you want to evaluate with this class. * **Event Title:** The descriptive title for this class. * **Event Identifier:** A globally unique identifier for this class. * **Source:** The background source or external reference code for this class.
* **Schedule Information** * **Event Start:** The start date and time for this class event. * **Event End:** The end date and time for this class Event. * **Duration:** Duration of this class event. * **Credit Hours:** The number of credit hours associated with completion of the class.
* **Publication** * **Status:** The business process for managing classes has several steps; this is the current step in the process. * **Registration Start:** The date and time when registration for this event is open, after which new registrations are permitted. * **Registration Deadline:** The date and time when registration for this event is closed, after which no new registrations are permitted.
* **Location Information** * **Venue:** The Venue where the class is taking place.
* **Attendance** * **Capacity**: Set the capacity limit for the class. Enter the **Minimal Capacity** (Optional) and **Maximum Capacity** number of registrants required to attend a class. If there is no minimum number of registrants required, you can leave the **Minimal Capacity** section blank and only add the maximum number of registrants that can attend the class. * **Waitlisting:** Enable or Disable the ability to allow Waitlisting for a class.
* **Instructors** * **Instructors:** Add instructors for the Class by clicking on the **Assign Instructors** button. * Search for the **Instructors** by **Name, Email** or **Group**. * Select the **Instructor** and click **Add**
# Publish Class Registration When you are ready to Publish your Class to the user Portal, search for the Class you created and under the Class Setup tab, click on the Publish button. When you are ready to **Publish** your **Class** to the user Portal, search for the **Class** you created and under the **Class Setup** tab, click on the **Publish** button. Select the **Registration Start** date (The date and time when registration for this event is open, after which new registrations are permitted) and **Registration Deadline** date (The date and time when registration for this event is closed, after which no new registrations are permitted.). *Note: The **Registration Start** and **Registration Deadline** dates controls when the* [*Self-Register*](/help/events/schedule-new-class/publish-class-registration) *and* [*Register Employees*](/help/events/schedule-new-class/publish-class-registration) *buttons appear on the Class Outline page.* The **Register Employees** button can be added/removed by Organization specific settings. Please ask your Shift iQ Account Representative if you need to add/remove this button. Click the **Publish** button. # Adding Class Registration Tile on Portal Page To add the **Class Registration Tile** to your Portal page, please contact your **Shift iQ Account Representative** to assist with the initial setup. # Class Statuses After a class is created, an administrator will see various statuses appear next to the class. After a class is created, an administrator will see various statuses appear next to the class. The flowchart below shows when statuses are updated and what they are updated to:
Class Statuses (1)
# Using Classes for Exam setup ## To enable the Exam Feature in Classes, please contact your Shift iQ Account Representative to assist with the initial setup **Shift iQ has functionality in the Classes toolkit that Organizations can use to serve up Assessment Forms to test Learner's knowledge of the Class they completed** --- [Next Page](/llms-full.txt/1)