Production Guide: Journal Template (HighWire)

 

Overview

Thia guide will refer to “templates” and “activities.” Templates are created by Rievent and added to your account for you to create CE/CME activities. The term “activity” is synonymous with “Course” and “Program”. Each activity type (journal, live event, enduring, RSS, webinar etc.) will have its own template.

Please also note that an activity evaluation may be built into the template if the same questions are asked for every activity. If this is the case, it will be automatically inserted into the activity workflow and will not need to be set up during production.

Step 1: Creating a New Activity

Step 2: Reviewing the Activity

Step 3: Publishing and Locking the Activity

Appendix A: Configuring Hint Links to Articles

Glossary

 

 

Step 1: Creating a New Journal Activity 

1.  To begin, click the icon-create-activity.jpg  icon next to the Manage Your Program Menu.
create-activity1.jpg


2.
  Enter the short name for the activity. The Short Name is how the activity will be listed in the Manage Your Program menu and will not be exposed to learners. If you have not already decided, you will need some sort of naming convention for your activities. 

When creating the Short Name, please keep in mind that it must be unique and should also include the Activity ID. For example, if your Activity ID is RD105, the Short Name might be in the format RD105 - Genetics and Type 2 Diabetes. The short name field has a 126 character limit. Acceptable characters include letters, numbers, underscore, dot, and dash.”. 

The short name field has a 126 character limit. Acceptable characters include letters, numbers, underscore, dot, and dash.

pre-prod1_HW-journal_.jpg


3.  
During the pre-production stage, you have the option to add the activity to other administrative accounts and also to upload any production-related files for storage (optional). Please note that the files stored here are for storage only, this feature is not intended for content hosting.  

Adding the activity to other administrative accounts allows them to see and access the activity from the Manage Your Program menu in their own admin account.

You can also manage administrative access to the series from the Review stage. This can be adjusted at any point in time.

pre-prod.jpg

pre-prod2.jpg


4.
 Next, select the template for the correct journal publication.
pre-prod3_HW-journal_.jpg


(Back to Table of Contents)

Production Wizard

The Production Wizard will walk you through the production process of creating and publishing a CME activity step-by-step, starting with the step of adding Activity Information. Once you've completed a step, you can go back at any time to edit what you've entered by clicking the appropriate tab in the Production Wizard. Always click the Save button for the steps that include a Save button, and Next after making any changes.

 

(Back to Table of Contents)

 

Activity information tab

5.  From the Activity Information tab, enter the Program ID, Activity Title, Release Date, Start Date, and Expiration Date. The Program ID and Program Name must be unique to the Rievent Platform. The Program ID is generally your internal program identification number or name, and the Program Name usually begins with the Program ID. The Program Name (same as the Short Name) field will already be populated for you.  

The date entered into the Release Date field will be populated to the Overview page.

This field is only used to populate the Release Date to the Overview Page, this is NOT the date learners will be able to request credit. 

Enter the date you wish learners to be able to begin requesting credit into the Start Date field.  Set the expiration date as the last full day that learners can request credit.

 

Next you have the option to enter a catalog summary for the activity (optional).  The text entered into the Catalog Summary field will be displayed to the learner on the CE Catalog. When you are finished, click Next to advance to the next screen.

The CE Catalog Summary field contains a 2000 character limit, which includes any characters that may be hidden in the source code.  If copy/pasting from a Word document, be sure to remove any hidden formatting characters before pasting into the wizard.  

 

(Back to Table of Contents)

 

Journal Info

6.  Next, enter the DOI (Digital Object Identifier) for the journal article. The DOI allows the Rievent Platform to pull the article content from HighWire and display it to the learner in the activity.  If you do not know the DOI, you can insert a temporary placeholder, but be sure go back and add the real DOI before publishing the activity. 

You can also enter volume number, issue number, and the journal citation for the activity (optional).  The text entered into these fields will be displayed on the learner’s CME certificate.

 

For templates that require multiple DOI’s, be sure to enter each one on a separate line.  

 

(Back to Table of Contents)

  

Classification

