Use Cases and Features

Features

A description of the Qualyzer features by feature area. Each feature area includes related use cases. Previous use cases have been archived.

Project Management

Features relates to the setup and managment of the metadata associated with a project.

Use Cases

  • A user creates a new project, adds new participants and investigators, and imports transcripts, memos, and audio files.
  • A user opens a new project, edits the descriptions of existing participants and investigators, imports transcripts, memos, and audio files.
  • A user renames transcript or memos through Qualyzer, or deletes participants and/or investigators.
  • A user deletes a project.
  • A user exports a project into a zip file, and imports it on another computer.
  • A user views or changes the properties related to a project.

Create Project

A New Project Wizard opens requesting: a project name, investigator nickname, Full Name, and Institution. The project name and investigator nickname are mandatory and limited to alphanumerical+ characters. The Full Name and Institution are optional. The investigator nickname is automatically filled with the "Default Investigator Name" as defined in the Qualyzer Preferences. Clicking Finish creates the project and updates the Project Explorer with the new project and new investigator.

Access: Menu bar (New | Project); Context menu in Project Explorer; View menu in Project Explorer.

Create Investigator

An Add Investigator wizard opens requesting: a nickname, Full Name, and Institution. The nickname is mandatory and limited to alphanumerical+ characters. The nickname will be automatically filled with the Default Investigator Name from the Qualyzer Preferences as long as no investigator currently exists with that name. The Full Name and Institution are optional. Clicking on Finish adds the investigator to the model, opens the investigator data in an editor, and refreshes the Project Explorer.

Access: Context menu in Project Explorer (any node); View menu in Project Explorer.

Create Participant

An Add Participant wizard opens requesting: a participant ID and Full Name. The participant ID is mandatory and limited to alphanumerical+ characters. The Full Name is optional. Clicking on Finish adds the participant to the model, opens the participant data in an editor, and refreshes the Project Explorer.

Access: Context menu in Project Explorer (any node); View menu in Project Explorer; Option in new Transcript Wizard.

Create Transcript

A New Transcript wizard opens requesting: a transcript name, date, related participants, and link to a related audio file. The transcript name is mandatory and limited to alphanumerical+ characters. It's mandatory to select at least one participant. The date is selected with a data chooser widget and is limited to valid dates. The audio file is optional. An option is given to create a new Participant. Clicking on Finish adds the transcript to the model, opens the transcript in an editor, and refreshes the Project Explorer, with the new transcript displayed. The new transcript is now linked from the corresponding participant editors.

Access: Context menu in Project Explorer (any node); View menu in Project Explorer.

Create Memo

A New Memo wizard opens requesting: a memo name, creation date, related participants (optional), related transcripts (optional), related codes (optional) and an author. The memo name is mandatory and limited to alphanumerical+ characters. The date is selected with a data chooser widget and is limited to valid dates. The current date is written by default. The author is mandatory and is selected from the list of investigators. Clicking on Finish adds the memo to the model, opens the memo in an editor, and refreshes the Project Explorer, with the new memo displayed. The new memo is now linked from the corresponding participant, investigator, and code editors.

Access: Context menu in Project Explorer (Create Memo, Create Memo for this Transcript (if transcript node selected), Create Memo for this Participant (if participant node selected)); Context menu in Transcript Editor (Create Memo for this Transcript); Context menu in Code Editor (Create Memo for this code); View menu in Project Explorer.

View/Edit Investigator

An editor opens with fields showing the investigator ID, Full Name, and Institution. These fields can be modified. The view also shows the memos associated with this investigator (read-only). Clicking on the memo name will open the memo in an editor. Whenever a field is modified, an asterisk appear in the editor's name tab. Changes can be saved by pressing Ctrl-S or through the menu bar (File | Save). Changes to the investigator nickname are immediately reflected in the Project Explorer. If the user attempts to close the editor (or Qualyzer) with unsaved changes, a dialog appears requesting a confirmation.

Access: Context menu in Project Explorer (Open); Double-clicking an investigator in the Project Explorer.

View/Edit Participant

An editor opens with fields showing the Participant ID, and Name. These fields can be modified. The view also shows the transcripts and memos associated with this participant (read-only). Clicking on a transcript or memo name will open the document in an editor. Whenever a field is modified, an asterisk appear in the editor's name tab. Changes can be saved by pressing Ctrl-S or through the menu bar (File | Save). If the user attempts to close the editor (or Qualyzer) with unsaved changes, a dialog appears requesting a confirmation.

