/
Better Together - Qbyte Financial DOI Integration to Qbyte Metrix

Better Together - Qbyte Financial DOI Integration to Qbyte Metrix

Search the Qbyte Metrix Wiki
 

Back to Better Together      Back to Qbyte Metrix Home    

DOIs set up and/or modified in Qbyte Financial that are required in Qbyte Metrix will automatically be pushed into staging tables within Qbyte Metrix. Production Accountants are then in control of the timing of when they pull new/changed DOIs and DOI Exceptions into Qbyte Metrix. The Effective Date provided by Qbyte Financial can be overridden in Qbyte Metrix before being integrated. DOIs are used to designate working interest owners and their ownership to revenues as well as expenses such as royalties and facility charges for a designated entity. DOI exceptions are required in situations where multiple DOIs are required for different purposes or activities, such as allocating royalties, facility charges, and sales.



What Needs to be Set Up in Qbyte Financial for DOI Integration with Qbyte Metrix?

DOIs can be sent to Qbyte Metrix as Default DOIs or product/purpose DOIs. If the Prod/Rev Code is EXC, then it will be treated as a Product/Purpose DOI. The Product and Purpose codes are cross-referenced to accounts in the Outgoing Cross References screen for Type Code METRIX _DOI. In our example, using Prod Rev codes of PRS and EXC, the following would take place:

  • For DOIs that have a PRS Prod Rev Code, the Product and Purpose codes will be set to 00.0 with a default flag equal to Y.

  • For DOIs that have an EXC Prod Rev Code, the Major and Minor account or accounts defined in the account group assigned on the Ownership Master for the cost centre will be used to determine the Product and Purpose from the outgoing Cross Reference. If a record is found, then the dest_value_1 is used for the Product Code and dest_value_2 is used for the Purpose Code. The default_flag is set to N for all DOIs where the Prod Rev Code is EXC.

Valid values for the Prod Rev Code on the DOI Links screen are set up using the Codes screen. 



Correct Codes Setup

In Qbyte Financial, navigate to Administration > Codes.

1. Query Code Type PRODUCTION REVENUE CODES.

2. Add the following Codes:

a. PRS – Production Revenue System Default.

b. EXC – Exception DOI for Production Revenue.

Required System Defaults to Activate Qbyte Financial - Qbyte Metrix integration

Use the System Default and Controls screen to add the appropriate revenue codes to the Default Value fields for DOI to Qbyte Metrix.

1. Navigate to Administration > System Defaults and Controls.

2. On the Sub-Systems tab, select 15 - DOI Interfaces. Set the Status to Active.

3. With sub-system 15 -  DOI Interfaces highlighted, select the Sub-Sys Comp tab.

4. Select 196 - DOI to Metrix and set the Status to Active.

5. With sub-system component 196 - DOI to Metrix selected, navigate to the Default Values tab. Default Values are set to indicate the valid Prod Rev Codes that will be entered on the ownership master for DOIs that will be triggered to Qbyte Metrix.

 

What Outgoing Cross References Should be Set Up?

Use the Outgoing Cross References screen to add records for Type Code = METRIX_DOI.

Qbyte FM Value 1 represents the Major Account and Qbyte FM Value 2 represents the Minor Account.

Destination Value 1 represents the Qbyte Metrix Product Code and Destination Value 2 represents the Qbyte Metrix Purpose Code.

The tables below list the Qbyte Metrix Product and Purpose codes used for DOI integration:

Qbyte Metrix Product

Description

Qbyte Metrix Product

Description

00

Not Product Dependent

OIL

Oil

GAS

Gas

COND

Plant Condensate

LPGNGL

LPG/MIX

C3

Propane

C4

Butane

C5

Pentane

C2

Ethane

SUL

Sulphur

RAWGAS

Raw Gas

Qbyte Metrix Purpose

Description

Qbyte Metrix Purpose

Description

OWN

Ownership

CRWN

Crown Royalties

FRHD

Freehold Royalties

ORR

Override Royalties

INDN

IOGC Royalties

OTHR

Other Royalties

In the example below, the account 8000 100 has the account description Oil Sales:

In this field...

Enter...

Value

In this field...

Enter...

Value

Qbyte FM Value 1

Major Account

8000

Qbyte FM Value 2

Minor Account

100

Destination Value 1

METRIX Product

OIL

Destination Value 2

METRIX Purpose

OWN

Navigate to Interfaces > Outgoing Cross References.

Set up the Outgoing Cross Reference values for METRIX_DOI accordingly.

How do I Set Up Account Groups?

Account Groups are used to set up Account Ranges that are required for Exception DOIs.