7.  From the Classification tab, select the metadata associated with the activity. This information will help learners browse for courses in the CE Catalog.  Once created, the list of metadata choices will be maintained by the Rievent Platform. 
 
Go through the list and check the meta-data tags you would like to assign to the activity.

 

8.  You can create new tags by clicking the Add button. To edit an existing tag, simply double click it, make the changes, then click Save.  You can also remove a tag by clicking the delete button. 

 

Below is an image displaying how the meta-data tags will be displayed in the CE Catalog. Only the metadata tags checked during production will show up in the CE Catalog.

 

 

 

 

Category shown to learners in the CE Catalog  Production Wizard Categories
Therapeutic Area Specialty (ex. Neurology) Editable in the production wizard.
Clinical Topic Clinical Topic (ex. Strokes) Editable in the production wizard.
Category Category (ex. 2017) Editable in the production wizard. This area can be used for custom segmenting of your activities. For example, create a custom segment to classify your activities by year, publication, credit type, etc.  
Audience Profession (ex. Physician) Editable in the production wizard.
Audience Categories Audience Categories (Uneditable terms are global for all customers) 
Speakers Not editable in the Production Wizard. Speakers are automatically shown based on active live events, webinar, and RSS activities that have speakers assigned to them.
Media Formats Media Formats (Uneditable terms are global for all customers) 
Activity Types Not editable in the Production Wizard. The activity type is automatically set based on the template being used to create the activity.

 

 (Back to Table of Contents)

 

Credit Options

9.  Next, configure the credit options for the activity. Check the boxes of the credit type(s) you would like to include and then fill out the min, max, and credit increment fields. To set a static credit amount without the option for learners to choose incremental credit, enter the same number for the min/max and enter 0 in the increment field. The credit release and expiration dates will default to the program start/end dates (configured from the Start tab) if left blank.  Click the Next button when you are finished.

 

 

 

(Back to Table of Contents)

 

Overview

10.  The Overview tab is where you will edit the default overview/disclaimer page that will appear first to the learner. The default overview page has been built into the template, but you must be sure to add any activity specific information, such as the learning objectives, to the page.  Language that is standard for all activities, such as the instructions, will be already be filled in for you.
 
Use the rich text editor to make format changes to the page. For more information on adding and formatting images to the Overview page, click here.

When you are finished, click Next to continue.

 

(Back to Table of Contents)

  

Activity Options

11.  From the Activity Options tab, you have the option to include additional evaluations, such as an Objectives Evaluation (activity specific questions) or Outcomes Evaluation, in addition to the Activity Evaluation. The Objectives Evaluation is typically used to ask the learner activity specific questions, while the Activity Evaluation contains the standard set of questions asked for all activities.  Click Next to proceed.

Depending on your template, you may see additional options listed.

 

 

(Back to Table of Contents)

 

CME Test

12.  The CME Test for this activity will be configured with a series of multiple-choice questions. There are two different ways to enter the test questions.  You can enter them all at once using the Multiple Choice Parser, or one at a time using the wizard. 

For complete instructions on how to use the Multiple Choice Parse, click here.


 
The Multiple Choice Parser is a great tool to use for quickly entering a group of multiple-choice questions into a test or survey.  It allows you to copy/paste a group of questions directly into the Rievent Platform.  To use the Multiple Choice Parser, select it from the drop-down menu after clicking the Add Question or Text button.

 

Next, Copy/Paste only the multiple choice questions into the Multiple Choice Parser.  Be sure a blank line separates each question, that each answer choice is on its own line, and that each correct answer is marked with an asterisk (*).  Click the Save button to add the questions to the test.  

 

To configure multiple choice test questions individually, start by clicking the Add Question or Text button and then selecting the Choose One question type.

 

Next, double click the question to insert text. To add answer choices, click the  icon and then double click to insert text.  You can also delete questions and answer choices with the  icon.  

 
 
To mark an answer choice as correct, click the  icon next it and the icon will change to a .


 
 
You may also edit the title displayed to the learner, minimum passing score, and the number of attempts the learner will be allowed to achieve the passing score. Awarding of credit and a certificate of credit is contingent on meeting this minimum passing score.

