Skip to content

Accounts and Instances

This section describes the usages and available settings for your account and available instances for your single or multi-tenant subscription.

Instances

When you log in with administrator privileges and have more then one (1) instance in your account you will be presented with a list of the available instances for selection as shown here:

Screenshot

To enter an instance simply click on the instance name to the right of the spinning globe illustration and you will be taken to the project list for that instance as shown below:

Screenshot

The project lists will be displayed based on the projects you own or are invited to. If you are the system admin you will see all projects for the selected instance listed.

You can filter the list of projects based on the following search criterias:

All Project Names - Start typing to filter the project list based on your entry in this field.

All Project Phases - Selecting this drop down box will list the available project phases as defined in the Input Configuration setting screen. You can then select the phases you want to filter the project list by.

All Customers - Selecting this drop down box will list the available customers as defined in the Input Configuration setting screen. You can then select the customers you want to filter the project list by if they have been assigned to a project.

Accounts

The "Accounts" icon from the left side command bar (highlighted in the illustration below) takes you to the corporate account membership functions for your company account. Note! You will only see this account icon if you have elevated administrator privileges for your company.

Screenshot

This will typically only list a single corporate account, unless you as a company administrator have multiple corporate accounts.

To get into the Account Settings click on the Cog Wheel icon.

To DELETE the account, click on the Trash Can icon. This will the prompt you to confirm the Account Deletion as shown below.

Screenshot

Type in DELETE in capital letters, and press the Delete button. Note! This action can not be undone! Press the Cancel button to abort.

Account Settings

Account Administrators only

If you have administrator privileges you can make changes such as adding/removing users, setting up meta data types, default connection types, asset costs, etc. to the corporate account. To do so, simply click on the Settings icon in the lower right-hand corner on the account card.

Screenshot

This will then display the "Modify Account" screen as shown here:

Screenshot

General Settings

This section defines the general settings for this account.

Screenshot

Name - Here you can set or change the corporate account name by editing the "Name" field.

Avatar - You can add or change the company logo by selecting a new image under the Avatar section. Click on the "Choose File" or equivalent based on your computer language settings and use the file dialog to select a new Avatar logo image. Most common image format are supported.

Screenshot

The selected file will then be uploaded and converted. Press the "Save Changes" button on top of the screen to keep the new or changed avatar image.

Screenshot

Press the "Save Changes" button to retain the changes.

Account Identifier

The Account Identifier is a unique name that is set up for your company when the account is created. This is used to designate your account meta data definitions so they can be mapped and made compatible with metdata according to standard definitions and for when you will be collaborating with other partners or using 3rd party integrations. This field is not editable.

Vendor Attribute Path

The API also supports the “vendorAttributes” attribute for assigning unique identifier. If you would rather employ this for auto inheritance, then you can specify this here under the “General Tab”. If you have programmatically defined “vendorAttributes” it will show up in the drop-down list, and you select it here to override the default setting of “vendorID”. This is new from version 1.4 of the API.

Log Retention

The log retention setting allows the account admin to specify the number of days that the log should be retained. Default is 90 days, and the range is (0-360) days.

  • accountLogs - This setting is for all log events for the Account itself.

  • projectLogs - This setting is for all project log events.

Press the "Save Changes" button to retain the changes.

Account Logs

This section will allow you to query and display the log events for your account.

Screenshot

Retrive account log - Press this button to retrieve the account log for the specified number of days entered in the Days field. Default is 30 days.

Export log result - Press this button to export the log out in TSV (Tab Separated Values) format.

You can filter your log result by using the following filters:

  • Action - This will display a drop down list of log event tags to help you narrow down the log. Select any of the following "custom-tag-modified", "login-token-expired", "login-user-not-found", "connection-segment.definition-added", "login-token-expired", and "project-added". Note! Depending on the recent log activity only the relevant log-events will be displayed in the drop down list.

  • Categories - At present this only has the "login" event tag.

  • User email - When you start to enter a specific email address the log results will automatically be filtered to show only the corresponding log entries.

Project Cost

