interface/usergroup/adminacl_help.php

   1 <?php
   2 /**
   3  * Access Control List Help.
   4  *
   5  * @package   OpenEMR
   6  * @link      http://www.open-emr.org
   7  * @author    Ranganath Pathak <pathak01@hotmail.com>
   8  * @copyright Copyright (c) 2017 Ranganath Pathak <pathak01@hotmail.com>
   9  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  10  */
  11
  12
  13 require_once("../globals.php");
  14
  15 use OpenEMR\Core\Header;
  16
  17 ?>
  18 <!DOCTYPE HTML>
  19 <html>
  20     <head>
  21     <?php Header::setupHeader();?>
  22     <title><?php echo xlt("Access Control List Help");?></title>
  23     <style>
  24         .oe-help-heading{
  25             color:#676666;
  26             background-color: #E4E2E0;
  27             border-color: #DADADA;
  28             padding: 10px 5px;
  29             border-radius: 5px;
  30         }
  31         .oe-help-redirect{
  32             color:#676666;
  33         }
  34         a {
  35             text-decoration: none !important;
  36             color:#676666 !important;
  37             font-weight:700;
  38         }
  39         h2 > a {
  40             font-weight:500;
  41         }
  42         @media only screen and (max-width: 768px) {
  43            [class*="col-"] {
  44            width: 100%;
  45            text-align:left!Important;
  46             }
  47         }
  48         @media only screen and (max-width: 1004px) and (min-width: 641px)  {
  49             .oe-large {
  50                 display: none;
  51             }
  52             .oe-small {
  53                 display: inline-block;
  54             }
  55         }
  56     </style>
  57     </head>
  58     <body>
  59         <div class="container">
  60             <div>
  61                 <center><h2><a name = 'entire_doc'><?php echo xlt("Access Control Lists");?></a></h2></center>
  62             </div>
  63             <div class= "row">
  64                 <p><?php echo xlt("A large application like openEMR is used by a multitude of users with varying roles and degrees of responsibility. It is imperative that access to various parts of the program be granted to users on a need to know basis. To achieve this - Access Control Lists (ACL) are used.");?>
  65
  66                 <p><?php echo xlt("These lists are used to determine who can access what in openEMR. They work in a top down manner, i.e. initially everybody is denied access to those parts of the program controlled by the ACL.");?>
  67
  68                 <p><?php echo xlt("Access is then granted selectively to portions of the program on a need to know basis.");?>
  69
  70                 <p><?php echo xlt("The parts of the program to which access can be controlled are called Access Control Objects (ACOs). ");?>
  71
  72                 <p><?php echo xlt("These ACOs are grouped into ten broad categories that are part of the default installation. They are - Administration, Accounting, Patient Information, Encounter Information, Squads, Sensitivities, Lists, Placeholder, Nation Notes and Patient Portal. Each of these categories has one or several sub-categories that provide access to specific parts of the program."); ?>
  73
  74
  75                 <p><?php echo xlt("These sub-categories represent the actual Access Control Objects (ACOs)."); ?>
  76
  77                 <p><?php echo xlt("The entire collection of ACOs forms the Access Control List (ACL)."); ?>
  78
  79                 <p><?php echo xlt("Rather than granting access to each ACO individually for each user the program grants access to groups that request these privileges. These groups are called Access Request Objects (ARO)."); ?>
  80
  81                 <p><?php echo xlt("The default installation has six such groups - Accounting, Administrators, Clinicians, Emergency Login, Front Office and Physicians."); ?>
  82
  83                 <p><?php echo xlt("Each of these groups (AROs) has access to pre-determined parts of the program (ACOs)."); ?>
  84
  85                 <p><?php echo xlt("Individual access can be tailored to fit the needs by assigning a user to one or more groups (AROs). The user will then inherit all the privileges, i.e have access to parts of the program (ACO), of each group (ARO) the user belongs to."); ?>
  86
  87                 <p><?php echo xlt("When a new user is created, access control is granted by the administrator or by a user with similar privileges by selecting which groups (AROs) a user can belong to."); ?>
  88
  89                 <p><?php echo xlt("This is done in Administration > Users."); ?>
  90
  91                 <p><?php echo xlt("If privileges have to be modified then it can be done either one user at a time at Administration > Users or more conveniently on this page i.e. Administration > ACL where all users are listed on one page and more options are available."); ?>
  92
  93                 <p><?php echo xlt("To see to all the ACOs that are available click on the eye icon."); ?>&nbsp <i id="show_hide" class="fa fa-eye fa-lg small" title="<?php echo xla('Click to Show'); ?>"></i>
  94
  95                 <div id="aco_list" class='hideaway' style='display: none;'>
  96                     <ul>
  97                         <li><strong><?php echo xlt('Administration (admin)');?></strong></li>
  98                             <ul>
  99                                 <li><?php echo xlt('Superuser - can delete patients, encounters, issues (super)');?></li>
 100                                 <li><?php echo xlt('Calendar Settings (calendar)');?></li>
 101                                 <li><?php echo xlt('Database Reporting (database)');?></li>
 102                                 <li><?php echo xlt('Forms Administration (forms)');?></li>
 103                                 <li><?php echo xlt('Practice Settings (practice)');?></li>
 104                                 <li><?php echo xlt('Superbill Codes Administration (superbill)');?></li>
 105                                 <li><?php echo xlt('Users/Groups/Logs Administration (users)');?></li>
 106                                 <li><?php echo xlt('Batch Communication Tool (batchcom)');?></li>
 107                                 <li><?php echo xlt('Language Interface Tool (language)');?></li>
 108                                 <li><?php echo xlt('Pharmacy Dispensary (drugs)');?></li>
 109                                 <li><?php echo xlt('ACL Administration (acl)');?></li>
 110                             </ul>
 111                         <li><strong><?php echo xlt('Accounting (acct)');?></strong></li>
 112                             <ul>
 113                                 <li><?php echo xlt('Billing (write optional) (bill)');?></li>
 114                                 <li><?php echo xlt('Allowed to discount prices (in Fee Sheet or Checkout form) (disc)');?></li>
 115                                 <li><?php echo xlt('EOB Data Entry (eob)');?></li>
 116                                 <li><?php echo xlt('Financial Reporting - my encounters (rep)');?></li>
 117                                 <li><?php echo xlt('Financial Reporting - anything (rep_a)');?></li>
 118                             </ul>
 119                         <li><strong><?php echo xlt('Patient Information (patients)');?></strong></li>
 120                             <ul>
 121                                 <li><?php echo xlt('Appointments (write,wsome optional) (appt)');?></li>
 122                                 <li><?php echo xlt('Demographics (write,addonly optional) (demo)');?></li>
 123                                 <li><?php echo xlt('Medical Records and History (write,addonly optional) (med)');?></li>
 124                                 <li><?php echo xlt('Transactions, e.g. referrals (write optional) (trans)');?></li>
 125                                 <li><?php echo xlt('Documents (write,addonly optional) (docs)');?></li>
 126                                 <li><?php echo xlt('Patient Notes (write,addonly optional) (notes)');?></li>
 127                                 <li><?php echo xlt('Sign Lab Results (write,addonly optional) (sign)');?></li>
 128                             </ul>
 129                         <li><strong><?php echo xlt('Encounter Information (encounters)');?></strong></li>
 130                             <ul>
 131                                 <li><?php echo xlt('Authorize - my encounters (auth)');?></li>
 132                                 <li><?php echo xlt('Authorize - any encounters (auth_a)');?></li>
 133                                 <li><?php echo xlt('Coding - my encounters (write,wsome optional) (coding)');?></li>
 134                                 <li><?php echo xlt('Coding - any encounters (write,wsome optional) (coding_a)');?></li>
 135                                 <li><?php echo xlt('Notes - my encounters (write,addonly optional) (notes)');?></li>
 136                                 <li><?php echo xlt('Notes - any encounters (write,addonly optional) (notes_a)');?></li>
 137                                 <li><?php echo xlt('Fix encounter dates - any encounters (date_a)');?></li>
 138                                 <li><?php echo xlt('Less-private information (write,addonly optional) (relaxed)');?></li>
 139                             </ul>
 140                         <li><strong><?php echo xlt('Squads (squads)');?></strong></li>
 141                         <li><strong><?php echo xlt('Sensitivities (sensitivities)');?></strong></li>
 142                             <ul>
 143                                 <li><?php echo xlt('Normal (normal)');?></li>
 144                                 <li><?php echo xlt('High (high)');?></li>
 145                             </ul>
 146                         <li><strong><?php echo xlt('Lists (lists)');?></strong></li>
 147                             <ul>
 148                                 <li><?php echo xlt('Default List (write,addonly optional) (default)');?></li>
 149                                 <li><?php echo xlt('State List (write,addonly optional) (state)');?></li>
 150                                 <li><?php echo xlt('Country List (write,addonly optional) (country)');?></li>
 151                                 <li><?php echo xlt('Language List (write,addonly optional) (language)');?></li>
 152                                 <li><?php echo xlt('Ethnicity-Race List (write,addonly optional) (ethrace)');?></li>
 153                             </ul>
 154                         <li><strong><?php echo xlt('Placeholder (placeholder)');?></strong></li>
 155                             <ul>
 156                                 <li><?php echo xlt('Placeholder (Maintains empty ACLs) (filler)');?></li>
 157                             </ul>
 158                         <li><strong><?php echo xlt('Nation Notes (nationnotes)');?></strong></li>
 159                             <ul>
 160                                 <li><?php echo xlt('Nation Notes (nn_configure)');?></li>
 161                             </ul>
 162                         <li><strong><?php echo xlt('Patient Portal (patientportal)');?></strong></li>
 163                             <ul>
 164                                 <li><?php echo xlt('Patient Portal (portal)');?></li>
 165                             </ul>
 166                     </ul>
 167                 </div>
 168
 169                 <p><?php echo xlt("The ACL page two sections."); ?>
 170                 <ul id="listed_items">
 171                     <li><a href="#users_section"><?php echo xlt("User Memberships");?></a></li>
 172                     <li><a href="#groups_section"><?php echo xlt("Groups and Access Controls");?></a></li>
 173                 </ul>
 174             </div>
 175             <div class= "row" id="users_section">
 176                 <h4 class="oe-help-heading"><?php echo xlt("User Memberships"); ?><a href="#listed_items"><i class="fa fa-arrow-circle-up float-right oe-help-redirect" aria-hidden="true"></i></a></h4>
 177                 <p><?php echo xlt("By default the User Memberships section is selected and all the active registered users will be listed in alphabetical order by their user names."); ?>
 178
 179                 <p><?php echo xlt("Clicking on the icon next to their name will bring up the 'Edit' window."); ?>
 180
 181                 <p><?php echo xlt("The 'Edit' window is divided into two columns, 'Active' and 'Inactive'. The groups (AROs) that are listed in the active column are those groups that the user belongs to."); ?>
 182
 183                 <p><?php echo xlt("The user's actual privileges are determined by the access to the parts of the program i.e. (ACO) that each group (ARO) has."); ?>
 184
 185                 <p><?php echo xlt("To move the groups from one column to another select one or more items from the column that you need to move them out of and press the relevant button with the double chevrons."); ?> <input class='button_submit' type='button' value=' >> ' >&nbsp;&nbsp;<input class='button_submit' type='button' value=' << ' >
 186
 187                 <p><?php echo xlt("To select multiple groups hold down the 'Shift' or 'Ctrl' keys while clicking."); ?>
 188
 189                 <p><i class="fa fa-exclamation-circle" style="color:orange" aria-hidden="true"></i> <strong><?php echo xlt("Note there is no 'Save' button."); ?></strong>
 190             </div>
 191             <div class= "row" id="groups_section">
 192                 <h4 class="oe-help-heading"><?php echo xlt("Groups and Access Controls"); ?><a href="#listed_items"><i class="fa fa-arrow-circle-up float-right oe-help-redirect" aria-hidden="true"></i></a></h4>
 193                 <p><?php echo xlt("Checking the Groups and Access Controls checkbox will reveal this section that lists all the categories with sub-categories (ACOs), i.e. the parts of the program controlled by the access control list privileges."); ?>
 194
 195                 <p><?php echo xlt("It also lets you create new groups (AROs) as well as remove existing ones."); ?>
 196
 197                 <p><?php echo xlt("These groups (AROs) can then be given a set of privileges by assigning different categories (ACOs)."); ?>
 198
 199                 <p><i class="fa fa-exclamation-circle" style="color:orange" aria-hidden="true"></i> <strong><?php echo xlt("This section DOES NOT let you create new ACOs."); ?></strong>
 200
 201                 <p><?php echo xlt("There are three actions that can be performed here - edit an existing group (ARO), add a new group (ARO) or delete an existing group (ARO)."); ?>
 202
 203                 <p><strong><?php echo xlt("EDIT EXISTING GROUP"); ?> :</strong>
 204
 205                 <p><?php echo xlt("To edit an existing group (ARO) click on the icon next to the desired group. This will bring up the edit window."); ?>
 206
 207                 <p><?php echo xlt("The items listed in the 'Active' column delineate the privileges of this group (ARO) and constitutes this group's Access Control List (ACL)."); ?>
 208
 209                 <p><?php echo xlt("Move the individual items from 'Active' to 'Inactive' or vice-versa by selecting the items and pressing the relevant button with the double chevron."); ?>  <input class='button_submit' type='button' value=' >> ' >&nbsp;&nbsp;<input class='button_submit' type='button' value=' << ' >
 210
 211                 <p><i class="fa fa-exclamation-circle" style="color:orange" aria-hidden="true"></i> <strong><?php echo xlt("Note there is no 'Save' button."); ?></strong>
 212
 213                 <p><?php echo xlt("Click the slashed-eye icon to close."); ?>
 214
 215                 <p><strong><?php echo xlt("ADD NEW GROUP"); ?> :</strong>
 216
 217                 <p><?php echo xlt("Click the 'Add New Group' button to display the 'New Group Information' section."); ?>
 218
 219                 <p><?php echo xlt("The Title will be the name of the new group (ARO) that you are going to create."); ?>
 220
 221                 <p><?php echo xlt("Use a unique word to identify this group, it has to be a single word, if using two words link them together with an underscore or hyphen."); ?>
 222
 223                 <p><?php echo xlt("Choose one of the four return values that reflect varying degrees of privilege."); ?>
 224                     <ul>
 225                         <li><?php echo xlt("view - can only read but not add or modify"); ?></li>
 226                         <li><?php echo xlt("addonly - can read and add but not modify"); ?></li>
 227                         <li><?php echo xlt("wsome - can read and partially modify"); ?></li>
 228                         <li><?php echo xlt("write - can read and fully modify"); ?></li>
 229                     </ul>
 230
 231                 <p><?php echo xlt("A short description of this group that will appear when you hover over the newly created group (ARO)."); ?>
 232
 233                 <p><i class="fa fa-exclamation-triangle" style="color:red" aria-hidden="true"></i> <strong><?php echo xlt("Review all the parameters that are entered and only then move to the next step. This is because once you create a group (ARO) you will NOT be able of modify any of the data that you have entered in THIS section. You can only delete the entire group (ARO) and start afresh."); ?></strong>
 234
 235                 <p><?php echo xlt("Click on the 'Add Group' button to create this new group (ARO)."); ?>
 236
 237                 <p><?php echo xlt("The group (ARO) that you created will now appear in alphabetical order in the 'Groups and Access Controls' section."); ?>
 238
 239                 <p><?php echo xlt("If you click on the edit icon next to this newly created group (ARO) you will note that the 'Active' column contains only a single entry - Placeholder (Maintains empty ACLs). As yet this new group (ARO) has NO access to any part of the program as there are no ACOs assigned in the 'Active' column."); ?>
 240
 241                 <p><?php echo xlt("Add desired privileges by moving items (ACOs) from the 'Inactive' column to the 'Active' column."); ?>
 242
 243                 <p><i class="fa fa-exclamation-circle" style="color:orange" aria-hidden="true"></i> <strong><?php echo xlt("Note there is no 'Save' button."); ?></strong>
 244
 245                 <p><?php echo xlt("You can close the edit box by clicking on the 'slashed eye' icon next to the group's name."); ?>
 246
 247                 <p><?php echo xlt("If you click on any user in the 'User Memberships' section you will now see these newly created group (ARO) in the 'Inactive' column. These can now be assigned in the usual fashion as needed."); ?>
 248
 249                 <p><strong><?php echo xlt("REMOVE GROUP"); ?> :</strong>
 250
 251                 <p><?php echo xlt("Click the 'Remove Group' button to display the 'Remove Group Form'."); ?>
 252
 253                 <p><?php echo xlt("Select the group (ARO) that you wish to remove."); ?>
 254
 255                 <p><?php echo xlt("Click the 'Yes' radio button."); ?>
 256
 257                 <p><?php echo xlt("Click the 'Delete Group' button to completely remove this group."); ?>
 258             </div>
 259             <div class= "row" id="advanced_acl">
 260                 <h4 class="oe-help-heading"><?php echo xlt("Advanced - Finer Access Control"); ?><a href="#"><i class="fa fa-arrow-circle-up float-right oe-help-redirect" aria-hidden="true"></i></a></h4>
 261                 <p><?php echo xlt("Click on the icon next to the 'Access Control List Administration' title to go to the phpGACL page."); ?> <i id='advanced' class='fa fa-external-link small' aria-hidden='true'></i>
 262
 263                 <p><?php echo xlt("Here you can customize the ACL further."); ?>
 264
 265                 <p><?php echo xlt("You have to have an understanding how the program is structured and the ability and willingness to modify the underlying code."); ?>
 266
 267                 <p><?php echo xlt("Click on the the following link to learn more about what is involved."); ?> <strong><a href="http://www.open-emr.org/wiki/index.php/ACL_Fine_Granular_Control" target="_blank"><?php echo xlt("ACL Fine Granular Control"); ?></a></strong>
 268
 269                 <p><?php echo xlt("Best of Luck."); ?> :)
 270             </div>
 271         </div><!--end of container div-->
 272         <script>
 273            $('#show_hide').click(function() {
 274                 var elementTitle = $('#show_hide').prop('title');
 275                 var hideTitle = '<?php echo xla('Click to Hide'); ?>';
 276                 var showTitle = '<?php echo xla('Click to Show'); ?>';
 277                 $('.hideaway').toggle('1000');
 278                 $(this).toggleClass('fa-eye-slash fa-eye');
 279                 if (elementTitle == hideTitle) {
 280                     elementTitle = showTitle;
 281                 } else if (elementTitle == showTitle) {
 282                     elementTitle = hideTitle;
 283                 }
 284                 $('#show_hide').prop('title', elementTitle);
 285             });
 286         </script>
 287     </body>
 288 </html>