To set the threshold as unlimited attempts, set both fields to 0. 

 

Next, add in any hint links you would like to include (optional). Hint links allow learners to quickly and easily navigate back to the specific location in the journal article related to a particular question.  When a learner clicks the link, they will be taken to the journal article where the exact text related to the question will be highlighted.

You have the option to add the links to 4 different parts of the question – the question text, answer choices, question hint box, or the rationale.  Depending on how you want the links to display for you learners will dictate which place in the question you should insert the links.  For example, if you would like to display the article hint links during the taking of the CME test, you would add the code to the end of the question text, to the end of an answer choice, or in the question hint box.  If you do not want learners to see the article hint links until AFTER they have completed the CME test, then you would insert the links in the question rationale.

For more information on how to configure hint links, please refer to Appendix A.

 

When you are finished configuring the test, be sure to click the Save button before continuing.


 

(Back to Table of Contents)

 

Objectives Evaluation

13.  If you selected to include an activity specific evaluation, you will create it now. The Objectives Evaluation for this example will be configured as a single rating question, asking learners to rate how well the activity met its stated objectives. To set-up the survey, start by clicking the Add Question or Text button and then selecting the Rating question type.


 
Double click the text box to insert the question text. For this example we will use the rich text editor.


 
Use the Rich Text Editor to add any formatting to your question. 

 

You can also use the Source button to enter in HTML source code to format the question. When you are finished with the editor, click Done.


 
To add the rating line items for the question, click the  icon and then double click to insert text.  You can also delete a questions and line items using the  icons. 

 

To change the labels of the rating scale to match the labels of the scale we just entered in the question text box, click “options” (located under the rating line items) and modify the labels to match yours. In this example, the default was changed to “1=Strongly Disagree,5=Strongly Agree.” The rating range can also be adjusted from the options menu.

Click Set to save the change.

 

When you are finished configuring the survey, be sure to click the Save button before continuing.

 

14.  For templates that include additional evaluations, use the same set of tools to create the evaluation.

 

15.  From the finished tab, click the Finished button to build your activity. After the activity is created, you (along with your stakeholders) will have the opportunity to review. If any changes are required, you may return to the Production Wizard to edit the activity.  


 
There will be a short delay after clicking Finished while the Rievent Platform communicates with HighWire Express (HWX) to confirm the journal article is in queue. Once that has been confirmed, a pop-up window (see image below) will prompt you to reload the page.  Be sure to click the Reload button.


 
(Back to Table of Contents)
  

Testing a New Activity

16.  From the Review stage, you will have the opportunity to test the activity from a learner’s perspective. At the top of the screen you’ll notice a Recent Notifications window; this indicates the status of communication between HighWire Express and Rievent.  If there are any errors during production, such as an incorrect DOI, the system will present a message in the Recent Notifications window. 

 

It has always been the case with article CME on HighWire that courses cannot be published until the print version goes live.  During this time, the publisher can preview the unpublished course via the Rievent administrative dashboard. The publisher can verify various aspects of the course, including a virtual view of the article (abstract, full text, and/or pdf) and highlight links (if applicable and available. Highlight linking is not possible for PDF-only articles).  However, since the associated issue content is under embargo, the view of the article that you are able to see is the last published / most recent version of the article, which could be the publish ahead of print (PAP) version.  It is not the current embargoed version (print issue).   

The Rievent application uses a citation service call to create a virtual view of the article within the Rievent application.  This service is designed to call the most recent version of the article.  The purpose of this virtual view is to enable the publisher to preview the end user's experience, including the test, its links to the article, and if available, the highlighted sections of text that are related to specific questions (subject to the same limitation as above - that highlights are not available for PAP).  However, as previously, the course cannot actually be published until the print version goes live.

 

(Back to Table of Contents)

  

Notification Messages

Notification messages display the status of communication between HighWire Express (HWX) and the Rievent Platform to validate the DOI, which allows the Rievent Platform to display the article content and sidebar links in the CME activity.  A table of messages and their meanings are listed below:

 

(Back to Table of Contents)

Testing the Request for Credit Process