This section allows you to predefine standard project cost items for any new projects/sub projects created in your account. This will allow you to also assign default values you typically have for all projects e.g. Admin Overhead:

Screenshot

Press the "+Add item" button to create a new entry and then you can populate the fields as follows:

  • Name - Enter the name of the cost item e.g. Admin Overhead.

  • vendorId - Enter the associated Vendor ID if any.

  • Cost Category - Select the corresponding cost category from the drop down list. Select from "SPS", "SPP", "platform", "vessel", "rig", "piping", "umbilical", "operation" or "generic".

  • Supplier - Select an existing supplier, or enter a new supplier if needed.

  • Cost - Enter the new cost value, and select the corresponding currency in the drop down list to the right.

  • Cost State Text - This field is if you have a cost server connection with your account and you want to display a specific message linked to the cost state. The corresponding Status can be selected from the drop down list to the right comprised of "danger", "primary", "warning", and "info" states.

  • Date - You can enter a start and end date that the cost applies to if any.

  • Lock - Press the padlock icon to change the state of the cost entry between locked and unlocked.

  • Delete - Press the "Delete" button to delete the cost entry.

  • Additional Cost Breakdown - You also have the possibility to break down asset cost into itemized parts and assigning individual cost for each sub part. Please see Cost Breakdown for more information.

Press the "Save Changes" button to save the changes.

The new costs you define here will also show up in Project View in the Custom Costs section as shown here:

Screenshot

Note! You will then see these in the project settings screen.

Asset Cost Settings

This section allows you to assign account based default costs for all the assets in the generic Asset Library. If you set up the costs on the account level these costs will be used as default for all new projects created.

Screenshot

You have the following options available to sort or narrow down the list:

  • Category - This drop down list will allow you to apply category filters so only the selected catagories will be shows e.g. "Template", "Host" etc.

  • Sub-Category - Select sub category filters if any to apply to the listing.

  • Type - Select the asset type from the drop down list and choose between "structure", "vessel", "submerged" or "virtual".

  • Name - This allows you to start entering an asset name and the list will search and update based on the name entered.

To assign a default cost on an asset for your account, simply modify the Price field next to the asset, and assign the appropriate Currency in the drop-down list to the right of the "Price" field. You also have the possibility to break down asset cost into itemized parts and assigning individual cost for each sub part. To do this simply click on the "Breakdown" button.

This will display the dialog for assigning "Cost" for individual parts as shown below:

Screenshot

To assign cost for an individual part, simply click on the "+Add" button to add a new line for each part that you wish to assign the cost for. You can add information in each of the following separate fields; Nr, Item, Quantity, Description, Cost, and Notes.

To delete an item from the list, simply click on the Remove button to the right of the "Notes" field. When you are done, click on the "Save" button to accept the entries made. To exit, click the "Cancel" button.

You can revert any changes to the default account values by pressing the "Reset to Default" button.

To save your changes, scroll up to the top of the page and press the "Save changes" button next to the account name.

Asset Statuses

This section allows you to create various visual status conditions that can then be applied to an asset to indicate an asset state that you define e.g. Obsolete, To be installed etc.

Screenshot

Create New Staged Asset Status - Press this button to create a new asset status that can be assigned to a staged asset in any project.

This will create a new entry in the status list as shown below:

Screenshot

  • Name - Type in the descriptive name for your new status here.

  • Color - Click on the color indicator to display the color selection dialog to pick a color for your new status.

  • Search - Start typing a search term in the search box to narrow down the status list if it has many entries.

Delete Selected Status - Press this button to delete the selected entry in the status list.

Press Save Changes at the top to store your changes.

You can now assign any created visual status to a staged asset by selecting it the asset property panel from the Status drop down list as shown here:

Screenshot

In this case Obsolete status has an orange color assigned to it and then the asset outline is set to this color:

Screenshot

Input Configuration

These settings are optional and are typically used by our EPC customers for additional information about the project.

Screenshot

As a system administrator you can define a list of Regions, Customers and/or Project Phases here.

+Add - By clicking on this button you can add new Region, Customer, Project Phases entries respectively. The entries you add to the Regions/Customer/Project Phases lists will then be available for selection in the Project Settings screen for selection when users create new projects. If you have multiple entries, you can arrange the order of the entries by selecting one and using the UP or Down arrow buttons to change the list position.

