Activity Sessions

When an Activity is prompted to a participant, Avicenna will create a Session for it. This session will hold information about the prompted Activity, responses provided by the participant or the researchers so far, and other related metadata.

To get an overview of the sessions in your study, follow these steps:

• Open the Sessions page on the Researcher Dashboard.
• Go to the Participants tab from the right-side panel and select the participants whose sessions you want to check. Note that currently, you can choose a maximum of 5 participants.
• Then go to the Activities tab and select your desired Activities.
• Press Apply Filters.

Following this, you can access all the Activity sessions with their status for the selected participants.

You can view the Activity sessions starting when a particular participant joins your study. To do this, after selecting a Participant ID under the Participants tab, click on the Go to Join Time button that appears. This is an important feature because it allows you to check all your study sessions and ensure they are created correctly for all the participants.

As you see in the top left corner, you can also specify the period that you want the sessions to be displayed in. You can select a Daily, Weekly, Monthly, or Yearly view. Also, below the session statuses, you can find a progress bar. As you hover the mouse over it, a tooltip appears that shows the number and percentage of sessions with a particular status. The image below shows that we have 245 Unanswered sessions for the selected participants, accounting for more than 82% of the sessions.

Also, you can hide or show sessions with specific statuses by tapping their status badge above the calendar.

Session Statuses

Each session has a status that can be one of the following:

• Unanswered/Unknown (ID 0) indicates that a response to this particular session hasn't been registered or uploaded yet. This status doesn't necessarily mean the session hasn't been initiated; it might have been prompted, but the response is yet to be recorded.
• Completed (ID 1) indicates the participant completed the session and submitted it.
• Canceled (ID 2) indicates the participant did not want to complete the session and explicitly canceled it.
• Expired (ID 3) indicates the session was not responded to in time, so Avicenna automatically marked the session as expired.
• Blocked (ID 4) indicates the session was blocked by another active session from the same Activity and could not be prompted (more details below).
• In Progress (ID 6) indicates the session is started by the participant but it's not completed, canceled, or expired yet.

In Avicenna, we consider an activity session a "concluded" when its status is one of the following:

• Completed
• Expired
• Canceled
• Blocked

For Expired, any data collected up to the time of expiration will be uploaded to Avicenna servers. Also, Blocked sessions indicate the Activity was not prompted to the participant, and therefore, there is no response available for it.

Expired Sessions and Expiry Time

Each Activity can have an Expiry Time, which specifies how long after the Scheduled Time Avicenna should wait for the participant to complete the Activity and submit it. If a participant fails to submit their response within the set timeframe, the session will be labeled as Expired.

Blocked Sessions

Each Activity can only have one session running at a time; sessions cannot overlap. If a new session is triggered while another session is already running for the same Activity, the new session will immediately be closed and labeled as 'Blocked'.

Let's say you schedule an Activity with a Time Trigger Logic (TL) for 8 am and 9 am, with expiry time set to 2 hours. At 8 am, Avicenna prompts the participant, starting a new session and waiting for completion. If by 9 am the participant hasn't responded or canceled the first session, the 9 am session can't start because the 8 am session is still active. Avicenna will then mark the 9 am session as 'Blocked'."

info

Bear in mind that once a session is canceled, expired, blocked, or completed, the corresponding upcoming Session Release Notifications will not be sent.

Sessions Metadata

Clicking on each session will give you its metadata which includes Activity, Participant, Scheduled Time, Response Time, and UUID.

• UUID is a Universal Unique Identifier that uniquely identifies a session in Avicenna.
• Scheduled Time specifies the time that the Activity was scheduled to be prompted. For sessions that are prompted via Triggering Logics types other than Time TL, this is set to the time the Avicenna app starts the session.
• Response Time specifies the time the Activity session was concluded and queued to be uploaded to the Avicenna server.

info

Whether you use Avicenna as a researcher or participant, all time values are automatically converted to your local time zone, i.e., Avicenna displays all the sessions based on the user's local time zone. Please refer to the Participation Period to learn how Avicenna deals with time.

Let’s work on an example scenario here. Assume that you are interested in viewing all the sessions that were or will be prompted for one of your study's participants (ID: 59982) in March 2023. To see these Activity sessions,

• Choose the Participants and the Activities from the right-side panel.
• Press Apply Filters.
• Then set the view to Month and select March 2023 for the date range.

Now you can see all the sessions scheduled for this participant in March 2023 with their status. Note that if there are more than two sessions in a cell, you will see a More button, which, if clicked on, will show you the list of all sessions in that particular time slot cell.

Actions on the Activity Sessions

You can perform several actions on a session on the Sessions page, including creating, editing, and deleting sessions. You can also edit the responses to a session as a researcher.

