{"id":54391,"date":"2022-05-05T16:22:41","date_gmt":"2022-05-05T08:22:41","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=54391"},"modified":"2024-07-08T10:12:12","modified_gmt":"2024-07-08T02:12:12","slug":"merrick-metadata-configuration-utility","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/field-explorer\/field-operator-administration\/merrick-metadata-configuration-utility\/","title":{"rendered":"Merrick Metadata Configuration Utility"},"content":{"rendered":"\n

Field Operator: Explorer Edition is built to use the same metadata structure (screens, menus, business components, etc.) as ProCount and Carte. The Merrick Metadata Configuration Utility<\/strong> which is installed with the IFS OI Merrick installer is used to configure all three of these applications. This section will describe adjustments to be made in the Metadata Configuration Utility that are specific to Field Operator: Explorer Edition.<\/p>\n

It is assumed that the reader has a working knowledge of the Merrick metadata concepts and configuration utility.<\/p>\n

Totals<\/h2>\n

Field Operator and Carte use the same configuration for Totals. Some of the properties on the Totals configuration in the Merrick Metadata Configuration Utility have been added in v4 solely for Field Operator: Explorer Edition. These settings have no effect on ProCount, Carte or Field Operator 3.X.<\/p>\n

The new settings can be edited on the Route Totals Setup<\/strong> screen:<\/p>\n

\"Table,<\/a><\/p>\n

Route\/Stop - Cards\/Charts and Route\/Stop Grid<\/h3>\n

It does not always make sense to display every total on the charts in Field Operator because there can be so many lines that the chart is unreadable. For this reason, these news settings define where a total value should show in the app.<\/p>\n

\"\"<\/a><\/p>\n

Totals set to display on Cards and Charts are more prevalent throughout the app where the user is viewing summary level data.<\/p>\n

\"Graphical<\/a><\/p>\n

Other totals can be set to display on grids only so the data is available for inspection at the detail level, but doesn\u2019t clutter the charts.<\/p>\n

Space Before<\/h3>\n

This setting adds a small space before this total in the Location Summary grid. This can help a user\u2019s eye to categorize totals and find what they are looking for.<\/p>\n

\"Table<\/a><\/p>\n

Include Average<\/h3>\n

When \u2018Include Average<\/strong>\u2019 is selected for a total, the Location Summary grid will calculate the average volume for the previous 7 days of readings. Two columns will be added to the grid to display the previous 7-day average and the difference between today\u2019s reading and that average.<\/p>\n

\"Graphical<\/a><\/p>\n

Variance Percent and Difference<\/h3>\n

If the \u2018Include Average\u2019<\/strong> option is selected, the total can also be configured to highlight in Yellow or Orange if the variance from the previous average is outside the tolerance set here. The variance must meet both the volume and percent criteria to turn color. This keeps the user from being alerted on low volumes. For example, if a well produces 2 MCF per day and today it produced 1 MCF, the user should likely not be alerted. But if a well produces 2,000 MCF per day and today it produced 1,000 MCF, the system should alert the user.<\/p>\n

Once configured, totals will turn yellow or orange on the Location Summary Grid in Field Operator: Explorer Edition. Users can tap or click highlighted cells to view details that explain why they were highlighted.<\/p>\n

\"Graphical<\/a><\/p>\n

Production Entities<\/h2>\n

Field Operator: Explorer Edition uses configurable SVG files for the icons on screen. These SVG files are part of the metadata files and the default set will help align the look of Field Operator: Explorer Edition<\/strong> and IFS OI Explorer<\/strong>. SVG files can be imported using the Merrick Metadata Manager<\/strong> utility.<\/p>\n

\"Graphical<\/a><\/p>\n

SVG files allows the Field Operator app to use the same icons as IFS OI Explorer.<\/p>\n

Once imported using the Metadata Manager, an SVG image can be assigned on the Define Production Entities<\/strong> screen, Reading Types<\/strong> tab.<\/p>\n

\"Graphical<\/a><\/p>\n

The Field Image<\/strong> setting has no effect on ProCount, Carte or Field Operator 3.x.<\/p>\n

Daily Readings Screen Configuration<\/h2>\n

Entry and review of Daily Readings is central functionality to the Field Operator application. Screens are presented in a \u2018Pivoted Grid\u2019 paradigm allowing the user to quickly page through the data to enter a daily reading for each entity on a location.<\/p>\n

\"A<\/a><\/p>\n

Grid Views for Everyone and Data Entry define Field Operator Daily Readings Screens<\/h3>\n

Field Operator uses the same screen definitions as ProCount (and Carte) for Daily Readings, but only a subset of the fields that display in ProCount will appear in Field Operator.<\/p>\n

Screens in the Merrick Metadata Config Utility are comprised of \u2018sections\u2019. Administrators configure a screen component to fill in each section. Combined, these sections define the screen to be displayed in ProCount.<\/p>\n

\"A<\/a><\/p>\n

\"A<\/a><\/p>\n

For each section of the screen, administrators select a subset of the fields to be visible as columns in Grid View<\/strong>.<\/p>\n

\"Table<\/a><\/p>\n

Only the fields assigned to the Everyone<\/strong> and Data Entry<\/strong> sections will be used by Field Operator.<\/p>\n

Additionally, the Daily Reading screens in Field Operator are driven by the Grid View<\/strong> of the screen configuration. The grid in ProCount \/ Carte and the Daily Reading screen in Field Operator are derived by combining the fields from grid configuration of each section of the screen.<\/p>\n

\"Timeline<\/a><\/p>\n

\"Graphical<\/a><\/p>\n

The Header<\/strong> on the Grid configuration is used as the label for the field on the Daily Readings screen in Field Operator. Labels configured the Form view are only used in ProCount and do not affect Field Operator. Other attributes on the Grid configuration such as Format<\/strong>, Text Align<\/strong>, Enabled<\/strong>, Control Type<\/strong>, Pick List<\/strong> and Default Type<\/strong> also are applied to the Daily Readings screen in Field Operator.<\/p>\n

Record Date<\/strong> is a special field. Record date must be included as the first field on the daily readings grid but will be used as the header for the column on the Daily Readings screen in Field Operator.<\/p>\n

Comments<\/strong> is also a special field. Previous versions of Merrick software stored Daily Notes about each day\u2019s reading in a table called CommentsTb in the ProCount database. In Field Operator, all comments are stored in IFS OI Explorer, but there is a special category of Comment for Daily Notes. If the old Merrick comments field is included on a daily screen, it will be removed. Every daily screen automatically has a Notes<\/strong> field in its stead.<\/p>\n

Less is More<\/h3>\n

It\u2019s important when configuring the screens for Field Operator to keep the user\u2019s experience with the application in mind. Field users tend to have smaller screens (iPads for example) and are focused only on the operational portion of the reading. ProCount users tend to have larger monitors and are focused on an accounting view of the reading. Be careful to only include in the Data Entry, Grid view, the fields that are appropriate to the field user.<\/p>\n

Extra fields on the screen make data entry more difficult and time consuming as the user\u2019s eyes need to search for what\u2019s important to him.<\/p>\n

For example, in many areas the user will never enter water gauges on an oil tank. Also, in such an area the field user is only concerned with the Gross oil production and does not record temperature and density daily. Although Merrick is flexible enough to provide daily net oil calculations on the tank daily screen, including those fields in an area where they are not needed causes the user to only see one tank at a time on his screen and can slow down data entry as he needs to scroll through his screen looking for what\u2019s pertinent.<\/p>\n

\"Graphical<\/a><\/p>\n

Forms Configuration<\/h2>\n

Readings that are not entered daily are entered as Forms<\/strong> in Field Operator (sometimes referred to as Transactions in Merrick). Forms<\/strong> include readings such as Run Tickets, Water Draws and Well Tests along with custom readings that you can define to meet your company\u2019s needs.<\/p>\n

Form and Grid View Settings Define a Field Operator Form<\/h3>\n

Unlike Daily Readings, a Form\u2019s configuration in Field Operator utilizes both the Form and Grid areas of the configuration in the Metadata Configuration Utility.<\/p>\n

In ProCount, the Metadata configuration\u2019s Grid settings define the list of records and the Form configuration defines the screen used to edit a record.<\/p>\n

\"Graphical<\/a><\/p>\n

The same concept is used in Field Operator. The Metadata configuration\u2019s Grid settings define the list of records and the Form configuration defines the screen used to edit a record.<\/p>\n

\"Graphical<\/a><\/p>\n

Field Operator, however, displays the Form as a single column of fields<\/em> instead of using the X, Y coordinates defined in the Metadata Configuration Utility. This is designed to make the form viewable on a small device such as a phone.<\/p>\n

A few special rules apply when configuring a form for Field Operator.<\/p>\n

Tab Order<\/strong>: The Tab Order defines the sequence in which the fields are displayed on the Form in Field Operator. While configuring the form in the Metadata Configuration Utility, click the Tab button in the toolbar to set the order for the fields in Field Operator. This setting also affects ProCount as it defines the sequence that fields will receive focus as the user presses the tab key.<\/p>\n

\"Graphical<\/a><\/p>\n

Column Width<\/strong>: Since Field Operator does not use the x\/y coordinates from the form definition, the looks to the Grid<\/strong> configuration to determine the widths in the single column form. Even if the field is not included in the grid view, the column width still is read from the grid configuration.<\/p>\n

\"Graphical<\/a><\/p>\n

A little extra care is needed to ensure the screen is easily readable for the user. Please visit the grid view and standardize the widths of the data entry fields on the screen.<\/p>\n

\"Graphical<\/a><\/p>\n

Labels<\/strong>: The labels on the Field Operator form come from the Form setup.<\/p>\n

\"Graphical<\/a><\/p>\n

Note:<\/strong> The Keep with Previous on Columnar Form<\/strong> attribute that was available in Field Operator v3.x is not currently available in Field Operator: Explorer Edition. Support for this attribute will be available in a future release.<\/p>\n

Form Cards for Map View<\/h3>\n

In Field Operator\u2019s Map View<\/strong>, when the user selects the Forms<\/strong>, a list of \u2018cards\u2019 displays the readings for the last few days. These are configured by selecting the Visible on Field Operator Card<\/strong> and Bold on Field Operator Transaction List<\/strong> attributes in the Grid View configuration.<\/p>\n

\"Graphical<\/a><\/p>\n

Data for fields set to be bolded will be separated by a little extra white space, like Date in the screen shot.<\/p>\n

Days to Load and Allow Edits for Forms<\/h3>\n

Visit the Business Components Setup screen in the Merrick Metadata Configuration Utility to define how many days of readings should be downloaded and editable for Forms in Field Operator: Explorer Edition.<\/p>\n

\"Graphical<\/a><\/p>\n

Configuring Entity Headers<\/h2>\n

Field Operator will always display the Entity Name and its Merrick ID in the header areas on the Daily Readings screens.<\/p>\n

\"\"<\/a><\/p>\n

This area of the screen can also be configured to display other information about the Entity by editing the Header Area of the daily screen.<\/p>\n

\"Graphical<\/a><\/p>\n

First add fields to the Form view of the header area. If Name and Merrick ID are already on the form, leave them there. If adding a field tied to a picklist, be sure that the picklist attributes are correctly filled in and that the text alignment is corrected.<\/p>\n

Ensure this form view is also laid out acceptably in the Header Area for ProCount.<\/p>\n

\"\"<\/a><\/p>\n

Next, switch to Grid View and ensure that the picklist properties and text alignment are set correctly here as well. Mark each field that you\u2019d like on the Entity Header in Field Operator with Visible on Field Operator Card<\/strong>. Also adjust the column\u2019s Width<\/strong> as this setting is used by Field Operator.<\/p>\n

\"Graphical<\/a><\/p>\n

The selected fields will be displayed after the name, reserving the width for each field as specified above.<\/p>\n

\"Table<\/a><\/p>\n

You should make the column widths as narrow as possible because iPads have less room to display this header information than a monitor in the office.<\/p>\n

Deploying Metadata Changes<\/h2>\n

Changes to screens should be treated as a development activity which requires testing before being deployed to the end users. The Merrick Metadata Configuration system provides the concept of Metadata Sets<\/strong> to allow for testing of changes. The basic concept is that you should:<\/p>\n

1. <\/strong>Make a copy of the production metadata set.<\/p>\n

2. <\/strong>Make your changes on the copy.<\/p>\n

3. <\/strong>Test your changes on the copy.<\/p>\n

4. <\/strong>Promote the copy as the production metadata set.<\/p>\n

Merrick\u2019s Metadata Manager<\/strong> utility can help you quickly make copies of metadata sets.<\/p>\n

In addition to working with a copy of the production metadata, it\u2019s recommended to also work with a test Field Operator Server Instance<\/strong> while performing this activity. Create a new instance and select just a couple of sample routes to work with. The process will require stopping and starting the server instance and reloading the download folders, so you will want to work with a very small data set. Often, you\u2019ll make a change to a screen, check it in the app and see that you need to immediately make another change (forgot the text align, misspelled something, forgot the format, etc.).<\/p>\n

For performance reasons, metadata is held in memory on the Field Operator Server. This keeps the app from reading this data from the database every time it\u2019s needed. This also means though, that your changes to metadata will not be immediately transmitted to the end user. Also the download folders are prepared for users to quickly download so that users don\u2019t have to wait for data to load from the database. This means to get a metadata change to a Field Operator: Explorer Edition device 1) the Field Operator Server\u2019s memory needs to be refreshed with the new config from the database and 2) the download folder needs to be updated.<\/p>\n

