Difference between revisions of "Users"

From FlexPoint documentation
Jump to: navigation, search
Line 1: Line 1:
 +
:
 +
=====5.1 Viewing Current Users=====
 
All current DRMS users from your organisations are listed in the User display on the ‘My Organisation’ tab. By clicking on each user, you will be able to see that users contact information and the user permissions associated with said user. However, the ability to view other users you will need to have the ‘Read Users’ permission activated.
 
All current DRMS users from your organisations are listed in the User display on the ‘My Organisation’ tab. By clicking on each user, you will be able to see that users contact information and the user permissions associated with said user. However, the ability to view other users you will need to have the ‘Read Users’ permission activated.
 +
 +
=====5.2 User Permissions=====
 +
When creating a user there are three sets of user permissions said user can potentially be granted. These user permissions and the corresponding descriptions are in the tables below:
 
:
 
:
 
{| class="wikitable"
 
{| class="wikitable"
Line 19: Line 24:
 
|-
 
|-
 
||''Read Users''
 
||''Read Users''
||Ability to see other organisation users and ability to see user roles
+
||Ability to see other organisation users
 +
:
 +
: Ability to see user roles
 
|-
 
|-
 
||''Write Users''
 
||''Write Users''
 
||Ability to create and edit organisation users
 
||Ability to create and edit organisation users
Ability to create user roles and assign roles to users
+
:
 +
: Ability to create user roles
 +
: Ability to assign roles to users
 
|-
 
|-
 
||''Read Sites''
 
||''Read Sites''
Line 33: Line 42:
 
||''Create Registrations''
 
||''Create Registrations''
 
||Ability to create new registrations
 
||Ability to create new registrations
Ability to receive "Registration Accepted/Rejected" notifications
+
:
|-
+
: Ability to receive "Registration Accepted/Rejected" notifications
||''Create Test Events''
 
||Unused
 
 
|-
 
|-
 
||''View Help''
 
||''View Help''
||
+
||Ability to access the help file
 
 
:
 
 
|-
 
|-
 
||''Read Device''
 
||''Read Device''
Line 67: Line 72:
 
||''Write Registration''
 
||''Write Registration''
 
||Ability to update draft registrations
 
||Ability to update draft registrations
Ability to create/update offers for a child event
+
:
 +
: Ability to create/update offers for a child event
 
|-
 
|-
 
||''Receive event notifications''
 
||''Receive event notifications''
||Ability to receive event status transition notifications for a child event - (submitted, window open, window closed, scheduled, dispatched, completed)
+
||Ability to receive event status transition notifications for a child event
 +
:
 +
: - (submitted, window open, window closed, scheduled, dispatched, completed)
 
|-
 
|-
 
||''Receive settlement notifications''
 
||''Receive settlement notifications''
Line 77: Line 85:
 
||''Submit Meter Data''
 
||''Submit Meter Data''
 
||Ability to upload ICP meter data for a registration
 
||Ability to upload ICP meter data for a registration
Ability to receive notifications prompting submission of meter data
+
:
 +
: Ability to receive notifications prompting submission of meter data
 
|-
 
|-
 
||''Download Meter Data''
 
||''Download Meter Data''
 
||Ability to visualize meter data for a registration
 
||Ability to visualize meter data for a registration
Ability to download meter data for a registration
+
:
 +
: Ability to download meter data for a registration
 
|}
 
|}
In order to create a new user under your organisation you have to have the create users permission activated. Additionally, when creating a new user you can only grant said user the permissions that you possess (i.e. if you don’t have the permission to ‘receive settlement notifications’ you cannot give a new user the permission to receive settlement notifications’).
+
5.3 Creating a New UserIn order to create a new user under your organisation you have to have the create users permission activated. Additionally, when creating a new user, you can only grant said user the permissions that you possess (i.e. if you don’t have the permission to ‘receive settlement notifications’ you cannot give a new user the permission to receive settlement notifications’).The information you will need to create a new user is:
 
 
: Image
 