The account group, for example, OILN would be entered in the Account Group on the DOI Links screen.

1. Navigate to Configuration > Joint Interest > DOI Account Groups.

2. Setup your Account Groups with the required accounts. Select the Account Group to modify and then select the Group Accounts tab.

What is the Correct way to Set Up a DOI Link so it Triggers to Qbyte Metrix?

The DOI Links screens below show a DOI link as the default DOI or exception DOI for the same cost centre.

The Default DOI will be assigned a Product OIL and Purpose OWN (from Cross Reference values). The UserDefined1 field on the DOI tab of the Maintain Integrations screen will show the Agreement ID then the Product and Purpose e.g. 226 OIL OWN

Reminder: Since DOIs are associated with Cost Centres within Qbyte Financial (no well/tract entities exist) the Application Integration Configuration within Qbyte Metrix for the DOI Validated By option must be set to Cost Centre. This means that all Qbyte Metrix Well/Tracts with that Cost Centre will have their DOI updated. If the Cost Centre represents a Unit and all wells and tracts in the Unit have the same Cost Centre, then the one DOI will be updated on all wells and tracts but not the Unit. Users should be aware of this before sending Unit DOIs to Qbyte Metrix.

 

What needs to be Set Up in Qbyte Metrix?

Application Integration Configuration

1. Under Application Integration, select Maintain > Configuration.

  • The Application Integration Configuration screen will be displayed.

IN THIS FIELD...

ENTER THIS INFORMATION...

IN THIS FIELD...

ENTER THIS INFORMATION...

Integration Active

Available options include Yes or No.

  • Yes indicates you will be using integration for one or more masters. 

  • No indicates you will not be using Application Integration.

DOI Validated by

Available options include C - Cost Centre or W - Well/Tract. This indicator controls what is used to link the DOI in the staging table to the Qbyte Metrix DOI. If this option is Cost Centre then the Entity ID populated in the staging table should be the Cost Centre and during Qbyte Metrix Integration, the system will find all well/tracts that have that Cost Centre and update their DOI. If this option is Well/Tract, then the Entity ID populated in the staging table should be the actual Qbyte Metrix Well/Tract ID (with the Entity Type W or T specified too) and during Qbyte Metrix Integration the system will update only the DOI of the Well/Tract specified.

Reminder: As mentioned above when the Cost Centre option is selected, all Qbyte Metrix Well/Tracts with that Cost Centre will have their DOI updated. This means that if the Cost Centre represents a Unit and all wells and tracts in the Unit have the same Cost Centre, then the one DOI will be updated on all wells and tracts but not the Unit. Users should be aware of this before integrating Unit DOIs into Qbyte Metrix.

Qbyte Financial: If integrating DOIs from the Qbyte Financial application, then this must be set to C – Cost Centre.

Field Label

In the bottom half of the screen, you will find user-defined fields that have been defined for the Integration tables with the labels that have been selected by the client. 

The field names for the various user-defined fields can be overridden here so they appear differently on the Integration tabs.

 

Integration Settings

1. Under Application Integration, select Maintain >  Integration Settings to access the Integration Settings

  • The information displayed on the grid determines what types of masters can be integrated, and which masters are to be locked for data entry.

2. Click the Edit button to edit the masters that are to be integrated and/or to be locked for user input.

IN THIS FIELD...

ENTER THIS INFORMATION...

IN THIS FIELD...

ENTER THIS INFORMATION...

Integration Active

Available options include Yes or No.

  • Yes indicates which masters you have enabled for integration.

  • The corresponding Integration tab will be enabled or disabled by this option.

Qbyte Financial: When both Cost Centre and Well Integration are Active the user must remember to integrate the Cost Centres prior to integrating the Wells using those Cost Centres or the Cost Centre will not exist when the Well is integrated causing the integration to be unsuccessful. Since Cost Centres in Qbyte Financial create both Cost Centre and Well records in the Qbyte Metrix staging tables, we can simplify this process and have the Well Integration automatically create the Cost Centre. To enable this functionality the user should keep Well Integration Active but Inactivate the Cost Centre Integration. When this situation is encountered when integrating wells if the Cost Centre on the well does not exist in Qbyte Metrix then it will be created (as a Non-System Generated Cost Centre).

Type

Qbyte Metrix allows integration for the following masters:

  • Cost Centre

  • Well

  • DOI and Exceptions

  • Owner

  • Royalty Obligations

  • Royalty Global Rates

Qbyte Financial: Currently, Global Rates and Royalty Obligations cannot be integrated from the Qbyte Financial application.

Lock Master

