The Object Management tool in the eLynx application allows you to create and manage Devices and Wells within the application. This tool can be used to add new Manual Entry points, alarm cry-out devices (our single and multi-input kits), enable and disable devices, and for our Premium Tier customers create Well objects for use with the Production Dashboard.
Only users with the appropriate administrative permissions in the application will have access to the "Manage Objects" tool.
Manage Objects is available in both the Desktop and Mobile presentations, most screenshots in this article are from the Desktop presentation unless otherwise noted.
Topics covered in this document are:
Accessing Manage Objects
You can launch Manage Objects from the Object Administration menu in the Administrative Tools.
The system will display the Manage Objects screen as shown below:
This screen will list all of the Devices and Wells in the current group, you can use the Group Picker above the list to change which group you are managing.
Adding a New Device
New Device objects can be added to the system by ensuring that the Device Tab is selected, then clicking the Add button in the upper right corner.
Note: By default objects added via Manage Objects are either cry-out devices (you will need the IMEI number from the physical device), or Manual Entry devices. IF you are a WebHost customer and are wishing to link a new device in your in-house SCADA system to eLynx Historian services our Support Staff can create a template for you that will allow you to manage adding devices with this tool that link back to your system. For standard Poll and Host Devices please contact our Support Staff for assistance. Any Devices added via this tool will be added to your account per the terms of your contract.
When you click on the Add button a screen will be opened to capture information on new Device.
Image of Add Device screen when in Copy from Existing Device mode.
The first thing you must do is select the appropriate Template Action from the drop-down menu. The choices are:
Copy from Existing Device - This will create a new Manual Entry device with a set of tags that match an existing Device in your system.
Create from Template - This will create a new Manual Entry (or WebHost with an appropriate template) Device with a list of tags as specified in a selected template. (Please see the article on Template Administration for information on creating templates.) Templates are useful if you want to create a new Device with a sub-set of tags from another Device.
Create Sat4DI Device - This is used to setup one of our Sat4DI Iridium based alarming devices.
Create Alarm Cry-out Modem Device - This is used to setup one of our Single Input or Multi Input cellular based alarming devices.
In addition, our eLynx Water Systems customer will have one additional option:
Create Water Leak Detection Device - This is used to setup one of our Water Pressure monitoring kits for use in monitoring and alarming on pressure losses that could indicate a Water Leak in your distribution system.
Since the rest of the screen changes based on this selection each option will be covered separately here:
Copy from Existing Device
Required Fields:
Device - Click the Pencil Icon to select the Device that will provide the list of Tags to create on the new Device. Once you have selected the source Device a list of Tags that will be created will be shown on the screen.
Device Name - Enter a name for the Device you are creating, this name must be unique for this Device, the system will validate the entry, an error will be displayed if the name is already in use.
Contract Hour - Click the drop-down arrow on this field and select the Contract Hour from the list that will be used to determine the time used for Daily tags and aggregations.
Identifier or Path - For WebHost customers this MUST match the name of the object in your in-house SCADA system exactly. For normal manual entry devices this value must be unique to this device and is generally some form of the device name. For instance, if I were to create a Device with the Device Name of "Bald Eagle Del 3" then I might use something like "BALDEAGLE3" for the Identifier.
Optional Fields:
Latitude - If you want this device to be included on a Map View in the system then enter the Latitude in this field in decimal degrees. (+ values for North latitudes, - numbers for south)
Longitude - As with the Latitude enter the value in decimal degrees. (- values for West longitudes, + values for East longitudes). Most web mapping applications (i.e. Google Maps) will allow you to drop a pin on the map and will display these values exactly as they need entered here.
Once all information is entered click the SAVE button to create the device....
Create from Template
The only difference between Copy from Existing Device and Create from Template is the first field, instead of Device it will change to Template and clicking the Pencil icon will display a list of Templates that you may use. All other fields are the same as the section above.
Create Sat4DI Device
Mobile View of the Create Sat4DI Device
Device Name - Enter a name for the Device you are creating, this name must be unique for this Device, the system will validate the entry, an error will be displayed if the name is already in use.
IMEI - Enter the IMEI number from the sticker on the Sat4DI device you are installing.
Tags
Note: The system will automatically add a Tag to the new Device to receive and store the Battery Voltage as measured by the Device.
You will need to click the ADD TAG button above the Tag list and add information for each input (up to four) you intend to use on the Device. That screen looks like this:
For each input four properties are required:
Tag Name - Enter a name to be used in the eLynx system for this input.
Summary Listing Tab - Click the drop-down to select AlarmLynx or CompressorLynx to determine which of these tabs this tag should appear under when looking at a Summary Listing.
Discrete Input - Click the drop-down to select which of the four inputs you are using for this Tag.
Wiring - Use the drop-down to select whether this input is wired Normally Open or Normally Closed.
After all the information is entered click the ADD button to return to the Create screen.
You may repeat the steps above to add additional inputs as required.
Once all Tags have been created click the SAVE button to create the Device.
NOTE: This will create the Device and Tags in the system but you will still need to use the Device Details or Tag Details screens to setup delivery of Alarm notifications.
Create Alarm Cry-out Modem Device
This device is setup identically to the Sat4DI device, the only difference is you have a choice of up to five inputs on these devices, please see the section above for details.
Create Water Leak Detection Device (Water Customers Only)
Mobile view of the Water Leak Detection Device setup screen.
Device Name - Enter a name for the Device you are creating, this name must be unique for this Device, the system will validate the entry, an error will be displayed if the name is already in use.
IMEI - Enter the IMEI number from the sticker on the Sat4DI device you are installing.
Max Sensor PSI - Use the drop-down to select the Pressure Rating for the transducer included with the kit (100/150/200/300 PSI).
Hydrostatic Analysis - If you have an analysis, or a known normal pressure expected at this location you can enter that here, the system will then calculation variances from that value in both absolute pressure and percent.
Latitude - If you want this device to be included on a Map View in the system then enter the Latitude in this field in decimal degrees. (+ values for North latitudes, - numbers for south)
Longitude - As with the Latitude enter the value in decimal degrees. (- values for West longitudes, + values for East longitudes). Most web mapping applications (i.e. Google Maps) will allow you to drop a pin on the map and will display these values exactly as they need entered here.
Once all information is entered click the SAVE button to create the device....
NOTE: This will create the Device and Tags in the system but you will still need to use the Device Details or Tag Details screens to setup delivery of Alarm notifications.
Other Device Options
Each Device card in the Devices tab has a more options menu button on its right edge:
Clicking this button will open a menu with options to Apply a Template to this device or to manage the manual entry tags on this device.
Apply Template
When you select Apply Template a new screen will open and you will need to fill in the following information:
Template - click the pencil icon to select which template you wish to apply to the Device. Once you have selected a Template the system will display a line of text with information about how many Tags are defined in the Template and how many will be added to the Device.
Note: Only tags that do not already exist on the device will be processed, if you select and template and it shows "0 tags will be applied..." then all of the Tags in the Template already exist on the Device.
Contract Hour - click the drop down arrow to select the contract hour for the new tags, Other contract hours already in use on the Device will be shown at the top to make it easy to match the rest of the Tags on the Device.
Identifier or Path - If the Device has Tags fed via SCADA the identifier will automatically default to using the same identifier here, this field is required so if the system does not automatically populate it then you will need to provide an entry here, usually a shortened form of the Device name.
Once the information is filled in click the SAVE button in the upper right corner to add the Tags to the Device.
Manage Tags
When you select Manage Tags a new screen will open and show you a list of manual entry tags on the current Device,
You can Add new manual entry tags by clicking the + button in the upper right corner a pop up window will open to gather information about the Tag you wish to add.
Enter the following information:
Tag Name - The name you would like displayed for this Tag
Contract Hour - click the drop down arrow to select the contract hour for the new tags, Other contract hours already in use on the Device will be shown at the top to make it easy to match the rest of the Tags on the Device.
Unit of Measure - click the drop down to see a list of supported Units of Measure. These are grouped by types so for instance if we wanted Barrels we would scroll to the Volume (Liquid) section of the list and select Barrels.
Decimal Places - Enter the number of decimal places for the system to use for this Tag.
Tag Type - This is the classification code that tells the system what this Tag will be used for (i.e. Line Pressure, Water Level etc.) Select a Tag Type from the list and click OKAY to return to the New Tag pop up.
Note: When you open this list it will automatically filter to classification codes already in use in your system. The filter is under "Options" and can be changed to "Currently in use", Common Tags, Hourly Tags, Daily Tags. In addition you can use the "Filter by Tag Type Name" to search for a particular type code.
Once all information for the new tag has been entered click the SAVE button to add the Tag to the Device.
Note: Each Tag card on the page has a more options button with an option to Edit the Tag, is simply opens the same window as New Tag and allows you to make changes to the existing Tag.
Adding a New Well
Wells are a special type of container object in the eLynx Application. The well itself has tags that track actual and average production, costs, targets, and variances from targets and also "contain" links to regular devices in the application to source some of these values, as well as others that might be of interest to the user (or for premium tier customers required for using some of the built in rules.)
The tags linked to source devices are a mix of optional and required links depending on settings used when creating the well (primary product, lift type, controller.) The system uses a step menu to gather all the required information for a well,
To start the process navigate to a group which contains all of the Devices that you will link to this well.
Then select Manage Objects from Object Administration in the Administration menu.
Then select the "Wells" tab on the display.
Then clicking the Add button in the upper right corner.
Well Object Standard Properties
Well Name - Enter a name for the new Well, this name must be unique.
Well API/UWI - Optional: Enter the API or the UWI identifier for the well.
Primary Product Type - Select the primary product from Gas/Oil/Water
Note: The linked source device MUST contain tags for the flow rate and previous day volume for the selected product, the other types may also be linked, but are optional. If you are creating a well where the only metering is on the Gas then you must select Gas as the primary product.
Lift Type - Select from ESP/Free Flowing/Gas Assisted Plunger Lift/Gas Lift/Plunger Lift/Rod Pump/Unknown
Lift Controller - Select the appropriate controller, this list will change based on the lift type.
Basin - Optional: Select the Basin from the drop down list.
Field - Optional: Select the Field from the drop down list:
Note: This list is typically empty but can be populated by eLynx, please contact our support group if you wish to use this. This field is informational only and is not used by the system for any purpose.
Pad - Optional: Select the Pad from the drop down list:
Note: This list is typically empty but can be populated by eLynx, please contact our support group if you wish to use this. This field is informational only and is not used by the system for any purpose.
Latitude - If you want this device to be included on a Map View in the system then enter the Latitude in this field in decimal degrees. (+ values for North latitudes, - numbers for south)
Longitude - As with the Latitude enter the value in decimal degrees. (- values for West longitudes, + values for East longitudes). Most web mapping applications (i.e. Google Maps) will allow you to drop a pin on the map and will display these values exactly as they need entered here.
Once all of the Standard Properties have been filled in click the Select Devices button in the lower right corner to advance to the next step.
Select Devices
In most cases you will be linking a single Device object to a Well.
There are cases when mutliple devices need to act as sources for a well, the most common cases are:
Gas Lift where the Injection meter and Production meter are separate devices in the application.
Other Lift Types where the Production meter and Lift Controller are separate devices in the application.
Click the check box next to each Device that will contribute tags to the Well, once the devices have been selected click the Select Tags button in the lower right corner.
Select Tags
The Select Tags screen is separated into two sections, at the top are a list of Tags that are required to be linked to a source device and will vary based on the choice of Product, Lift Type, and Controller. The lower section will allow you to link additional tags (Flow Rate and Previous Day volumes for the other two product types, tubing and casing pressures etc.)
For each Tag select the Source Device from the center column, then select the Source Tag from the right column.
Only the required tags at the top must be linked, but if you have sources for the Optional tags you should link them before proceeding.
Once all of the available linkages are setup click the Summary button in the lower right corner to review the configuration of the new Well.
Well Summary
The Summary page will show the Standard Properties at the top, show a list of the Tags that will be created directly on the Well in the next section (this list is managed by the application and cannot be changed), and finally, show a list of Tags and their source Devices near the bottom.
Review everything carefully and if you are satisfied with the information shown click the Save Changes button to create the new Well in the application.
Bulk Options
Bulk options are launched from the page level More Options button in the upper right corner of the page.
The options present will change based on whether the Devices tab or the Well tab is selected.
Disable Objects
Disable Objects is available on both the Devices and Wells tab, when select this option the page will update to show a list of all Devices or Wells in the currently selected Group.
You may enter part of the Device or Well name in the Filter by in the Options panel to search for a particular Device or Well to change.
Each object has two checkboxes Enabled and Visible that may be changed independently.
If the Enabled box is unchecked the Device will be disabled in the system. If this is a SCADA device it will no longer receive data (either from our internal polling engine or for WebHost via your in house SCADA system.)
If the Visible box is unchecked the Device or Well will no longer be visible in the application, will no longer be included in any reports.
Bulk Device Setup
Bulk device setup is similar to the Add Device functionality covered above, this option DOES NOT support bulk addition of Cryout devices, but does allow you to use a Template, or another Device to create the Tag list that will be added to the Device.
When you select this option you will see the following screen:
Template Action - Select either "Create from Template" or "Create from Device" from the drop down menu.
Template/Device - Use the Pencil Icon to select from your Templates or pick an existing Device that will supply the information for the Tags to be created on the new devices.
There are two ways to enter the Standard Properties for each of the Devices you wish to create.
You may fill in the information on screen for teh Device Name, Identifier, Contract Hour and optionally Latitude and Longitude then click the ADD DEVICE button. When you click the ADD DEVICE button a new card will open to allow you to enter information for the next device. You may repeat filling in as many cards as necessary until you have a card for of the Devices you wish to create.
Each card also has a Trash Can icon at the right edge so you can remove an entry created in error before creating the Devices.
Note: Do not click ADD DEVICE for the last Device as that will create an empty card the the SAVE button is only enabled when all cards are filled out.
ADD FROM FILE - You may create a .CSV file (Comma Separated Variables) with a list of Devices and their other Standard Properties and import it. The file should at a minimum have 3 columns for the Device Name, Identifier, and Contract Hour, but may also include the Latitude and Longitude information for mapping. When you click the button you will be asked to load the file, the system will then display a grid showing the data from the file.
If your file has a head row you should check the "File Has Header Row" checkbox in the upper right hand corner.
For each column in the file you should select which Standard Property that column contains information for. Once you have identified all the columns click the checkboxes next to each row you wish to import, or the "Master" checkbox (to the left of the drop-downs) to select all rows. Once selected click the IMPORT button in the upper right corner. This will return you to the previous screen with a card created for each selected row in the file.
Once all of the Cards are complete click the SAVE button in the upper right corner to create all of the Devices.
Comments
0 comments
Article is closed for comments.