Skip to content

Commit 328efb6

Browse files
committed
Updated documentation
1 parent 9a8d017 commit 328efb6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/DeveloperGuide.html

+6-2
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,13 @@ <h4>Setup for Non-Optional Integration Tests</h4>
139139
<li>Log in to your REDCap site.</li>
140140
<li>Create an empty project in REDCap.</li>
141141
<li>Create a project in REDCap for the &quot;Basic Demography,&quot; &quot;DAG,&quot; and &quot;Longitudinal Data&quot; 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>
143144
<li>Once you have your tokens, copy the &quot;config-example.ini&quot; file to a file
144145
named &quot;config.ini&quot; and then set the URL in that file to be the
145146
URL for the API of your REDCap instance, and set the tokens to be
146147
the tokens requested in the previous step.</li>
148+
<li>In the Control Center in REDCap, download the &quot;Date Calculated Fields&quot; external module and then enable it.</li>
147149
<li>In REDCap, enable the &quot;Date Calculated Fields&quot; external module for the &quot;Basic Demography&quot; project.</li>
148150
<li>In REDCap, add a test user to the DAG project, assigning only default, basic permissions. Add that user to the 'group1' DAG.</li>
149151
</ol>
@@ -240,6 +242,8 @@ <h4>Setup for Optional Project Creation Tests</h4>
240242
<strong>super.token</strong> to a valid super token value. Note that the tests for project creation
241243
have no way to delete the projects that are created, so they will need to be deleted
242244
manually.</p>
245+
<h4>Set the Timezone</h4>
246+
<p>Set the timezone property in the <strong>config.ini</strong> file.</p>
243247
<p>Note: the .gitignore file in PHPCap is set to ignore the <strong>tests/config.ini</strong> file, so that your
244248
personal API tokens will not be committed to Git. </p>
245249
<h4>Running the Automated Tests</h4>
@@ -312,7 +316,7 @@ <h3 id="Documentation">Documentation</h3>
312316
<li>HTML versions of the Markdown documentation in the docs-md/ directory, which are generated programmatically, stored in the <strong>docs/</strong> directory.</li>
313317
</ul>
314318
<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>
316320
<h4>API Document Generation</h4>
317321
<p>To generate the API documentation (stored in <strong>./docs/api</strong>), execute the following command in PHPCap's root directory:</p>
318322
<div class="description"><pre><code>phpdoc</code></pre></div>

0 commit comments

Comments
 (0)