forked from cityEHR/cityehr-documentation
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathconfiguring-a-runtime-application.dita
More file actions
177 lines (177 loc) · 10 KB
/
Copy pathconfiguring-a-runtime-application.dita
File metadata and controls
177 lines (177 loc) · 10 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
<topic id="configuring-a-runtime-application">
<title>Configuring a Runtime Application</title>
<shortdesc>There are two types of applications you can create. You can either create a new one from scratch, or one that is shipped with cityEHR (like Elfin, Elfin2, or Ponseti). Instructions for making a New Application can be found in Section 13.1, and instructions for making an application that is shipped can be found in Section 13.2 </shortdesc>
<body>
<section id="Creating-Your-Own-cityEHR-Application-New-Application">
<title>Creating Your Own cityEHR Application – New Application</title>
<p>These instructions assume you are making an application with the identifier myEHR. Note that this identifier can contain upper/lower case characters and digits but no spaces.</p>
<ol>
<li>
<p>Navigate to cityEHR Log-in Page</p>
</li>
<li>
<p>Enter user credentials. If you are starting from a blank database, the admin page will take a while to load. For this initial log-on, you will have to authenticate with username: user and password: password. This log-on may take some time as the system builds the application. Your screen may look like this:
</p>
<p>
<image href="images/log-on-page-loading.png" format="image/png">
<alt>cityEHR log on page loading</alt>
</image>
</p>
</li>
<li>
<p>Click "Start"</p>
<p>
<image href="images/log-on-page-start-button.png" format="image/png">
<alt>cityEHR log on page start up button</alt>
</image>
</p>
</li>
<li>
<p>Navigate to the Administration Page at the top right of the screen next to “Quit”. Click “Administration”.</p>
<p>
<image href="images/admin-view-button.png" format="image/png">
<alt>Primary Administrative page</alt>
</image>
</p>
</li>
<li>
<p>Now navigate to and click on “New Application” in the menu left of the screen. See below.</p>
<p>
<image href="images/admin-new-app.png" format="image/png">
<alt>New Application page within Administration</alt>
</image>
</p>
</li>
<li>
<p>Now enter an Application Id. For this exercise, we will name the Application Id “myEHR”. Ids can be made up of upper and lower case characters a-z, digits 0 to 9, and dashes (-) or underscores (_). There cannot be spaces in the Id. Some installation Ids have configurations shipped with the cityEHR installation and if you pick one of those Ids it will install that configuration for you. if you pick a new Id, then it starts from scratch. myEHR will be our new Id for this exercise.</p>
</li>
<li>
<p>Now click the button that has a check mark to verify your application Id.</p>
<p>
<image href="images/admin-new-app-verify-button.png" format="image/png">
<alt>Verifying the Application ID</alt>
</image>
</p>
</li>
<li>
<p>If this ID has never been used before, your screen will look like this:</p>
<p>
<image href="images/admin-new-app-config.png" format="image/png">
<alt>New application configuration</alt>
</image>
</p>
</li>
<li>
<p>You can change the display name of your new application and change the logos.</p>
</li>
<li>
<p>Once you are finished changing the display name and logos (if you want), you can now click on “Create New Application ID” identified by the lighting bolt. See image below.</p>
<p>
<image href="images/admin-new-app-config-create.png" format="image/png">
<alt>Creating a new application ID</alt>
</image>
</p>
</li>
<li>
<p>A Dialogue Box will appear. Click Confirm.</p>
<p>
<image href="images/admin-new-app-config-confirm.png" format="image/png">
<alt>Dialogue box to create new application</alt>
</image>
</p>
</li>
<li>
<p>cityEHR will now create your new application. This may take a few moments. Your
screen should now look like this, with three completed steps:</p>
<p>
<image href="images/admin-new-app-completed.png" format="image/png">
<alt>Page displayed when new application is created</alt>
</image>
</p>
</li>
<li>
<p>Once cityEHR has finished creating your application, navigate to “Quit” in the Purple Dashboard.</p>
</li>
<li>
<p>On the log-in page, you should now be able to select your new application in the drop-down menu.</p>
<p>
<image href="images/log-on-page-app-select.png" format="image/png">
<alt>Selecting alternative application on cityEHR log on page</alt>
</image>
</p>
</li>
<li>
<p> your application will be “empty” until you create, configure, and import an information model for your application. Navigate to section 13 called “Manipulating an Information Model” for instructions on how to do this.</p>
</li>
</ol>
</section>
<section id="Creating-a-Shipped-Application">
<title>Creating a Shipped Application</title>
<p>This section will teach you how to create an application that ships with cityEHR, such as Elfin or Elfin2. For this example, we will create an application with the id Elfin.</p>
<ol>
<li>
<p>Navigate to Administration page and then to “New Application” under “System” in the menu on the left of the screen.</p>
<p>
<image href="images/admin-new-app-nav.png" format="image/png">
<alt>Navigating to New Application in Administration</alt>
</image>
</p>
</li>
<li>
<p>Enter the shipped application id “Elfin” or “Elfin2” or “Ponseti”. For this exercise, enter the application ID “Elfin2”.</p>
<p>
<image href="images/admin-new-app-elfin.png" format="image/png">
<alt>Entering the shipped application name "Elfin2"</alt>
</image>
</p>
</li>
<li>
<p>Click “Verify Application Id” (the check mark icon) in the top right of the display screen.</p>
<p>
<image href="images/admin-new-app-elfin-verify.png" format="image/png">
<alt>Verifying the new application "Efin2"</alt>
</image>
</p>
</li>
<li>
<p>Your screen should now look like the one below if you have typed in Elfin2.</p>
<p>
<image href="images/admin-new-app-elfin-confirm.png" format="image/png">
<alt>Configuration page and dialogue box for Elfin</alt>
</image>
</p>
</li>
<li>
<p>If you have typed in “Ponseti” as the application ID, your screen will look like the one below.</p>
<p>
<image href="images/admin-new-app-config-ponseti.png" format="image/png">
<alt>Shipped application, Ponseti configuration page</alt>
</image>
</p>
</li>
<li>
<p>These are two applications that ship with cityEHR that can be created in your local database.</p>
<p>
<image href="images/admin-new-app-elfin-completed.png" format="image/png">
<alt>Page displayed when new application (Elfin) is created</alt>
</image>
</p>
</li>
<li>
<p>Now click “Create New Application” (lightning bolt icon) and wait for it to load. This may take a few minutes.</p>
</li>
<li>
<p>Once it has finished creating, navigate to Quit in the Purple Dashboard</p>
</li>
<li>
<p>You should now be able to select “Elfin 2” as an application from the log-in page</p>
</li>
<li>
<p>Click Start and you will be navigated to the start-up home page for Elfin2.</p>
</li>
</ol>
</section>
</body>
</topic>