The purpose of this article is to explain how to get started inside the Petro.ai Panel
Overview
The Petro.ai Panel allows users to connect to a Petro.ai Database from within Spotfire. It allows for data to be saved to and loaded from the Petro.ai Database with preconfigured functions. An overview of the different Petro.ai Panel menus can be found below:
- The Home menu allows you to create and save Well Groups to the Petro.ai DB from marked wells in Spotfire. Currently saved Well Groups in the Petro.ai DB can also be browsed here.
- The Action menu allows you to load and save data to and from the Petro.ai DB via predefined functions. Once a function is defined it can be refreshed, which will load or save new data to/from the Petro.ai DB.
- The Table Settings menu tells the Petro.ai Panel which table, filter, marking, and columns to use when pushing data to the Petro.ai DB.
- Use the Database Connections menu to connect the Petro.ai Panel to your Petro.ai Database.
- The Petro.ai Panel has an in-visualization Help menu to offer quick description to users and reference. The Help menu can be accessed by clicking the help button in the Petro.ai Panel. The help menu also includes a link to additional, in-depth documentation.
In this article, we will step through a few examples of saving and loading data to Petro.ai Database using the Petro.ai Panel.
How to Create Well Groups and Save to the Petro.ai DB
The Petro.ai Panel must have a valid Petro.ai Database connection and valid Table settings before being used. These can be configured by following the steps below.
- Click on the Database Connection menu
- Use the drop-down to select the desired Database connection.
Upon selecting, an icon will spin before indicating a successful connection.
Note: If a connection is not set up, See Spotfire Administration: Configure MongoDB in Administration Manager - After successful connection, click the "Table Setting" menu.
- Use the drop-downs to configure the Table Settings which will be used to create well groups.
Click Refresh, if you don't see your table to configure. This will refresh Petro.ai Panel with any new data tables created in Spotfire. - Click Save
- Click on the Home menu
- Open a table visualization, by clicking the table visualization icon
- Select/Mark a group of wells from your table configured in the Table Settings above
- In the Home menu, create a group name for your wells (Note: Next to Create, you can see how many marked from the table visualization)
- Click Create - This will create a group of the marked wells with the given name and save them to the Petro.ai Database.
How to Edit Existing Well Groups
- In the well groups panel, Click the well group that you want to edit.
- After selecting the group to edit, the "Active Group" panel will be shown (see below).
In the Active group menu, there are options to:Mark - Marks/Highlights the original group of wells saved. Add to Group - Save the new Marked to the existing group Remove From Group - Removes marked/selected from the existing group Delete - Deletes the entire group Name - Change the name of the existing group Description - Add a description to the created group Save - Save new settings configured Refresh - Click Save after editing existing groups.
How to Load from the Petro.ai DB
- Click the Database Connection menu
- Use the drop-down to select the desired Database connection.
Upon selecting, an icon will spin before indicating a successful connection.
Note: If a connection is not set up, See Spotfire Administration: Configure MongoDB in Administration Manager - Click the Action menu
- Click on the Add Function tab
- Select a new action
Note: after selecting a new function, a configuration panel will populate with options for the specific function. Each new function will have different options, the load Well Production Table is shown below: - Configure the settings for the function
- Click Create to save new action
After clicking create the Petro.ai Panel will create an output table in Spotfire with the name specified in the function and populate that table with data from Petro.ai.
How to Edit a Function
Once a function has been created it can be refreshed, viewed, and edited via the Actions menu in the Configured Functions tab:
Refresh - Refreshes the action, loading or saving data from/to the Petro.ai DB | |
Edit - Edits the previously saved function configuration | |
Remove - Removes the function from the configured function list. |
- Click Edit to change the existing function.
- Edit any fields, under Edit the Function
Example: This is the same function created above. - Click Save when complete
For additional information on Petro.ai Panel documentation, click here