Account Settings allows each user to customize specific information regarding their own account as well as set up access to the API. The following sections discusses accessing, updating and viewing information for your user account.
Access Account Settings
You can navigate to the User Profile & Settings section from any page by clicking the Account Settings icon in the left side menu down towards the bottom. When your Account Settings page loads, by default, the user profile loads with access to a settings tab and API Management.
User Profile
From the User Profile tab, you can update your user and account information, such as your phone number, profile picture, email and password (unless using SSO).
Be sure to click SAVE in the upper right corner if you make any changes.
Settings
The settings under this tab will let you change your default settings sitewide.
Choose a Theme
- eLynx offers two themes, Light and Dark mode.
General Preferences
-
Offline Mode - Set your application to offline mode to do manual entry when not in an area with good coverage, allowing you to upload all of your data at one time.
- Data Grid Options - Default settings for all grids in the application. (Utilize the Graphic to see a preview of your choices)
- Font Size
- Cell Padding
- Page Size
Summary Listing / Site Listing Preferences
- Enabling 'Display function icons' will provide a column of shortcuts on your summary, or site listing that will take you directly to different functions, such as trending, with one simple click.
- Enabling 'Display devices in alarm at the top of the grid' will filter any devices in alarm state (if the tags have been configured on your summary/site listing) to the top of the device list.
- Enabling 'Display outlet devices at the top of the grid' will move any outlet devices to display at the top of the list.
Marketing Report Preferences:
- 'Sort Dates' allows you to choose the date sorting for your Marketing Reports.
Graph Preferences
- 'Data Tooltip Display' allows you to choose shared or separate. Shared on hover shows all data points on the graph in one tooltip pulling the closest data point to that time. Separate only displays the data value for the one line hovered over.
- 'Default Stacked View' allows you to choose the default number of stacked graph sections displayed on screen before needing to scroll.
Group Preferences
- 'Default View' Sets the default page you wish to have load when you access the application for all groups.
Gauge Sheet Preferences
Options for the Gauge sheet can be changed in the options panel and can be set as your default here.
- 'Gauge Sheet View' allows you to choose if you wish to see the gauge sheet in a spreadsheet view or in a form view.
- 'Show Device columns', checked by default, can be turned off to only show Tank Columns. (One must be checked.
- 'Show Tank Columns', checked by default, can be turned off to only show Device Columns. (One must be checked.
Tag Preferences
- 'Default Tag History View for Mobile' sets the default to either a chart view or a grid for mobile.
Be sure to click SAVE in the upper right corner if you make any changes.
API Management
The API allows for data retrieval (any report configured within the eLynx application can be accessed via the RunDataReport method) Accessing Attachments, Memo's, Alarms, Run Tickets, Dynacards, Diagnostic Events, Tag Data, and Production Targets.
API Accesss/Request Access
If you've already signed up, your API keys will be displayed, if not, simply click on the "Request API Access" link and your keys will be generated and displayed.
Your API keys will be shown on the screen and may be copied and used for authentication when creating your API request.
Key Expiration & Renewal
API keys are valid for six months after they are issued, the expiration date is shown directly below the key. We suggest you set a reminder on your calendar a few days before this date to renew your key before it expires. If you let your key expire you will need to setup a new key and update any applications or scripts with the new key.
Renewing your key is done via the same API Management tab of your User Profile. Next to both the Primary and Secondary keys there is a more options button which will open a menu and allow you to perform the four following actions.
- Copy: Copies the key to your clipboard.
- Regenerate: Revokes your existing key and generates a new key. You should do this if you feel security of the old key has been compromised.
- Renew: Extends the expiration date of the key to six months from today.
- Revoke: Removes the key from the system and prevents any data access using that key.
Additional Options
There are two additional links on the API MANAGEMENT tab. The first REMOVE API ACCESS will revoke both keys and no longer allow access to the API. The second will take you to the Developer portal which has documentation on all of the requests you can make via the API.
Automating Key Renewal
Renew and Regenerate key operations CAN BE automated using the API calls RenewAPIKey and RegenerateAPIKey as long as your current key is still valid. For this reason we STRONGLY recommend that when you are developing your interface to our API that you call the RenewAPIKey once per month for both your Primary and Secondary API keys. This will ensure that your scripts run for as long the user account the API key is assigned to is a valid user in the eLynx system.
Comments
0 comments
Please sign in to leave a comment.