+Import CSV - If you need to add a larger list of customers and/or regions you can upload this from a CSV file. The format is just the name on every line e.g.

Customer 1
Customer 2
Customer 3

Remove - Click on this button to delete a selected entry in the corresponding list. You will be prompted for confirmation of the delete operation.

Customer is internal to the company - Check this option if you are collaborating with Customer that is trusted and you can then invite anyone from internal users and alliance users.

Customer is part of an Alliance With the Company - Check this option if you are collaborating with another company e.g. in an alliance and by checking this option that company if added to the Customer list can then be invited into your internal projects.

These two options have been created for EPC companies. See the table below for more information on usage:

User Type Description
Normal User If no "Internal" or "Alliance" user association the user can only invite normal or internal users to a project. "Alliance" users are not shown.
Internal user Can invite "Internal" ,"Normal" and "Alliance" users into a project.
Alliance user Can invite all users except users in other alliances they are not part of e.g. will only see users in same alliance.

Note! - The project phase is an optional setting and may not be activiated on your account.

API settings

Use the Create API Token button to create a unique API token for your account that must be used for communicating with the Field Activity Planner REST API for integration and/or development work.

Screenshot

Name - You can add a descriptive name to each key to better identify the various keys you create and distribute.

Copy - Click this button to copy the API key to the clipboard.

Revoke - Click this button if you wish to revoke a token. A dialog will prompt you for confirmation.

To save your changes, scroll up to the top of the page and press the "Save changes" button.

You can then e.g. issue a GET query to your dedicated instance backend for the logs with the header information comprised of the token you just generated and with the Content-Type set to "application/json".

https://myinstance.backend.fieldap.com/API/v1.2/logs

or

https://myinstance.backend.fieldtwin.com/API/v1.2/logs

For more information, please see the API Documentation

User settings

Under the Users setting tab you as an Administrator can invite new users and assign and/or change Admin privileges and default project roles. You can add as many users as you like as dictated by your license agreement.

Screenshot

Inviting a new user - Click on the "Invite a new user" button as shown above will display the following dialog:

Screenshot

Account Administrator - Check this box if the user should have Account admin privileges.

Email - Enter the email address of the person you wish to invite in the text field.

Instances - Select the instance that this user should be invited to from the drop down list if you have multiple instances as part of your license.

Customer - Select the customer name that this user should be linked to if that has been defined under the Input Configuration settings.

Default User Role - Select the user role that the invited user should have e.g. Administrator, Editor, Viewer, or any of the roles defined under the User Roles settings.

Press the "Send Invitation" button to issue the invitation. Otherwise select "Cancel" to return without inviting anyone.

A user will be listed as pending until they click on the invite link in the email and save their user details. You can delete pending invitations and issue a new one by pressing the Resend button.

They will then receive an invite email:

Screenshot

When the new user accepts the invitation by clicking the link in the invitation email the user needs to fill in some user information.

Screenshot

Note! The Phone field must be filled in with the user's mobile phone number as the FieldTwin Design uses token based authentication as a security measure over SMS/Email, unless your account is set up for corporate SSO authentication. The mobile phone number must also be prefixed with the country code at present. The other fields are not required.

Search - You can use the free text search field at the top of the screen to narrow down the user list. Simply start typing in names or email etc.

Screenshot

Each individual user entry has the following editable options available:

Screenshot

Administrator - To change the user account role between Admin and User simply click on the Toggle button next to the avatar image under the Administrator column, and it will toggle the admin role between Yes or No.

Assets - Toggle this to Yes if the user should be able to select the Asset Settings under the asset library. Note! Only for Super Admins.

Instances - This field will list which instances the user is part of. The system administrator can assign and/or remove the user to several instances depending on your license agreement.

Customer - You can assign a customer entry to the user from the drop-down list if any have been defined under the Input Configuration settings.