The information you will need to create a new user is:
 
 
 
 
* Name
 
* Name
 
* Email Address
 
* Email Address
Line 93: Line 99:
 
* Whether or not the user needs/wants to receive SMS notifications
 
* Whether or not the user needs/wants to receive SMS notifications
  
: Image
+
There are three standard sets of user permissions granted when creating an organisations user. These set ups are as follows:'''Full User – '''A full user is a participant with the maximum permissions given to a DRMS user.'''Notification Recipient – '''A notification recipient is a user who only has access to the DRMS to ensure they are aware if their organisation is participating in events.'''Accounts Manager – '''An accounts manager is a user who only has access to the DRMS to have access to the settlement information located in the DRMS.
 
+
===5.4 Deactivating a User===
: Image
+
If you no longer want one of the users associated with your organisation to have access to the DRMS all you need to do is click on said user under the ‘My Organisation’ screen. By clicking on the pencil icon in the top left-hand corner you can transition the user from Active to Inactive.Please do not delete a user completely from the DRMS as this can impact the historic information stored on the DRMS about your organisation.
 
 
: Image
 

Revision as of 01:35, 2 July 2019

5.1 Viewing Current Users

All current DRMS users from your organisations are listed in the User display on the ‘My Organisation’ tab. By clicking on each user, you will be able to see that users contact information and the user permissions associated with said user. However, the ability to view other users you will need to have the ‘Read Users’ permission activated.

5.2 User Permissions

When creating a user there are three sets of user permissions said user can potentially be granted. These user permissions and the corresponding descriptions are in the tables below:

System Permissions
Read Api Docs Access to API docs page
Organisation Permissions
Read Organisation Ability to read own organisation
Write Organisation Ability to edit organisation details and organisation roles
Read Users Ability to see other organisation users
Ability to see user roles
Write Users Ability to create and edit organisation users
Ability to create user roles
Ability to assign roles to users
Read Sites Ability to see organisation sites
Write Sites Ability to create, read and update organisation sites
Create Registrations Ability to create new registrations
Ability to receive "Registration Accepted/Rejected" notifications
View Help Ability to access the help file
Read Device
Write Device
Device Test Events
Registration Permissions
Read Registration Ability to see registration and associated child-events
Write Registration Ability to update draft registrations
Ability to create/update offers for a child event
Receive event notifications Ability to receive event status transition notifications for a child event
- (submitted, window open, window closed, scheduled, dispatched, completed)
Receive settlement notifications Receive settlement related notifications (invoice created, child event withdrawn)
Submit Meter Data Ability to upload ICP meter data for a registration
Ability to receive notifications prompting submission of meter data
Download Meter Data Ability to visualize meter data for a registration
Ability to download meter data for a registration

5.3 Creating a New UserIn order to create a new user under your organisation you have to have the create users permission activated. Additionally, when creating a new user, you can only grant said user the permissions that you possess (i.e. if you don’t have the permission to ‘receive settlement notifications’ you cannot give a new user the permission to receive settlement notifications’).The information you will need to create a new user is:

  • Name
  • Email Address
  • Cell Phone Number
  • Whether or not the user needs/wants to receive SMS notifications

There are three standard sets of user permissions granted when creating an organisations user. These set ups are as follows:Full User – A full user is a participant with the maximum permissions given to a DRMS user.Notification Recipient – A notification recipient is a user who only has access to the DRMS to ensure they are aware if their organisation is participating in events.Accounts Manager – An accounts manager is a user who only has access to the DRMS to have access to the settlement information located in the DRMS.

5.4 Deactivating a User

If you no longer want one of the users associated with your organisation to have access to the DRMS all you need to do is click on said user under the ‘My Organisation’ screen. By clicking on the pencil icon in the top left-hand corner you can transition the user from Active to Inactive.Please do not delete a user completely from the DRMS as this can impact the historic information stored on the DRMS about your organisation.