Skip to content

Commit 03dd43a

Browse files
Addressing more PR comments
1 parent ac58991 commit 03dd43a

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/utility-guides/CallAndRecallUtils.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ These utilities interact directly with the **OracleDB** backend to run failsafe
1111
- [Main Methods](#main-methods)
1212
- [`run_failsafe`](#run_failsafe)
1313
- [`invite_subject_for_fobt_screening`](#invite_subject_for_fobt_screening)
14+
- [Prerequisites](#prerequisites)
1415
- [Supporting Classes](#supporting-classes)
1516
- [Example Usage](#example-usage)
1617

@@ -78,6 +79,18 @@ Transitions the subject into an **invited state** for FOBT screening.
7879

7980
---
8081

82+
## Prerequisites
83+
84+
Before using the Call and Recall utility, ensure that the following prerequisites are met:
85+
86+
1. **Database Access**: The utility requires access to the OracleDB instance where the relevant stored procedures are defined.
87+
88+
2. **NHS Number**: A valid NHS number must be provided for the subject being processed.
89+
90+
3. **Environment Variables**: As this utility relies on the `UserTools` utility you must ensure that you have correctly created and populated a `local.env` file. For more information on this [See the README](../../README.md)
91+
92+
---
93+
8194
## Supporting Classes
8295

8396
These classes are required by the utility:
@@ -93,8 +106,8 @@ These classes are required by the utility:
93106
## Example Usage
94107

95108
```python
109+
from utils.user_tools import UserTools
96110
from utils.call_and_recall_utils import CallAndRecallUtils
97-
from classes.user_role_type import UserRoleType
98111

99112
# Log in with a user and populate the user_role variable
100113
user_role = UserTools.user_login(

0 commit comments

Comments
 (0)