| User Data |  |
| User Data | |
User defined data (user parameters) can be utilized to sort and filter your projects for reporting, as well as for adding custom data and lookup tables for calculations in User Functions.
Classifications of user data
User Data in WellSpring can be broken down at a high level in three ways, the last two of which are related. First the data can be:
Second the data can be defined at four levels in WellSpring:
*Note: Defining user data at the asset level is not recommended, as it can impede the calculation performance for large projects.
It is recommended that all user data be defined at the project level. It can apply at any of the levels discussed below.
Data defined below the project level can only apply to the asset (including scenario) where it is defined but data defined at the project level has various options for assets at which it applies, controlled by the asset type filter:
Note: As is clear from the above descriptions, if you want to have a user variable defined at all assets of a particular type (e.g. all wells), you could either define the variable at the first asset created and copy that asset (which will also copy the user variable) or you can define the variable at Project (or Company) level and apply an asset type filter. The latter option is to be preferred both from the point of view of it not requiring such foresight and also for more efficient data storage. It is recommended that user data defined at the asset level only be used where the variable and not just its value is unique to that asset.
Adding a user variable
With small exceptions, the user data definition screen where user variables are created looks similar whether the variables are at Company, Project, or Asset Level. However, the user data on this screen at the three Levels are quite distinct and the various ways of accessing this screen are not the same for all Levels.
Company Level user data can only be accessed via Admin menu - User Defined Data (Company Level). Company Level user variables can only be created or redefined by a super user but the list of them can be viewed by any user; other users will see the screen greyed out.
This screen may, in turn, be accessed in variousways:
The user data entry screen which is accessed will be for the selected asset. Selection may be done either in the Network tab or in the hierarchy to the left of the Data (or some other) tab.
There is an additional route, probably the most convenient, to Project Level user data through the “(user data)” URL to the right of the Project name.
Depending on the types of user variables existing for the selected asset, the user variable definition screen may not have all possible columns visible. When all columns are visible, the user variable definition screen appears as follows:
Any existing User Defined Data for the selected asset appears in a table. At the top is a row allowing addition of a new user variable. The variable name is entered in the leftmost free text cell. (Note that although spaces are permitted in these names, it may be advantageous to avoid them or use underscores so that quotation marks are not required in user function syntax.) The type is selected in the dropdown immediately to the right and then clicking the “Add Definition” button appends the new variable to the table below.
The user variable types available are:
The first five types all fall under the general heading “Scalar” (denoting single datum entry) used above; Table and Time Series each require an array of data to fully define them and are almost invariably created to appear in User Defined Functions. Text strings are always used in filters since string functions (such as concatenation in Excel) are not available in WellSpring. The first four user variable types can be used either in filtering or in user defined functions.
As indicated by its appearance in the user data table, the variable type cannot be changed after a definition has been added. To change variable type, the old variable would need to be deleted and a new one with the same name added. A similar situation pertains with the definition of whether a Time Series is monthly, which is controlled by the check box to left of the “Add Definition” button, or yearly (default). On the other hand the Attribute Name can be freely edited and, when this is done, appearances of the variable in the model will automatically update to the new name. The Units column of the table is only relevant to real (Double) data and can similarly be changed without requiring redefinition of the user variable from scratch.
Where the added user variable will appear is controlled by the “Asset Type Filter”. For definition at the asset level, the “Asset Type Filter” dropdown is disabled with the value fixed to the asset type where the variable is defined. For Project or Company Level user variables the dropdown offers all of the above options.
There follows a “Hidden” check box which allows you to temporarily or permanently hide the user data. This can be useful where you want a comprehensive list of user parameters and would like to hide the ones that you are not actively using . The Dictionary check box is greyed out except for String variables. It provides the means to indicate that the variable must be chosen from a finite set of possible strings (analogous to a validation list in Excel). Between the Dictionary and Sort columns is an unheaded column which allows Table definition (through a URL) and Time Series definition through direct entry of its length (all that is required to define its structure).
The Sort column and column of Delete buttons are fairly self-explanatory. The former allows related user variables to be kept nearby in the list; moves can be by one or ten rows at a time.
Company Level User Data
In the Company Level user data definition screen (Admin menu - User defined data) there is an additional “User Group Filter” dropdown. This controls whether a user variable added here truly appears in every project within the company or only appears in the projects of a group, say a division, within the company. The User Group Filter defaults to “All Groups” for a newly created variable but the super user can select any available group from the dropdown list.
*To create new user data definitions at the company level, you must have administrative "Super User" access.
In order for user data with a user group filter to be picked up by the intended projects, the User Group dropdown in the Project Data screen must be set to the same value as in the User Group Filter dropdown.
The user group terminology is appropriate to the sort of situation described above but the same functionality can be used for other purposes. For example, there may be text variables that are relevant to gas fields but not oil fields or vice versa. By creating “User Groups” called “Gas” and “Oil”, the same user could select “Gas” for a gas project and “Oil” for an oil project. Other examples might be onshore and offshore or operated and non-operated.
*Note: Please contact Enersight if you would like to create new groups.
Although Company Level user variables can only be defined by a super user in the Admin menu - User Defined Data (Company Level), the data itself is entered /
edited within the project by all users, just like other user data. Company Level user data can be used to "filter" the project list when using linked projects (See Project Consolidation and Meta Projects).
To use user data to filter for reporting see Reporting Options.
See also