17.  To review the activity, click the Launch Program link. This will allow you to participate as a learner.


 
(Back to Table of Contents)

 

Making Changes to an Activity

To make changes to the activity, go back to the Production Wizard by clicking Production.

 

Access the different areas of the Production Wizard by clicking the tabs on the left side of the screen. After making the necessary changes and clicking the Next button, be sure to click the Finished button from the Finished tab.

 

(Back to Table of Contents)

 

Deleting Test Records

Once you have tested the activity, be sure to delete all test records created during the review process.  Each time the activity is tested as a learner, a participation record is created.  Test participation records can be deleted using the Records tab. 

1.  First be sure the correct activity is listed in the Manage Your Program drop-down menu.

Leaving all criteria fields blank and clicking the Search button will return all records associated with the activity, (which can be useful in deleting test records for activities not yet available to learners, since all the records listed will be test records.)   However, you can also search for individual records by using the various search criteria fields. 


2.
 From the search results page, click the    icon to delete the test records. You can also check the boxes for all the test record(s) you would like to delete, then click the Delete Selected button.


You can also search for test records across all activities by selecting ALL PROGRAMS from the Manage Your Program menu.  



(Back to Table of Contents)

Publishing and Locking the Activity

18.  When you are satisfied with the activity, click the Draft Review Complete button to begin publishing and locking the activity.

 

Publish and lock

19.  Click Publish and Lock Program to publish the activity to the Rievent driven CE Catalog. This also locks the activity to prevent anyone from accidentally making any changes.   Delete any test records created during the review process by clicking the Search... button. 

Even when activities are published and locked, they will not be available for participation and will not display in the CE Catalog until the activity release date has been reached.   

 

After clicking the Publish and Lock Program button, there will be a short delay while the Rievent Platform communicates with HighWire Express to validate the journal article.

 

Once the activity is published and locked, the “friendly” URL for accessing the journal activity is provided.

To edit a locked activity, simply click the Unlock for Edit When an activity is unlocked, it will be removed from the CE Catalog until you re-publish it.

 

Below is the updated CE Catalog, which now contains the newly created activity.

 

(Back to Table of Contents)

 

Appendix A:
Configuring “Hint” Links to Articles

Hint links allow learners to quickly and easily navigate back to the specific location in the journal article related to a particular question.  When a learner clicks the link, the exact text related to the question will be highlighted. 

When configuring a CME Test, you have the option to add the links to 4 different parts of the question – the question text, answer choices, question hint box, or the rationale.  Depending on how you want the links to display for your learners will dictate which place in the question you should insert the links.  For example, if you would like to display the article hint links during the taking of the CME test, you would add the code to the end of the question text, to the end of an answer choice, or in the question hint box.  If you do not want learners to see the article hint links until AFTER they have completed the CME test, then you would insert the links in the question rationale. 

To add hint links to test questions, add the code (format shown below) to the desired part of the question (question text, answer choice, rationale, or hint box).  Be sure to include the double brackets on either end of the hint code.  

Code format for adding hint links to questions:

[[ "highlight starts at this text" : "highlight stops at this text" | link text displayed to the learner ]]

The vertical line character | is found on most keyboards above the “ENTER” key on the right side of the keyboard.  Pressing SHIFT + \  will generate the | character.

The start and end span of text must be unique, meaning that specific block of text does not appear anywhere else in the article. A quick way to check if the text span is unique is to press CTRL + F when viewing the article, enter the text into the search box. If the text occurs only once in the article, then it will work the text highlighting. 

 Example:  [[ "Currently, there are" : "mistake (Fig. 1)." | Show hint! ]]

 

 

In addition to highlighting textual references in a journal article, you can also link to figures and tables.  To link to figures or tables, use the caption text for the figure or table as the start and end text for highlighting.  Below are some examples:

Code format for the highlighted text in the image below:

[[ "Figure 1." : "and by age (B)." | Show hint! ]]

 

 

Code format for the highlighted text in the image below:

[[ "Table 1." : " 2009 in Lombard, Italy" | Show hint! ]]

 

 

 

Adding Hint Links to Test Questions:

