You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DeveloperGuide.html
+6-2
Original file line number
Diff line number
Diff line change
@@ -139,11 +139,13 @@ <h4>Setup for Non-Optional Integration Tests</h4>
139
139
<li>Log in to your REDCap site.</li>
140
140
<li>Create an empty project in REDCap.</li>
141
141
<li>Create a project in REDCap for the "Basic Demography," "DAG," and "Longitudinal Data" test projects in directory <strong>tests/projects/</strong>, and import each of those test project files into the REDCap project created for it.</li>
142
-
<li>In REDCap, request API tokens for the empty project and the projects imported in the step above.</li>
142
+
<li>In REDCap, request API tokens for the empty project and the projects imported in the step above. Make sure that user setting for each
143
+
project allow API import and export.</li>
143
144
<li>Once you have your tokens, copy the "config-example.ini" file to a file
144
145
named "config.ini" and then set the URL in that file to be the
145
146
URL for the API of your REDCap instance, and set the tokens to be
146
147
the tokens requested in the previous step.</li>
148
+
<li>In the Control Center in REDCap, download the "Date Calculated Fields" external module and then enable it.</li>
147
149
<li>In REDCap, enable the "Date Calculated Fields" external module for the "Basic Demography" project.</li>
148
150
<li>In REDCap, add a test user to the DAG project, assigning only default, basic permissions. Add that user to the 'group1' DAG.</li>
149
151
</ol>
@@ -240,6 +242,8 @@ <h4>Setup for Optional Project Creation Tests</h4>
240
242
<strong>super.token</strong> to a valid super token value. Note that the tests for project creation
241
243
have no way to delete the projects that are created, so they will need to be deleted
242
244
manually.</p>
245
+
<h4>Set the Timezone</h4>
246
+
<p>Set the timezone property in the <strong>config.ini</strong> file.</p>
243
247
<p>Note: the .gitignore file in PHPCap is set to ignore the <strong>tests/config.ini</strong> file, so that your
244
248
personal API tokens will not be committed to Git. </p>
<li>HTML versions of the Markdown documentation in the docs-md/ directory, which are generated programmatically, stored in the <strong>docs/</strong> directory.</li>
313
317
</ul>
314
318
<p>Since all documentation in the <strong>docs/</strong> directory (except for the README.md file) is automatically
315
-
generated, these files should not be editied manually.</p>
319
+
generated, these files should not be edited manually.</p>
316
320
<h4>API Document Generation</h4>
317
321
<p>To generate the API documentation (stored in <strong>./docs/api</strong>), execute the following command in PHPCap's root directory:</p>
0 commit comments