Default Project Role - The system is configured by default with the following user roles; Administrator, Editor, and Viewer. If you have defined custom user roles, then these will appear in the drop-down list. For more information, please see the documentation on User Roles settings screen. Note! You need to assign users a default project role.

Edit user information - Click on the cog wheel icon to edit the user settings.

Delete user - Click on the Trash Can icon if you want to delete the user. A dialog will prompt you to confirm the action as it cannot be undone!

Invitation - If a user has not accepted the invitation by clicking on the link in the invitation email, they will have a pending status. You can click on the Resend button to send the invitation again.

User Roles Settings

The User Roles setting screen will display the Default User Roles permission settings for the Administrator, Editor and Viewer roles. As an Account Admin you can edit the permissions for the default user roles operations and data object access. You can also create new default or custom user roles.

Screenshot

When you select a default user role under the Generic section of the table, you can also choose to assign that role to a specific customer if that has been defined under the Customer section of the Input Configuration Screen as described elsewhere in this documentation as shown here:

Screenshot

This means you can adjust default user roles also based on Customer as a criterion.

The Permission table is where all user roles operations and data object access are controlled for each role. See the illustrations below for the default Administrator role permissions:

Screenshot

Exclude Role - If you check this setting the User role will be excluded and not available for selection. You will see a Lock icon appearing after the role name in the User Role list on the left-hand side of the screen signifying that the role has been excluded. This mean that the role will not be available for selection in the Users settings screen where you assign roles to users.

To edit the role permissions simply check the appropriate check boxes for the various operations and data access in the Permissions table section. Note! If the Admin setting is checked under project this means that all the permissions are available. To edit any other setting, you must then uncheck this. Once complete, press the blue Save Changes button at the top of the screen.

Metadata Filtering by Tags - You can define what Metadata a user role should see by using the Tags feature during Metadata creation. If you add a tag for e.g. projectcost and then add this to a new user role as shown in the illustration below that user will only see metadata that has been tagged with "projectcost".

Screenshot

You can read more acout it here: Adding Metadata

Integration Access - This section is where all 3rd party or optional Tabs integrations that are provided and registered with the system will be listed:

Screenshot

This means that you can assign access to integration Tabs to the assigned default or custom user role. For each integration tab you can select if the Role should be able to Edit or View the integration tab. Simply use the check boxes for each listed tab to select the view or edit capabilities. Note! If a user role can Edit it means that the role also can View the tab.

Click on the Save Changes button on the top of your screen once you have made your modifications.

The User(s) With This Role section will list all users with assigned this role, and also list all the projects they are a member of for this account.

Screenshot

Create a New User Role - This button will create a new custom user role where you as an admin can select the appropriate permissions for your company project workflow. See illustration below where we create a customer user role for a Drilling Engineer:

Screenshot

Delete - Click on the red Delete button to delete the selected user role. A dialog will prompt you to confirm the deletion as it cannot be undone:

Screenshot

Restore Default User Roles - This red button at the top right of the screen will restore the system default user roles of Administrator, Editor, and Viewer if any of them have been deleted from the account.

Connections Settings

This allows you to modify or create new default connection types for any new projects created for your corporate account. All users can also add project specific connection types on a per project basis afterwards. To modify an existing connection, you can change the connection Name, Category, Symbol, Color, Width, and Dashed properties.

Screenshot

+ Add New Connection Type - You can add new default connection type by pressing the button and filling in the Name, Category, Symbol, Color values etc.

Delete Connection - You can delete a selected connection by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

Clone - Click on this button to create a copy of the selected connection with the same settings. A new entry will appear at the bottom of the list with the "- clone" postfix to the connection name.

  • ID - This is the unique system ID assigned to the new well type. Note! This is not changeable.

The connection properties you can change are as follows:

  • Name - Type the name of your connection type.

  • Category - Select the category of your connection e.g. Umbilical, Production, Water Injection, etc.

  • Symbol - Type in the symbol designation for the connection e.g. GI for gas injection.

  • Color - Use the color picker dialog to select a new color for your connection.

  • Width - Specify the width of the connection. Valid inputs between 0,1 and 2.

  • Dashed - Check this is you want the connection drawn as a dashed line.

  • MBR - If you will be using the Bend Radius design tool you can specify a default bend value radius here.

  • Allowed Connection Type - Select the connection type for your connection from the drop down list e.g. Riser, Jumper, Straight, etc.

  • Obsolete - Check this box if this connection type is now obsolete. If you click on the "Refresh Obsolete Connection Warnings" button then all projects using this connection type will have this flagged visually as an obsolete connection.