Access: Context menu in Project Explorer (Open); Double-clicking a participant in the Project Explorer.

Delete Investigator

If the investigator is associated with any memo or transcript, a message dialog appears indicating that the investigator cannot be removed because of the existing links. If there is only one investigator in the project or all the investigators in the project are selected, a message dialog appears indicating that there must be at least one investigator associated with the project. If investigators from multiple different projects are selected a message dialog opens indicating that the operation cannot be completed. Otherwise, a dialog box appears asking for a confirmation. If the user selects OK the investigator is deleted from the project and the Project Explorer is updated to reflect the change. If an editor corresponding to the deleted investigator is open, it is closed when the investigator is deleted.

Access: Context menu in Project Explorer (Delete).

Delete Participant

If the participant is associated with any memo or transcript, a message dialog appears indicating that the participant cannot be removed because of the existing links. If participant from multiple projects are selected a message dialog appears indicating that the operation cannot be completed. A dialog box appears asking for a confirmation. If the user selects OK the participant is deleted from the project and the Project Explorer is updated to reflect the change. If an editor corresponding to the deleted participant is open, it is closed when the participant is deleted.

Access: Context menu in Project Explorer (Delete).

Delete Transcript

If the transcript is associated with any memo, a message dialog appears indicating that the transcript cannot be removed because of the existing links. If transcripts from multiple projects are selected a message dialog appears indicating that the operation cannot be completed. A dialog asks for a confirmation and gives the option to delete the audio file, any codes associated only with this transcript, and any participants associated only with this transcript. If OK is selected the transcript (and corresponding rtf file) is deleted, along with any options specified in the dialog box. If the editor was opened it is closed. All fragments are also deleted, thus no longer being referenced in the code editor.

Access: Context menu in Project Explorer (Delete).

Delete Memo

If memos from multiple projects are selected a message dialog appears explaining that the operation cannot be completed. A dialog asks for confirmation and gives the option to delete any codes that are only associated with this memo. If the user selects OK the memo and corresponding rtf file are deleted. If the option to delete codes was selected they are also deleted. All references to the memo are updated and all references to fragments it contains are removed. If the editor was open it closes.

Access: Context menu in Project Explorer (Delete).

Delete Project

A dialog box appears asking for a confirmation. If the user selects OK the project is removed from disk and the Project Explorer is updated. Any open editors belonging to the project are also closed when the project is deleted.

Access: Context menu in Project Explorer (Delete).

Export Project

A dialog box appears asking for a file location. If the user selects an existing file a overwrite confirmation appears. If the users confirms, a zip archive of the project is created as the file selected. The archive contains all the project resources (all the files in the project location on the workspace). Inside the zip, the files are put in a directory with the project name.

Access: Context menu in Project Explorer (Export Project).

Import Project

A dialog box appears asking for a file location. Only existing files can be selected. Once a file is selected, the dialog shows all the projects in the file (directories containing a .project file at their root), and provides check boxes to allow the user to select the project to imports. If the user selects at least one project and clicks imports, the project is created in the workspace. If any errors occur during the import phase, the import is rolled back and a message is displayed.

Access: Context menu in Project Explorer (Import Project).

Modify Transcript Properties

A form dialog box appears showing the transcript properties: Name (non-modifiable), File Path (non-modifiable), Date (modifiable), Participants (modifiable), Audio File (modifiable). If values are changed, clicking OK records the changes. If the audio file is changed while the transcript is open in an editor the audio file must not be playing or paused for the change to take effect in the audio player.

Access: Context menu in Project Explorer (Properties on Transcript node).

Modify Memo Properties

A form dialog box appears showing the memo properties: Name (non-modifiable), File Path (non-modifiable), Date (modifiable), Participants (modifiable), Transcripts (modifiable), Codes (modifiable), Author (modifiable). If values are changed, clicking OK records the changes.

Access: Context menu in Project Explorer (Properties on Memo node).

Modify Project Properties

A form dialog box appears showing the project properties: File Path (non-modifiable), Active investigator (modifiable from list of investigators). If values are changed, clicking OK records the changes.

Access: Context menu in Project Explorer (Properties on Project node).

Import Transcript

