Qbyte Metrix Interface
What do I Need to Set up in Qbyte Metrix?
Directories
1. To set up directories, navigate to the menu and select Administration > System Configuration > Directories.
2. In the Directory Type field, highlight the record for Financial Vouchers, and enter the following information:
In this field... | Enter this value... |
---|---|
Inbound / Outbound Use |
|
Directory Path | The directory in which revenue interfaces that have been processed by Qbyte Metrix are stored. |
Include Month in Path |
|
Entry Definitions
Entry definitions define the debit and credit account for entries from production accounting. Each entry that matches the entry definition set up will be coded to the specified debit and credit account for that type.
1. To set up entry definitions, navigate to the menu and select Financial > Definitions, then select the Entry Definitions tab.
2. Enter entry definition information:
In this field | Enter this value |
---|---|
Province |
|
Product |
|
General | Choose from SALE, CRWN, ROY, etc |
Specific Type | Choose from Crown Royalties, Non Residents Tax, Contract Fees, etc. Only a general type is required.
|
Entry Required | Indicates whether an entry is required during the revenue interface. Valid values are:
|
Debit Account | The description of the debit account that will be used for this entry type. |
Credit Account | The description of the credit account that will be used for this entry type. |
Taken in Kind | Indicates whether the entry definition is for Taken In Kind sales. Valid values are:
|
Vendor | Used if entries from a specific vendor require a specific debit and credit account, the vendor ID is entered. WIO/Vendor Exceptions entries will be required if this field is populated.
|
Working Interest Owner | Used if entries from a specific working interest owner require a specific debit and credit account, the working interest owner is entered. WIO/Vendor Exceptions entries will be required for this Working Interest Owner.
|
Sub-Entry Key | Used to book an entry differently from similar screens for specific properties. (e.g. gas sales for a property is booked to DR Accts Rec and CS Gas Sales, but for a specific property the debit entry is DR Gas Mktg). Note: This field must be used in conjunction with the Sub Entry field on the Journal Voucher Definition Master. |
Sub-Entry Code | Used in conjunction with the Sub-Entry Key from a previous entry definition that is identical. When these are used together, the created entry is repeated, and each entry can be booked to different debit and credit accounts. |
Account Definitions
Account definitions define the debit and credit account description for entries from production accounting.
1. To set up account definitions, navigate to the menu and select Financial > Definitions, then select the Account Definitions tab.
2. Enter account definition information:
In this field | Enter this value |
---|---|
Account Name | The description of the account. |
GL Account Number | The net account from Qbyte Financial. During the revenue interface, the appropriate gross account will be found for this entry. Note: If entering a major account with four characters, enter the account without spaces. If entering a major account with three characters, enter the account with a space. |
Cost Centre Required | Indicates whether the account requires a cost centre. Valid values include:
|
Volume Required | Indicates whether the account requires a volume. Valid values include:
|
Booking Code | The booking code of the account. Valid values include:
The no bill flag is B on all sales, royalties and expense transactions that are distributed to partners. |
Vendor Type | The vendor type of the account. Valid values include:
|
Source Vendor Type | The source vendor type of the account. Valid values include:
|
Detail Required | Indicates whether additional detail is used. Additional detail is required in the following situations:
Additional detail is not required in the following situations:
|
Calculate Gross Values | Indicates whether gross values are calculated. Valid values are:
|
GST Code | Enter 99. |
Sort Order | Used to sort accounts on the Voucher report. This field will default to 00. |
Comment Type | The description displayed on the journal voucher for the account definition. Valid values are:
|
Break on Tract Entity | Valid values are:
|
Reference Format | Used to create the invoice number. Valid values are:
|
Reference Number | The reference number that is used in the reference format for payable and receivable accounts. |
Voucher Definitions
Voucher definitions define which properties should be associated with specific journal entries. The journal vouchers will use the assigned voucher number and description every month.
1. To set up voucher definitions, navigate to the menu and select Financial > Definitions, then select the Voucher Definitions tab.
2. Enter voucher definition information:
Column / Field | Value |
---|---|
Entity Type | The entity type of the voucher. Valid values are:
|
Entity ID | The battery ID, unit ID or control group to be included in the voucher. |
Voucher Required | Indicates whether the property should be booked. |
Voucher Number | The voucher number assigned for the voucher definition. |
Voucher Description | The description of the voucher. |
Sub Entry Code | The sub entry code works in conjunction with the Sub Entry field on the Entry Definitions tab. Together they allow entries for selected properties to be booked differently. |
Maintain WIO/Vendor Exceptions
WIO/Vendor exceptions allow the booking of specific vendors or working interest owners to be different than other vendors or working interest owners, with similar entries through Entry Definitions.
1. To set up WIO/Vendor definitions, navigate to the menu and select Financial > Definitions, then select the WIO/Vendor Exceptions tab.
2. Enter WIO/Vendor exception information:
In this field | Enter this value |
---|---|
Type | The type of the WIO/Vendor exception. Valid values include:
|
Owner ID | The ID of the owner or vendor in the WIO/Vendor exception. |
Owner Name | The name of the owner or vendor in the WIO/Vendor exception. |
Batch Number
The batch number for the financial interface is assigned sequentially.
1. To see the batch number, navigate to the menu and select Financial > Definitions, then select the Batch Number tab.
Financial Group
Financial processing can be run by control group or financial group. Financial groups allow the revenue interface for multiple control groups to be run. To create a financial group, navigate to the menu and select Financial > Financial Groups.
OneStep Interface
1. To use the OneStep interface, navigate to the menu and select Administration > Region, and set the Qbyte FM OneStep to Yes.
What do I Need to Set up in Qbyte Financial?
Voucher Types
To easily identify revenue vouchers, create a voucher type that will be used for all vouchers created during the Qbyte Metrix Revenue Interface process.
1. Navigate to the menu and select Configuration → Voucher → Voucher Type Controls.
2. The Voucher Type must have the Batch Edit Auto Gen and Auto Numbering check-boxes selected.
3. The voucher type created must now be assigned to the REVU066 module.
This means that all vouchers created by the Qbyte Metrix Revenue Interface process will be assigned the desired voucher type.
To do this, navigate to the menu and select Administration > Modules, and add the voucher type in the Voucher Type Code field.
System Defaults
To activate revenue interfaces from Qbyte Metrix, various sub-systems, sub-system components and system defaults must be configured. To configure these, navigate to the menu and select Administration > System Defaults and Controls.
Sub-System 1 - CORE
1. In the System Defaults and Controls screen, highlight sub-system 1 - CORE, and ensure the Status is Active.
2. While sub-system 1 - CORE is highlighted, select the Sub-Sys Comp tab.
3. Highlight sub-system component 1 - CORE.
4. While sub-system component 1 - CORE is highlighted, select the Default Values tab, and enter the following system defaults:
Column / Field | Value |
---|---|
LDR_PATH | The directory in which the revenue interface control file is stored. |
SHL_PATH | The directory in which the revenue interface shell script is stored. |
TRUNCATE_ALLOWED | Indicates whether the temporary tables which store revenue interface data are truncated at the beginning of each revenue interface process. The temporary tables are:
Valid values are:
|
Sub-System 2 - QBYTE FM
1. In the System Defaults and Controls screen, highlight sub-system 2 - QBYTE FM, and ensure the Status is Active.
2. While sub-system 2 - QBYTE FM is highlighted, select the Sub-Sys Comp tab.
3. Highlight sub-system component 5 - BATCH EDIT, and ensure the Status to Active.
While sub-system component 5 - BATCH EDIT is highlighted, select the Default Values tab, and enter the following system defaults:
Column / Field | Value |
---|---|
BATCH_EDIT_TRANS_TOLERANCE | The maximum tolerance allowed for balancing a revenue interface voucher. |
Sub-System 12 - REVENUE INTERFACE
1. In the System Defaults and Controls screen, highlight sub-system 12 - REVENUE INTERFACE, and change the Status to Active.
2. While sub-system 12 - REVENUE INTERFACE is highlighted, select the Sub-Sys Comp tab.
3. Highlight sub-system component 12 - CORE, and change the Status to Active.
4. As well, highlight sub-system component 198 - METRIX, and change the Status to Active.
5. While sub-system component 12 - CORE is highlighted, select the Default Values tab, and enter the following system defaults:
Column / Field | Value |
---|---|
REVENUE_HISTORY_DATA_PATH | The directory in which revenue interfaces that have been processed by Qbyte Financial are stored. Once the Revenue Interface is processed, the report ID will be appended to the file name, and the CSV file created by Qbyte Metrix will be moved to this directory. |
REVENUE_INTERFACE_DATA_PATH | The directory in which revenue interfaces that have been processed by Qbyte Metrix are stored. |
REV_INT_IGNORE_CLIENT_ID_X | The business associate IDs (e.g. Purchasers, Royalty Owners, Partners) that will be ignored by the Revenue Interface process. Each additional business associate entered will have a sequential number entered in X (e.g. REV_INT_IGNORE_CLIENT_ID_2) Business associate 999999 is typically entered here, as it is used for Taken in Kind revenue transactions and royalty gross up transactions |
REV_INT_INVOICE_DATE_SOURCE | The invoice date used in Qbyte Financial. Information on how the invoice date is generated can be found here. |
REV_INT_NOBILL_INDICATOR_CODE | Codes defined will create intercompany transactions where the business associate is an organization. Typically all billable transactions to insider organizations will have a no bill indicator of B entered. Each additional no bill indicator entered will have a sequential number entered in X (e.g. REV_INT_NOBILL_INDICATOR_CODE2) |
REV_INT_PAYABLE_INVC_DAY | The day of the payable invoices created during the interface process. (e.g. 15 would represent the 15th of the month). |
REV_INT_RECEIVABLE_INVC_DAY | The day of the receivable invoices created during the interface process. (e.g. 25 would represent the 25th of the month). |
User Defaults - OneStep Interface
To run the OneStep interface, user defaults must be configured for each user that is running the OneStep interface.
1. To configure these, navigate to the menu and select Administration > User Defaults.
2. In the User Defaults section, enter the default printer and source code:
Running Revenue Interface Using the OneStep
Qbyte Financial OneStep is a process that can be used by Qbyte Metrix clients that use Qbyte Financial as their financial system.
The OneStep process will automatically submit the Qbyte Metrix Interface (REVU066) and Validate Interfaced Vouchers (ACTU116) processes in Qbyte Financial when the Financial Interface Final process is run successfully in Qbyte Metrix.
Running Qbyte Financial OneStep Process
Additional information OneStep Information
Problem Solving Financial Interface Final OneStep
Running Revenue Interface in Qbyte Metrix
Running the revenue interface without using the one step interface requires properties run the financial processing in Final Mode before the interface can be run in Qbyte Financial. This process will create the interface file in the specified directory, that is then processed in Qbyte Financial.
Financial Processing
To run financial processing, navigate to the menu and select Financial > Processing.
Financial Interface - Preliminary Mode
Enter financial processing information. Running the financial interface in preliminary mode will create reports that can be reviewed prior to running the financial interface in Final Mode:
In this field | Enter this value |
---|---|
Production Date | The production date of the financial interface. This value will default to the current production month. |
Entity Type | The type of entity to be processed. Valid values are:
|
Entity | The name of the control group or financial group of the financial interface. |
Financial Interface - Final Mode
Running the financial interface in final mode will update the control group as interfaced, and create the revenue interface file that can be processed by Qbyte Financial:
In this field | Enter this value |
---|---|
Production Date | The production date of the financial interface. This value will default to the current production month. |
Entity Type | The type of entity to be processed. Valid values are:
|
Entity | The name of the control group or financial group of the financial interface. |
Regional Financial Interface - Preliminary Mode
Enter financial processing information. Running the regional financial interface in preliminary mode will create reports that can be reviewed prior to running the financial interface in Final Mode:
In this field | Enter this value |
---|---|
ProductionDate | The production date of the financial interface. This value will default to the current production month. |
Entity Type | This field will default to Region. |
Entity | The region of the financial interface. This field will default to the region assigned to the Master Owner. |
Include Amendments | Indicates whether to include amendments in the financial interface. Valid values are:
|
Regional Financial Interface - Final Mode
Running the regional financial interface in Final Mode will update the control group as interfaced, and create the revenue interface file that can be processed by Qbyte Financial:
In this field | Enter this value |
---|---|
Production Date | The production date of the financial interface. This value will default to the current production month. |
Entity Type | This field will default to Region. |
Entity | The region of the financial interface This field will default to the region assigned to the Master Owner. |
Include Amendments | Indicates whether to include amendments in the financial interface. Valid values are:
|
Financial Reports
To view financial reports, navigate to the menu and select Financial > Financial Reporting.
In this field | Enter this value |
---|---|
Accounting Date | The accounting date of the financial interface.
|
Transactions | Indicates which transactions to display. Valid values are:
|
Separate Royalty Reports by Owners | Valid values are:
|
Include Net Zero Records | Valid values are:
|
Financial Interface IDs | The name of the financial interface. |
Running Revenue Interface in Qbyte Financial
Running Qbyte Metrix Interface
To run the revenue interface in Qbyte Financial, navigate to the menu and select Interfaces > Qbyte Metrix Interface.
Enter revenue interface information:
In this field | Enter this value |
---|---|
Organization ID | The organization that the revenue interface will be processed in. |
Accounting Period End Date | The accounting period that the revenue interface will be processed in. |
Metrix Batch Number | The batch number of the revenue interface. |
Load Upload Data Files (Y/N) | Indicates whether the file generated by Qbyte Metrix will be processed. Enter Y to upload the revenue interface file. |
PA Filename | The name of the revenue interface file generated by Qbyte Metrix. |
Print Detail Report (Y/N) | Indicates whether the Production Accounting Interface Audit report will be run during the process. |
Running Validate Interfaced Vouchers
To run the Validate Interface Vouchers process in Qbyte Financial, navigate to the menu and select Interfaces > Validate Interfaced Vouchers.
2. Enter revenue interface information:
In this field | Enter this value |
---|---|
Batch ID | The report ID of the report that processed the revenue interface. |
Voucher Number | The number of the voucher. |
Voucher Type Code | The type of the voucher. |
Organization ID | The organization that the revenue interface will be processed in. |
Accounting Period End Date | The accounting period that the revenue interface will be processed in. |
Override User ID | The user that processed the revenue interface. |
Source Module ID | The module ID to process. |
Revenue Interface Reports
The following reports can be generated by the revenue interface process in Qbyte Metrix:
Financial Voucher
Voucher Account Summary
Voucher Cost Centre Summary
Voucher Details
Ownership Summary
Purchaser Statement
Royalty Owner Statement
Facilities Charges - Expense owner/income
Royalty Calculations Back Up
The following reports are generated by the revenue interface process in Qbyte Financial:
REVU066 - Qbyte Metrix Interface report
ACTU116 - Validate Interfaced Vouchers report
ACTR243 - Interface Summary report
REVR063 - Production Accounting Interface Audit report
Sample Reports
Qbyte Metrix Interface report
Validate Interfaced Vouchers report
Interface Summary report
Production Accounting Interface Audit report
Revenue Interface FAQ
Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.