The process is as follows:<\/p>\n

1.<\/strong> Make the changes in the Merrick Metadata Configuration Utility (you can leave the utility open between iterations, just be sure to Apply changes).<\/p>\n

2.<\/strong> Stop and start the eVIN Instance in the eVIN Enterprise Manager and wait for the message \u2018ProCount Data Loader Initialized\u2019 in the log.<\/p>\n

\"Graphical<\/a><\/p>\n

3. <\/strong>Invoke Rebuild Field Operator Download Folders<\/strong> in the Enterprise Manager and wait for the message \u201cLoaded ___ locations in ___ seconds\u201d in the log<\/p>\n

\"Graphical<\/a><\/p>\n

4. <\/strong>If the Field Operator client has been running, its Live Sync has likely received an error because the server instance was stopped.<\/p>\n

\"Graphical<\/a><\/p>\n

Tap the word Error<\/strong> to visit the Sync Status screen. The log should have a message stating that the Field Operator Server is offline. Tap Retry Now<\/strong> to re-download the data from the Downloads folders on the server.<\/p>\n

\"Graphical<\/a><\/p>\n

5. <\/strong>For many changes you will need to Close and Re-open the Field Operator app<\/strong> after the sync has succeeded to see the changes on the device.<\/p>\n

Note:<\/strong> To see the metadata changes in ProCount, you\u2019ll need to recycle the app pool in IIS. There is no need to recycle the app pool while testing Field Operator only.<\/p>\n","protected":false},"excerpt":{"rendered":"

Field Operator: Explorer Edition is built to use the same metadata structure (screens, menus, business components, etc.) as ProCount and Carte. The Merrick Metadata Configuration Utility which is installed with the IFS OI Merrick installer is used to configure all three of these applications. This section will describe adjustments to\u2026<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":29,"featured_media":49358,"parent":49330,"menu_order":11,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[1],"tags":[],"class_list":["post-54391","page","type-page","status-publish","has-post-thumbnail","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/54391","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/29"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=54391"}],"version-history":[{"count":18,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/54391\/revisions"}],"predecessor-version":[{"id":67901,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/54391\/revisions\/67901"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/49330"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/49358"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=54391"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=54391"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=54391"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}