The use of Metdata allows you to enable DATA DRIVEN DESIGN in your pre-engineering phase when designing field layouts. Metadata allows you to build or link your own data model to your private Asset Library or with the Generic library.
This is especially useful for providing equipment and costing options while designing the field. E.g. by defining metadata your users can then select various equipment configurations with corresponding options and link them to your VendorID, WBS, cost specifications etc.
Meta Data Editor¶
An easy to use UI allows you to define your various metadata attributes with a wide range of data types, units, and input options for user selection on assets, connectors and connections. Furthermore the metadata are highly customizable, and supports dependencies, filters and much more.
Meta Data API Support¶
Everything you can do with the Meta Data Editor you can also do through the FieldAP REST API so you can programatically configure everything. You can read more about the API here in the API DOCS
Add Meta Data for Connections, Assets and Connectors¶
By clicking the Connections, Assets or Connectors tabs in the top of the Account Settings page, you can add your own custom Meta Data Types.
Press the Add Meta Data button and the following section will appear to the right as shown below:
ID - This is the unique ID (indentifier) for this metadata, and typically is used as a reference for metadata API operations. It is a Read Only value.
Name - Specify the name of your new meta data entry in this field.
Vendor ID - You can also assign an optional alphanumeric Vendor ID of your choosing, which can be useful for API integrations etc.
To remove the entry, click on the Remove button.
As an example, in the illustration below under the Assets tab in Account Configuration we have selected a "Manifoil" and clicked Add Meta Data, named the Meta Data Type: "Service", and selected the Data Type as "choices". Then we added 3 options using the Add Options button named Production, Injection and Gas Lift. As Default we selected Production.
When a user now drags a manifold on stage you will see that the Service option is now availble in the Metadata section as shown here:
And the drop down list allows the user to select the desiered configuration.
Meta Data Types¶
You can add as many Meta Data entries as you want for Connections, Assets, Connectorsm and Virtual Assets. The available data types are as follows:
|Choices||List of alphanumeric options|
|Boolean||True or False|
You select the Meta Data Type from the Control drop-down list as shown below:
This is an alphanumeric text string and you can designate a Default value e.g. describe the input you are looking for.
This is a numerical input field where you define a Minimum, Maximum, and a Default numerical value. You can define the Units to be used for the field. Select a Unit category first and then the available Unit type selections available will vary based on the category selected.
You can also check the the Value is a cost option so it will get computed in the cost equipment module. You can also define the numerical field to be read only by checking the Value is read-only option. And lastly, if you add meta data for a Connection, you can also define the numerical value to be used in a cost per lenght calculation by selecting the "Cost is per length" option e.g. cost per meter of pipeline.
This will display a horizontal slider UI element that gets defined with a minimum, maximum value and the step value of the slider You can also check the the Value is a cost option so it will get computed in the cost equipment module. And you can define the numerical value to be used in a cost per lenght calculation by selecting the "Cost is per length" option.
This is a list of choices you define (alphanumeric or numberical) that can have a cost value attached to each element thats get computed in the cost equipment module. The Default drop down list allows you to specify the default selection. You can allow for multiple options to be selected if you check the "Can multi-select" option. If you add meta data for a Connection, and it is an numerical value it can be used in a cost per lenght calculation by selecting the "Cost is per length" option.
This will present the user with a TRUE/FALSE checkbox with the possibility to have a "Cost per length" attached to it thats get computed in the cost equipment module. The Default checkbox indicates the default boolean state e.g. if checked the option is TRUE by default.
This is a meta data type that makes it possible for you to link another asset to your object. As an example you make a data type called slot 1 in a 4 slot template - you can then choose asset as data type, and in the project you link a xmt asset into the slot. Then the metadata for the xmt will also show up in your meta data editor in the project and every asset linked will then be computed in the cost equipment module.
The Asset data type also has a Filters section, where you can preselect the following filters; Category, Type, and Sub type to help narrow down end user selection when using the Meta data editor in a project.
Allows you to place a button with the text specified in the Caption field into the Meta data editor. You can then assign an URL in the Action URL field that typically invokes a call to an external service/server for launching a simulation, calculation, or some other operation with your own or 3rd party software.
The action URL can be comprised of the following parameters;
|%subProject%||Sub project ID|
|%id%||Selected element id (the one the metaData is linked to)|
|%type%||Selected element type ('stagedAsset', 'connector', 'connection')|
Example : https://myserver/query/%account%/%project%
This data type allows you to create a table for user data entry. Use the +Add Header to create Columns. Then input your column name in the Header Name field. Press the Remove buton to delete an entry.
The sample definition used here will then appear to the user as follows:
Add a Condition¶
This section allows you to add logic to the meta data configuration combined with the Group (Tab) field.
The Select a dependency drop down list will show all the metadata you have defined so you can select the one you want. Then select if the condition should be Equal or Not Equal to the values or options you have defined for the meta data. Use the Add a condition button again to create multiple conditions.
As shown above you can have an conditional extra selection tab displayed for the user in the Meta data editor. To do this you specify conditions such as Display the Group tab (named external in this sample) if Slot 1 is equal to XMT. This will then show the following to the user.
In project view you now have the option of copying metadata from one connection, assset etc. and paste them to a single or a selection of assets/connections by using the Copy Metadata option as shown here:
For the selected Manifold as shown above we will then use the Paste metadata option on the other 3 manifolds in the project as shown below:
Now all four manifold assets have the same metadata values.