A form dialog box appears asking the user to enter: A file name (mandatory), a transcript name (mandatory, does not already exist, alphanumeric+), a date (mandatory), a selection of at least one participant, and a corresponding audio file (optional). If the user clicks OK the new transcript is created and copied to the project workspace, the Project Explorer shows the transcript, and the transcript is opened in an editor. If the transcript file cannot be opened or located, an error dialog appears and the transcript is not imported. Two types of files can be imported: rtf, and .txt. Text files are automatically converted into rtf.

Access: Context menu in Project Explorer (Import | Transcript).

Import Memo

A form dialog box appears asking the user to enter: A file name (mandatory), a memo name (mandatory, does not already exist, alphanumeric+), a date (mandatory), an author (mandatory), related participants (optional), related transcripts (optional) and related codes (optional). If the user clicks OK the new memo is created and copied to the project workspace, the Project Explorer shows the memo, and the memo is opened in an editor. If the memo file cannot be opened or located, an error dialog appears and the memo is not imported. Two types of files can be imported: rtf, and .txt. Text files are automatically converted into rtf.

Access: Context menu in Project Explorer (Import | Memo).

Collapse All

All the non-root nodes in the Project Explorer are collapsed. Only the root nodes (Projects) are shown.

Access: Collapse All icon (-) in the Project Explorer's action bar.

Rename Project

A rename dialog appears asking for the new name. Entering a new valid name and clicking OK renames the project.

Access: Context menu in Project Explorer (Rename on Project node).

Rename Transcript

A rename dialog appears asking for the new name. Entering a new valid name and clicking OK renames the transcripts and updates all the links to this transcript in participants and investigators. The corresponding audio file is renamed as well.

Access: Context menu in Project Explorer (Rename on Transcript node).

Rename Memo

A rename dialog appears asking for the new name. Entering a new valid name and clicking OK renames the memos and updates all the links to this memo in participants, investigators, and codes.

Access: Context menu in Project Explorer (Rename on Memo node).

About

A message dialog appears describing what Qualyzer is about.

Access: Menu bar (Help | About)

Close All

All the open editors are closed. If any editor contains unsaved changes, a confirmation dialog appears asking the user to check which resource they wish to save.

Access: Menu bar (File | Close All)

Qualyzer Preferences

Default Investigator Name

This sets the name that will be used for the investigator when creating a new Project. It will also be used whenever a new investigator is created so long as the project does not already contain an investigator with that name.

Fragment Color

This sets the color to be used for the highlighting of text fragments that have been marked with a code.

Seek Time

This controls the amount of time that the seek back and seek forward actions subtract or add to the position of the audio file in the transcript editor.

RTF Editor Font

This controls the font that the memo and transcript editors use to display documents.

Transcript Editor

The transcript editor allows users to edit and save transcripts, play the corresponding audio file, and to associate codes and comments with various fragments of text.

Use Cases

  • A user open an empty transcripts, plays the audio file, and transcribes an interview. The user stops and starts the audio as needed, and formats different sections in bold, italics, underline.
  • A user opens a transcript, makes some modifications, and saves the changes.
  • A user opens a transcript, reads some sections, selects a quote, and adds a code related to the quote.
  • A user transcribes an interview from an audio file and create timestamps that associates times in the audio file with paragraphs.
  • A user selects a fragment in a transcription and listens to the interview's part related to that fragment.

Open Transcript

A text editor opens showing the text of the transcript. The text can be modified. Whenever unsaved changes exist, an asterisk appear in the editor's name tab. Changes can be saved by pressing Ctrl-S or through the menu bar (File | Save). If the user attempts to close the editor (or Qualyzer) with unsaved changes, a dialog appears requesting a confirmation.

Access: Context menu in Project Explorer (Open); Double-clicking a transcript in the Project Explorer.

Play Audio File

Above the transcript editor, a widgets supports playing, pausing, and stopping the audio file associated with the transcript. If no audio file is associated with the transcript, the widget is grayed out. A slider shows the position of the player in the audio file. Clicking on the slider seeks to the appropriate position in the audio file. If the audio file is playing or paused it must first be stopped if you wish to change the audio file associated with the open transcript (via the Transcript Properties menu).

Access: Transcript Editor.

Quick Seek

A user presses a key to move the audio slider a few seconds earlier and start playing. A different key allows to move the slider a few seconds later and start playing. The amount of time for back and forward quick seek can be configured (with different values) in the Preferences page (Default is 3 seconds). The key bindings for activating Quick Seek can also be configured in the Preferences page (Defaults are F7 and F8). It is also possible to type the desired time directly into the Audio Bar by selecting the current time.