Adding hint links to the end of a test question will display the link to the learner on both the CME Test as well as the Test Results page.  When a learner accesses their test results from the My Courses page, they will also see the link displayed in their test results.

Learner’s View – CME Test

 

Production Wizard View

 

 

Adding Hint Links to Answer Choices:

Adding question hint links to answer choices will display the link to the learner on both the CME Test and the Test Results page.  In addition, the learner will also see the link when they access their test results from the My Courses page.

Learner’s View

 

 

Production Wizard View

 

 

Adding Hint Links to Question Rationale:

Adding question hint links to the question rationale will display to the learner on the Test Results page, but will NOT show on the CME Test page.  When a learner accesses their test results from the My Courses page, they will also see the link displayed in their test results.

 

Learner’s View (Test Results Page)

 

Production Wizard View

 

Adding Hint Links to the “Hint” Box of a Question:

Hint links added to the “Hint” box of a question during production will ONLY display to the learner on the CME Test page. The test results page will NOT display the link.  Also, learners will not see the links displayed on the test results page when accessed from My Courses.

Learner’s View

 

Production Wizard View

 

(Back to Table of Contents)

 

Production Wizard Glossary - HighWire Journals

Name Description Format Character
Limit
Program ID The internal activity identification number or name. If you do not have an internal identifier, you will need to create one. This must be unique for each activity in the Rievent Platform. Typically the Activity ID is part of the Activity Name. For example, if the Activity Name is RD105 - Genetics and Type II Diabetes, then the Activity ID would be RD105.  Acceptable characters include letters, numbers, underscore, dot, and dash (hyphen).  No spaces are permitted.  Text or Number 53
Program Name (Same as Short Name) The Activity Name is how the activity will be listed in the Manage-Your-Program drop-down menu.  This name will not be exposed to learners. (Most customers prefer to preface the name with the Activity ID and decide to use the activity title or a truncated version of the activity title.) Text or Number  126
Activity Title The full title of the activity as you would like it to appear on the overview page, email messages, and the certificate.  This title will be visible to learners. Text or Number  512
Start Date The date the activity will be accessible. Credit will not be available to learners before this date. MM/DD/YYYY -
Release Date  The date entered here will be populated to the Overview page. It does NOT control activity access.  MM/DD/YYYY -
Expiration Date The last full day the activity will be available.  Credit will not be available to learners after this date. MM/DD/YYYY -
Catalog Summary The information entered here will be visible to learners while browsing activities from the CE Catalog page. Rich Text  2,000
D.O.I Digital Object Identifier for the content piece. This unique identifier allow Rievent to pull the article content from HighWire and display it to learners within the activity.  Text or Number -
Journal Citation For templates that include this field, the text entered will display on the learner's certificate.  Text or Number 256
Min Credit The minimum number of credits a learner can claim for the activity. Number 5
Max Credit The max number of credits a learner can claim for the activity. Number 5
Increment Increment by which learners will be allowed to claim credit. For example, entering a 0.5 increment with a max of 2.0 and min of 1.0 credits will allow learners to claim 1, 1.5, or 2 credits. For activities without an increment, set the field to 0.  Number 5
Credit Release
Date
The date selected credit type will become available to learners. If left blank, this date will default to the program start date. MM/DD/YYYY -
Credit Expiration
Date
The date selected credit type will no longer be available to learners. If left blank, this date will default to the program end date. MM/DD/YYYY -
Overview Page The overview/accreditation information that you would like to appear as the first page in the activity. Rich Text -
Post-Test A graded test used to measure a learner competence. Presented after the content piece.  - -
Test Question Rationale  Shown to learners after successfully completing the Post-Test. Rich Text  10,000
 Objectives
Evaluation
An additional evaluation that can be used to gather various pieces of information, such as how well the activity met its stated learning objectives. - -
Outcomes If included, after completing the activity, learners will be sent weekly reminder emails inviting them to participate in a post-activity outcomes evaluation. This evaluation is designed to measure the effect of the activity on opinions, practices, or clinical outcomes. The reminder emails will start and end at the interval set on the Activity Options tab in the template.  - -


(Back to Table of Contents)