Available options include Yes or No.

  • Yes  will disable the Create New button on the corresponding Qbyte Metrix Maintenance screen. It will allow editing of data but it will disable the data fields that can be populated from Integration. Fields on the Maintenance screen that are not available to be Integrated will still be enabled.

  • No indicates that all functionality on the corresponding Qbyte Metrix Maintenance screen will be available.



How do I Process DOI Integration Within Qbyte Metrix?

Note: Before a Qbyte Financial DOI can be integrated into Qbyte Metrix, the Cost Centre/Well and Business Associate/Owner must be integrated first. 

You must then process the integrations in the following order:

  1. Cost Centre (or Well)

  2. Owner

  3. DOIs

 

Accepting DOIs and DOI Exceptions integrated from Qbyte Financial in Qbyte Metrix

Qbyte Financial to Qbyte Metrix integration provides Qbyte Metrix Production Accountants the ability to first review the data populated in staging tables and then to choose to integrate the data into the actual Qbyte Metrix tables.

1. Navigate to the Process Integrations screen. Under the Application Integration menu, select Process to open the Process Integrations screen. 

2. Select the DOI and Exceptions tab. 

  • The screen will open and default to showing all DOIs that have a Process Status of Non-Processed.  Displayed records can be in one of three states:  

    • Non-Processed - waiting to be Integrated

    • Processed - already Integrated 

    • Previously Deleted - deleted prior to being integrated

To see previously processed entries, you can change the Process Status filter to include DOIs that have been either Processed or Previously Deleted.

The first row is highlighted by default and the owners that participate in that DOI are displayed below the grid.

To select one or many DOIs, click the Selected checkbox beside each row.

  • This action activates the Delete and Integrate buttons. 

To see the owners of the selected DOI, ensure the row is also highlighted by selecting anywhere within it.

The Override Effective Date allows you to change the Effective Date before integrating the DOI into Qbyte Metrix.

3. Select DOIs to integrate and update the Override Effective Date if needed.

bt1.png

4.  Once you have selected all the records you want to integrate, click the Integrate button.

  • A pop-up window will appear to confirm that the selected records are to be processed.

  • Select OK to integrate the selected masters or Cancel to return to the Process Integrations screen. 

If no errors are found, the message Selected records have been successfully integrated will appear at the top of the screen 

The grid will now be filtered by the Process StatusProcessed. 

Once a record has been successfully integrated (which changed its state to Processed) it cannot be Deleted or Integrated again.

5. Filter by Entity ID to find the newly integrated DOI.

If there were errors, the Integration screen will again be displayed with the DOI having a Process Status of Non-Processed and with an Error Indicator of Yes.

  • The Error Description will indicate how to correct the error.

  • The DOI can again be integrated after the errors have been fixed (for example, integrate the owners before the DOI, integrate the well before the DOI etc.).

Once successfully integrated, the DOI can be viewed in the DOI Maintenance.

6. Select the Masters tab and select DOI.

7. Enter the Well ID in the Entity ID field and select the View button.

  • The DOIs will be displayed.

  • Clicking on a specific DOI Sub will display details in the grid below.

bt2.png

What are the Technical Details?

Data is triggered from Qbyte Financial into a series of staging tables. These tables may physically reside in the same database instance as Qbyte Financial, or they may exist in an entirely separate database instance. If synonyms are defined for each of these database objects (tables and sequences), Qbyte Financial will recognize the table names. Qbyte Financial must also have select/insert/update/delete access to these Qbyte Metrix staging tables.

TABLE NAME

DESCRIPTION

SEQUENCE

TABLE NAME

DESCRIPTION

SEQUENCE

OWNER_INTEGRATIONS

Business Associates

IM002_SEQ

WELL_INTEGRATIONS

Cost Centres - legal location

IM003_SEQ

DOI_INTEGRATIONS

DOIs

IM004_SEQ

COST_CENTRE_INTEGRATIONS

Cost Centres - name/id

IM010_SEQ

  • The data in these tables is deleted after the records are moved to the Qbyte Metrix staging tables.

  • The Qbyte Metrix staging tables are not deleted, as they are key to the audit trail between Qbyte Financial and Qbyte Metrix.

The following packages must be valid:

PACKAGE NAME

TRIGGER ON

PACKAGE NAME

TRIGGER ON

ba_transfer_metrix.pkg

business_associates

ba_address_transfer_metrix.pkg

ba_addresses

pa_ba_transfer_metrix.pkg

pa_ba_properties

tov_metrix.pkg

temp_ownership_validations

cc_metrix.pkg

cost_centres

 


Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.