Access: Shortcut keys in the transcript editor.

Creating Timestamps

In the transcript editor, the user creates a timestamp by right-clicking anywhere in a paragraph and selecting Add Timestamp. The timestamp will be created with the current Audio Slider position. A marker is created (on the left of the editor). Hovering over the marker displays the time associated with it.

Access: Context menu in the transcript editor

Seeking at Timestamps

Clicking on a timestamp (marker) moves the audio player's slider to the time marked by the timestamp.

Access: Transcript Editor marker bar

Format Text

Text can be selected in the Transcript Editor, and changed to bold, italics, or underline (or any combination thereof). The text can be changed back to normal or to any other combination of characteristics. If the text selection spans text that is and is not formatted along a certain format type (bold, italics, underline), then the formatting option is disabled for this dimension. The status of the formatting is shown in the context menu.

Access: Shortcut keys in when an open Transcript Editor has focus. Context menu in the transcript editor. Button bar above the editor.

Word Wrap

In the transcript editor, text automatically wraps down when it reaches the edge of the editor.

Access: Automatically triggered in the Transcript Editor.

Mark Fragment

In the transcript editor, text can be selected and associated with a code. A marked fragment is identified with a light gray background and an icon in the right gutter.

Access: Only available as a side-effect of the Add Code feature.

Unmark Fragment

In the transcript editor, if all codes associated with a fragment are deleted, the fragment is automatically unmarked. Alternately, the fragment can be selected and explicitly deleted. A confirmation dialog appears informing the user that this will remove the associations to code related to this fragment. If the use confirms all links to code are removed and the fragment is unmarked.

Access: Available as a side-effect of the Delete Code or Delink Code features, or through a context menu in the Transcript Editor.

Memo Editor

The memo editor allows users to edit and save memos.

Use Cases

  • A user open an empty memo, and adds some notes.
  • A user formats different sections in bold, italics, underline.
  • A user opens a memo, makes some modifications, and saves the changes.

Open Memo

A rich text editor opens showing the text of the memo. The text can be modified. Whenever unsaved changes exist, an asterisk appear in the editor's name tab. Changes can be saved by pressing Ctrl-S or through the menu bar (File | Save). If the user attempts to close the editor (or Qualyzer) with unsaved changes, a dialog appears requesting a confirmation.

Access: Context menu in Project Explorer (Open); Double-clicking a transcript in the Project Explorer.

Format Text

Text can be selected in the Memo Editor, and changed to bold, italics, or underline (or any combination thereof). The text can be changed back to normal or to any other combination of characteristics. If the text selection spans text that is and is not formatted along a certain format type (bold, italics, underline), then the formatting option is disabled for this dimension. The status of the formatting is shown in the context menu.

Access: Shortcut keys in when an open Memo Editor has focus. Context menu in the memo editor. Button bar above the memo editor.

Word Wrap

In the memo editor, text automatically wraps down when it reaches the edge of the editor.

Access: Automatically triggered in the Memo Editor.

Mark Fragment

In the memo editor, text can be selected and associated with a code. A marked fragment is identified with a light gray background and an icon in the right gutter.

Access: Only available as a side-effect of the Add Code feature.

Unmark Fragment

In the memo editor, if all codes associated with a fragment are deleted, the fragment is automatically unmarked. Alternately, the fragment can be selected and explicitly deleted. A confirmation dialog appears informing the user that this will remove the associations to code related to this fragment. If the use confirms all links to code are removed and the fragment is unmarked.

Access: Available as a side-effect of the Delete Code or Delink Code features, or through a context menu in the Memo Editor.

Working with Codes

Codes are associated with transcript or memo fragments. Management of codes is done through a Code Editor.

Use Cases

  • A user creates a new code by entering a name and description.
  • A user views the list of codes for the project and edits a code's description.
  • A user reviews a transcript and adds a code to a text fragment.
  • A user exports their list of code to a file in an open-format.

Add Code

A New Code wizard appears asking for a code name (mandatory) and a description (optional). The code name must be in alphanumeric+ format and not already exist. When the user selects OK, the code is added to the model. If the Code Editor is open when a new code is added, the Code Editor shows the newly added code.