Search - The search field allows you to filter connections by starting to type in your search criteria.

and arrows - This will move the selected connection entry up or down in the list.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the connection segment type. See the Meta data section for more information.

To save your changes, scroll up to the top of the page and press the "Save changes" button.

Screenshot

Connection Segments

You can now define “Segments” on a connection meaning that it can be comprised of multiple segments. This can be used to e.g. assign various segments of a connection for rock dumping, trenching, or if a connection is assembled with different types/materials e.g. parts of a mooring line could be chain etc. In this screen you can define various segment types and assign metadata to them.

Screenshot

Click the "Add New Connection Segment Type" button to add a new segment type:

Screenshot

This will add a new segment type to the list. Then you can set/change the following:

  • Name - Type in the name for your connection segment.

  • Color - Use the color picker dialog to select a new color for your segment.

  • Vendor ID - You can assign your desiered VendorID in this text field.

Delete Connection Segment Type - Press the red delete button to delete the created Segment. You will be asked to confirm the deletion.

Search - The search field allows you to filter connection segments by starting to type in your search criteria.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the connection segment type. See the Meta data section for more information.

Connection Types

This allows you to define or edit Connection Types or connection systems if you will. By default, the following connection types or systems are defined:

  • Standard
  • Straight Line
  • Riser – Lazy Wave - This is formula based lazy wave calculation.
  • Jumper – Horizontal Z
  • Jumper – Vertical M
  • Jumper – Vertical N
  • Riser - Catenary - This is a formula based catenary calculation.

The default types also have a predefined “Render As” option e.g. how the connection will be represented graphically on stage as you can see in the screen shot below:

Screenshot

Add New Connection Type - To create a new Connection Type, press this button. Then give it a name and assign how it should be rendered on stage by selecting from the Render As drop down list. Standard is the default render type e.g. rendered as a classical connection.

Search - Type in your search criteria in the search field to narrow down the connection list.

and arrows - This will move the selected connection type entry up or down in the list.

Delete - If you are the account Admin you can delete a connection type by clicking on this button on the right side. Other users will not see this option. A dialog will appear and prompt you to confirm the delete action as this cannot be undone.

Press the Save Changes button on top of the screen to save any changes you make.

To learn more about how to use the available Connection Types and their respective parameter settings please see the Connection Types section for more information.

By creating a new Connection Type or system you can then use it to discriminate metadata when creating new meta data types for “Connections”. See the Meta data section for more information.

Well Type Settings

The Well Type settings screen allow you to create different well types for your account that you can assign to your manually created or imported wells. More importantly this means you can assign Metadata definitions for your Well Types. This is useful if you need to add user configuration or input attributes for wells in your project. This could be for costing purposes or for defining data needed for integrating with external Drilling & Well software such as e.g. ProWell Plan and Oliasoft.

Screenshot

Add New Well Type - Click this button to create a new Well Type entry in the list.

  • ID - This is the unique system ID assigned to the new well type. Note! This is not changeable.

  • Name - Enter or edit the name of the well type entry in this text field.

  • Vendor ID - You can assign your VendorID in this text field.

Search - Type in your search criteria in the search field to narrow down the well type list.

Delete Well Type - You can delete a selected well type by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the connection segment type. See the Meta data section for more information.

Well Bore Type Settings

The Well Bore Type settings screen allow you to create different well bore types for your wells that you can assign to your manually created or imported wellbores. More importantly this means you can assign available Metadata for your Well Bore Types. This is useful if you need to add user configuration or input attributes for well bores in your project. This could be for costing purposes or for defining data needed for integrating with external Drilling & Well software such as e.g. ProWell Plan and Oliasoft.

Screenshot

