Versions Compared

Old Version 4

changes.mady.by.user Divya Prabhu (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user asawari

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Adding custom fields in Distribution Protocol

In v5.0, you OpenSpecimen allows you to add additional custom fields at the DP level and order level. These custom fields can include Lab Number, Approval ID, etc.

At Distribution Protocol level

You can configure the custom fields on the distribution protocols ( DP ) page to record additional information such as - lab number, center, etc. Once added, the pages will look like this:

...

Note:

...

SBRC Approval No. of votes, Project Number, and Grant Code are custom fields.

...

Expand
titleClick here to view steps..

Create DP level custom field

To configure custom fields at any level, you have to first create a new custom form (using the forms tool), which contains the fields

...

you want to

...

display on the DP or DP requirements pages. Refer to ‘How to create a form?’ to create a new form.

Create DP level custom field

Expand
titleClick here to expand
Go to the forms list page

Steps:

  1. Navigate to “Forms” card and select the form you created.

  2. Click on the 'Spanner' icon of the form to be attached.

  3. Select level as 'Distribution Protocol Custom Fields' from the 'select level' drop-down

  4. Click on 'Attach Form'.

Create DP Requirement level custom field

Similarly, you can also add custom fields at the DP requirements level. 

Expand
titleClick here to expand

  1. Go to the forms list page.

  2. Click on the 'Spanner' icon of the form (containing the desired fields) to be attached.

  3. Select level as ' DP Requirement Custom Fields' from the 'select level' drop-down

  4. Click on 'Attach Form'

Image Removed

Adding custom fields to Order level

...

Image Added

At Order level

Often, you need to collect additional data with each Order. E.g., shipping address, MTA document, etc. 

In v5.0, you You can create a custom form with fields to be displayed on the 'create orders' page. This can be configured either at the system level or distribution protocol ( DP ) level. 

Level

Description

System

Default custom fields for all the DPs.

DP 

This overrides the system configuration. This is useful when you want to collect different data per DP.

...

Expand
titleClick here to view the steps:

Step-1: Create a custom form

Refer to the wiki page on “How to create a form?

...

” Save and note the form identifier (The numeric code at the end of the URL).

Info

Note: Do not attach the form to any level as following the steps below will automatically attach it to ‘Order Custom Fields’ level

Step-2.a: Configure at the System level

...

titleinfo
Expand

Click here to expand

  1. Login as super admin

  2. Go to Home→ Settings→ Administrative→ Order Custom Fields Form

  3. Specify the identifier of the saved form

  4. Update the property

Step-2.b: Configure at Distribution Protocol level

Expand
titleClick here to expand
Go to

  1. Navigate to the ‘Distribution Protocols’ list page.

  2. Create new

or

  1. / edit the existing distribution protocol.

  2. Select the custom form that you created from the ‘Order Custom Fields’ drop-down.

  3. Click on 'Create'

or

  1. / 'Update'

Image RemovedImage Added

Once configured, the Order page will look like this:

...

Image Added

Note: 'Shipping address' and '

MTA document

Additional Data' are custom fields.

Create a query for custom fields

Order level custom fields can be queried using the query interface and displayed on the query results page.

Info

Note: You will only be able to query the custom form fields attached at the system level. There is no option to create a query on the form attached at the DP level in the field 'Order Custom Fields' 

...

Download order report

If any custom fields have been configured, those fields will be displayed in the downloaded order reportNote: For a regular user to access the Super Admin created order level custom field form,

  1. The regular user should have ‘Manage Form’ access.

  2. The regular user should have privileges of Create/Update/Delete access to the Distribution Protocol and Order etc. in their role.

  3. Super Admin should attach that form to the distribution protocol, which contains all the distribution sites accessible to the regular user.

  4. The form should not be attached to any other distribution protocol, which contains any distribution sites that are not accessible to the regular user.