Access: Project Explorer Context Menu (New | Code); Table Viewer in the Code Editor; Context Menu in the Transcript Editor (either after marking a new fragment, or right-clicking on an existing fragment).

View/Edit Codes

The Code Editor appears, showing a table with all the codes and their frequency (number of fragments with that code attached) on the left. To the right of the table is another table containing the hierarchical view. Below the two tables is a label showing which code is currently selected. Below that is a text field containing the code's description. Clicking on a code name cell fills in the text field with the code's description. Selecting a code in the hierarchy will select the corresponding code in the list. The list also has a button which toggles filtering of all the codes which are in the hierarchy. Any changes to the text field will mark the editor with and asterisk. Any change in the editor are reflected in the model.

Access: Context Menu in Project Explorer (Open); Double-clicking on the Codes node in the Project Explorer.

Rename Code

Selecting this option opens a dialog that asks for a new name. The name must match the standard naming format and must not already be taken by another code. Clicking OK renames the code, updating the list and all its occurences in the hierarchy.

Access: Context Menu in the code editor.

Delete Code

If the code is associated with a memo then a message dialog appears indicating that it cannot be removed. If the code is associated with any fragment, the confirmation dialog indicates how many code associations will be removed from fragments. If the user confirms, the code and all its associations are deleted. The Code Editor is refreshed. Any open memo and transcript editors are also refreshed.

Access: Context menu in the code editor.

Viewing Coded Fragments

An editor is displayed with a list of fragments associated with a code. On top of the editor, there is a label describing the query (e.g., All fragments associated with Code B). The editor shows all fragments organised by transcript or memo. The transcript/memo sorting order is alphabetical. Each fragment is highlighted and surrounded by one sentence (before and after) unless the fragment is at the beginning or the end of a paragraph. In this case, there is only one sentence added (above or below, as appropriate), or no sentence if the fragment is the entire paragraph. Clicking on the fragment itself opens the corresponding document in an editor with the fragment selected.

Access: Transcript Editor Context Menu (Search Marked Fragments and Search Hierarchy Fragments); Table Viewer Context Menu (Search Marked Fragments and Search Hierarchy Fragments) in the Code Editor.

Creating Code Hierarchies

An editor is displayed with hierarchies of codes. The user can drag and drop codes to copy or move them into existing hierarchies. The frequency of each code (simple frequency) and its children (aggregated frequency) are displayed. There are only a two restrictions when working with code hierarchies. First, Qualyzer prohibits cycles and duplicates in a hierarchy. This means that a code cannot be its own descendant and it cannot have the same code as a child more than once. Second, a code can only be used once as a root, but it can be used as a child in other hierarchies.

Access: Code Editor

Export Codes

A file chooser appears. The user selects a file name and clicks OK. The list of code and their frequencies is stored in text/CSV format (do we need a specific character encoding?).

The file's contents are of the format : Code Name, Total Frequency, Document Name, Document Frequency,

Where Document name and frequency are repeated for each document containing the code. There is one such line per code.

Access: Context menu in the project explorer (Export | Codes)

Future features

Qualitative Analysis

There are tasks that are frequently done when analyzing coded data. Some of these tasks are tedious when done manually and could benefit from automated support.

Use Cases

  • A user searches for co-occurrences of codes.

Searching for Co-occurrences

A query editor is displayed with a summary of the codes that are frequently associated with a queried code, either on the same fragment or on a nearby fragment. The frequencies of the co-occurrences are displayed in the summary. Then, a list of fragments associated with these codes is displayed.

Access: Transcript Editor Context Menu (Search Co-Occurrences); Table Viewer Context Menu (Search Co-Occurrences) in the Code Editor.

Transcription Support

Investigators sometimes want to hear how a participant said something, or when producing an interview summary, what the participant exactly said.

Use Cases

  • A user wants to indicate that the interviewer is now asking a question.

Question/Answer Shortcut

In the transcript editor, when the user presses a shortcut key (e.g., ctrl-g), the following text with the following format is added to the transcript:

Interviewer:

Access: Transcript Editor

Question/Answer Highlighting

In the transcript editor, questions are formatted in bold. A question is recognized by a token at the beginning of a line (e.g., "q:", "Interviewer*:" (would match InterviewerA:, InterviewerB:).

The format and the token should be configurable (on a per project basis?).

Access: TranscriptEditor, Configuration: Preference Page

Updated

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.