Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The

payment

Payments tab allows payment schemes to be created and applied to a study.

Percentage involves tracking the percentage of assessments completed within a study period

It can also be used to view all payments created and mark them paid.


To create a new payment scheme, click on “+ Add payment scheme.”

image-20240821-151138.png

There will be an option to select

“Percentage” payment type

either a “Percentage” or a “Dollar Amount” Payment Scheme Type.

Panel
bgColor#B3D4FF

Dollar Amount

Under review.

Panel
bgColor#B3D4FF

Percentage Payment

The “Percentage” payment scheme keeps track of the percentage of assessments completed for the selected assessment schedule(s).

To set this scheme, create a name and select “Percentage” when creating a new payment scheme.

Image RemovedImage Added

The next form will establish the Level Name, Amount (in dollars), and Percentage.

  • Level Name - will appear as text in this payment schedule.

  • Amount (in dollars) - used to define the amount of credit the participant will earn for completing a certain percentage of surveys

  • Percentage - used to define requirements for the minimum percentage of surveys that need to be completed for a specific level of payment

To add Levels, click “Add a Row” and fill in required fields denoted by “*”.

image-20240731-152104.png

In the example above, the “75% - 100%” Level Name indicates that the participant needs to complete at least 75% of the total scheduled assessments selected to earn $20.01.

The resulting payment log will look the same for both Android and Apple users (shown right).

iPhonePaymentLogPercentFINAL.png

The next form will provide a list of schedules within Stages. To attach this payment scheme, check the box next to the schedule(s) you want to use. After selecting the schedule(s), click “Done.”

image-20240909-153608.png

Created payment schemes will appear in the payments tab. Schemes can be deleted by clicking on the red delete icon button next to the scheme.

image-20240522-201044.pngImage Removed

Panel
bgColor#B3D4FF

Payment Progress

Payment progress can be viewed in the app for completed assessments by following these steps: 1) creating a question with the “Payment Log” question type, 2) creating an assessment (or adding the question type to an already created assessment), and 3) creating a self-initiated schedule so that it will appear on the participant’s device.

Panel
bgColor#DEEBFF

Part 1 of 3: Create Question

After creating the payment scheme, create a new question by clicking on “+ Add a New Question.”

image-20240522-201439.pngImage Removed

Fill in the variable name, select “PaymentLog” for the question type, then continue to the second section of the form.

image-20240501-165338.pngImage Removed

Select the percent participation payment log type and click “Done.”

Image RemovedOnce the question has been created, an assessment will need to be

image-20240522-201044.pngImage Added

Once created, the last step is to implement this payment scheme in a Payment Log Question Type. Please go here to find out how to do so: https://mhealthotrc.atlassian.net/wiki/spaces/EDCW/pages/2923462660/Payment+Log#Payment-Progress .

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#4C9AFF

IMPORTANT NOTE: In order for a participant to see a payment scheme, it MUST be included in an Payment Log question and that question MUST be included in an assessment. Even if a payment scheme has been created in the study, participants will not see the scheme unless a Payment Log question has been created and put into an assessment.


This section shows how to interact with payments created.


Panel
bgColor
#DEEBFF

Part 2 of 3: Create Assessment

To create a new assessment, click “+ Add New Assessment.”

image-20240522-201649.pngImage Removed

Complete the required fields and click “Next.”

Panel
bgColor#C0B6F2
Assessment Timeout (minutes) –Allows studies to customize how long a specific assessment can be; when using Add/Edit/Clone Assessment operations.Image RemovedImage Removed

After confirming, the next section of form will allow you to add the assessment question called “PaymentProgress” to this assessment. To select this question, click the dropdown and a list of questions that have been created will appear. After selecting the question, click the “Done” button to ensure the question saved.

image-20240911-202549.pngImage Removed

After adding the question, click “Save” to create the assessment.

image-20240911-203059.pngImage Removed

The newly created assessment will appear in the list of created assessments.

image-20240522-202222.pngImage Removed

Panel
bgColor#DEEBFF

Part 3 of 3: Create Component

After creating the assessment, a component needs to be created within a stage.

To get started, click on the add component icon.

image-20240522-202719.pngImage Removed

A dialog box will appear with fields that need to be completed, select participant initiated. This will create a button on the app home screen. Select the assessment previously created named “Payment Log Example” and select groups that should receive the participant initiated assessment.

image-20240731-155821.pngImage Removed

plogbuttonFINAL.pngImage Removed

When you click “Next,” a confirmation dialog box will appear. Select “Yes” to save and continue.

The next section allows an assessment to prompt or be available on any selected days. Clicking on the blank field for “Days of the week” will populate a list of days that can be selected. In this example, the payment log can only be viewed Monday through Friday.

image-20240522-195840.pngImage Removed

A shortcut to selecting all days, selecting all weekdays, or selecting only weekends can be utilized by clicking on “Actions.”

image-20240522-200044.pngImage Removed

Maximum daily attempts are the number of times a participant can view/access the assessment. Interval total attempts are the total number of attempts an assessment can be viewed/accessed per stage. For this example, the payment log can be viewed a total of ten times in the participant’s current stage.

image-20240522-200221.pngImage Removed

After completing the scheduling details, the newly created component will appear under the stage it was created.

image-20240522-203920.pngImage Removed

Clicking “+“ expands, showing schedule details such as days of the week, maximum daily attempts, and maximum total attempts.

image-20240522-204135.pngImage RemovedTo make any edits, simply click on the edit icon for the specific schedule you would like to edit
#B3D4FF

Viewing and Marking Payments

The Payments tab also displays all payments created for every participant in the study ordered by the date they were created.

image-20241025-134200.pngImage Added

Click on the “View Payments” button to open a dialog box that displays all the payments created.

image-20241025-134346.pngImage Added

Each log will show every payment created across all participants in the study. Each line will show when the payment was created, when the last time the payment was updated, which participant the payment was created for, how much the payment is worth, the status of the payment, and an action to mark the payment as “Paid”.

Clicking on the “+” button beside the log will open up the history of the payment showing the past status and when the payment was in that status.

In the example above, the history of the $1 Paid log shows that the payment was in the “Created” status on 10/24/24 at 2:31:40 PM. The history of the $5 Created log is empty since no action has been taken.

PreviousButton.png
NextButton.png

Panel
bgColor#DEEBFF

Home | Submit a Ticket | SCC | Privacy