+ Add New Well Bore Type - Click this button to create a new Well Bore Type entry in the list.

  • ID - This is the unique system ID assigned to the new well bore type. Note! This is not changeable.

  • Name - Enter or edit the name of the well bore type entry in this text field.

  • Vendor ID - You can assign your VendorID in this text field.

Search - Type in your search criteria in the search field to narrow down the well bore type list.

Delete Well Bore Type - You can delete a selected well bore type by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the connection segment type. See the Meta data section for more information.

Layer Types Settings

This section allows you to assign available Metadata for the various types of Layers. This is useful if you need to add user configuration or input attributes for e.g. 3D surfaces in your project. This could be for defining data needed for integrating with external software related to reservoirs. An example would be to define reservoir pressure etc.

Screenshot

+ Add New Layer Type - Click this button to create a new Layer Type entry in the list.

  • ID - This is the unique system ID assigned to the new layer type. Note! This is not changeable.

  • Name - Enter or edit the name of the layer type entry in this text field.

  • Vendor ID - You can assign your VendorID in this text field.

Search - Type in your search criteria in the search field to narrow down the well bore type list.

Delete Layer Type - You can delete a selected layer type by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the connection segment type. See the Meta data section for more information.

MetaData Definitions

This is the main metadata settings screen where you will create, edit, or delete any metadata definitions and associated attributes and conditions for your Account.

Screenshot

+ Add Definition - Click this button to create a new metadata definition.

Delete Definition - You can delete a selected metadata definition by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

Search - Type in your search criteria in the search field to narrow down the list of metadata definitions.

MetaData Definitions - See the dedicated Meta data documentation section for more detailed information on how to create, edit, or delete these definitions.

MetaData Groups

This settings screen allows you to create metadata groups. By creating a group you can then assign severeal metadata definitions to it. This is then useful for when you want to apply multiple metadata definitions in one operation to several assets such as XMTs, connections etc. in one single operation.

Screenshot

+ Add New Metadata Group - Click this button to create a new metadata group.

Delete MetaData Group - You can delete a selected metadata group by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

Search - Type in your search criteria in the search field to narrow down the list of metadata groups.

MetaData Definitions - See the dedicated Meta data documentation section for more detailed information on how to use metadata groups.

Assets Settings

This section allows you to assign available Meta data for your asset library or to view/edit asset connector information.

Screenshot

  • Refresh Obsolete Asset Warnings - If you click on this button, it will mark a list of the projects which the obsolete assets are being used in. They will be marked with a warning sign next to the project names in the project dashboard as shown below:

Screenshot

This will then show up as follows:

Screenshot

Search - Type in your search criteria in the search field to narrow down the asset list.

Edit Connector - You can also edit the Socket connectors e.g. connection points on the asset. This will display the “Update Sockets Connector” dialog as shown here:

Screenshot

Use the zoom/pan icons to navigate to the desire “Socket Connector” and select it by clicking it. You can then change the following settings:

  • “Type” - Select the type of connector based on the Connections you have defined from the drop-down list.

  • “Orientation” - Select either “Horizontal” or “Vertical” orientation.

  • "Flow" - Select either Inlet or Outlet for the socket.

Press the “Update” button to make the change effective. The “Reset” button will reset the settings to the original defaults. Cancel will abort any changes.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the asset. See the Meta data section for more information.

Virtual Assets

Virtual assets are non-visual descriptions/objects that can be assigned metadata and can be linked to other assets, connections, and connectors. Examples here could be the creation of virtual fluid assets that can be assigned to pipelines for running simulations, non-visible topside equipment such as pumps that needs to be assigned a cost and appear in bill of materials etc.

Screenshot

ID - This is the unique system asset ID for the virtual asset. Note! This is not changeable.

+ Add Virtual Asset - Click on this button to create a new virtual asset.

Delete Virtual Asset - Click on this button to delete the selected virtual asset. A dialog box will prompt you to confirm as this action in not reversable.

Search - Type in your search criteria in the search field to narrow down the virtual asset type list.

  • Name - Enter a new name or edit the name for the selected virtual asset.

  • Sub type - Drop down list allows you to assign a type to it e.g. SPS, piping, rig, vessel etc. as shown here:

Screenshot

  • Category - Assign it to a category as e.g. Manifold, Template, XMT etc. as shown here:

Screenshot

  • Sub-Category - Assign it to a sub-category if this is defined.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the virtual asset. See the Meta data section for more information.

Connectors Settings

This section allows you to create new Connector types to your account, and you can also assign Metadata definitions for them.

Screenshot

+ Add New Connector - Press this button to add a new connector to the list.

Delete Connector - You can delete a selected Connector from the list by clicking on this button. A dialog box will prompt you to confirm as this action in not reversable.

Search - Type in your search criteria in the search field to narrow down the connector list.

  • ID - This is the unique system ID assigned to the new layer type. Note! This is not changeable.

  • Name - Specify or edit the name for the new connector.

  • VendorID - Use this field to specify your vendor ID if you use one.

MetaData Definitions - This section allows you to search and assign the available metadata definitions to the connector type. See the Meta data section for more information.

Import and Export

This section allows you to Import/Export various data objects from one FieldTwin instance to another e.g. Metadata, Connections, Connection-Types or Project data. This is useful if you need to allow a partner or a customer to work on the project. This functionality works in a "click-zip-ship" fashion.

Export

Screenshot

Action - Select either Import or Export as the action you want to perform.

Screenshot

For importing/ exporting, simply select the Import/Export action from the Action menu.

Objects - Select your preferred object to import/ export from the objects menu:

Screenshot

  • Connections - If you select connections, you can select all or an individual connection from the drop-down list:

Screenshot

  • Connection Type - If you select connection type, you will need to select a type from the drop-down list:

Screenshot

  • Project - Select this to import or export an entire project. This will present the following options:

Screenshot

Select the project you want from the drop-down list of all projects in the account, and then select one or more of the following project specific options.

  • Export All - Check this option to export the entire project with all data objects.

  • Export Costs - Select this option to include the export of any cost data.

  • Export Metadata Definitions and Values - Check this option to include Metadata and associated values. Also, use the Export Only Public MetaData Definition if you do not want to export Metadata that has been marked as private.

  • Export Account Information - Check this option to include the account information.

  • Export Layers - Check this option to include the Layer data.

Finally click on the Start Export button.

This will start gather all the data and make it ready for download. The data will be saved into a zip archive and a Download option will appear when ready. Click this button and the ZIP archive named "Project" with projectID appended will be saved in your Download folder.

Import

If you receive a FieldTwin Zip archive, then you can import it into your account. This is using the same option selection set as described for the Export option above. Make you Object selection first as described earlier. When ready press the Start Import button. This will present a file dialog according to your language settings allowing you to select the project data zip archive you have received:

Screenshot

This will then upload the FieldTwin project data selected into your account.

Tabs

This section allows you to create custom tabs, that will display an embedded iFrame or web page if you will as a separate Module tab. This is useful if you want to display result pages from integrations such as flow assurance simulations, engineering calculations, or embed business dashboards such as PowerBI or similar etc.

Screenshot

Create Custom Tab - Press this button to create a new tab or module.

Use following settings to configure the tab/module:

  • Name - This will be the name displayed for the module.

  • URL - This is the URL for the web page that will be embedded and displayed. Note! Only HTTPS connections are allowed unless you check Use proxy below.

  • Use proxy - Enable this if the resource you are loading does not have HTTPS or CORS enabled.

  • Use Get Verb Instead of Post - Check this if your page does not load and you get a 405 error in the developer console as the default is a POST request that includes JWT tokens as extra security for 3rd party integration partners.

  • Do not pass arguments in URL for GET request - If the option above is selected, you can then select this option so no arguments will be passed in the URL for any GET request.

  • Allow Access to Whole Project - Check this box if the loaded integration should have access to all sub-projects and not only the current selected one.

  • Allow Access to all User's Project - Check this box if the loaded integration should have access to the current user projects and not only the current one.

  • Project Settings URL - This allows you to create a dedicated project settings web front end that will be displayed in the FieldTwin Design Project Settings screen as shown below:

Screenshot

  • Project Settings Arguments - Here you can add parameteres that will be passed to the project settings URL defined above for your integration.

  • Account Settings URL - This allows you to create a dedicated account settings web front end that will be displayed in the FieldTwin Design Account Settings screen as for the project settings described above.

  • Account Settings Arguments - Here you can add parameteres that will be passed to the account settings URL defined above for your integration.

  • Tab Display Position - Here you can select your preferred position for the created custom tab; Module Panel(default), Hidden Global Tab, Hidden Local Tab, Bottom, Property Panel, Project View or Toolbar Button. See the Tab Display Position table below for more information.

  • Dialog Width - If the Toolbar Button option is selected this will set the width in pixels of the modal dialog box displaying the integration.

  • Dialog Height - If the Toolbar Button option is selected this will set the height in pixels of the modal dialog box displaying the integration.

  • Delete - The Delete button will delete the tab. You will be prompted to confirm as this option is not reversable.

Tab Display Position

See the screen layout below for the following embed layout options namely; Module Panel, Property Panel, Project View, and the Toolbar Button placed on the toolbar with the "PowerBI" caption.

Screenshot

The two (2) nonvisible options are as follows:

  • Hidden Global Tab (Always open, but with no UI) - This means that your embedded web page without UI elements is always open/running and will be able to capture events from the application for your integration.

  • Hidden Local Tab (Open when a project loads, but with no UI) - This means that your embedded web page without UI elements is only open/running when a sub-project is loaded and will only then start to e.g. capture events from the application for your integration.

As an example of Tab embedding you can link in a PowerBI dashboard for your projects e.g. the following is a sample dashboard courtesy of 4Subsea with data from the Norwegian Petroleum Directorate for the North Sea using the following URL:

https://app.powerbi.com/view?r=eyJrIjoiNGI4Mzk3YWEtMzQ3Zi00NWM3LTg5NmMtN2NmNzlmYzkwMmUxIiwidCI6ImNkZjRjZjNkLWRlMjMtNDljZi1hOWIwLWFiZDJiNjc1ZjI1MyIsImMiOjh9

Sample Module Embed

We use PowerBI for the module name and the Module Panel embed position:

Screenshot

WMS Settings

Here you or your mapping department can preconfigure the setup of different external/internal WMS servers (Mapping servers such as ArcGis) for your users so when they create new projects, they do not have to configure it first.

Screenshot

Click on the Create WMS server button to get started. Then click on the Configure button.

Screenshot

As you can see above, we create a default configuration for the Norwegian Petroleum Directorate open WMS map service named Norwegian Petroleum Directorate WMS. When your users now create a new project, they can then add mapping support to the project without configuring anything.

Screenshot

Delete - The Delete button will delete the selected WMS configuration. You will be prompted to confirm as this option is not reversable.

For information on configuring the various WMS option, please see Configure WMS

Modules

This section allows you to define various settings for external back end or 3rd party services. At the moment you will see the Cost-server configuration section displayed.

Cost-Server Settings

The cost server configuration is used if you are integrating your own costing software with Field Activity Planner Cost Server interface so that you can invoke the Server button in the Cost modules for your own proprietary cost calculation functionality. For more information and for documentation on the Cost Server interface, please contact your Field Activity Planner representative.

Screenshot

  • Cost-server field - Enter the URL pointing to the location of the Cost Server interface.

  • Security token - Enter the optional security token for cost calculation authentication.

  • Batch multiple cost queries into one - Select this checkbox if you want to avoid sending individual requests for each cost item to be calculated by the server.

  • Do not compute cost of items that have no metadata defined - Select this checkbox, then connection (or staged assets) without metadata will not be calculated by the cost server.

Note! If a metadata is set to have a default value, then it will count as a "set" metadata.

  • Configuration - This will see the Cost-server configuration.

To save your changes, scroll up to the top of the page and press the "Save changes" button.

Metadata Order

The Metadata Order setting is where you can arrange the list order of items created under Metadata for Groups and Sub Groups that appears as tabs in project view when you have selected the appropriate asset, virtual asset or connection.

Screenshot

See the Meta data section for more information on how to do this.