= OpenSpecimen HowTo Use Expedited Entry for a Study

Tags: [[OpenSpecimen]] [[HowTo]]

== Procedure 1

- Find the `cp_id` of the protocal to use the expedited method.  This can be obtained from the URL when viewing the protocol or its participants.  For example `https://www15.lamp.le.ac.uk/openspecimen/#/cp-view/12/participants`
2. Log into the database and select the record from the `os_cp_workflows` table:

{{{
#!sql
SELECT * FROM os_cp_workflows;
}}}

3. Take note of the `CP_ID` of a process that currently uses the expedited method.
4. Duplicate the existing record with the new ID:

{{{
#!sql
INSERT INTO os_cp_workflows SELECT {new_cp_id}, WORKFLOWS FROM os_cp_workflows WHERE CP_ID = {old_cp_id};
}}}

5. Stop Tomcat
6. Make sure that the Java process has stopped using `ps -f` and killing the process if necessary.
7. Start Tomcat

== Procedure 2

The settings are set using the REST API. See [[https://openspecimen.atlassian.net/wiki/display/CAT/UK+configuration;jsessionid=DAE0BD2C084248321CE32F05F0966221|OpenSpecimen REST API Documentation]].

- The `cp_id` is the id of the protocol and can be obtained from the URL when viewing the protocol or its participants.  For example `https://www15.lamp.le.ac.uk/openspecimen/#/cp-view/12/participants`
- Use Postman or other HTTP utility to make the following request:

 URL:: http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols/{cp_id}/workflows
 Method:: PUT
 Content-Type:: application/json
 parameter:: cp_id using the value from above.
 Request Body::

{{{
[
  {
    "name":"registerParticipant",
    "view":"plugin-ui-resources/le/collect-specimens.html",
    "ctrl":"leRegAndCollectSpecimensCtrl",
    "data":{
      "boxOpts":{
        "dimension":{
          "rows":8,
          "columns":12
        },
        "compact":false
      }
    }
  }
]
}}}

 Response Body::
{{{

{
    "cpId": <cp_id>,
    "shortTitle": <cp_short_title>,
    "workflows": {
        "registerParticipant": {
            "name": "registerParticipant",
            "view": "plugin-ui-resources/le/collect-specimens.html",
            "ctrl": "leRegAndCollectSpecimensCtrl",
            "data": {
                "boxOpts": {
                    "dimension": {
                        "rows": 8,
                        "columns": 12
                    },
                    "compact": false
                }
            }
        }
    }
}
}}}
- The setting can be deleted by updating all the values to empty using the REST API.  For example

{{{
[
  {
    "name": "",
    "view": "",
    "ctrl": "",
    "data": {  }
  }
]
}}}
- I used Postman to get it to work.  I had to supply my username and password in the Basic Auth section.
- Also need to set up auto label formats - see [[https://openspecimen.atlassian.net/wiki/x/doB1]]

[[BackLinks]]