Creating a Session

The Sessions page offers you two ways to create a session.

First, You can tap the Create New Sessions button above the calendar and select Create via CSV File to upload a CSV file. The CSV file must include the Participant ID, the Activity ID, and the Scheduled Time in each row. For instance, the CSV file can be like this:

user_id,activity_id,scheduled_time
44457,14269,1705814200000
44658,14369,1706821400000

If you still need a sample file to modify and use, you can download it by clicking on the link inside the dialog you can see below:

In this interface, you have the option to either drag and drop your file or choose it directly from your device. Upon confirmation, a dialog will appear displaying which sessions were successfully created and identifying any that encountered issues:

info

The Scheduled Time should be in milliseconds since the Unix epoch. You can use a tool like Epoch Converter to convert the date and time to milliseconds.

Another way is that you can also click on the whitespace area of the calendar cells for the upcoming days. This will take you to the Create Session dialog, where you can specify the Activity, the Participant, the Scheduled Time, and the Expiry Time. Note that the session that you create this way or using a CSV file will be a Researcher-Defined Session.

info

When you create a session in the Create Session dialog, only the selected participants from the right-side panel will be visible in the Participant field. Also, you can create sessions for one participant at a time. However, using the CSV option, you can create multiple sessions for multiple participants and activities.

Deleting a Session

If you want to delete a session, there are two ways:

1. First, tap the Delete Sessions button above the calendar and enter the UUID of the sessions you want to delete. As you see in the image below, you can only delete the Researcher-Defined sessions here. Also, note that only future sessions can be deleted.

   

2. Second, click on any session (in the future or the past) in the calendar and tap the Delete icon. Doing this opens a dialog where you must confirm that you want to delete the session. Note that here you can delete all the possible session types, including Time TL and Researcher-Defined sessions. Avicenna will automatically reload the devices for such sessions.

   

Editing a Session

In addition to creating or deleting, you can edit a session on the Sessions page. Keep in mind that you can only edit future sessions. To do this,

• Click on an upcoming session in the calendar.
• Then tap the Edit icon.
• You can change the Scheduled Time and Expiry Time in the opened dialog.
• By default, the participant’s device will be reloaded to ensure the changes are applied.

Note that, like deleting a session, you won’t see the Reload participant’s device option for the Researcher-Defined sessions, as Avicenna will automatically update them.

note

The Edit Session option is disabled for Researcher-responded sessions due to the immediate scheduling nature of these sessions. As they are set to occur 'now,' effectively the moment they are created, their scheduled time is immediately considered to have passed. Consequently, no changes can be made to the session once it has begun.

Editing Responses

As a researcher, you may need to edit the responses of the participants. Avicenna allows you to edit the responses of the participants for a session. To do this, follow these steps:

• Go to the Activity Sessions page.

• Click on the session you want to edit.

• Click on the Edit Response button, and you will be directed to the page where you can edit the responses.

  

Currently, researchers can only edit responses for survey activities.

Some types of questions allow you to clear the current answer by clicking on the clear button rather than doing it manually. These question types include:

• Single Answer
• Visual Analog Scale (VAS)
• Calendar
• Audio
• Video
• Image
• Audio/Text

For surveys, you can also view the response history for each of the questions by clicking on the 3-dots menu and clicking on View Response History. To learn more, check the Viewing Survey Response History section.

Also, you can view the comments on any response or add your own. To do this, click on the 3-dots menu and then click on View Response Comments. To learn more, check the Commenting on Survey Responses section.

info

Editing the sessions other than the Researcher-responded sessions will result in reloading the participants' devices.

However, if editing a Researcher-responded session results in a change of criteria or survey question content placeholders of another session, the participants' devices will be reloaded.

note

When you're editing the responses as a researcher, the session won't expire even if the survey has an expiry time.

Saving a Session

After you have modified the answers, you can Save or Submit the session by clicking on the button at the top right corner of the page. If you click on Save, the session will be saved and the session's status will be changed to In Progress.

If the response to a question is invalid based on the question properties (e.g. format, min, max), you won't be able to save your response and you will be informed by an alert message.

Submitting a Session

If you click on Submit, the session will be saved and the session's status will be changed to Completed. However, the Response Time for the session will be set only the first time you submit your answer.

Same as saving a session, you can't submit your response if your responses are invalid based on the question properties.

Downloading Sessions

The Activity Sessions page also lets you download all the sessions defined in your study in a CSV format. To do that, tap the Download as CSV button above the calendar. The downloaded file provides information about the sessions, including the Participant ID, the Activity ID, the Scheduled Time, the Record Time, Status, etc.