OAQ Publisher Workflow Docs

OAQ is a web-based tool that helps publishers create author questionnaires and creates structured data from author responses. You can read more about the project on the Harvard Library portal.

SECTIONS
» Account Management
» Organizations
» Questionnaires
» Questions
» Responses

Questionnaires

An author questionnaire is a form that a publisher sends to its authors to collect details such as name, publications, biography, contacts, professional interests, PR opportunities, etc.

In OAQ, the core objects of a questionnaire are sections containing questions. An organization admin or staff member assembles these pieces to create each questionnaire.

Creating a new questionnaire

  1. Click Questionnaires in the top bar to view a list of all your organization’s questionnaires.
  2. Click Create a new questionnaire. Alternatively, click + Add a questionnaire in the top bar.
  3. In the popup window, enter a name and description for the questionnaire. This text will be visible only to users within your organization, not authors. You can also edit these details later.
  4. Click Create to save the new questionnaire, or click Close to discard your changes.

If you click Create, you will be taken to the Edit Questionnaire page. The questionnaire will be saved to your organization’s list, so you can get back to it at any time by clicking Questionnaires in the top bar.

Essential Questions section

OAQ requires the collection of some basic author information. This means that when you create a new questionnaire, it will contain a default section called Essential questions. You cannot delete these questions, but you can rename the section or distribute the questions to other sections. You can also move questions from other sections into the Essential Questions section, but you cannot create a new question directly in this section.

Actions you can perform on a questionnaire

OAQ allows you to perform a number of actions on a saved questionnaire. When you click Questionnaires in the top bar, you can view a list of all your organization’s questionnaires. The column titled Actions lists all the actions you can perform on each one:

Action Result
View Shows a view of the questionnaire as the author will see it.
Edit Takes you to the Edit Questionnaire page.
Send to authors Pops up a window where you can invite authors to the questionnaire.
Clone Pops up a window where you can enter a name and description in order to clone the questionnaire.
Responses Takes you to a page where you can manage author responses for the questionnaire.

The following sections provide more detail on these actions.

Viewing a questionnaire

You can preview how a questionnaire will look to an author.

  1. Click Questionnaires in the top bar to view a list of all your organization’s questionnaires.
  2. Find the name of the questionnaire you want to view.
  3. Under Actions, click View.

Editing a questionnaire

You can customize a questionnaire to meet your organization’s needs.

  1. Click Questionnaires in the top bar to view a list of all your organization’s questionnaires.
  2. Find the name of the questionnaire you want to edit.
  3. Under Actions, click Edit.

This will take you to a page where you can add sections and questions. You can also click Name and description to edit the questionnaire details that are shown in the list view.

The following sections provide more detail on editing functions.

Creating a new section

  1. On the Edit Questionnaire page, click Add New Section.
  2. In the popup window, add a name and description for the section. For example, if you want to group questions related to biographical details together, you might enter the name “Biographical information” and add some descriptive text. (Note you can edit the name and description at any time from the main Edit Questionnaire page.)
  3. Click Create to save the section, or click Close to discard your changes.

Clicking Create will take you back to the Edit Questionnaire page where your new section will appear at the bottom of the page.

Managing questions within a section

Once you have created a new section in your questionnaire, you can manage questions within it.

  1. On the Edit Questionnaire page, find the section you want to manage.
  2. Click Add / Remove questions.

This will take you to a page where you can perform the following actions.

Create a new question and add it to the section

  1. Click Create new question.
  2. In the popup window, fill out the question components.
  3. Click Create to save the question, or click Cancel to discard your changes.

Note that if you create a new question this way, it will appear within the section and will also be added to the organization-wide questions. Alternatively, you can create an organization-wide question directly.

Add an existing question to the section

This step requires you to have previously added at least one organization-wide question.

  1. Under Add Questions, select a question from the dropdown (or start typing its name in the search box). Note that all organization-wide questions will appear as options in the dropdown, but any questions already in the questionnaire will be dimmed; questions that are available to be added will be shown at the top of the results list.
  2. Click Add Question.
  3. Confirm that the question appears under Questions Currently In this Section.

Remove a question from the section

  1. Under Questions Currently In this Section, click the trashcan icon next to the name of the question you want to remove.
  2. In the popup window, click Yes to remove the question, or click No to go back.
  3. Confirm that the question has disappeared from Questions Currently In this Section and is once again available in the dropdown.

Note that this process will only remove the question from the individual questionnaire. The question will still exist in the organization-wide questions.

When you have finished with this page, click Done Adding Questions, Take Me Back To Section Editor.

Moving elements around

The Edit Questionnaire page provides a drag-and-drop interface so you can easily reorder questions and sections within a questionnaire.

Moving a question within a section

  1. To the right of the question, click and hold the + icon.
  2. Drag the question above or below the other questions in the section as desired.
  3. Release the cursor when you are satisfied with the question’s position.

Moving a question to another section

  1. To the right of the question, click the link that says Move to another section.
  2. In the popup window, select the section from the dropdown under To that you want to move the question into.
  3. Click Move.
  4. Confirm that the question has moved to the desired section.

Moving an entire section

  1. To the right of Edit Name and Description, click and hold the crosshair cursor icon.
  2. Drag the section pane above or below the other sections on the page as desired.
  3. Release the cursor when you are satisfied with the section’s position.

Removing a section

  1. To the left of Edit Name and Description, click the trashcan icon.
  2. In the popup window, confirm that you want to remove the section from the questionnaire.

Sending a questionnaire to an author

When you are satisfied with your questionnaire, click I Am Done Making My Questionnaire at the bottom of the Edit Questionnaire page. You can now begin sharing it with authors.

  1. Click Questionnaires in the top bar to view a list of all your organization’s questionnaires.
  2. Find the name of the questionnaire you want to share.
  3. Under Actions, click Send to authors. (Alternatively, you can click either View or Responses, then click Invite authors to answer the questionnaire.)
  4. In the popup window, enter the author’s email address. If you’re sending to multiple authors at once, press Enter after typing each address before typing the next one.
  5. Click Invite to send the email, or click Close to discard your changes.

Clicking Invite will send the recipients your organization’s customized email message with a link to your questionnaire. Additionally, the questionnaire will be added to the Responses list with a status of Sent.

The publisher staff member who sends the invite will get an email notification when an author has submitted a response.

Cloning a questionnaire

To create a questionnaire that is based on an existing questionnaire rather than creating one from scratch, you can use the clone function.

  1. Click Questionnaires in the top bar to view a list of all your organization’s questionnaires.
  2. Find the name of the questionnaire you want to clone.
  3. Under Actions, click Clone.
  4. In the popup window, enter a unique name and description for the cloned questionnaire.
  5. Click Clone to save your cloned questionnaire, or click Close to discard your changes and go back.

Clicking Clone will save the new questionnaire to your organization’s list. You can then edit as desired.