Business FLEX® 250.1
Production Balance Configuration Guide Document ID: PB-CFG-250 Revision Date: September 2016
Copyright, Notices, and Trademarks
Copyright, Notices, and Trademarks © Honeywell International Inc. 1998 – 2016. All Rights Reserved. While this information is presented in good faith and believed to be accurate, Honeywell disclaims the implied warranties of merchantability and fitness for a particular purpose and makes no express warranties except as may be stated in its written agreement with and for its customer. In no event is Honeywell liable to anyone for any indirect, special or consequential damages. The information and specifications in this document are subject to change without notice. Honeywell, Experion, Uniformance and Business FLEX are registered trademarks of Honeywell International Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. Crystal Reports and Business Objects are trademarks or registered trademarks of Business Objects SA in the United States and/or other countries. Adobe and Acrobat Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. OSIsoft and The PI System are either registered trademarks or trademarks of OSIsoft, Inc. All other brand and product names shown are trademarks of their respective owners.
About Business FLEX® Business FLEX® is a family of advanced applications that improve plant profitability by enabling plant staff to work more effectively and make better decisions. To learn more about Production Balance and other Honeywell software solutions, contact your Honeywell account manager. Visit us online at www.honeywell.com/ps, or contact us at 800-822-7673. Honeywell, 1860 West Rose Garden Lane, Phoenix, Arizona, 85027, USA
Release Information Business FLEX: Release 250.1 Revision Date: September 2016 Business FLEX Database Version: BF250.0.00 Document ID: PB-CFG-250
ii • Production Balance Configuration Guide
Contents
Contents About This Document
1
Overview Before You Begin About This Guide Production Balance Enhancements Related Documents Contact Us
1 2 2 2 3 3
Configuration Overview
5
Prerequisites Configuration Steps Key Concepts Integration With Other Applications
5 5 7 13
Part 1 – Security Configuration
15
Security and Access Control Configure Oracle-Based Security Configure Web-Based Security
15 15 16
Part 2 – Production Balance Analysis Configuration
19
Site Survey
19
Introduction Data Sources Application Interfaces Collect Process Flow Diagrams
19 19 19 20
Model Analysis
21
Introduction Step 1 – Balance Family and Balance Group Identification Step 2 – Create a Production Balance Flow Diagram Step 3 – Build a Production Balance Model Step 4 – Analyze the Production Balance Model
Model Configuration Overview Step 1 – Balance Family Definition Step 2 – Balance Group Configuration Step 3 – Balance Boundary Definition Step 4 – Process Historian Tag Configuration
21 22 23 25 29
31 31 32 33 47 48
Production Balance Configuration Guide• iii
Contents
Step 5 – Equipment Configuration Step 6 – Equipment Mode Configuration Step 7 – Equipment Hierarchy Configuration Step 8 – Product Configuration Step 9 – Product Hierarchy Configuration Step 10 – Route Configuration Step 11 – Validate the Model
50 57 59 61 62 63 74
Background Processes Configuration
79
Introduction Prerequisite Background Processes Production Balance Background Processes
79 81 86
Production Balance Analysis Configuration in Production Balance Web 101 Preliminary Information Automated Processing Configuration Writeback Configuration Balance Family and Group Access Configuration
101 102 106 112
Tune the Reconciliation Solver Settings
115
Introduction Settings for Linear Models Settings for Simultaneous Balance Models
115 116 118
Part 3 – Production Balance Logging Configuration
121
Update the Production Balance Model
121
Introduction Units of Measure Balance Group and Equipment Attribute Configuration Intermediate Node Equipment Running Gauge Production Type Production Balance Logging Equipment Tree Configuration
Background Processes Configuration Introduction Production Balance Logging Background Processes
121 121 122 124 125 126 127
129 129 130
Production Balance Logging Configuration in Production Balance Web 139 Automated Processing Configuration Writeback Configuration Balance Family, Balance Group and Inventory Group Access Configuration
iv • Production Balance Configuration Guide
139 142 142
Contents
Production Tracker Configuration
143
Introduction Activity Configuration Extensions for Production Balance Logging Event Configuration Extensions for Production Balance Logging Equipment Configuration Extensions for Production Balance Logging Hierarchy Configuration Miscellaneous Configuration for Production Balance Logging
143 143 147 148 148 150
Part 4 – Inventory Calculation Configuration
155
Model Configuration
155
Overview Step 1 – Plan the Inventory Calculation Model Step 2 – Inventory Group Configuration Step 3 – Inventory Equipment Configuration Step 4 – Inventory Equipment Hierarchy Configuration Step 5 – Product Configuration Step 6 – Product Hierarchy Configuration Step 7 – Display Units Configuration
155 156 157 157 158 158 159 159
Inventory Calculation Attribute Configuration
163
Introduction Configure Strapping Data Form Configure Equipment Form Configure Products Form
163 164 169 173
Other Inventory Calculation Configuration Operations
177
Automated Processing Configuration Writeback Configuration Inventory Group Access Configuration
177 180 180
Part 5 – User Interface Configuration
181
Customize the Web User Interface in the Web Administration - Configuration Display 181 Customize the Web User Interface in the PB Configuration Site Settings Display183 Customize the Report Headers and Logo 192 Create Links from the Production Balance Client to Custom Equipment and Lineup Displays 193
Appendix A – Inventory Calculation Attributes Introduction Common Equipment Attributes Equipment Class – Tank Equipment Class – Gross Volume Equipment Class – Net Volume Equipment Class – Mass
197 197 198 199 208 213 215
Production Balance Configuration Guide• v
Contents
Equipment Class – Composition Gross Volume Equipment Class – Composition Net Volume Equipment Class – Composition Mass
216 219 220
Appendix B – Tank Calculator extension for Japanese standards223 Introduction Common Equipment Attributes Equipment Class – JTANK
Appendix C – Lookup and User Attribute Reference Lookup Table User Attributes Inventory management related lookups Configuration of unit types Configuration of Tank Composition Propagation
223 224 224
243 243 251 251 252 252
Appendix D – Configuring MSGLOGSERVER and PHDSQL for RAC Environment 255
vi • Production Balance Configuration Guide
About This Document
About This Document Overview Production Balance is Honeywell’s solution for state of the art material balancing and data reconciliation. It provides advanced mathematical tools which may be used for performing statistical data reconciliation, to identify gross errors, to detect missing movements and to perform production allocation calculations. Production Balance is comprised of the following components: •
The Production Balance Client application is used for data reconciliation and analysis. In addition, it may be used for configuring the equipment and product attribute values, and strapping table data, used for the Production Balance inventory calculations.
•
The Production Balance Web environment provides additional Production Balance functionality, including: Logging
Production Balance Logging is used for collecting information pertaining to the activities carried out at the plant site for use in the Production Balance analysis tools. To this end, it provides facilities for manual material movement entry, automated and manual lineup creation, inventory calculations, and movement composition tracking. In addition, Production Balance Logging may be used for automating the transfer of material movement records from Production Tracker 1 into Production Balance.
Analysis
Production Balance Analysis includes the Production Balance reports, product rollup results and an auto processing progress monitor. It provides facilities for adjusting the product rollup results and for converting the movement records collected in Production Balance Logging into transfer records used in the Production Balance reconciliation calculations.
Configuration Production Balance Configuration provides facilities for configuring Production Balance Logging and Analysis. Production Balance auto processing, writeback, web roles and web display settings are all configured here.
1
Production Tracker is the central repository for work order tracking and material movement information for the Business FLEX family of software applications.
Production Balance Configuration Guide• 1
About This Document
Before You Begin Before configuring Production Balance, you must be familiar with TPI (also called the TotalPlant® Information application), as many of the Production Balance configuration steps require it. ATTENTION: Prior to Business FLEX 200 and Uniformance 210, there were two versions of TPI: Uniformance TPI and Business FLEX TPI. Currently, only Business FLEX TPI is supplied. As part of the Business FLEX 200 release, much of the functionality that was included in Uniformance TPI has been moved or copied to Business FLEX TPI. This change has made it possible to install the Business FLEX database and TPI, without Uniformance. In addition, a number of the TPI-based, Business FLEX applications currently support process historians other than the Uniformance Process History Database (PHD). As Production Balance supports non-PHD process historians, Uniformance is no longer a prerequisite for this application. Uniformance 210 Update Patch Release 210.1.3 or Uniformance 215 supplies PHD and the utilities needed to support it. The user interface that was referred to as "Uniformance TPI" is now called the "PHD Configuration Tool". For more information about Uniformance and the new PHD Configuration Tool, refer to the Uniformance literature.
You must be familiar with the process historian that will be used with Production Balance, as Production Balance is designed to monitor and display data stored in the process historian. It is assumed that you are familiar with Business FLEX, Uniformance and TPI installation, configuration and operation procedures. In addition, it is assumed that this prerequisite software has already been installed and configured prior to attempting to configure Production Balance.
About This Guide This manual describes how to configure Production Balance. It does not however provide details on how to install the application on a target computer system. Refer to the Business FLEX Installation Guide for details on installing the necessary desktop and background process components for Production Balance.
Production Balance Enhancements The current release of Production Balance includes the following major enhancements and functional changes: Inventory Management Enhancements
Added inventory monitoring functionality to the Production Balance client user interface (for example, strapping tables).
Inventory Calculation New options added for mass or volume based calculations, based Enhancements on equipment type. Added support for spherical tank calculations. Added support for component level inventory calculations.
2 • Production Balance Configuration Guide
About This Document
Limit Checking and Write-Back Error Statistics
Added limit checks and more writeback error statistics to the Production Balance client user interface.
Missing Movement Enhancements
Transfer records are automatically created when a missing move is activated. This enables for multiple moves on the same route. Activated moves apply to the entire balance family, but only apply for the current Production Balance case.
Internationalization Support Process Historian Support
Production Balance supports historical data collection from any process historian that is OPC HDA compliant. Data collection from PHD continues to be supported.
Web Role-Based Access to balance families and groups, inventory groups and Access to Equipment equipment in the Production Balance Web displays can be and Groups controlled by Web role assignments.
Related Documents Further information about Production Balance and related applications can be found in the following documents. Document
Title
PB-USR-250
Production Balance User Guide
PL-USR-250
Production Balance Web User Guide
PB-REF-250
Production Balance Supplementary Reference Guide
PB-SUP-250
Production Balance - Using Operating Events Supplementary Guide
BF-INS-250
Business FLEX Installation Guide
BF-REF-250
Business FLEX Security Reference Guide
BF-SUP-250
Business FLEX Third Party Process Historian Configuration Guide
PRM-USR-250
Business FLEX TPI Plant Reference Model User Guide Uniformance Process History Database User Guide Well Test Manager Administration Guide
For more information on the other Business FLEX applications see the documents included on the Business FLEX Software DVD. Refer to the Business FLEX Software Change Notice for a list of the documents that are supplied.
Contact Us Please send any comments or questions to the Help Desk at
[email protected]. Ensure that you type Business FLEX Production Balance in the subject line of your e-mail.
Production Balance Configuration Guide• 3
About This Document
This page is intentionally left blank
4 • Production Balance Configuration Guide
Configuration Overview
Configuration Overview Prerequisites Before you can configure Production Balance, the following server based components must be present: •
Business FLEX Database in Oracle®
•
Process Historian (for example, PHD)
•
Business FLEX Application Server
•
Business FLEX TPI
•
Background Processes for Production Balance (Note: Configuration of the background processes is covered later in this document.)
•
Experion Desktop Server (EDS) (Required for the Production Balance Web environment.)
•
If the Production Balance Logging utilities are going to be integrated with Production Tracker, Production Tracker must be installed and configured prior to starting Production Balance Web configuration.
In addition, the Production Balance Client application must be activated in the Business FLEX TPI environment and the Production Balance Client user interface must be installed on at least one client computer.
Configuration Steps Part 1 – Security Configuration
Prior to configuring the Production Balance software components, security in the TPI and Web environments must be configured as described in Part 1 of this Guide. Part 2 – Production Balance Analysis Configuration
Production Balance Analysis configuration consists of the following general steps: Step Description 1.
Site Survey
2.
Model Analysis
3.
Model Configuration
Production Balance Configuration Guide• 5
Configuration Overview
Step Description 4.
Background Processes Configuration
5.
Automated Processing Configuration
6.
Writeback Configuration (Optional)
7.
Balance Family and Group Access Configuration
8.
Tune the Reconciliation Solver Settings
These configuration steps are described in detail in Part 2 of this guide. Part 3 – Production Balance Logging Configuration
Production Balance Logging configuration consists of the following general steps: Step Description 1.
Update the Production Balance Model
2.
Background Processes Configuration
3.
Automated Processing Configuration
4.
Writeback Configuration (Optional)
5.
Balance Family, Balance Group and Inventory Group Access Configuration
6.
Production Tracker Configuration (Only needed if the interface to Production Tracker is going to be used.)
These configuration steps are described in detail in Part 3 of this guide. Part 4 – Inventory Calculation Configuration
Production Balance Inventory Calculation configuration consists of the following general steps: Step Description 1.
Model Configuration
2.
Inventory Calculation Attribute Configuration
3.
Automated Processing Configuration
4.
Writeback Configuration (Optional)
5.
Inventory Group Access Configuration
These configuration steps are described in detail in Part 4 of this guide.
6 • Production Balance Configuration Guide
Configuration Overview
Part 5 – User Interface Configuration
Configuration of the Production Balance user interface consists of the following optional steps: Step Description 1.
Customize the Web User Interface in the Web Administration - Configuration Display
2.
Customize the Web User Interface in the PB Configuration Site Settings Display
3.
Customize the Report Headers and Logo
4.
Create Links from the Production Balance Client to Custom Equipment and Lineup Displays
These configuration steps are described in detail in Part 5 of this guide.
Key Concepts Equipment and Nodes The equipment configured in the Plant Reference Model can be physical or logical entities, including: – Individual equipment items (for example, storage tanks, mills or separators). – Unit operations or process equipment which Production Balance is to reconcile around (for example, distillation towers or catalytic converters). – Boundary equipment or processes which act as a source or destination for the material entering or leaving the area of the site being reconciled (for example, material stockpiles, rail yards, shipping docks or truck loading areas). – Virtual equipment items used for splitting or merging material flows (for example, pipeline splits, manifolds or junctions). Each piece of equipment has a unique name, description and type. In addition, attributes are defined for each piece of equipment. Some of the attributes have a related value or a DCS tagname. For example, tanks can have the attribute CUTINVTAG. You can either enter the inventory value manually in the value field or select a tag in the tag name field form. Throughout this document, the words "equipment" and "node" are used interchangeably.
Production Balance Configuration Guide• 7
Configuration Overview
Equipment Groups Various pieces of equipment can be combined into logical groups. The following equipment layout scenarios could be represented by equipment groups: •
Equipment in the plant can be associated with logical balance group equipment.
•
When there is a possibility of multiple modes for equipment, all the modes (Logical Equipment) can be associated with that specific equipment.
Within the Plant Reference Model, equipment groups consist of a parent equipment name, one or more associated equipment names, and a hierarchy type. The hierarchy type enables different types of groups to be configured. Products The products defined in the Plant Reference Model represent the materials in the equipment and nodes at the site. Each product has a unique name and description. Each product has associated information attributes. The attributes configured for each product are determined on the basis of the product type and plant operations. For example, to qualify a product as a component, the product must be assigned the PRDCT_COMPONENT attribute. This makes the attribute available for selection as a component in the inventory configuration form. This attribute can be used in the tank composition tracking. Product Routes, Transactions and Movements Product routes identify the flow of products from one piece of equipment to another. They are used by several Business FLEX Production Management applications including Production Balance, Product Costing, Batch Tracking and Tank Composition Tracking. When Production Tracker is present, product routes can either be configured manually using TPI or they can be generated automatically through the Production Balance's Logging interface to Production Tracker. Automatic route generation is the preferred method in this case. Transactions represent material transfers between the equipment or nodes along a product route. As part of the reconciliation calculations, Production Balance tries to determine if the data associated with material transfers has been missed. In this case, the missing transfer transactions are referred to as missing movements. Balance Group and Balance Type Production Balance uses balance groups to identify the equipment involved in the balance calculations. The equipment assigned to balance groups includes all process units and inventory storage in the area of interest, as well as shipment and receipt points external to the plant. Each balance group represents a single balance type (for example, mass balance, volume balance, individual component balance or enthalpy balance).
8 • Production Balance Configuration Guide
Configuration Overview
Balance Family All of the balance groups in the same area of the plant are assigned to a single balance family. In general all of the equipment and routes in the area of the site to be reconciled are assigned to every balance group in the same balance family. Organizing all the related balance groups into a single balance family, enables the Reconciliation solver to perform simultaneous balance calculations. These calculations are performed for all of balance groups together. Balance Boundary Every balance group is assigned a corresponding balance boundary. The balance boundary is an equipment group used for identifying the equipment in the balance group. In addition, the equipment is inside the balance for the reconciliation calculations. All nodes inside the balance boundary become balance constraints in the Production Balance reconciliation calculations. Any equipment item that is assigned to a balance group, but is not assigned to the corresponding balance boundary is considered to be outside of the balance. Generally, boundary equipment and external nodes (for example, pipelines, docks, flares, and so on) are not included in the balance boundary group. Reconciliation does not try to balance the nodes that are outside the balance boundary. Inventory To balance the quantity of material that passes through a given area of a plant, Production Balance must keep track of the material that remains within the area being reconciled. This is done by comparing the quantity of material (inventory) in each node at the start and the end of the time period of interest. The quantity of material in a node at the start of the period is referred to the opening inventory. The quantity of material in a node at the end of the period is referred to the closing inventory. Inventory values are collected for equipment items such as tanks. These values are used in the reconciliation calculations and are referred as inventory nodes. Equipment items or nodes where material passes through and does not accumulate do not generally have inventory data associated with them. These nodes are not included in the inventory reconciliation calculations. When inventory equipment is grouped together for inventory calculation purposes, these groups are referred to as inventory groups. Measured Values versus Reconciled Values The raw data used in the reconciliation calculations is referred to as measured values or measurements. Measured values can include volume or inventory values for nodes, flow rates for the material passing through a route, the quantity of material transferred to a waiting ship and others.
Production Balance Configuration Guide• 9
Configuration Overview
When the reconciliation calculations are performed, Production Balance attempts to balance the material movements through the area of interest based on the measured values supplied to it. To close the balance, the Reconciliation solver generally needs to adjust the supplied measured values. The adjusted measured values are referred to as reconciled values. Measured Units and Balanced Units Data reconciliation requires that all transaction and inventory data used in the calculations be provided in conserved units. In many cases, the measured values will not be in conserved or consistent units of measure. Using a factor for each measurement, measurements can be converted to balanceable quantities in a consistent unit of measure. For example, volume is not conserved across many processing operations, whereas mass is conserved. As a result, units of mass are typically used for data reconciliation. However, many plants record inventory and flows in volume units. In the case of mass balancing of volume measurements, density is required to convert volume to mass. The units of measure for the measured values are referred to as measured units. The units of measure used in the reconciliation calculations are referred to as balanced units. The units of measure supported in Production Balance are those which are available in PHD. Refer to the Uniformance Process History Database System Manual for a complete list of units of measure supported in PHD. For non-PHD process historians, Business FLEX TPI can be used for entering the units of measure. Factor Values and Factor Multipliers Factor values and factor multipliers are used for converting the measured values in measured units into balanced units for each balance type and to convert the resultant reconciled values back into measured units. The relation between the measured units and the balanced units is as follows: Balanced Units = Measured Units * Factor Value * Factor Multiplier General term factor rather than density is used in Production Balance to indicate that balance types, other than mass balance, can be supported. For example, a component balance for sulfur or copper could be modeled using composition factors (for example, mass or volume fractions).
10 • Production Balance Configuration Guide
Configuration Overview
Factor values are required for each inventory measurement, transfer and missing movement. Factors for each measurement must convert the measurement to a balanceable quantity, although the system can handle unit of measure conversion so that factors can be specified in common units. For example, transfers or inventories can be measured in BBLS, the balanced units can be TONS, and the factor values can be in LB/USGAL, KG/M3 or G/ML. The interface would calculate the factor multiplier that converts the factor value to BBL/TON. The only constraint is that the measured, balanced and factor value units must all be standard PHD units, with one exception. Density measurements in API gravity are handled internally by the client application, which internally converts API to G/ML, and then uses the factor multiplier to convert from G/ML to the required conversion units (for example, G/ML). The unit name must be ‘API’ to enable this functionality. Note that not all measurements must be in the same units for Production Balance. For example, liquid flows could be measured in BBL, gas flows in SCF, and solids transfer in LBS or TONS. The factor values must be in units such that all transfers are converted into balanceable quantities. For example, for a mass balance the factor values could be G/ML for BBL measurements, LB/SCF for gas flows, and would not be required for solids transfers in LBS. Additional support exists to convert tags from rate units into absolute units. For example, Production Balance converts a tag, configured as TON/ HR in PHD, to the absolute units of TON. Only the units valid in PHD are supported in this function. For the rate tags, the absolute value calculated will be the average for the period of interest. This function will not handle other units, such as molar flow rates where the factor is a molecular weight. Measurement Types and Factor Types The measured values and factor values used in the reconciliation calculations can be assigned a measurement type or factor type that provides an indication of the quality of the supplied raw data. The Production Balance Reconciliation solver recognizes three measurement or factor types: Fixed, Measured and Unmeasured. Fixed measurements or factor values are not adjusted by data reconciliation. Their values are treated as 100% accurate. Typically, custody measurements would be treated as fixed. NOTE: A node with only fixed flows and inventory would cause a reconciliation problem as there would be no way to adjust the flows to achieve a balance. Assigning Measured type to a measurement or factor value indicates that the value is adjustable. Measured and factor values of this type must have a tolerance that indicates the degree of adjustability. Assigning Unmeasured type to a measurement or factor value indicates that no measurement is available. The Reconciliation solver uses model redundancy to calculate the measurements and factor values of this type.
Production Balance Configuration Guide• 11
Configuration Overview
Balance Periods and Balance Cases The frequency at which of the reconciliation calculations are performed is referred to as the balance period. In addition, this time span can be referred to as the balance schedule, accounting period or case length. In Production Balance, the reconciliation and production allocation calculations are performed for a single balance case. Normally each balance case corresponds to a single balance period. When ad hoc calculations are performed, you are free to set the start and end times for the case to any date and time. Component Balance In some cases there may be several product components that could be balanced simultaneously. For example, in mineral processing there is a need to track the material balance for the various metals extracted from the process operations. Typically, it is difficult to achieve an overall plant mass balance because of lack of instrumentation. Thus, the primary metal component is balanced first, with reconciliation adjustments being used for backing calculate adjustments to inventory and transfer measurements of the composite material, and associated assays/grades for the prime material. These adjusted measurements are then used in secondary and subsequent balances of multiple co-products or byproducts of interest. Production Balance can be used for carry out simultaneous balancing of all components at the same time. NOTE: Support for sequential component balancing has been retained to support legacy Production Balance installations. Sequential balancing is not recommended for new customers. Production Allocation Production allocation is normally a financial (or non-engineering) process in which key flow meter readings in a network are fixed and the resultant material imbalances are adjusted or allocated onto other non-fixed measurements. In Production Balance, production allocation is a separate utility that recalculates quantities for low confidence meters based on the values measured in high confidence meters in the same balance group. The allocation is based on the Measurement * Factor * Factor Multiplier to ensure all allocated flows are on the same basis. Flow measurements can be allocated in any balance, component or total. NOTE: Inventory allocation (adjusting closing inventory on many storage nodes to match some production measure) is not supported.
12 • Production Balance Configuration Guide
Configuration Overview
The reconciliation and production allocation functions have been brought together, to help identify data problems before the allocation calculations are performed. This helps to ensure that allocation is performed efficiently and effectively. In addition, the reconciliation results may be used for measurement estimation when a meter normally allocated has failed and results in an unreasonable allocation.
Integration With Other Applications Integration with Production Tracker When Production Tracker is present, product routes can be generated automatically through the Production Balance Logging interface to Production Tracker. Automatic route generation is the preferred route configuration method when Production Tracker is present. If you are planning to integrate Production Balance with Production Tracker, special configuration requirements need to be incorporated into the Production Balance model. (See Production Tracker Configuration for details.) Integration with Well Test Manager Honeywell's Well Test Manager application is normally used for calibrating the production capability of each well in shared gathering facilities. Calculated flow rates for the individual components (for example, oil, gas, water or C1, C2, C3, and so on.) are available to Production Balance in PHD tags. The following diagram displays the Well Test Manager Architecture and how it relates to Production Balance.
Production Balance Configuration Guide• 13
Configuration Overview
See the Well Test Manager Administration Guide for details.
14 • Production Balance Configuration Guide
Part 1 – Security Configuration
Part 1 – Security Configuration Security and Access Control The Web user interface recognizes users by their Window domain user accounts. TPI uses user-based security, but can also be configured with Window’s domain user accounts. Production Balance uses a set of roles to determine which forms and reports each person can use. The site administrator grants these roles to users. Depending on the network configuration, new users may be automatically granted access. This topic is meant for a site administrator. Oracle and TPI Oracle database objects, and TPI forms and reports, are secured with the Business FLEX TPI tools. Web Security The Experion Desktop Server, or EDS, provides the underlying Web-based infrastructure for Production Balance and other Honeywell applications. Production Balance uses a set of Web roles (defined in EDS) to determine which Web forms and reports each person can use. The site administrator grants these roles to users. The roles can be assigned to users or to groups. The groups can be either defined within EDS or defined in the Window’s domain. The users can be assigned roles directly or inherit roles through group membership. Depending on the network configuration, new users may be automatically granted access. Refer to the Standard Web Security Roles for details on abilities and functions of each role.
Configure Oracle-Based Security All standard forms and reports in TPI are secured with the Business FLEX TPI tools. Refer to the Business FLEX Security Reference Guide for details. User Roles All user accounts are assigned to one or more roles. Each role is assigned various permissions. Users get the most permissive access rights based on all roles to which they belong.
Production Balance Configuration Guide• 15
Part 1 – Security Configuration
Following is the User Role Configuration form:
User Profiles
Some Production Balance functions require that users are assigned appropriate User Attributes. User attributes are similar to roles, and are assigned to users with the User Profile form, which appears in the Security Configuration application in the Business FLEX TPI menus. Use the Application Password form in the Plant Reference Model module in TPI to configure the Production Accountant with a type of PRODACCT. This provides access to the reprocess functions in the Production Balance client user interface.
Configure Web-Based Security The Administration – Security display (available from the Experion Desktop Home page) is used for configuring user accounts and the attributes of a user in the Web environment. To enable users to use Production Balance their Web user account must be assigned at least some of the Web roles described in the Standard Web Security Roles table as described in the following table. Roles can be either associated directly to a user or a group to which the user belongs. For details on creating Users, Groups, and Roles in the Business FLEX Web environment, refer to Business FLEX Security Reference Guide.
16 • Production Balance Configuration Guide
Part 1 – Security Configuration
Standard Web Security Roles The following table lists the standard Web roles used in Production Balance, and the abilities that each role includes. Standard Web Security Roles Role
Abilities and Functions
PLAdmin
Provides access to the Site Settings displays for configuration purposes.
PLDataEntry
Provides editable access to the Production Balance Logging displays.
PLUser
Provides read-only access to the Production Balance Logging displays.
PMUser
Provides access to the Production Management application on the Experion Workspace Welcome screen. All Production Balance Web users must have the PMUser role assigned. Otherwise they cannot access the Production Management application.
PBUser
Provides editable access to the Production Balance Analysis displays.
The roles are additive. For example, someone who requires read-only access to the Production Balance Logging displays only would be assigned the PMUser + PLUser roles. But, a data entry person could be assigned the PMUser + PLUser + PLDataEntry + PBUser roles. The administrator must have access to all of the displays and must be assigned all of the roles: PMUser + PLUser + PLDataEntry + PBUser + PLAdmin. The following table describes the roles required for accessing various displays and for other privileges: To access…
Roles required…
Production Balance Reports display
PB_USER, PMUSER
Production Balance Logging displays
PL_USER, PMUSER
Production Balance Logging displays and PMUSER,PL_USER and PL_ADMIN Production Balance Configuration display Create the auto_prc schedule
PMUSER,PL_USER and PL_ADMIN
Schedule cases, create movements, and modify inventory records
PMUSER,PL_USER,PL_ADMIN and PLDATAENTRY
Read only access
PMUSER,PB_USER and PL_USER
Administration access and privileges
PMUSER,PL_USER,PL_ADMIN,PB_USER and PLDATAENTRY
Assign balance families and inventory groups to the specific web roles
PMUSER, PL_USER, PL_ADMIN, and PLDATAENTRY
NOTE: Access to the Production Balance families and inventory groups are limited to specific web roles. The administrator must assign the balance families and inventory groups to the specific roles through the Role Security webpage. The balance families and inventory groups that are assigned only to your current roles are visible. The administrator has access to all balance families and inventory groups. Production Balance Configuration Guide• 17
Part 1 – Security Configuration
ATTENTION: Production Balance configuration requires administrator access to both the Business FLEX TPI and Business FLEX Web environments. In the Business FLEX Web environment, ensure that the users who will be performing Production Balance configuration have been assigned all of the Web roles identified in the Standard Web Security Roles as described in the table. In addition, the users must be assigned the CoreAdmin role.
18 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Site Survey
Part 2 – Production Balance Analysis Configuration Site Survey Introduction The first step in configuring Production Balance for a site is to collect relevant site data needed to configure the site in the Plant Reference Model.
Data Sources Identify the sources of the data to be used in Production Balance. The data sources could include: •
Field data (for example, meters, analyzers, lab results)
•
Process Historian (for example, PHD)
•
Other Honeywell applications (for example, LIMS Quality Management, Well Test Manager, Production Tracker, and so on.)
Application Interfaces Identify where the results from the Production Balance application are to be stored and what other applications need to use these values. The data interfaces for writeback processes could include: •
Database tables in the Business FLEX database
•
Connections to other Business FLEX applications (for example, Product Costing, Batch Tracking and Tank Composition Tracking)
•
Connections to third party applications (for example, Enterprise Resource Planning (ERP) or Supply Chain Management (SCM) systems)
Production Balance Configuration Guide• 19
Part 2 – Production Balance Analysis Configuration Site Survey
Collect Process Flow Diagrams An essential resource needed for Production Balance configuration is the Process Flow Diagrams (PFDs) for the areas of interest at the plant site. Where good PFDs are not available and cannot be readily provided, then Process and Instrumentation Drawings (P&IDs) may be used. In general, the larger the plant the more difficult it becomes to work with P&IDs. These diagrams must include: •
Meter information (for example, measured value type, units of measurement, tags, and so on.)
•
Product information
•
Product routes (both metered and non-metered) 2
•
Equipment (both inventory (that is, metered and non-metered)
•
Units and processes
•
Boundary equipment and processes
2
The product route source and destination equipment can be used for representing boundary point meters on units.
20 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Analysis
Model Analysis Introduction Purpose
One of the most common problems in yield accounting is that large amounts of time can be spent building detailed models and setting up data collection for systems which don't have sufficient measurements to answer the desired questions. To save time in the long run, the preferred method for configuring Production Balance involves modeling the areas of interest and demonstrating solvability, prior to configuring the Plant Reference Model. With a single linear balance, it is relatively easy to verify solvability by manually "walking" through a flow diagram. With simultaneous balances the task is much more difficult. It is recommended that when a problem is not clearly deemed to be solvable (that is, all flows and qualities are not measured everywhere), that Production Balance be configured using a Microsoft® Access® database. The database can then be used in Production Balance to validate the solvability of the model. Model analysis assists you with the following: •
Defining the Production Balance scope.
•
Documenting the measurements, equipment, products and routes in the area of interest.
•
Determining data adequacy or inadequacy.
•
Identifying meter optimization opportunities.
•
Finalizing the model for configuration.
•
Ensuring that the reconciliation problem can be solved with the available data.
Advantages
By modeling the reconciliation problem to be solved first, the following benefits can be achieved: •
Provides validation of the scope of work.
•
Manages the scope of the model and the associated project.
•
Focuses the data collection effort.
Production Balance Configuration Guide• 21
Part 2 – Production Balance Analysis Configuration Model Analysis
Despite these advantages, model analysis is not a substitute for: •
General analysis of the solution to be provided.
•
Data interface specifications.
•
Data collection activities.
All of these procedures need to be performed as part of the general Production Balance configuration procedures. Model Analysis Steps Step Description 1.
Identify the balance families and balance groups for the site.
2.
Construct a Production Balance flow diagram.
3.
Build a Production Balance model.
4.
Analyze the model, which involves the following subtasks: •
Run the model in Production Balance.
•
Identify missing data.
•
Tune the model.
•
Review potential model improvements with the customer.
•
Finalize the model scope.
Step 1 – Balance Family and Balance Group Identification Based on the reconciliation requirements for the site, identify the balance groups and the balance families they belong to. Remember that each balance group represents a single balance type. For those areas of the plant which require more than one type of balance calculation, a separate balance group is required for each balance type. If simultaneous balancing is to be performed on the set of balance groups in a given area, all of the balance groups must belong to the same balance family. If there is only one type of balance calculation required for a given area of the plant, then a single balance group is sufficient and it must be assigned to its own balance family. Similarly, if simultaneous balancing is not to be performed for an area of the plant with multiple balance groups, a separate balance family must be defined for each balance group.
22 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Analysis
Step 2 – Create a Production Balance Flow Diagram Diagram Preparation For each balance group identified in Step 1, create a separate Production Balance flow diagram. Use the Process Flow Diagrams (PFDs) as a starting point. The drawing tool you use to create the diagram is not important. Use whatever tool you are comfortable with. The Production Balance flow diagram must be a simplified version of the supplied PFDs. It must only show the information that is relevant to Production Balance. This can be achieved as follows: •
Limiting the diagram to the equipment and routes that will be part of the balance group.
•
Generating block diagrams for the major processes.
•
Simplifying the routes between equipment.
•
Looking for equipment that needs to be included in the model, but may not be obvious from the flow plan (for example, blenders that are essentially piping manifolds). Equipment like this is added as virtual nodes.
For example Production Balance flow diagrams, see the Workflow Scenarios in the Production Balance User Guide. NOTE: After you are comfortable with the use of Production Balance flow diagrams for model analysis, you are free to include multiple balance groups in the same diagram. Data Collection After you have a simplified Production Balance flow diagram for each balance group, collect the relevant Production Balance information for each diagram. The following data is required. Inventory Equipment
– Equipment name – Associated product – Measured value – Measurement type (Fixed, Measured or Unmeasured) – Factor value (for the balance type) – Factor type (Fixed, Measured or Unmeasured), where applicable – Tag information
Production Balance Configuration Guide• 23
Part 2 – Production Balance Analysis Configuration Model Analysis
Non-Inventory Equipment
– Equipment name – Associated product Routes/Transactions
– Source and destination equipment 3 – Associated product – Movement type (Move, Ship, Receipt) – Measured value, if any – Measurement type (Fixed, Measured or Unmeasured) – Factor value (for the balance type) – Factor type (Fixed, Measured or Unmeasured), where applicable – Tag information Unit and Boundary Equipment
– Equipment name – Indication of whether the node is in the balance and out of the balance NOTES: 1. Actual data values (quantities) for the measured and factor values are immaterial at this stage. 2. Measurement types and factor types are dependent on the associated data availability. 3. Don't worry if process historian tags are not available at this stage of the project. The actual tagnames can be specified later. Factor Value Examples
The factor values for each balance group will vary with the type of balance being solved. For example, for a refinery which is solving a mass balance based on measured volume values, the factor values will be density measurements. For a mining operation which is solving a component balance, the factor values could be the component fraction in each inventory node and product route. For an oil and gas facility which is solving a component balance for oil, the factor values could be the mass fraction of oil in each equipment item and stream.
3
The route source and destination equipment can be used for representing unit boundary points (and their associated meters).
24 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Analysis
Step 3 – Build a Production Balance Model Using the Production Balance flow diagram and the data collected; create a manual model of each balance family in Microsoft Access. Use the demonstration databases supplied with Production Balance as a starting point. The manual model you create is for all of the balance groups in a single balance family. It must cover a single balance period. The following tables describe the data that must be provided in the Microsoft Access database tables. NOTE: Any of the database tables in the demonstration databases that are not included here, can be left unchanged for model analysis purposes. Similarly, within the individual database tables any columns that are not listed can be left blank. IP_PRDCT Table
Create a separate record for each product in the model and populate the following columns. Column Name
Description
PRDCT_NAME
Enter the product name. This is required for the missing movement user interface. Only one product is needed to validate solvability.
DSCR
Repeat the product name.
ACTIVE_CHK
Mark each product as active.
PB_CASE Table
For balance families with multiple balance groups, create a separate case record for each balance group. Column Name
Description
CASE_ID
Identify each record with a unique CASE_ID. (This ID is used for matching the records in the other database tables to the balance group they apply to.)
USER_NAME
Enter “PB” in every record.
CASE_DT_TM
As you are not connecting to the Business FLEX database, you are free to choose a fictitious balance period. Make sure the case time (CASE_DT_TM) is later than the end time (END_DT_TM), and the end time is later than the start time (START_DT_TM). Enter the same times for each balance group.
START_DT_TM
Enter a start date time for each balance group. (See CASE_DT_TM for details.)
END_DT_TM
Enter an end date time for each balance group. (See CASE_DT_TM for details.)
PRC_SEQ
Ensure that each record has a unique PRC_SEQ number. This is used for determining the order in which the balance groups are calculated by the Reconciliation solver.
Production Balance Configuration Guide• 25
Part 2 – Production Balance Analysis Configuration Model Analysis
Column Name
Description
BAL_GRP_NAME
Enter a unique balance group name in each record.
SDR_STATUS
Set the balance group status to ACTIVE for all of the records.
BAL_FAM_NAME
Enter the same balance family name in each record.
IS_TOTAL_GRP
Select this option for one balance group only to impose the constraint that the sum of all other balance groups in the family must equal this one.
PB_INV Table
Create two records for each inventory node in the model, one for the open inventory measurement and one for the close inventory measurement. Column Name
Description
CASE_ID
This must match one of the balance group case IDs from the PB_CASE table.
EQ_NAME
Enter the name of the equipment that contains the inventory.
IS_OPEN_INV
Identify the open inventory measurements by selecting this check box.
MEAS_TYPE
Describe how the solver is to treat the inventory measurement, by entering one of the following values: 0 = Fixed 1 = Measured -1 = Unmeasured Typically opening inventory measurements are Fixed and closing inventory measurements are Measured.
MEAS_QTY_MEAS _UNITS
Enter a value 1, 100, and so on for each measured or fixed inventory.
TOL
Enter a value 1, 5, and so on for the tolerance for each Measured inventory node. (A tolerance value can be entered for Fixed and Unmeasured inventory node as well. The solver uses the values appropriately.) Entering 0 for an inventory measurement causes the solver to treat it as Fixed.
IS_ABS_TOL
Leave blank if the tolerance is a % of the measured value.
FCTR_VALUE
Enter a value 1, 100, and so on for the factor value.
FCTR_MULTIPLIER
Enter a value of 1 for the factor multiplier. (The factor multiplier is normally used for performing engineering unit conversions.)
FCTR_TOL
Enter a value 1, 5, and so on for the factor value tolerance.
IS_ABS_FCTR_TOL Leave blank for tolerance to be a % of the factor value.
26 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Analysis
PB_NODE Table
For equipment item and node that is inside the balance boundary for one or more balance groups, create a separate record for each balance group it applies to. Column Name
Description
CASE_ID
The CASE_ID is used for matching the node record to the associated balance group.
EQ_NAME
Enter the name of the equipment node.
HAS_INV
Select this option if the inventory in the equipment is to be considered in the reconciliation calculations.
IN_BAL
Select this option for each balance group to impose the constraint in + opening = out + closing
IN_USE
Select this option in every record.
IS_SPLITTER
Optional advanced feature that can be used for adding the constraint that all flows out of a node have the same factor value.
IS_PERFECT_MIX
Optional advanced feature that can be used for adding the constraint that all flows out of a node and the closing inventory have the same value. To use this feature, the IS_SPLITTER option must also be selected for the same node.
IN_ALLOC
Optional advanced feature that can be used for those sites that want to use the Production Allocation solver. In addition, set the ALLOC_TYP attribute for the inventory nodes that are to be included in the production allocation calculations by selecting the appropriate option from the Allocation Type dropdown list on the Equipment Property Sheet form. The allocation type options are: Option Type
Numeric Value
MEASURED
1
FIXED
0
UNMEASURED
-1
EXCLUDED
-2
PB_TRNSFR Table
For every product route with a source or destination that is inside the balance boundary for one or more balance groups, create a separate record for each balance group it applies to. Column Name
Description
CASE_ID
The CASE_ID is used for matching the route record to the associated balance group.
SRC_EQ_NAME
Enter the name of the source node.
DEST_EQ_NAME
Enter the name of the destination node.
START_DT_TM
In each record enter the same start time defined in the PB_CASE table.
END_DT_TM
In each record enter the same end time defined in the PB_CASE table.
Production Balance Configuration Guide• 27
Part 2 – Production Balance Analysis Configuration Model Analysis
Column Name
Description
IN_USE
Select this option in every record.
MEAS_TYPE
Select the measurement type for the measured value, by entering one of the following values: 0 = Fixed 1 = Measured -1 = Unmeasured
MEAS_QTY_MEAS _UNITS
Enter a value 1, 100, and so on.
TOL
Enter a value 1, 5, and so on.
FCTR_VALUE
Enter a value 1, 5, and so on.
FCTR_MULTIPLIER
Enter a value of 1.
FCTR_TOL
Enter a value of 1, 5, and so on.
FCTR_TYPE
Select the measurement type for the factor value, by entering one of the following values: 0 = Fixed 1 = Measured -1 = Unmeasured
PHYS_ID
It is recommended that a sequential number beginning with 1 be entered for each product route record. Each balance group must use the same value for all corresponding movements. For example, moving product X from equipment A to equipment B starting at date/time S and ending at date/time E, must have the same physical movement identification number for all the balance groups.
ALLOC_TYP
(Optional advanced feature.) Select the allocation type for the inventory nodes that are to be included in the production allocation calculations by entering one of the following values: 0 = Fixed 1 = Measured -1 = Unmeasured -2 = Excluded
As noted previously, the actual data values (quantities) for the measured and factor values are immaterial. For the inventory equipment and transactions, enter a sample value such as 1 or 100, into the model for the measured and factor values. This simplification is acceptable because the goal of the model is to determine if it is solvable and not to determine the accuracy of the reconciliation results. Similarly, the tolerances for the measured and factor values are not important. The same tolerance value can be used, say 5%, in all cases.
28 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Analysis
Step 4 – Analyze the Production Balance Model Run the Model in Production Balance
After the manual model has been defined in a Microsoft Access database, open the database in the Production Balance Client application and proceed as follows: •
Use the Production Balance display to validate the model against the Production Balance flow diagram.
•
Select the Singular Value Decomposition solver in the Solver Settings dialog box.
•
Run the Reconciliation solver.
For more information about the Production Balance Client application, refer to the Production Balance User Guide. Identify Missing Data
View the results generated by the Reconciliation solver. Is the model solvable? If the Reconciliation solver was unable to balance the case, there may be errors in the manual model or there could be problems with the data that is available from the site. Use the following statistics to analyze the reconciliation results. Statistic
Description
% Redundancy
A statistic that displays the degree of redundancy in a model, based on the measured and unmeasured values relative to the balance nodes. A typical value would be about 20 to 35%. This value is improved with more measured data and with fewer unmeasured values.
Redundancy Statistic
An indication of the redundancy of measurements or factor values in a model. Only displayed for measurements or factor values that have been assigned the Measured and Unmeasured measurement type. Redundant
A redundant statistic for a measurement or factor value implies that there are enough associated values available in the balance, that the value can be calculated by the solver, based on the balance equations, even if the measurement or factor value were not present.
Non-Redundant
A non-redundant statistic for a measurement or factor value implies that there are insufficient associated values available in the balance, that the value can be calculated by the solver, based on the balance equations, if that measurement or factor value were not present.
Observable
An observable statistic for an unmeasured value implies that the value can be calculated by the solver with a high degree of confidence, based on the balance equations.
Production Balance Configuration Guide• 29
Part 2 – Production Balance Analysis Configuration Model Analysis
Statistic
Description Non-Observable A non-observable statistic for an unmeasured value implies that there are too many unknowns in the model, such that that there are a number of values that could be used for solving the balance. For measured values, this uncertainty is also reflected in the associated high and low confidence limits, which will typically span zero. In the modeling of Production Balance an attempt must be made to minimize the non-observables in the model. This is to ensure that the reconciliation results can have a meaningful interpretation. The ideal model is to have all measurements and factor values as redundant. Typically as more instrumentation is added, the statistics must show a progression from Non-Observables to Observables and from NonRedundant to Redundant.
Tune the Model
To improve the model, the following changes can be made: •
Increase the number of redundant flows.
•
Decrease the number of non-observable flows. Ideally there must not be any.
•
Increase the number of measurements.
•
Reroute the product routes.
•
Reduce the complexity of the model.
•
Exclude extraneous equipment from the balance constraints, by removing them from the balance boundary.
•
Provide flow estimates. In particular, small unmeasured flows that are not of great concern can be estimated based on plant design data and given a large (+/- 25%) tolerances.
Use the Production Balance user interface to carry out ‘What If?’ scenario testing. This can help you identify the measurement locations that could lead to improved model redundancy. Reconfigure the Production Balance model, based the analysis and rerun the Reconciliation solver. Repeat this process until you are satisfied with the model. Review the Analysis Findings
After you are satisfied with the revised Production Balance model, review your findings with the plant. If it is found that new meters are required to solve key flows. They must be identified as early as possible to enable time for changes in the field. Finalize the Model Scope
If changes are made on site, finalize the Production Balance model and update the Production Balance flow diagram accordingly.
30 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Model Configuration Overview Configuration Sequence After you are satisfied with the balance models for the site, you can configure them in the Business FLEX database. The following order of configuration is recommended: Step Description 1.
Define the balance families.
2.
Configure the balance groups for each balance family.
3.
Identify the balance boundary for each balance group.
4.
Configure the process historian tags.
5.
Configure the equipment in the balance model.
6.
Configure the equipment hierarchy.
7.
Configure the equipment modes.
8.
Configure the products in the balance model.
9.
Configure the product hierarchy.
10.
Configure the routes in the balance model.
11.
Validate the model.
NOTE: Proper configuration of engineering units in Uniformance or TPI is critical to Production Balance operation. Be sure to configure the engineering units in accordance with the Uniformance or TPI documentation before you configure Production Balance.
Production Balance Configuration Guide• 31
Part 2 – Production Balance Analysis Configuration Model Configuration
Configuration Tools Each configuration step is performed using the Plant Reference Model application forms in Business FLEX TPI and is described in detail in the following sections. Prerequisites Before you proceed with the Plant Reference Model configuration, the following prerequisites must be met: •
Process historian (for example, PHD) must be configured.
•
Business FLEX database must be installed and running.
•
Business FLEX suite of applications must be installed and running.
•
Production Balance must be enabled in TPI.
Integration with the Legacy Production Accounting Application The configuration of Production Balance includes the configuration of the original Production Accounting 4 application components. This configuration, together with the connections to the Plant Reference Model and process historian, are required by Production Balance. Wherever possible, the Production Accounting configuration instructions have been incorporated into the Production Balance configuration instructions in this document. The Production Accounting user interface is provided as a legacy component. It is not used with standard Production Balance. (See the Production Balance Supplementary Reference Guide for details.)
Step 1 – Balance Family Definition For each balance family identified for the site, create a separate equipment entity in the Business FLEX TPI Equipment Configuration form with a type of BALFAM. The balance groups which belong to each balance family are assigned later, as part of Step 7 – Equipment Hierarchy Configuration.
4
The features and functions provided by the original Production Accounting application have been incorporated into Production Balance.
32 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Step 2 – Balance Group Configuration Create the Balance Groups For each balance group in each balance family, create a separate equipment entity in the Business FLEX TPI Equipment Configuration form with a type of BAL. Be sure to use balance group names that are relevant and easily recognizable. (For example, the balance group name could match the balance type associated with it: MASS for a mass balance, VOLUME for a volume balance, OIL for a component balance for oil, COPPER for a component balance for copper, and so on.) The equipment that belongs to each balance group is assigned later, as part of Step 7 – Equipment Hierarchy Configuration. After the balance group has been defined, use the Business FLEX TPI Equipment Configuration form to configure the balance group attributes described in the following subsections. Balance Group Attributes The balance group attributes are listed in the following tables. Where appropriate, references to more detailed information have been provided. Basic Configuration Attributes Attribute
Req’d Default
Description
SDR_BALGROUP
Y
TRUE
A value of TRUE indicates that the balance group is configured for Production Balance. In addition, it indicates that Statistical Data Reconciliation (SDR) processing is requested for this balance group.
SDR_USE_RESOLVED
N
FALSE
By default, the measured quantities used for SDR are the raw measurements. If this attribute is set to TRUE, resolved values from Production Accounting are used instead. Changing the default setting is not recommended.
Production Balance Configuration Guide• 33
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute SDR_BNDRY
Req’d Default Y
Description Identifies the equipment name which serves as the balance boundary for the balance group. NOTES: •
Balance boundary equipment names must be 40 characters or less.
•
For each balance boundary assigned to a balance group, create a matching equipment entity in the Business FLEX TPI Equipment Configuration form, with a type BALBNDRY.
(See Step 3 – Balance Boundary Definition for details.) SDR_MM_OPMODE
N
FALSE
A TRUE value avoids the missing movements with inactive mode equipments.
PA_PRC_DELAY
N
0
Specifies the auto processing delay in minutes. May be used for enabling external data (for example, lab results) to be entered into the system before processing occurs.
SDR_CHKPRDSWTS
N
TRUE
If the value of this attribute is FALSE, then the product timestamp checking functionality is turned off. Otherwise, the product switch timestamp is turned on.
Factor Attributes Attribute
Req’d Default
Description
SDR_FCTRTYPE
Y
Label for the balance type (for example, V or VOLUME for volume, M or MASS for mass, and so on). Used for information only.
SDR_FCTRVALATTR
Y
Identifies the attribute name to be used for specifying equipment and route factors. For example, DENSITY or MASSBALFACTOR would be reasonable attribute names for a factor that converted volume measurements to mass balance. To make the name assigned to SDR_FCTRVALATTR available as equipment attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of EQUIPMENT. To make the name assigned to SDR_FCTRVALATTR available as a route attribute, it must be added to the
34 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute
Req’d Default
Description Lookup table with a lookup type of ACCREPORT. (See Special Factor Attribute Definitions for details.)
SDR_FCTRDFLTATTR
Y
Identifies the product attribute name to be used for specifying default product factors (for example, DFLT_DENSITY or DFLT_GRAVITY). To make the name assigned to SDR_FCTRDFLTATTR available as a product attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of PRODUCT. (See Special Factor Attribute Definitions for details.)
SDR_FCTRDFLTUNIT
Y
Specifies the unit of measure for default factor values entered as product attributes (for example, G/ML or API). All default factors specified as product attributes must be in these units.
SDR_FCTRBALUNIT
Y
Specifies the balanced units of measure (for example, TON). Each measurements factor must be capable of converting from measured units to balanced units.
SDR_USE_FCTRTOL
Y
SDR_FCTRDFLT_LOW ERLIMIT_ATTR
N
FALSE
The factor types are Fixed if FALSE. If set to TRUE, the factor type is inferred from the confidence and tolerance of the factor tag. Identifies the attribute name to be used for specifying limits of default product factors. To make the name assigned to SDR_FCTRDFLT_LOWERLIMIT_ATTR available as a product attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of PRODUCT.
SDR_FCTRDFLT_UPPE RLIMIT_ATTR
N
Identifies the attribute name to be used for specifying limits of default product factors. To make the name assigned to SDR_FCTRDFLT_UPPERLIMIT_ATTR available as a product attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of PRODUCT.
Production Balance Configuration Guide• 35
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute SDR_FCTR_LOWERLI MIT_ATTR
Req’d Default N
Description Identifies the attribute name to be used for specifying limits on equipment and routes. To make the name assigned to SDR_FCTR_LOWERLIMIT_ATTR available as equipment attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of EQUIPMENT.
SDR_FCTR_UPPERLIM IT_ATTR
N
Identifies the attribute name to be used for specifying limits on equipment and routes. To make the name assigned to SDR_FCTR_UPPERLIMIT_ATTR available as equipment attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of EQUIPMENT.
Default Measurement Type Attributes
See Default Measurement Type for details. Attribute
Req’d Default
Description
SDR_FIXOPEN_DFLT
N
TRUE (Fixed)
SDR_FIXCLOS_DFLT
N
FALSE Specifies the default measurement type (Measured) for closing inventory measurements. In general, closing inventory must be treated as Measured, by setting this attribute to FALSE. The tolerance then controls the degree of adjustability.
SDR_FIXRCPT_DFLT
N
TRUE (Fixed)
Specifies the default measurement type for receipts. Normally the receipts are treated as Fixed, by setting this attribute to TRUE.
SDR_FIXSHIP_DFLT
N
TRUE (Fixed)
Specifies the default measurement type for shipments. Normally the shipments are treated as Fixed, by setting this attribute to TRUE.
SDR_FIXCONS_DFLT
N
FALSE Specifies the default measurement type (Measured) for transfers on routes of accounting type CONS (consumed). Set to TRUE for a Fixed measurement type and to FALSE for a Measured measurement type.
SDR_FIXPROD_DFLT
N
FALSE Specifies the default measurement type (Measured) for transfers on routes of accounting type PROD (produced). Set to TRUE for a Fixed measurement type and to FALSE for a Measured measurement type.
36 • Production Balance Configuration Guide
Specifies the default measurement type for open inventory measurements. In general, open inventory must be treated as Fixed, by setting this attribute to TRUE.
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute SDR_FIXTRN_DFLT
Req’d Default N
Description
FALSE Specifies the default measurement type (Measured) for transfers on routes of other accounting types (for example, FROM, TO or OTH). Set to TRUE for a Fixed measurement type and to FALSE for a Measured measurement type.
Overlapping Flow Detection Attributes
See Overlapping Flow Detection for details. Attribute SDR_OVERLAP_SRC
Req’d Default N
TRUE
Description Indicates whether to check for overlapping movements with the same source. If set to TRUE or the attribute is not specified, transfers from the same source, with the same measurement tagname, which overlap in time, are detected and the measurement type is set to Unmeasured. Set this attribute to FALSE to disable overlap detection.
SDR_OVERLAP_DEST
N
TRUE
Indicates whether to check for overlapping movements with the same destination. If set to TRUE or the attribute is not specified, transfers to the same destination, with the same measurement tagname, which overlap in time, are detected and the measurement type is set to Unmeasured. Set this attribute to FALSE to disable overlap detection.
SDR_SWINGTM_SRC
N
5
Specifies the allowable source overlap in minutes.
SDR_SWINGTM_DEST
N
5
Specifies the allowable destination overlap in minutes.
Production Balance Configuration Guide• 37
Part 2 – Production Balance Analysis Configuration Model Configuration
Miscellaneous Optional Attributes Attribute SDR_OPEN_INV_TYP
Req’d Default N
Description Balance group attribute which controls the retrieval of opening inventory. Valid values are CLOSE-RECON, CLOSE-MEAS, and CLOSE-SMR, which control whether the closing inventory from the prior period is retrieved from the reconciled, measured or SMR values as the current opening inventory. (SMR values are specified, if available, are measured if no specified quantity is provided, or are reconciled if the flow or inventory is marked as Unmeasured.) If omitted or null value, the behavior is backward compatible – that is, opening inventory is retrieved from the prior period’s closing inventory record in IP_CUT_INV. (Refer to the section Opening Inventory for details.)
SDR_MEASTOL_MIN
N
0
Specifies the tolerance, in percent, to use for transfers and inventory measurements with a measurement type of Measured and a tolerance of zero. (Refer to the section Zero/Minimum Tolerance for details.)
SDR_FLOW_MIN
N
None
If the absolute value of the quantity transferred is less than this threshold (in measured units), the transfer is treated as Unmeasured rather than Measured. (Refer to the section Minimum Transfer Quantities for details.)
TOTAL_GRP
N
FALSE
If set to TRUE, the balance group is a total balance group. In this case, the balance group is the sum of all of the other balance groups in the balance family. (Refer to the section Total Balance Group for details.)
PA_MONTHLY_BAL
N
FALSE
If set to TRUE, identifies the balance group for monthly balancing. (Refer to the section Monthly Balancing for details.)
38 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute SDR_SEQ_PARENT
Req’d Default N
FALSE
Description If set to TRUE, identifies the parent balance group for sequential balancing. (NOTE: Support for sequential component balancing has been retained for legacy Production Balance installations. Sequential balancing is not recommended for new customers. See the Production Balance Supplementary Reference Guide for details.)
Writeback to Production Accounting and Net Production (Legacy)
See Writeback to Production Accounting and Net Production for details. ATTENTION: This configuration only applies to legacy sites that are configuring writeback to Production Accounting and Net Production. For non-legacy sites, Writeback is presently configured in the Production Balance Web environment. See Writeback Configuration for details. Attribute
Req’d Default
Description
SDR_WRITEBCK_PA
N
TRUE
A value of TRUE enables writeback to the IP_MTRL_TRNSFR and IP_CUT_INV tables.
SDR_WRITEBCK_NP
N
FALSE
A value of TRUE enables writeback to the Net Production IP_NET_PRDCTN table.
SDR_WB_RECON
N
FALSE
Specifies if cases with a status of reconciled are to be written back (TRUE or FALSE).
SDR_WRITEBCK_INV
N
SPEC
Indicates the type of inventory data to be written to the IP_MTRL_TRNSFR, IP_CUT_INV and/or IP_NET_PRDCTN tables. Valid values are: SPEC - Writeback specified close inventory quantities only. SPEC/RECON - Writeback all specified values and reconciled values for close inventory records marked as Unmeasured. RECON - Writeback reconciled inventory quantities to the SPEC_QTY field.
Production Balance Configuration Guide• 39
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute SDR_WRITEBCK_TRN
Req’d Default N
SPEC
Description Indicates the type of transaction data to be written to the IP_MTRL_TRNSFR, IP_CUT_INV and/or IP_NET_PRDCTN tables. Valid values are: SPEC - Writeback specified material transaction quantities. For Measured or Fixed quantities, the measured quantity is written to the column IP_MTRL_TRNSFR.RES_QTY to support Production Accounting reports. SPEC/RECON - Same as above plus writeback reconciled values for transactions marked as Unmeasured. RECON - Writeback reconciled transaction quantities to the RES_QTY field. NULL - If this attribute is omitted, or no value is specified, no transaction writeback occurs.
Writeback to PHD (Legacy)
See Writeback to PHD (Legacy) for details. ATTENTION: This configuration only applies to legacy sites that are configuring writeback to PHD for Production Accounting and Net Production. For non-legacy sites, Writeback is presently configured in the Production Balance Web environment. See Writeback Configuration for details. Attribute
Req’d Default
Description
SDR_WRITEBCK_PHD
N
FALSE
A value of TRUE enables writeback to PHD.
SDR_WB_PHD_TRNTS
N
START
Indicates whether the total transfer quantity for the balance period is to be written to PHD with the timestamp of the start or end of the period. Valid values are START and END. If this attribute is not configured, the START timestamp is used by default.
SDR_WB_PHD_INVTS
N
START
Indicates whether the closing inventory for the balance period is to be written to PHD with the timestamp of the start or end of the period. Valid values are START and END. If this attribute is not configured, the START timestamp is used by default.
SDR_PUTMEASQTY
N
Identifies the tag for the measured quantity in measured units.
SDR_PUTMEASBALQ
N
Identifies the tag for the measured quantity in balanced units.
40 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute
Req’d Default
Description
SDR_PUTRECONQTY
N
Identifies the tag for the reconciled quantity in measured units.
SDR_PUTRECONBALQ
N
Identifies the tag for the reconciled quantity in balanced units.
SDR_PUTSMRQTY
N
Identifies the tag for SMR quantity (specified, if available, or measured if no specified quantity, or reconciled if the flow or inventory is marked Unmeasured). Quantity written in measured units.
SDR_PUTSMRBALQ
N
Identifies the tag for the SMR quantity in balanced units.
SDR_PUTMEASFCTR
N
Identifies the tag for measured factor value writeback.
SDR_PUTRECONFCTR
N
Identifies the tag for reconciled factor value writeback.
SDR_PUTSMRFCTR
N
Identifies the tag for SMR factor value writeback.
The SDR_PUT* attributes are provided to allow indirection for PHD tag writeback. The value for each of these attributes is the attribute name for the equipment or route which in turn indicates the tag to writeback data to. To make the name assigned to each SDR_PUT* attribute available as an equipment attribute, it must be configured in the Uniformance TPI Attribute Configuration form with an entity type of EQUIPMENT. Similarly, to make the name assigned to each SDR_PUT* attribute available as a route attribute, it must be added to the Lookup table with a lookup type of ACCREPORT.
Production Balance Configuration Guide• 41
Part 2 – Production Balance Analysis Configuration Model Configuration
Writeback in Balanced Units (Legacy)
See Writeback in Balanced Units for details. ATTENTION: This configuration only applies to legacy sites that are configuring writeback to Production Accounting and Net Production. For non-legacy sites, Writeback is presently configured in the Production Balance Web environment. See Writeback Configuration for details. Attribute
Req’d Default
SDR_FCTRBALGRP
N
PA_NOSETUP_PRC
Y
Description Identifies the artificial balance group name used as parent for writeback in balanced units to the IP_MTRL_TRNSFR and IP_CUT_INV tables.
TRUE
A value of TRUE stops the background processes from automatically creating a case for the artificial balance group assigned in the SDR_FCTRBALGRP attribute.
NOTE: The artificial balance group must also be defined in the equipment hierarchy with a hierarchy type of BALGROUP. Special Factor Attribute Definitions Factor Attribute Names for Equipment and Routes
Factor values are associated with inventory equipment using equipment attributes and with routes 5 using product route attributes. The attribute name is the same for both, and is identified by the balance group attribute SDR_FCTRVALATTR. This level of indirection enables different factors to be configured for different balance groups. To make the name assigned to SDR_FCTRVALATTR available as equipment attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of EQUIPMENT. To make the name assigned to SDR_FCTRVALATTR available as a route attribute, it must be added to the Lookup table with a lookup type of ACCREPORT. Factor Attribute Names for Products
Default factor values are associated with products through product attributes. The attribute name is identified by the value of the balance group attribute SDR_FCTRDFLTATTR. To make the name assigned to SDR_FCTRDFLTATTR available as a product attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of PRODUCT. 5
The factor values for unit boundary point meters are configured using product route attributes. They are associated with the route source or destination.
42 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Default Measurement Type Open and close inventory readings have a default measurement type. Unless otherwise configured (or no data is available), open is treated as fixed, and close as measured. There is no point in having open and close inventory both adjustable, as the difference between open and close is the important quantity (regularly scheduled inventory change) for reconciliation. When a product route is configured in Business FLEX TPI, it is given an accounting type of SHIP, RCPT, CONS, PROD, FROM, TO or OTH. Production Balance assigns default measurement types based on the accounting type of each route. The default is further configurable by route accounting type. Shipments and receipts are often custody type measurements and the associated measurements are normally verified or are made with highly reliable meters. As a result, they are often treated as fixed measurements by default. In all cases, the default measurement type is Fixed if TRUE and Measured if FALSE. Overlapping Flow Detection In some cases multiple flows are measured from the same source or to the same destination by the same flow tag (for example, when the flow on a route is being calculated by tank level changes). Normally, switch tags would be used for indicating that one route was active and another was not. However, in some cases the switches may be set or calculated incorrectly. There is logic in PbInterface which can be activated to detect these overlapping flows and mark them as unmeasured, rather than acting as if the two flows are based on accurate, independent measurements. One consideration in detecting overlaps is that there is some swing time when switching sources or destinations. If the swing time is small relative to the length of the transfer, then this overlap can be disregarded – the SDR algorithm adjusts the flows reliably. The allowable swing time can be configured using balance group attributes. should be identified as overlapping
may be acceptable as swing time
TK101 to Docks
TK101 to Docks
TK101 to Pipeline 00:00
02:00
04:00
06:00
08:00
TK101 to Pipeline 10:00
12:00
14:00
16:00
18:00
20:00
22:00
24:00
The default value for SDR_SWINGTM_SRC and SDR_SWINGTM_DEST attributes is 5 minutes. For example, if there is a 5 minute overlap between two moves with the same source (or destination) and measurement tag, then the overlap is ignored. If there is a longer overlap, then both moves are marked as Unmeasured.
Production Balance Configuration Guide• 43
Part 2 – Production Balance Analysis Configuration Model Configuration
Opening Inventory The optional balance group attribute, SDR_OPEN_INV_TYP, can be used for directing PbInterface and/or PbSequential to retrieve opening inventory from the prior period’s closing inventory. The factor value is retrieved in addition to the inventory quantity. Either the reconciled or measured values can be retrieved depending on configuration. Zero/Minimum Tolerance If the tolerance is zero for a measured transfer or inventory value with a measurement type of Measured, SDR treats the value as Fixed by default. Often, the zero tolerance value results from configuration or data problems and is not the appropriate value. If the tolerance is truly zero, then the measurement type must be Fixed, instead of Measured. Measured values with zero tolerances are automatically set to the value specified (in percent) by the balance group attribute SDR_MEASTOL_MIN. For example, if SDR_MEASTOL_MIN is 5, then all transfer and inventory measurements with a tolerance zero would have their tolerance reset to 5%. Minimum Transfer Quantities If a transfer is less than a threshold value, it may be because of instrument noise. The balance group attribute SDR_FLOW_MIN controls this behavior. Any transfer with a quantity less than the value specified is deleted from PB_TRNSFR. If no other flow exists on the associated route, then a candidate missing movement is created for that route. Note: Unit conversion is not currently supported for this attribute. As a result, this parameter works best when all flows are in consistent units. Total Balance Group For balance families comprised exclusively of balance groups for component balances, a special balance group can be created which acts as a total balance group. When configured, the total balance group forces the reconciled measured value (for each route or node) to be equal to the sum of the reconciled measured values in the other component balance groups. TOTAL
(
Reconciled Measured Value
Factor )=∑ ( ∗ Reconciled ∗ Multiplier Factor Value
44 • Production Balance Configuration Guide
Bal. Group
Reconciled Measured Value
Reconciled Factor ∗ Factor Value ∗ Multiplier )
Part 2 – Production Balance Analysis Configuration Model Configuration
The reconciliation calculations force the reconciled measured values (in balanced units) in the associated balance groups to add up to the total balance group's reconciled measured value. (The flows and inventories in the total balance group must match the sum of all of the other balance groups in the balance family.) It is assumed that the set of component balance groups together represent 100% of the material in each node or route. To configure a total balance group, create a separate balance group and set the TOTAL_GRP balance group attribute to TRUE. Monthly Balancing In some processing plants, inventory measurements are only available on a monthly cycle. This has resulted in the need for a monthly reconciliation period; that is, based on the accumulation of material transfers and inventory changes over this time. Setting the balance group attribute PA_MONTHLY_BAL to TRUE identifies the group for monthly balancing. Writeback Configuration ATTENTION: Writeback configuration described here only applies to legacy sites that are configuring writeback to Production Accounting and Net Production. For non-legacy sites, Writeback is presently configured in the Production Balance Web environment. See Writeback Configuration for details.
Writeback to Production Accounting and Net Production (Legacy)
NOTE: This configuration applies to legacy sites that are configuring writeback to Production Accounting and Net Production only. If PbProcessPending (or PbWriteback) is configured and enabled as a background process, it writebacks specified or reconciled values from Production Balance to the material transfer, cutoff inventory and/or Net Production tables in the database. The SDR_WRITEBCK_PA and SDR_WRITEBCK_NP balance group attributes control writeback processing. The SDR_WB_PHD_TRNTS and SDR_WB_PHD_INVTS attributes control the writeback timestamps. The SDR_WRITEBCK_INV and SDR_WRITEBCK_TRN control the type of data that is written back. The default behavior is to writeback only when the case status is Balanced. Writeback of Reconciled cases is controlled by the balance group attribute SDR_WB_RECON.
Production Balance Configuration Guide• 45
Part 2 – Production Balance Analysis Configuration Model Configuration
Writeback to PHD (Legacy)
NOTE: This configuration applies to legacy sites that are configuring writeback to Production Accounting and Net Production only. The SDR_WRITEBCK_PHD balance group attribute enables writeback to PHD. In addition, each route and equipment for which writeback is desired must have tags associated to store the writeback value. The other balance group attributes, associated with writeback to PHD are used for identifying the equipment and route attribute names that control writeback for each balance group. Like the factor attributes, there is one level of indirection. The value of an attribute on the balance group is the name of the corresponding equipment and route attribute that is used for identifying the writeback tag. For example, if the value of SDR_PUTRECONQTY = DAILYVOL, then any equipment or route attributes of DAILYVOL identify the writeback tag. To make the name assigned to each SDR_PUT* attribute available as an equipment attribute, it must be configured in the Uniformance TPI Attribute Configuration form with an entity type of EQUIPMENT. Similarly, to make the name assigned to each SDR_PUT* attribute available as a route attribute, it must be added to the Lookup table with a lookup type of ACCREPORT. Any or all of the SDR_PUT* attributes can be defined for each inventory equipment and route. If a tag is associated with an equipment item through this attribute, the closing inventory is written to the specified tag, with the timestamp of the end of the balance period. (The prior balance period’s close inventory is the current balance period’s open inventory, and will have the timestamp of the start of the current balance period.) If a tag is associated with a route through this attribute, then the total through the route for the balance period is written to the tag. Note that tags can be associated with either or both the source and destination route. The data is written with the timestamp of the start of the balance period. For routes or equipment with no data for the case, a value of 0 is written. NOTE: Older versions of Production Balance used the SDR_PUT* attributes (for example, SDR_PUTMEASQTY) directly as equipment and route attributes, with no indirection. However, this approach did not support multiple writeback tags per equipment or route for the same quantity type (for example, quantity in measured units). To support component factor balancing, indirection was added. For backward compatibility, the use of the previously mentioned attributes as attributes on inventory equipment and routes will be supported as the default. This is true when these attributes are not configured for the balance group.
46 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Writeback in Balanced Units (Legacy)
NOTE: This configuration applies to legacy sites that are configuring writeback to Production Accounting and Net Production only. The IP_MTRL_TRNSFR and IP_CUT_INV tables support only one unit of measure per balance group. An artificial balance group is required to support writeback of results in balanced units. Use the SDR_FCTRBALGRP attribute on the original balance group to identify this artificial balance group. Then assign the PA_NOSETUP_PRC attribute to this balance group. This is to ensure that the background processes do not automatically create cases for it. In addition, the artificial balance group must be identified as a balance group in the Equipment Hierarchy Configuration form (in Business FLEX TPI). It can be both the parent and member of the hierarchy, with a group type of BALGROUP. Do not put any other equipment in the balance group or Production Balance will try to calculate the group on a balance period basis. Parent Equipment Name
Equipment Name
Hierarchy Type
BALGROUP
Missing Movement Generation All lineups/routes that have a source or destination in the balance family are treated as candidate missing movements by the Missing Movement Detection Algorithm in Production Balance, and are listed in the Missing Movements form when the Missing Movements solver runs. No balance group attributes need to be configured for missing movement filtering. ATTENTION: The balance group attributes originally configured for missing movements (SDR_MM_RT_*) no longer apply.
Step 3 – Balance Boundary Definition Configure the Balance Boundary for Each Balance Group For each balance group configure the associated balance boundary using the SDR_BNDRY balance group attribute. NOTE: Balance boundary equipment names must be 40 characters or less. Create the Balance Boundary Equipment For each balance boundary assigned to a balance group, create a matching equipment entity in the Business FLEX TPI Equipment Configuration form, with a type BALBNDRY. The equipment that is internal to the balance boundary is assigned later, as part of Step 7 – Equipment Hierarchy Configuration.
Production Balance Configuration Guide• 47
Part 2 – Production Balance Analysis Configuration Model Configuration
Step 4 – Process Historian Tag Configuration Overview In Production Balance extensive use is made of process historian tags to automate the collection of input data to the maximum extent possible. Process historian tags are typically used for measuring flows, inventories and factor values. In addition, the tags can bring in other values like product. Laboratory results from a LIMS system are typically downloaded to PHD tags for use in factors. Calculated or virtual tags may also be used for providing values (for example, calculation of a flow from a valve position). In general process historian tags must be configured prior to configuring equipment for Production Balance. This is especially true for online measurements as the process historian system must be installed and commissioned prior to configuring Production Balance. As equipment and lineups are configured, tags may be assigned as attributes. Thus having the required tags built prior to the configuration saves jumping back and forth between these two tasks. The model analysis exercise must have identified where measurements were required as input. Otherwise, development of any required virtual tags or configuration of LIMS download tags (driven by Production Balance), are likely to be iterative exercises. Production Balance stores output data in database tables. The database tables may also be further configured to write some types of results to process historian tags. This is sometimes done to facilitate trending of actual versus reconciled data, or to use calculated results for other purposes when the flow or factor is otherwise unmeasured. Configuration of these tags is normally left until the end of a design phase or even until after implementation of Production Balance. Process Historian Tags for Equipment In a Process Historian application, configure the following process historian tags for equipment: •
For each inventory node, configure the process historian tags for the measured and factor values that are to be collected from process historian.
•
Configure any required virtual tags.
New Equipment Attributes for PHD Tags
If you need to create a new equipment attribute in the Business FLEX database that can be read from a PHD tag, use VALCHAR for the attribute type. Do not use REFTAG. This is necessary because if REFTAG is used as the attribute type, PHD automatically fills in the attribute value with the tag ID and there is no way to change it afterwards. By using VALCHAR, you still get the drop-down list, but the attribute value is left blank.
48 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Process Historian Tags for Routes In the Process Historian application, configure the following process historian tags for routes: •
Product tags that identify the product in the route.
•
Measurement tags that record the amount of product moved between the route source and destination.
•
Switch tags that indicate whether a flow is detected through the route or not.
Third Party Process Historian Tags If a process historian other than Honeywell’s Uniformance PHD is going to be used, additional configuration is required before you can configure the associated tags in Production Balance. See the Third Party Process Historian Configuration Guide for details. ATTENTION: As part of the configuration of the third party process historian, the system administrator runs a standard utility program (called GETIT) to collect the tag definitions from the historian and to load them into the Business FLEX database. The tags are then synchronized between the IP_TAG and BF_TAG tables in the database. These tag synchronization activities must be planned and repeated whenever tag configurations are changed in the historian. Refer to the Third Party Process Historian Configuration Guide for details.
Unlike PHD tagnames, the tagnames in a non-PHD process historian can exceed the 32 character limit imposed by PHD. As a result, tagnames from non-PHD process historians are referred to as "long tagnames". No matter how many tagname characters are used, non-PHD process historian tagnames are always treated as long tagnames. Tagname syntax depends on the process historian used. Some historians, such as OSIsoft's PI System®, prefix each tagname with the server name followed by the tag hierarchy details. Some sites configure tagnames such that they contain the complete tag hierarchy details. In such cases, the tagname must not exceed 2000 characters (including the tagname, server prefix and tag hierarchy details). As part of the tag synchronization process between the historian and the Business FLEX database, a short tagname is created for each long tagname collected from the historian. Wherever tagnames are configured as part of Production Balance configuration, the short tagname must be entered. (For a list of the corresponding long and short tagnames look in the Business FLEX TPI Tag Configuration form.)
Production Balance Configuration Guide• 49
Part 2 – Production Balance Analysis Configuration Model Configuration
Well Test Data Integration Honeywell's Well Test Manager application can be used for calculating values for individual well production (for example, oil, gas and water values). This data can be integrated with Production Balance. The connection to Well Test Manager is provided by configuring Production Balance to use PHD tags that contain Well Test results. (See the Well Test Manager Administration Guide for details.) Well Test Manager only supports Uniformance PHD. It cannot be used with non-PHD process historians.
Step 5 – Equipment Configuration Create the Equipment and Nodes For every equipment or node in the balance model, use the Business FLEX TPI Equipment Configuration form to configure the attributes described in the following subsections. Equipment Attributes The equipment attributes are listed in the following tables. Where appropriate, references to more detailed information have been provided Basic Configuration Attributes Attribute
Req’d Default
EQUIP
Y
N
TRUE
Description A value of TRUE identifies the equipment item as equipment. Associates the factor tag with the equipment. Each balance group may add its own factor tag here. The attribute name is identified by the balance group attribute SDR_FCTRVALATTR. (See Factor Attributes for details.)
N
Associates the lower limit factor tag with the equipment. Each balance group may add its own factor tag here. The attribute name is identified by the balance group attribute SDR_FCTR_LOWERLIMIT_ATTR. (See Factor Attributes for details.)
N
Associates the upper limit factor tag with the equipment. Each balance group may add its own factor tag here. The attribute name is identified by the balance group attribute SDR_FCTR_UPPERLIMIT_ATTR. (See Factor Attributes for details.)
50 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute MOVEDEST
Req’d Default N
FALSE
Description Setting this attribute to TRUE causes a list box in the Business FLEX TPI Product Movement Entry form to be populated. If this TPI form is going to be used for manual movement entry, it is recommended that all equipment be assigned as MOVEDEST.
MOVESRC
N
FALSE
Setting this attribute to TRUE causes a list box in the Business FLEX TPI Product Movement Entry form to be populated. If this TPI form is going to be used for manual movement entry, it is recommended that all equipment be assigned as MOVESRC.
PRODUCT_TAG
N
Specifies the tag which returns the name of the product in the equipment.
SDR_MEAS_TYP_OPE
N
Specify FIXED, MEASURED or UNMEASURED to override the default configuration for opening inventory measurement type. (See Overriding Default Measurement Types for details.)
SDR_MEAS_TYP_CLO
N
Specify FIXED, MEASURED or UNMEASURED to override the default configuration for closing inventory measurement type. (See Overriding Default Measurement Types for details.)
PRDCTN_TYPE
Y
POOL
Defines the equipment type when creating a route to or from the equipment. Value is POOL, PROCESS or PERIMETER. For the Net Production report, receipts are movements where the source equipment has the PRDCTN_TYPE attribute set to PERIMETER. Similarly, shipments are movements where the destination equipment has the PRDCTN_TYPE attribute set to PERIMETER. Shipments are further restricted to non-consumption equipment. (That is the destination equipment must not have the CONSUMER attribute set to TRUE.) See Production Type in the Update the Production Balance Model section of this guide (Part 3), for a description of how PRDCTN_TYPE is used in Production Balance Logging.
Production Balance Configuration Guide• 51
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute MEAS_LOWER_LIMIT and MEAS_UPPER_LIMIT
Req’d Default N
Description Low and high limits for the measured value for inventory equipment. If measurement limits are not configured, limit checking is not done. Values for MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT must be entered in the same units as the corresponding measured values. In addition, each value must be entered on a day (24 hr) basis. (See Measurement Limit Values for details.)
Inventory Equipment Attributes
See Inventory Equipment Configuration for details. Attribute
Req’d Default
CUTINV
N
CUTINVTAG
N
INV
N
INVTAG
N
FALSE
Description A value of TRUE causes the inventory equipment item or node to be included in the Cutoff Inventory Report. Specifies the tag to be used for looking up the cutoff inventory amount for the equipment item.
FALSE
A value of TRUE causes normal inventory data collection to occur for the equipment item. Specifies the tag to be used for normal inventory data collection for the equipment item. The tags identified in INVTAG and CUTINVTAG can be identical for the same piece of equipment.
CONSUMER
N
The presence of this attribute identifies the equipment item as consumption equipment. This attribute is used in the Net Production report. An equipment item is a consumer when the material that enters it is consumed and leaves the system, instead of being transformed and continuing to be processed. Therefore, fuel to furnaces or to flare, or other losses are consumed, whereas feedstock to a unit that is converted to product is not considered as consumed. All movements with this equipment as the destination are collected as consumed for reporting purposes.
NOTE: The first four of these attributes (CUTINV, CUTINVTAG, INV and INVTAG) are required for inventory equipment.
52 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Miscellaneous Optional Attributes Attribute IN_ALLOC
Req’d Default N
FALSE
Description If set to TRUE, the node is to be included in production allocation. (See Production Allocation Configuration for details.)
ALLOC_TYP
N
EXCLUDED As equipment attribute, ALLOC_TYP refers to the closing inventory for the equipment item. If set to FIXED, the associated measured value meter is to be included in the production allocation calculations and is considered to be very accurate. If set to UNMEASURED, the associated measured value meter (if there is one) is of such poor quality that it must be calculated by the Production Allocation solver. If set to MEASURED, the associated measured value meter is to be included in the production allocation calculations but it may not be accurate. If set to EXCLUDED, the associated measured value meter is not to be included in the production allocation calculations. Any other value, including NULL, is treated as EXCLUDED. (See Production Allocation Configuration for details.)
SPLITTER
N
FALSE
If set to TRUE, the node is treated as a splitter. The factor values (for example, concentration or density) for every stream that leaves the node are forced to be identical. The factor value for the material stored in the node must equal the factor value in every output stream. (See Splitter and Perfect Mixing Configuration for details.)
PERFECT_MIX
N
FALSE
If set to TRUE, the closing inventory factor value for the equipment item is forced to equal the factor value in the outflow streams. NOTE: PERFECT_MIX only applies to inventory nodes and can only be used if SPLITTER has been set to true for the same node. (See Splitter and Perfect Mixing Configuration for details.)
Production Balance Configuration Guide• 53
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute TANK_LVL_TOL
Req’d Default N
Description A level tolerance value for manual tanks. This value is only required if there is no level tag for the tank.
ATTENTION: The equipment attributes originally configured for Writeback to PHD no longer apply. Writeback is presently configured in the Production Balance Web environment. See Writeback Configuration for details.
Factor Attributes Factor values are associated with inventory equipment using equipment attributes. The attribute name is identified by the balance group attribute SDR_FCTRVALATTR. This level of indirection enables different factors to be configured for different balance groups. (See the discussion of balance group Special Factor Attribute Definitions for details.) NOTE: In order for the name assigned to SDR_FCTRVALATTR to be available as equipment attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of EQUIPMENT. Every inventory equipment must have an attribute with a name matching the previously described configuration (for example, DENSITY_TAG or MASSBALFACTOR). A sample configuration for tank 101 is described. Note that a tag or a constant may be specified. Attribute
Tagname
Description
DENSITY_TAG
TK101.DENSITY
Associates a density factor tag with Tank 101.
Factor Tag Notes
When there are multiple balance groups in a single balance family, each balance group must point to different factor tags. Within a balance family, the factor tagnames must be unique. Overriding Default Measurement Types The default measurement types (configured for the balance group) can be overridden for each equipment using equipment attributes. The SDR_MEAS_TYP_OPE and SDR_MEAS_TYP_CLO attributes must be associated with any inventory equipment for which an override of default is required. The open and close behavior can be overridden and specified independently.
54 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Measurement Limit Values The MEAS_LOWER_LIMIT and MEAS_UPPER_LIMIT attributes are used for configuring the low and high limits for the measured value for inventory equipment. If the measured or reconciled value is outside these limits, a message is generated and the value that is out of range is highlighted in the Production Balance Client application. If the measurement limits are not configured, limit checking is not done. The PB transfer table (PB_TRNSFR) reports total quantity over an interval. As a result, the limit calculations are done on a comparable basis. This enables any balance group of any duration to work with the limit values. Values for MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT must be entered in the same units as the corresponding measured values. In addition, each value must be entered on a day (24 hr) basis. Accordingly the limit values are calculated on a proportional basis and reported in PB_TRNSFR table. The following two examples show how these limits are calculated: Example 1:
If the balance period is 24 hours in duration, and the configured MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT values are 5000 and 1000, respectively, then the limit values would be as follows: MEAS_UPPER_LIMIT = (24/24) ∗ 5000 = 5000 MEAS_LOWER_LIMIT = (24/24) ∗ 1000 = 1000 Example 2:
If the balance period is 12 hours in duration, and the configured MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT values are 5000 and 1000, respectively, then the limit values would be as follows: MEAS_UPPER_LIMIT = (12/24) ∗ 5000 = 2500 MEAS_LOWER_LIMIT = (12/24) ∗ 1000 = 500 The equipment limit value reported in PB_INV table is the configured limit value in all cases. It is not prorated based on the length of the current balance case.
Production Balance Configuration Guide• 55
Part 2 – Production Balance Analysis Configuration Model Configuration
Inventory Equipment Configuration Production Balance can be configured to collect cutoff inventory values for individual equipment items or nodes in each balance group. Tags that measure the net inventory are associated with each inventory node and are defined as equipment. When configured, Production Balance retrieves cutoff inventory quantities each balance period. There are two sets of attributes related to inventory data collection in Production Balance. •
The CUTINV and CUTINVTAG attributes solely collect the cutoff inventory for the equipment item.
•
The INV and INVTAG attributes allow different tags to be used to calculate the quantity of material moved.
NOTE: The tagname used for the attribute INVTAG may be identical to the CUTINVTAG tagname. Product Identification
The product in the inventory equipment at cutoff time is determined automatically. The following is a brief description of the logic used for determining the product name. 1. If the equipment is defined with the attribute PRODUCT_TAG and a tagname is defined for that equipment, the value in that tag (must be a character tag type) at the balance period end time, is placed in the Product Name field. This is the first condition checked for. 2. The last transfer where that the equipment item was the destination is selected from the material transfer table. If the routing belonging to that transfer does not have the Use Alternate Route Flag set, the product name for that transfer is used. If the flag is set, the next oldest transfer is selected. 3. If none of the product identification determines the product name, the system inserts UNKNOWN for the product name. Splitter and Perfect Mixing Configuration Production Balance can control the factor values (for example, concentration or density) in and around the inventory nodes in the balance group. The SPLITTER attribute on a node can be used for forcing the factor values for every stream that leaves the node to be identical. Setting the PERFECT_MIX attribute to TRUE for inventory nodes, forces the closing inventory factor value for the node to equal the outflow factor value. These SPLITTER and PERFECT_MIX attributes can help to avoid inconsistent factor value profiles in the inventory nodes. (For more information see the Production Balance User Guide.) In general, the need for these attributes must be determined after Production Balance is running. 56 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Production Allocation Configuration For those sites that want to use the Production Allocation solver, identify the nodes which are to be included in production allocation by setting the IN_ALLOC attribute to TRUE. In addition, set the ALLOC_TYP attribute for the inventory nodes that are to be included in the production allocation calculations by selecting the appropriate Allocation Type option in the Business FLEX TPI Equipment Configuration form. The allocation type options are: Option Type
Numeric Value
MEASURED
1
FIXED
0
UNMEASURED
-1
EXCLUDED
-2
For more information about Production Allocation see the Production Balance User Guide.
Step 6 – Equipment Mode Configuration Operating Modes Some equipment may have operating modes or discreet ways of operating them. In cases like this there is often a requirement to provide yield reports independently on these equipment items based on their mode of operation. To this end operating modes are configured as equipment and follow the same general rules for configuration. The equipment type must be OP-MODE, and the attribute MODE must be assigned. Lineups would then be configured to each mode as appropriate. It is generally recommended that the lineups be provided with switch tags based on virtual tags that are synchronized such that the routes open or close appropriately based on a single equipment mode tag. Operators may manually set one tag describing the unit mode or it may be possible to infer the mode from other information like operating conditions or analyzer targets. When a mode is to be inferred, a virtual tag must be used for determining and return the mode. Details of the lineup and switch tag configuration are described in Step 10 – Route Configuration. For new installations of Production Balance, it is expected that the Production Balance Logging feature, in Production Balance Web, will be used for logging mode changes. They can be configured manually in TPI. If the Operations Monitoring or Operating Instructions applications are present, and the Business FLEX TPI Mode Change form is going to be used for mode
Production Balance Configuration Guide• 57
Part 2 – Production Balance Analysis Configuration Model Configuration
change logging, modes can only be configured in TPI. See the Production Balance Supplementary Reference Guide for details. When the site is not using the Operations Monitoring or Operating Instructions applications, Production Balance may use the Business FLEX TPI Mode Change form in place of using a tag to define operating mode. This is not a generally recommended approach but may offer some sites value because of the workflow it enables. See the Production Balance Supplementary Reference Guide for additional details on use of this option. Equipment Mode Attributes The equipment mode attributes listed in the following table are configured in the Business FLEX TPI Equipment Configuration form. Basic Configuration Attributes Attribute
Req’d Default
INST
N
Description Add this attribute to indicate that operating instructions may be used for issuing mode change commands for the equipment. Only applies if the Business FLEX Operating Instructions application is present.
MODE
N
FALSE
Set this attribute to TRUE if the item is an operating mode for equipment rather than a piece of equipment.
Example
The following examples show the equipment attributes that would need to be configured for a unit called "FCCU", with two modes called "FCCU MODE 1" and "FCCU MODE 2". Equipment Equipment Name
Description
Equipment Type
Active
Effective Start Date
FCCU MODE 1
(As desired)
OP-MODE
X
(Now)
FCCU MODE 2
(As desired)
OP-MODE
X
(Now)
FCCU
(As desired)
UNIT
X
(Now)
Equipment Attributes Equipment Name
Equipment Attribute
FCCU
EQUIP
FCCU MODE 1
MODE
FCCU MODE 2
MODE
58 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Step 7 – Equipment Hierarchy Configuration Define the Equipment Hierarchies Equipment hierarchy configuration is performed in the Business FLEX TPI Equipment Hierarchy Configuration form. Configure the Balance Family - Balance Group Hierarchy Assign each balance group to its associated balance family, by creating a separate record for each balance family - balance group pair with the type BALFAM. Parent Equipment Name
Equipment Name
Hierarchy Type
BALFAM
Balance Group Reporting Sequence
As part of the equipment hierarchy configuration the hierarchy sequence must be configured for balance groups. The sequence is used for controlling the order in which the balance groups appear in the Production Balance Analysis reports (in Production Balance Web) for a given balance family. NOTE: Each SEQ value in a given balance family - balance group hierarchy must be unique. Configure the Balance Group - Equipment Hierarchy Assign the equipment and nodes to associated balance group, by creating a separate record for each balance group - equipment entity pair with the type BALGROUP. Parent Equipment Name
Equipment Name
Hierarchy Type
BALGROUP
Note: It is recommended that all of the equipment and nodes in the area of the site covered by the balance family, be included in every balance group in the balance family. This must be done, even for equipment that is not going to be included in the balance calculations for a given balance group. In addition, assign the equipment modes to the balance group. Parent Equipment Name
Equipment Name
Hierarchy Type
BALGROUP
Production Balance Configuration Guide• 59
Part 2 – Production Balance Analysis Configuration Model Configuration
Configure the Balance Boundary - Equipment Hierarchy The equipment entities in the balance group that are to be included in the balance calculations for that balance group, must be assigned to the associated balance boundary. This is done by creating a separate record for every equipment entity in the balance boundary with the type BALBNDRY. Parent Equipment Name
Equipment Name
Hierarchy Type
BALBNDRY
Every equipment entity that is assigned to the balance boundary for a given balance group, is considered to be inside the balance for the reconciliation calculations for that balance group. The equipment entities in the balance group that are not assigned to the balance boundary, are considered to be outside the balance and are not included in the reconciliation calculations for that balance group. Recommended Implementation Technique
For Production Balance models with multiple balance groups, it is recommended that the assignment of equipment to balance groups and to balance boundaries be completed for a single balance group using TPI. After this is complete, copy the balance group and balance boundary records to Microsoft Excel. After the records are in Excel, you can capitalize on the editing features in Excel to create the equivalent records for the other balance groups and balance boundaries in the same balance family. After completion, copy the new balance group and balance boundary records back into TPI. Configure the Equipment - Equipment Mode Hierarchy Assign the equipment to the associated equipment mode, by creating a separate record for each equipment mode - equipment entity pair with the type MODE. Parent Equipment Name
Equipment Name
Hierarchy Type
< Equipment Name>
MODE
Example
The following example displays the equipment hierarchy attributes that would need to be configured for a unit called "FCCU", with two modes called "FCCU MODE 1" and "FCCU MODE 2". Application Name
Parent Equipment Equipment Name Name
Hierarchy Type
Sequence
SITE
FCCU UNIT
FCCU MODE 1
MODE
(Blank)
SITE
FCCU UNIT
FCCU MODE 2
MODE
(Blank)
60 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Configure the following Equipment Hierarchy for Balance Group to appear on the web: Parent Equipment Name
Equipment Name
Hierarchy Type
BALFAM Name
BALFAM Name
BALROOT
BALFAM Name
BALGROUP Name
BALFAM
BALGROUP name
EQUIP Name
BALGROUP
Configure the following hierarchy for PB groups to appear in Move and Mode pages: Parent Equipment Name
Equipment Name
Hierarchy Type
BALGRP Name
EQUIP Name
PL_EQUIPMENT
BALGRP Name
BALGRP Name
PL_ROOT
BALGRP Name
BALGRP Name
PL_BRANCH
Configure the following hierarchy for Equipment Hierarchy - IM group to appear on the web: Parent Equipment Name
Equipment Name
Hierarchy Type
IMGROUP Name
IMGROUP Name
PL_ROOT
IMGROUP Name
IMGROUP Name
PL_BRANCH
IMGROUP Name
EQUIP Name
PL_EQUIPMENT
Step 8 – Product Configuration Create the Products For every product in the balance model, add the product name to the Business FLEX TPI Product Configuration form. Product Attributes The product attribute identified in the following table may be configured. Attribute
Req’d Default Y
Description Identifies the default factor for the product. The attribute name is identified by the balance group attribute SDR_FCTRDFLTATTR. (See Factor Attributes for details.)
Production Balance Configuration Guide• 61
Part 2 – Production Balance Analysis Configuration Model Configuration
Factor Attributes Default factor values are associated with products through product attributes. The attribute name is identified by the value of the balance group attribute SDR_FCTRDFLTATTR. (See the discussion of balance group Special Factor Attribute Definitions for details.) NOTE: In order for the name assigned to SDR_FCTRDFLTATTR to be available as a product attribute, it must be configured in the Business FLEX TPI Attribute Configuration form with an entity type of PRODUCT. Default factors must be defined for all products. Default factors are used when there is no factor available for the node or flow, either because there is no factor tag defined, the tag has a null value, or the timestamp of the factor value is older than the timestamp of the last product switch for the route or node. The product default factor can be defined as a constant or a tag. If a constant, the factor units are taken to be those configured as the default factor units for the balance group (for example, SDR_FCTRDFLTUNIT = G/ML). Attribute
Value
DFLT_MASSBALFCTR
1.0
Tagname
If a tag, then the most recent value prior to the end of the balance period (for inventory) or transfer (for flows) is used, and the factor units are the units of the tag. Attribute DFLT_MASSBALFCTR
Value
Tagname
Units of Measure If the quantity input units of measure in Production Accounting (PA) (which come from the legacy cut off inventory workflow in TPI) are different than the balance units, then an additional lookup called PRDCTUNIT must be configured with the corresponding units. (For example if the input units are BBL but the balance units are TONNE, then create a unit of BBL in IP_LKP with LKP_NAME = PRDCTUNIT and LKP_VALUE = BBL.)
Step 9 – Product Hierarchy Configuration Product hierarchy configuration is performed in the Business FLEX TPI Product Hierarchy Configuration form. The standard Net Production reports require a three level product hierarchy, similar to Family / Group / Product, where families contain groups which contain products. Ensure that all products are included in the third level, with product groups at the first and second levels.
62 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Each entry in the Product Hierarchy Configuration form must be identified by Application Name = PB and Hierarchy Type = REPORT. NOTES: •
Do not configure products at level one or two of the product hierarchy.
•
No product must be entered twice in the hierarchy.
•
If a product of interest is left out of the hierarchy it will be excluded from the report.
•
If a three tier hierarchy is not configured, the reports will require extensive customization.
Product Reporting Sequence
As part of the product hierarchy configuration the hierarchy sequence must be configured for product families and product groups. The sequence is used for controlling the order in which the products appear in the Production Balance Analysis reports (in Production Balance Web) for a given product group or family. NOTE: Each SEQ value in a given product group - product hierarchy must be unique.
Step 10 – Route Configuration Define the Product Routes The lineups between the equipment are defined in the Business FLEX TPI Product Route Configuration form. NOTES: 1. Branching at intermediate nodes or links is not recommended. Installers are encouraged to use direct connections between source and destination equipment instead. If branching at an intermediate node is required, it can only be configured manually in the Business FLEX TPI Product Route Configuration form. 2. If branching at links is used, links can join multiple sources to one destination or one source to multiple destinations, but not both. See the Route Configuration Notes later in this section for details. 3. For users who are familiar with Production Tracker, the route source and destination is the equivalent of the boundary point meters on equipment or units. The factor values for these meters are configured using product route attributes.
Production Balance Configuration Guide• 63
Part 2 – Production Balance Analysis Configuration Model Configuration
Using the Product Route Configuration Form
If the Business FLEX TPI Product Route Configuration form is used, two entries per lineup must be made which share a common link node. One entry is the source relative to the link node and the other entry is the destination relative to the link node. Each route half is associated with equipment and an optional product. Product can be based on the yield model that represents the unit's current operation mode. In addition, each half is related to a primary measurement DCS tag. You can also define a switch tag for either the source or destination half of the transaction. The switch tag state indicates to the system which of the multiple destinations or sources are active. A destination change can indicate that a different type of product is produced, such as offspec to on spec, or low pour to high pour, and so on. Following is the Product Route Configuration form.
The following buttons are displayed in the title bar of the Product Route Configuration form. Click this…
To do this…
New Form
Create a new instance of the Product Route Configuration form. Two or more Product Route Configuration forms can be open and in use at the same time.
Detail
Display the Detail window of the form. The context is the multiple routings format. The Detail View remains displayed on the form until you click the Factor button.
64 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Click this…
To do this…
Factor
Display the Factor window in the bottom portion of the form. The context is the active product routing. That window remains displayed on the form until you click the Detail button.
Enter Query
Display the Query Dialog. The query dialog provides the ability to search for entries within the database.
The following fields appear in the Detail portion of the Product Route Configuration form. The asterisk (*) indicates mandatory fields. In this field…
Do this…
*Link
Enter a name for the logical connection between the sources and destinations for any product routing. The link is assigned manually and is repeated for each possible source and destination entry.
*Src/Dest
Select whether the entry is a source or destination entry half of the link. Multiple source and destinations are supported. Select either S (source) or D (destination).
*Equipment /Mode
Select the possible product routings for a particular equipment mode. The routings may have a different product stream name, may exist, or not exist for different equipment modes. Modes are defined in the equipment definition with an attribute of MODE.
Measurement Tag
Select the tag that identifies the inventory or flow quantity for the product movement. This tag records the amount of product moved between the source and destination. NOTE: In order to display a route in the Lineup Editor of PB Web involving an equipment that has measurement tag configured, it is required that the measurement tag configured should match with the tagname value of the FLOW attribute configured for the same equipment in the equipment configuration.
*Op type
Select the operation type for the entry, such as product movement, yield, extraneous feed, and so on. NOTE: For routes to be used in the legacy TPI Product Movement Entry form, the source must be configured with an operation type of MOVE in order for the movement to appear in Production Balance.
Active?
Select whether the entry is currently active. An X indicates an active entry.
Static Route?
Select whether the route is static. Static routes are portions of a stream that do not change with changes in lineup or modes of operation. An X indicates static routes.
Product
Select the product name associating the product routing to a particular product. The product is validated to exist and be currently active in the product configuration table. A list of valid product names is available. Leave this field blank if a Product Tag is assigned.
Switch Tag
Select the tag that indicates whether a flow is detected or not. If the switch tag value is used and it indicates a flow is not occurring, that is, value is 0, the automated processes that collect the detailed product movement information do not insert a detailed product movement for this entry. If the switch tag indicates a flow, that is, value is 1, for all or a portion of the accounting period collected, a detailed transfer is created. The
Production Balance Configuration Guide• 65
Part 2 – Production Balance Analysis Configuration Model Configuration
In this field…
Do this… transfer is created for the time period for which the flow was detected as active.
*Acct Type
Select the reporting and accumulation rules on accounting reports for the quantities measured for this product routing entry.
Product from Alternate Route
Select whether the product name must come from an alternate routing entry. For example, in a blender there are transfers of products and additives. The product may have been transferred into the blender prior to the additives. In Production Balance, the last transfer into the equipment determines the product name of the material. For the additives routing entry, you can set the flag to indicate that the product name of the material in the blender must not be that of the additive, but must be derived from another product routing entry.
Product Tag
Select the tagname that identifies the product.
Alloc Type
Select the allocation types of this product route. If set to FIXED, the associated measured value meter is to be included in the production allocation calculations and is considered to be very accurate. If set to UNMEASURED, the associated measured value meter (if there is one) is of such poor quality that it must be calculated by the Production Allocation solver. If set to MEASURED, the associated measured value meter is to be included in the production allocation calculations but it may not be accurate. If set to EXCLUDED, the associated measured value meter is not to be included in the production allocation calculations. Any other value, including NULL, will be treated as EXCLUDED. (See Production Allocation Configuration for details.)
Notes
Enter descriptive notes related to the configuration and ongoing maintenance of this product routing.
The following fields appear in the Factor portion of the Product Route Configuration form. The asterisk (*) indicates mandatory fields. In this field…
Do this…
*Accounting Report Type
Select the route attribute to be configured. The Accounting Report Type entries are defined in the lookup value table with lookup type ACCREPORT.
*Factor Tagname
Enter the value or tag for the route attribute.
66 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Route Attributes The route attributes listed in the following table are configured in the Factor portion of the Product Route Configuration form. The attribute name is selected from the Accounting Report Type list box and the value is entered in the Factor Tagname. Where appropriate, references to more detailed information have been provided. Basic Configuration Attributes Attribute (Accounting Report Type) RECONPUT
Req’d Default N
Description If this attribute is configured, the Production Balance resolved quantity is downloaded into the tag identified in the Factor Tagname field. The timestamp associated with this value is the start of the balance period. Associates the factor tag with the route. The attribute name is identified by the balance group attribute SDR_FCTRVALATTR. (See Factor Attributes for details.)
Associates the lower limit factor tag with the route. The attribute name is identified by the balance group attribute SDR_FCTR_LOWERLIMIT_ATTR. (See Factor Attributes for details.)
Associates the upper limit factor tag with the route. The attribute name is identified by the balance group attribute SDR_ FCTR_UPPERLIMIT_ATTR. (See Factor Attributes for details.)
SDR_FCTRAVERAGE
N
Specifying this route attribute causes Production Balance to use a calculated weighted average for the factors. A dummy tagname must be defined, even though it is not used. If this route attribute is not configured, SDR_FCTRLAST is used instead. In this case, the last good factor value is used by Production Balance. (See Averaged Factor Values for details.)
SDR_RTG_FIXED
N
Specify this attribute to indicate that transfers on a route are FIXED. A tagname is required, but ignored. (See Overriding Default Measurement Types for details.)
Production Balance Configuration Guide• 67
Part 2 – Production Balance Analysis Configuration Model Configuration
Attribute (Accounting Report Type) SDR_RTG_MEAS
Req’d Default N
Description Specify this attribute to indicate that transfers on a route are MEASURED. (See Overriding Default Measurement Types for details.)
SDR_RTG_UNMEAS
N
Specify this attribute to indicate that transfers on a route are UNMEASURED. (See Overriding Default Measurement Types for details.)
ALLOCATION
N
If this attribute is configured, the route is included in an allocation procedure. The allocation resolution method is specific to upstream oil and gas production. If you use ALLOCATION, a dummy tag must be inserted in the Factor Tagname Field. (Note: This attribute is for legacy use only. It is not related to the Production Allocation feature available from the Production Balance user interface.)
MEAS_LOWER_LIMIT and MEAS_UPPER_LIMIT
N
Low and high limits for the measured value for routes. If measurement limits are not configured, limit checking is not done. Values for MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT must be entered in the same units as the corresponding measured values. In addition, each value must be entered on a day (24 hr) basis. (See Measurement Limit Values for details.)
ATTENTION: The route attributes originally configured for Writeback to PHD no longer apply. Writeback is presently configured in the Production Balance Web environment. See Writeback Configuration for details.
Factor Attributes Factor values are associated with routes 6 using product route attributes. The attribute name is identified by the balance group attribute SDR_FCTRVALATTR. This level of indirection enables different factors to be configured for different balance groups. (See the discussion of balance group Special Factor Attribute Definitions for details.) NOTE: For the name assigned to SDR_FCTRVALATTR to be available as a route attribute, it must be added to the Lookup table with a lookup type of ACCREPORT.
6
The factor values for unit boundary point meters are configured using product route attributes. They are associated with the route source or destination.
68 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Unlike in older versions of Production Balance, it is no longer a requirement that every route half have a measurement/meter assigned to it. Source and destination product routes may have a factor attribute with a matching name (for example, DENSITY_TAG or MASSBALFACTOR). The configuration must not be duplicated or identical between the two halves of the same route. Blanks are acceptable. In the case of transfers from tanks, the factor value on the route can be often assumed to be the same as the tank factor value of the source. Depending on the process unit and material, unit production streams will either be sampled periodically, or a constant density may be reasonable. Factor Tag Notes
When there are multiple balance groups in a single balance family, each balance group must point to different factor tags. Within a balance family, the factor tagnames must be unique. Averaged Factor Values
By default, Production Balance uses the most recent factor value prior to the end of a transfer. This approach was taken to avoid using out-of-date data for some portion of a transfer if a sample was taken in the middle of the transfer, and is appropriate when streams are sampled infrequently. However, when there are several or more samples per balance period, an average factor would be more appropriate. When a balance period is a month, there will often be many samples over the period. The average must be the flow weighted average of the factor tag over the duration of the transfer. This weighted average grade calculation can be performed externally to Production Balance in virtual tags, but needs to be part of the standard solution to meet market expectations, and to reduce implementation costs. To configure the calculation of weighted averages, the routes require an additional attribute SDR_FCTRAVERAGE. A dummy tagname has to be defined with this attribute although it is not used. (If this route attribute is not configured, SDR_FCTRLAST is defined by default and appears in the Product Route Configuration form for the route. In this case, the last good factor value is used by Production Balance.)
Production Balance Configuration Guide• 69
Part 2 – Production Balance Analysis Configuration Model Configuration
Overriding Default Measurement Types The default measurement types (configured for the balance group) can be overridden for each route using route attributes. NOTE: The mechanism for specifying the measurement type is implemented differently for equipment and routes. This is because equipment attributes support text values whereas routes require tagnames and do not support text values. One (and only one) of the following attributes must be associated with a route for which an override of default measurement type is required. – SDR_RTG_FIXED – SDR_RTG_MEAS – SDR_RTG_UNMEAS The tagname specified is ignored, but a tagname is required. If multiple attributes are specified they are all ignored. Measurement Limit Values The MEAS_LOWER_LIMIT and MEAS_UPPER_LIMIT attributes are used for configuring the low and high limits for the measured value for routes. If the measured or reconciled value is outside these limits, a message is generated and the value that is out of range is highlighted in the Production Balance Client application. If the measurement limits are not configured, limit checking is not done. The PB transfer table (PB_TRNSFR) reports total quantity over an interval. As a result, the limit calculations are done on a comparable basis. This enables any balance group of any duration to work with the limit values. Values for MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT must be entered in the same units as the corresponding measured values. In addition, each value must be entered on a day (24 hr) basis. Accordingly the limit values are calculated on a proportional basis and reported in PB_TRNSFR table. The following two examples show how these limits are calculated: Example 1:
If the balance period is 24 hours in duration, and the configured MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT values are 5000 and 1000, respectively, then the limit values would be as follows: MEAS_UPPER_LIMIT = (24/24) ∗ 5000 = 5000 MEAS_LOWER_LIMIT = (24/24) ∗ 1000 = 1000
70 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Example 2:
If the balance period is 12 hours in duration, and the configured MEAS_UPPER_LIMIT and MEAS_LOWER_LIMIT values are 5000 and 1000, respectively, then the limit values would be as follows: MEAS_UPPER_LIMIT = (12/24) ∗ 5000 = 2500 MEAS_LOWER_LIMIT = (12/24) ∗ 1000 = 500 Production Tracker Integration Considerations When Production Tracker is present, product routes can either be configured manually using TPI or they can be generated automatically through the Production Balance's Logging interface to Production Tracker. Automatic route generation is the preferred method in this case. If you are planning to integrate Production Balance with Production Tracker, be sure to include the configuration of ports into account when you are configuring routes for Production Balance. See the Production Tracker Configuration section for details. In addition, if the movement data for a given route is to be collected from Production Tracker, do not make that route static. Route Configuration Notes General Configuration Recommendations
•
It is not necessary for every route source and destination to have a meter assigned to them. This is no longer a requirement and any references to this in the Production Balance Supplementary Reference Guide can be ignored.
•
Only configure what you have. If there is a measurement on a route source, configure it. Do not configure a measurement or meter on a route source or destination node, if it does not exist.
•
All product routes entered must be marked as active (set the Active option to X or ON).
•
The Static Route flag must only be set to ON, if the route is a permanent lineup to be collected by the background processes.
•
Branching at intermediate nodes or links is not recommended. Installers are encouraged to use direct connections between source and destination equipment instead. If branching at an intermediate node is required, it can only be configured manually in the Business FLEX TPI Product Route Configuration form.
Production Balance Configuration Guide• 71
Part 2 – Production Balance Analysis Configuration Model Configuration
Naming Suggestions
•
It is recommended that a simple method be used for naming link nodes (for example, number sequences).
•
Link names must be unique for each transfer group to match source(s) and destination(s).
•
When naming the product routes, different link names must be used for the routings representing the same stream in different balance groups.
Links and Modes
•
It is recommended that each route be configured with one source and one destination. To support legacy installations, links can join multiple sources to one destination or one source to multiple destinations, but not both. Configuring multiple sources to multiple destinations through a single link will result in unpredictable and incorrect reconciliation results, and must not be used.
•
Branching at link nodes is not recommended for new sites.
•
Each operating mode or actual process equipment must be joined to all appropriate links.
Tags
•
Measurement tags and static route flags are not required when quantities are manually entered. Transfers must only show up for the time periods when a product movement is entered.
•
Switch tags used in product routing must be configured as integer tags with a high extreme of one and low extreme of zero.
72 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Product Notes
•
Product names are optional and are determined from the last movement into the location, if required. However, it is much better to positively declare the product rather than rely on this functionality.
•
It is poor practice to rename a product across links. Don't change the product name across link nodes.
Product Routing Configuration Options
Many different product routing configurations can represent the same mapping of sources to destinations. Deciding which configuration to use is governed by how you want to relate and report the transfers. For example, configuring a stream that may either go to flare or to another process can be configured as the following: •
Two different modes of operation of the source unit (switched with the stream destination).
•
By configuring the stream with two destinations and switch tags (to flare when that routing is detected and the next process unit otherwise).
Both configurations collect, resolve, and report the stream correctly. The difference is in the detailed data collected and available to respond to other business questions such as “What was the charge to the unit when the stream was going to flare?” Collecting the source unit data as a separate mode of operation automatically collects related data for each flaring event, when treating the flaring as switched stream would require manual queries to snapshot related information. This same scenario may also be configured as one mode of operation (source unit) with two destinations (without switch tags configured) for the same stream, measured by virtual tags that multiply the flow quantity by the switch value. This results in the reports always showing both destinations for the stream, even if one of the flows is zero for the entire period. The application requests data from the process historian in the units of measure configured for the balance. If a tag is configured to measure flows within that balance in a unit of measure that cannot be converted to the units of the balance, the measurement is then requested in the native units for that tag. Ensure you do not use tags that you cannot convert to the balance units of measure whose native units are in flow rates. This results in measurements collected, which are closing value minus opening value, times the time frame, always resulting in invalid (often negative) quantities. To correct this situation, a virtual tag can be created in totalized units and configured to be collected in place of the flow rate tag.
Production Balance Configuration Guide• 73
Part 2 – Production Balance Analysis Configuration Model Configuration
The application supports multiple balance groups. Each balance group requires a set of equipment or equipment modes to be related to it. The same equipment can be in more than one balance group. The product routings involving the equipment are collected for each balance group. The same streams can be configured differently with source or destination equipment in different balance groups. The application collects all product routings configured for the equipment, in both or all balance groups, independent of balance group. The application selects only the other equipment in this balance group and does not have the matching product routing sources and destinations that belong to the other balance group(s). Non-matching product routings are discarded by the application after all transfer components are collected. Production Allocation Configuration For those sites that want to use the Production Allocation solver, set the ALLOC_TYP attribute for the routes that are to be included in production allocation calculations by selecting the appropriate Allocation Type option in the Product Route Configuration form. The allocation type options are: Option Type
Numeric Value
MEASURED
1
FIXED
0
UNMEASURED
-1
EXCLUDED
-2
NOTE: The ALLOCATION attribute in the Factor portion of the Business FLEX TPI Product Route Configuration form is for legacy use only. It is not related to the Production Allocation feature available from the Production Balance user interface. For more information about Production Allocation, refer to the Production Balance User Guide.
Step 11 – Validate the Model After the Production Balance model has been configured in the Business FLEX database, the Production Balance Configuration Validation tool can be used for validating the PHD process historian tags and units configured for the model. NOTE: The Configuration Validation tool can only be used for validating process historian tags configured in PHD. Skip this step if a non-PHD process historian is being used. The Configuration Validation tool is a Microsoft Excel workbook called Configuration Validation.xls. that is installed with the Production Balance Client application.
74 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
Software Prerequisites Before you can run the Configuration Validation tool, the following software prerequisites must be met: •
Uniformance PHD must be installed and running.
•
The Business FLEX database and the required Business FLEX applications must be installed and running.
•
Microsoft Excel must be set up with the Macro Security Level must be set to Medium or Low.)
Data Source Setup
Before you can run the Configuration Validation tool in Excel, the connection to the Business FLEX database in Oracle must be preconfigured as follows. 1. On the computer where the Production Balance Client application was installed, open the ODBC Data Source Administrator. (The ODBC Data Source Administrator is accessed from the local Administrative Tools > Data Sources (ODBC) shortcut. The location of this shortcut will depend on which Windows® Operating System is present.) 2. In the System DSN tab, click Add. 3. In the Create New Data Source dialog box selected the Oracle in OraHome92 driver and click Finish.
Production Balance Configuration Guide• 75
Part 2 – Production Balance Analysis Configuration Model Configuration
4. In the ODBC Driver Configuration dialog box, enter the Data Source Name and TNS Service Name for the Business FLEX database in Oracle, and click OK.
Run the Validation Configuration Tool To validate the Production Balance model run the Validation Configuration tool as follows: 1. Open the Configuration Validation.xls workbook which is stored in the \Program Files\Honeywell\Business FLEX\ProductionBalance
folder on the computer where the Production Balance Client application was installed. 2. In the Configuration Validation worksheet, enter the following information: In this field...
Enter this...
DSN
Data source name for the Business FLEX database in Oracle.
User ID
The user name required for the Business FLEX database.
Password
The password required for the Business FLEX database.
Balance Group
The name of the Production Balance group you want to validate.
76 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Model Configuration
3. Click the Validate button to proceed with model validation for the selected balance group. The validation results appear in the following worksheets. Worksheet
Description
Inactive tags in Route
Reports any inactive historian tags used in routes.
Inactive tags in Inventory
For each active route in the balance group, the tool looks for the tags configured in the TAGNAME and FLW_SWITCH_TAGNAME attributes in the IP_PRDCT_RTG table. If the corresponding tags in the IP_TAG table are inactive (ACTIVE_CHK = null), the tag is listed in this worksheet. (The FLW_SWITCH_TAGNAME attribute is the Switch Tag configured in the Product Route Configuration form.) Reports any inactive historian tags used in inventories. For each inventory equipment item in the balance group, the tool looks for the tags configured in the TAGNAME attribute (where ATTR = CUTINVTAG or INVTAG) in the IP_EQUIP_ATTR table. If the corresponding tags in the IP_TAG table are inactive (ACTIVE_CHK = null), the tag is listed in this worksheet.
Production Balance Configuration Guide• 77
Part 2 – Production Balance Analysis Configuration Model Configuration
Worksheet
Description
Quantity tags with null tol
Reports any quantity or factor tags with null tolerances. Looks at the following quantity and factor tags configured for the balance group in the IP_EQUIP_ATTR table and determines if the corresponding tag tolerance in the IP_TAG table is a null value: Quantity Tags
Factor Tags
CUTINVTAG INVTAG
SDR_FCTRVALATTR SDR_FCTR_LOWERLIMIT_ATTR SDR_FCTR_UPPERLIMIT_ATTR
In addition, this checks the route factor tag configured in table IP_PRDCT_RTG_FCTR_DETAIL. Flow rate tags with Reports any flow rate tags with absolute tolerances. abs tol Looks at the flow rate tags configured for the balance group on the routes and determines if the corresponding tag in the IP_TAG table has a tolerance type of absolute (TOTYPE = A): Inventory tags with Reports any inventory tags with percent tolerances. percent tol Looks at the CUTINVTAG and INVTAG inventory equipment tags configured for the balance group in the IP_EQUIP_ATTR table and determines if the corresponding tag in the IP_TAG table has a tolerance type of percent (TOTYPE = P):
4. Back in the Configuration Validation worksheet, click the Validate Constructed to Actual Factor Conversion button to validate the unit conversions for the selected balance group. The validation results appear in the following worksheet. Worksheet
Description
Const To Actual Factor Units
Reports any constructed factor units (quantity units/balance units) that are not convertible to the actual units of the factor tag.
5. Repeat steps 2 through 4 for each balance group in the model. Use the validation results to correct your model as needed.
78 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Background Processes Configuration Introduction Background processes are used for performing regular, scheduled jobs. Production Balance makes use of several background processes to collect and process data needed by Production Balance, to carry out reconciliation calculations and to write the reconciliation results back to the Business FLEX database. Background processes are normally installed on a single server computer at a site and run without human interaction. All background processes are installed as part of the Business FLEX Application Server components. Refer to the Business FLEX Installation Guide for information about installing these components. The following table lists the background processes used in Production Balance. All background processes are required except as noted. Name
Purpose
Required
MsgLogServer
Housekeeping routine that logs messages from other background processes.
Yes
PhdSql
Retrieves data from PHD. Runs continuously.
Yes
If a process historian other than PHD is being used, this background process is not available. Purge Message Log Housekeeping routine that purges messages saved by Data the MsgLogServer background process.
Yes
Data Distribution
Sends tag information generated by various Business FLEX applications, including Production Balance, to PHD. Only required for Writeback to PHD.
Optional
PA Setup
Creates a Production Balance auto processing entry for Optional each new case. Copies the auto processing settings and steps from the previous case.
PA Auto Process
Carries out the default auto processing steps for each new auto processing entry created by the PA Setup background process.
PA Auto Reprocess
Reprocesses the PA Auto Process case when Yes requested from TPI. Carries out raw data and factor data reprocessing, when requested from the Production Balance user interface.
PbInterface
Collects inventory, missing movements and transfer data, and stores it in the Production Balance tables.
Yes
Yes
Production Balance Configuration Guide• 79
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Name
Purpose
Required
PbProcessPending
NOTE: This background process is not applicable for non-legacy sites, and hence it must be disabled. Writeback is configured currently in the Production Balance Web environment. Refer to Writeback configuration for more details.
Yes
Reprocesses the PA Auto Process case when requested from the Production Balance user interface. Reconciles the current balance. Writes the reconciliation results back to the database and to process historian tags. Processes sequential cases. The PbWriteback functionality has been incorporated into the PbProcessPending background process. PbRecon
Automatic Production Balance solver that reconciles the Optional current balance and saves the results to the database. Optional background process that can be used instead of the Production Balance Client user interface to run the reconciliation analysis automatically.
PLWriteback
Writes the attribute values configured in the PB Configuration - Writeback display to process historian tags.
Optional
The writeback operation is triggered by the following events: 1. An inventory group has been set to release. 2. A balance case has been saved as balanced in the Production Balance Client application.
This topic is meant for a site administrator. TIP: Some of the examples shown here have a CONNECT_STRING setting of “totalplant/totalplant@totalplant”. This represents the user account, password, and database name used for connecting to Oracle. The usual recommendation for configuring the Application Server is to use a Windows account named uniserver and to allow programs running on this Windows account to be authenticated by Windows. If you follow this recommendation, you must use the CONNECT_STRING setting of “/@totalplant” for all background processes.
Parameters for the Background Processes The Application Server, also known as the Background Process Scheduler, reads the information entered using the Application Server Configuration form to produce an execution string and dispatch the appropriate processes with their respective arguments. Two types of parameters may be defined for each background process depending on the type of process and how it is developed: command line parameters used by executables, cmd or bat files. These parameters may be positional or could be command line switches typically used by executables. When these parameters are defined, it is mandatory to enter a value for the Seq (sequence) field. This notifies the scheduler that the parameter is a command line argument and a part of the execution string.
80 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
In addition, a sequence defines the relative position of the parameter in the command line, not a physical one. This means that a value of 2 does not imply that the parameter is the second on the command line. It would only be true if another parameter has a sequence value of less than 2. Therefore, order the parameters based on sequence ordering from the lowest value to the highest. The second type of parameters are those accessed on demand by background processes. There are several executable background processes that read the value of the parameter versus receiving it as a command line argument. This is the only mechanism to supply user-defined parameters for PL/SQL programs. The most important parameter is the CONNECT_STRING parameter. As the majority of the background processes expect the connection string, they can connect to Oracle. The value of this string is the actual string for the connection, if left empty, the scheduler fills this argument position with its default connection string. The sequence number is mandatory and specifies the relative position of the connection string on the command line. Some applications can be configured using switches instead of or in addition to normal positional arguments. The parameter CMDLINE_SWITCHES specifies the command line switches. The scheduler does not insert double-quotes around the value of CMDLINE_SWITCHES to ensure the individuality of the switches. ATTENTION: On the Application Server Configuration form, if the Program Type is DB Proc, the sequence number must not be provided and the Sequence field on the Parameters tab must be left blank. If the Program Type is OS Program, then defining the sequence number in the Sequence field is mandatory.
Prerequisite Background Processes For all of the prerequisite background processes, use the Business FLEX TPI Application Management's Application Server Configuration form in Business FLEX TPI to configure when and how to run each background process. MsgLogServer The Message Log Server process (called “MSGLOGSERVER” in Application Server configuration) is responsible for saving messages generated by other background processes as they run. ATTENTION: This housekeeping activity is important for the smooth operation of the Application Server component. This background process must be running for some of the other background processes to run correctly.
Production Balance Configuration Guide• 81
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Following is the Application Server Configuration form for the background process:
NOTE: To configure the MSGLOGSERVER in RAC environment, refer Appendix D.
82 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
PhdSql The PhdSql process enables programs to retrieve data from PHD. ATTENTION: This program runs continuously and must be active. TIP: The CMDLINE_SWITCHES parameter can optionally specify a debugging parameter, which can be -d0, -d1, -d2, or -d3. The -d0 setting is the default, writes the least amount of information to log files, and is recommended. Using a higher debug level may noticeably slow down the application.
Following is the Application Server Configuration form for the background process:
NOTE: To configure the PHDSQL in RAC environment, refer Appendix D.
Production Balance Configuration Guide• 83
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Purge Message Log Data The Purge Message Log Data background process is responsible for purging messages generated by other background processes that are saved by the MsgLogServer background process. This housekeeping activity is important for the smooth operation of the Application Server component. Otherwise, log messages would accumulate, fill up available disk space, and slow down other programs. Following is the Application Server Configuration form for the background process:
Data Distribution Data Distribution uses a background process to send Production Balance data to PHD. This background process (distribtophd.exe) sends tag information generated by various applications in Business FLEX, to PHD. At regular intervals, entries written into the IP_DATA_DISTRIB_PENDING table are picked up and sent to PHD. If errors occur when sending to PHD the appropriate IP_DATA_DISTRIB_PENDING record is marked as being in error together with the error message. In addition, an error message is written to the
84 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
message log (IP_MSG_LOG). On subsequent process runs, robust PHD data distribution automatically tries to resend records marked in error. Following is the Application Server Configuration form for the background process:
Main Form Parameter
Value
Program Type
OS Program
Execution Type
C
Production Balance Configuration Guide• 85
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Parameters Tab Parameter
Default Value
CMDLINE_SWITCHES
Seq
Parameter Required
Value Required
Description
1
Yes
Yes
Mandatory switches -cs user / pswd @ database (database connect string) / and @database are required -pn "" (process name) must match an entry in the TPI Background Process Form Optional switches -sleep (sleep interval in seconds) defaults to 300 if not supplied -ph (PHD host connect string) defaults to environment variable setting if not supplied. PHD_HOST /DEBUG (debug flag) causes 'debug' statements to be written to standard output.
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
Distribtophd
Production Balance Background Processes For all of the Production Balance background processes, use the Business FLEX TPI Application Management's Application Server Configuration form in Business FLEX TPI to configure when and how to run each background process. PA Setup The PA Setup background process creates a Production Balance auto processing entry for each new case of a given balance group. It does this by copying the auto processing settings and steps from the previous balance group case. PA Setup supports monthly balancing. It does not automatically create entries for balance groups with equipment attribute PA_NOSETUP_PRC. PA Setup is required for sites that plan to use monthly balances, sequential balancing or writeback of factor balance results.
86 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
PA Setup must be configured to run at the same interval as the balance group auto processing and to launch shortly after the close of the balance period. See the Automated Processing Configuration Procedure for details.
NOTE: PA Setup process is required while selecting the repeating field for creating a new balance case in auto processing page. It is used to create a new auto processing entry for the non-adhoc balance case. Based on the time interval type selected, new auto processing entries are created. Usually, the PA Setup is configured to run before the PA Auto process run for balance groups. Main Form Parameter
Value
Program Type
DB Proc NOTE: It is not required to specify the Connect String parameter value for this type of program.
Execution Type
T
Production Balance Configuration Guide• 87
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Parameters Tab Parameter
Parameter Value Default
Seq
PA_OFFSET
Parameter Value Parameter Value Required Required Description No
Yes
To introduce an additional delay in the processing of PA Setup, specify the PA_OFFSET parameter with a value corresponding to the delay desired in minutes.
Execution Statements Tab Parameter
Value
Start Statement
PA.SetupPrc
PA Auto Process PA Auto Process carries out the default auto processing steps for each new auto processing entry created by the PA Setup background process. It generates cutoff inventory and material transfer records. PA Auto Processing must be configured to run shortly after the PA Setup background process.
88 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Main Form Parameter
Value
Program Type
OS Program
Execution Type
T
Parameters Tab Parameter
Parameter Value Default
Seq
Parameter Required
Value Parameter Value Require Description d
CONNECT_STRING
1
Yes
No
PARAM1
2
No
PARAM2
3
No
PARAM3
4
No
CMDLINE_SWITCHES
5
No
No
Database connections string. If left NULL the Scheduler defaults to the account and database that it connects with. Process the specified sequence number (case). Process the specified balance group name. Auto Processing step to start processing from. Must be one of the steps identified in Step Configuration for the Auto Processing Steps. Switches: Level 0 -d0 diagnostics (errors only) Level 1 -d1 diagnostics Level 2 -d2 diagnostics (all diagnostics) -l log file Log file name -h or -? Help
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
auto_prc
Production Balance Configuration Guide• 89
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
PA Auto Reprocess PA Auto Reprocess reprocesses the PA Auto Process case when requested from TPI. It carries out raw data (PA Auto Process) and factor data (PbInterface) reprocessing, when requested from the Production Balance user interface.
Main Form Parameter
Value
Program Type
OS Program
Execution Type
P
Parameters Tab Parameter
CONNECT_STRING
90 • Production Balance Configuration Guide
Parameter Value Default
Seq
Parameter Required
Value Parameter Value Require Description d
1
Yes
No
Database connections string. If left NULL the Scheduler defaults to the account and database that it connects with.
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Parameter
Parameter Value Default
Seq
CMDLINE_SWITCHES
Parameter Required
Value Parameter Value Require Description d
No
No
Switches: -d0
-d1 -d2
-l log file -h or -?
Level 0 diagnostics (errors only) Level 1 diagnostics Level 2 diagnostics (all diagnostics) Log file name Help
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
auto_reprocess
Production Balance Configuration Guide• 91
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
PbInterface PbInterface collects inventory, missing movements and transfer data, and stores it in the Production Balance tables in the proper units.
Main Form Parameter
Value
Program Type
DB Proc
Execution Type
P
Parameters Tab Parameter
PARAM1
92 • Production Balance Configuration Guide
Parameter Value Default
Seq
Parameter Value Parameter Value Required Required Description
1
No
Yes
The parameter value represents the minimum sequence number to start processing from. The sequence field must be set to 1 for this parameter. The name of the parameter is irrelevant.
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Execution Statements Tab Parameter
Value
Start Statement
PbInterface.ExecPbInterface
PbProcessPending NOTE: This background process is not applicable for non-legacy sites, and hence it must be disabled. Writeback is configured currently in the Production Balance Web environment. Refer to Writeback configuration for more details. PbProcessPending carries out a number of operations including: •
Reprocesses the PA Auto Process case when requested from the Production Balance user interface.
•
Reconciles the current balance.
•
Processes sequential cases.
•
Writes the reconciliation results back to the database.
Main Form Parameter
Value
Program Type
DB Proc
Execution Type
P
Parameters Tab
There are no parameters to configure. Execution Statements Tab Parameter
Value
Start Statement
PbInterface.ExecProcessPendingCases
Production Balance Configuration Guide• 93
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
PbRecon Statistical data reconciliation for a given balance period or case can be automated with the optional PbRecon background process. Automated processing involves solving the balance for the balance period and the subsequent saving of the results to the database without any user intervention. Typically PbRecon would be configured as a background process and set to execute periodically after a new case is generated. If PbRecon is not activated, the Production Balance user interface can be used instead.
Main Form Parameter
Value
Program Type
OS Program
Execution Type
P
94 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Parameters Tab Parameter
CONNECT_STRING
CMDLINE_SWITCHES
Parameter Value Default
Seq
Parameter Value Required Required
Parameter Value Description
1
Yes
Database connections string. If left NULL the Scheduler defaults to the account and database that it connects with. Switches: Used for Oracle ops$ -@ host login. -c user/pwd@host -c is optional Database selector. -d database type Enter msaccess or oracle. Default is Oracle. Path to directory for -l log directory process log file. Balance family -f balance family selector. When specified -s and -t are required. Start time selector. -s start time When specified -f and -t are required. End time selector. -t end time When specified -f and -s are required. Process ad hoc -h balance family. Default is to process the scheduled balance family. No value required. Use bilinear solver. -2 Default is to use the linear solver. No value required. Enable debug file -b output. Default is disabled. No value required. Set status to Active -r on success. Default status is Reconciled. No value required. -v Show dll versions. -? Usage information.
No
Production Balance Configuration Guide• 95
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
If no case parameters (case ID, or balance group and end time) are specified as command line switches, then PbRecon executes all the cases with a status of Pending. By default all the cases processed successfully by PbRecon are saved with a case status of Reconciled. The command line switch -r can be used for overriding this default behavior; such that cases are saved with a case status of Active. If errors are encountered during reconciliation (for example, singularities) the case status is set to Active. Execution Statements Tab Parameter
Value
Start Statement
Pbrecon
Special Installation and Operation Requirements
Unlike the other Production Balance background processes, PbRecon is installed with the Production Balance client software, not as part of Business FLEX Application Server. To generate the solver options for PbRecon, the Production Balance client software must be installed on the Business FLEX Application Server, even if the Production Balance user interface will not normally be run from there. As part of the Production Balance client software installation on the Business FLEX Application Server, PbRecon is registered locally and the executable is installed in the required Application Server directory. Do not enable PbRecon until after you have run the Reconciliation solver using the Production Balance user interface on the Business FLEX Application Server at least once. Be sure that you use the UNISERVER account or the local account used for running the background process on the Application Server. Running the Reconciliation solver causes the solver settings to be written to the local registry. The settings stored in the registry are used by the PbRecon background process when it runs. Be sure that the registered solver settings are correct by checking the Solver Settings dialog box in the Production Balance user interface. (See the Production Balance User Guide for a description of the solver settings.) Add the Matlab path information to run the PBRecon automatically. Usually, these two path information are added automatically if PB Client is installed in the machine. Otherwise, add the following two variable values to the path in the environmental variables: 1. :\Program Files\MATLAB\MATLAB Component Runtime\v76\bin\win32 2. :\Program Files\MATLAB\MATLAB Component Runtime\v76\runtime\win32
96 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Production Allocation Considerations
If Production Balance is to be used primarily to carry out production allocation calculations, simultaneous reconciliation must be run for all of the balance groups in the balance case, before the case can be saves as Balanced. This step is required, even if the reconciliation results are not needed. As a result of this limitation, it may be helpful to have PbRecon carry out reconciliation automatically. This is to ensure that users don't have to complete this step manually just to save the production allocation results. Reprocessing from the Production Balance User Interface Configuration Requirements
Users who are identified as Production Accountants in their Business FLEX TPI User Profile can trigger balance case reprocessing. The Reprocess button displayed is visible only for Production Accountants.
In addition to being able to Reprocess individual cases, the File menu command Reprocess Cases enables the reprocessing of multiple cases by the background processes. This menu command is only available when all of the forms in the Production Balance display have been closed. When a case is reprocessed, all existing data for the case is deleted and the Production Balance tables are reloaded from Production Accounting data. In order for the reprocess functionality to work, all of the following background processes must be enabled: PA Auto Process, PA Auto Reprocess, PbInterface and PbProcessPending. NOTE: The PbProcessPending background process is not applicable for nonlegacy sites, and hence it must be disabled. Writeback is configured currently in
Production Balance Configuration Guide• 97
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
the Production Balance Web environment. Refer to Writeback configuration for more details. Writeback Options
Whenever a case is saved as Balanced, the specified or reconciled data is written to the material transfer and cutoff inventory tables if the system is so configured. If the balance group is configured with the attribute SDR_WB_RECON set to True, then writebacks occur when the case is saved as Reconciled.
98 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
PLWriteback PLWriteback is an optional background process that can be used for write the attribute values configured in the PB Configuration - Writeback display to process historian tags. The writeback operation is triggered by the following events: 1. An inventory group has been set to release. 2. A balance case has been saved as balanced in the Production Balance Client application.
Main Form Parameter
Value
Program Type
NT
Execution Type
P
Production Balance Configuration Guide• 99
Part 2 – Production Balance Analysis Configuration Background Processes Configuration
Parameters Tab Parameter
Parameter Value Default
CONNECT_STRING
SCAN_FREQ
1
Seq
Parameter Value Parameter Value Required Required Description
1
Yes
No
2
Yes
No
Database connections string. If left NULL the Scheduler defaults to the account and database that it connects with. Time interval in minutes at which the background process runs.
Execution Statements Tab Parameter
Value
Start Statement
Honeywell.HPI.ProductionLogger.PLWritebackExe.exe
100 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Production Balance Analysis Configuration in Production Balance Web Preliminary Information Production Balance Web Display Access
The configuration steps described in the section are performed in the Production Balance Web user interface. To access the Production Balance Web displays log in to a computer that has Web access to the Experion Desktop Server. Log in as a user who has been assigned all of the Production Balance Web roles and the CoreAdmin Web role. Refer to the section Configure Web-Based Security section for details. Navigation Tree Contents
When the equipment hierarchy for Production Balance is configured in the Business FLEX database, the tree in the Production Balance Web Navigation pane is automatically generated with the balance families set up in the hierarchy. This tree is used as the starting point for Production Balance configuration in the Web environment.
Production Balance Configuration Guide• 101
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Automated Processing Configuration ATTENTION: Production Balance automated processing is presently configured using the Auto Processing display in the Production Balance Web environment. The old Auto Processing form in Business FLEX TPI has been retained for legacy sites. See the Production Balance Reference Guide for details.
Auto Processing Display The Auto Processing display is used for configuring automated data collection and balancing processes for the balance families in Production Balance Analysis. New balance cases are defined and initiated using this display. In addition, this display is used for controlling data collection and calculations for Production Balance Logging and for the Inventory Calculation utility.
Access
To access the Auto Processing display, open the Production Management workspace in the Production Balance Web environment and select PB Configuration > Auto Processing from the Production Balance menu. When the Auto Processing display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance families and inventory groups defined for the system. The associated balance groups and equipment are not displayed.
102 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Automated Processing Configuration Procedure 1. Before you configure automated processing for Production Balance Analysis, the balance families and balance groups must be preconfigured. 2. For the balance family decide on the following: – Units of measure for the measured values – Length of the balance period (that is, frequency of balance case execution) – Start time for the first balance period to be reconciled Having this information ahead of time is helpful because automated processing has been configured for a given balance family and saved to the database. After saving, the settings cannot be changed. 3. Open the Auto Processing display in Production Balance Web. 4. In the Balance Family/Equipment Tree, select the balance family you want to configure. NOTE: The configuration applies to every balance group in the selected balance family. 5. In the Scheduling subtab, click Add, and fill in the following fields. In this field...
Do this...
Area
Displays the balance family to be configured. Leave this field unchanged.
Type
Configure the length of the balance period by selecting the calculation frequency (for example, Hourly, Daily, Weekly, and so on). For Ad Hoc cases (Repeating option is cleared) this field is disabled.
Repeating
Select this option for normal (that is, automatic) balance case processing. Clear this option to create an Ad Hoc balance case for the balance family.
Status
Displays the current status for the balance case. This field cannot be changed.
Start Date Time
Enter the start date and time for the first balance period to be reconciled. For an Ad Hoc balance case, enter the desired start date and time for the Ad Hoc case.
End Date Time
For Ad Hoc balance cases only, enter the desired end date and time for the Ad Hoc case. This field is hidden if the Repeating option is selected (that is, for normal balance case processing).
Cycle Type
Select the Cycle Type for the balance family as Mass Balance, Volume Balance or Other. (This is a legacy attribute.)
Production Balance Configuration Guide• 103
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
In this field...
Do this...
Units
Select the unit of measure that the balance is to be recorded in. The units are validated to exist in the Lookup Configuration information with the lookup name of UNITS. A list of values is available.
6. After all of the fields have been filled in, click Store to save the Auto Processing entry to the database. 7. Saving the entry causes the Auto Processing display's Steps subtab to be populated with the default steps performed by the PA Auto Process background process, as well as the Production Balance Logging steps.
The Steps subtab contains the following information: This field…
Does this…
Step Name
Identifies the background processing module executed for each balance group in the balance family. The values are defined in the Lookup Configuration procedure with the lookup name of AUTOSTEP_PB.
Sequence
Sets the order in which the automated processing steps are to be performed. NOTE: The sequence numbers do not have to be contiguous.
Run Check
Indicates if the step is to be executed. Automated processing runs the step if the Run Check option is selected ( ).
8. By default all of the steps for Production Balance Analysis and Logging are checked. Be sure to clear the steps that are not required. Refer to Step Configuration for the Auto Processing Steps for Production Balance Analysis for a list of the recommended steps for Production Balance Analysis.
104 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
9. Add other automated processing steps by clicking the Add button in the Steps subtab. Enter the background processing module name, the desired processing sequence number and select the Run Check option for the new step if it is to run. 10. Click Store in the Steps subtab to save the automated processing steps configuration to the database. ATTENTION: 1. All of the balance groups within a balance family must be processed at least once before corresponding cases will be available for selection in the Production Balance client user interface. Even if a single balance group is missed, the corresponding balance family cases appear in the Select Family to Edit dialog box with a status of INCOMPLETE. Incomplete balance cases cannot be selected for reconciliation. 2. The entries in the Steps sub-tab for a given balance case cannot be changed if the balance case has been submitted for processing. 3. You need to provide the sequence number and store the steps in automated processing steps configuration. If you do not provide the sequence number and store the steps, an unhandled exception error appears. In this case, close and open the Internet Explorer window and provide the sequence number and store the steps again.
Deleting an Automated Processing Entry
Automated processing entries can be deleted from the database by selecting the associated row in the top half of the display and clicking Delete in the Schedule subtab. Deletions can only be performed if the balance case has not yet been submitted for processing. After this has occurred, the automated processing entry cannot be deleted. Step Configuration for the Auto Processing Steps for Production Balance Analysis The following table indicates whether the individual steps need to be included in the automated processing operations for Production Balance Analysis. Auto Processing Step
Recommended Configuration
INSTRUCT
Normally not used but has negligible performance impact. Must be set to run.
DEPENDANT
Normally not used but has negligible performance impact. Must be set to run.
PRODMOVE
Commonly used for interfacing to externally provided movements. Must be set to run.
SWITCH
Commonly used. Must be set to run.
INVENTORY
Commonly used. Must be set to run.
TRANSFER
Commonly used. Must be set to run.
RECON
Commonly used. Must be set to run.
PBINTERFACE
Required step.
Production Balance Configuration Guide• 105
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Auto Processing Step
Recommended Configuration
PBWRITEBACK
Optional writeback step for legacy implementations of Production Accounting, Net Production and TCT writeback functionality.
PLWRITEBACK
Optional writeback step for the writeback settings configured in the PB Configuration Writeback display (described in the next section).
If the Production Balance Logging processes are to be run for the selected balance family, the Production Balance Logging steps can remain selected (leave the checkmark in the associated Run Check options). See the Production Balance Logging Automated Processing Configuration section in Part 3 of this guide for details.
Writeback Configuration The Production Balance Writeback feature enables results to be written back to process historian tags when a case is saved or when the inventory calculations have been completed. The process historian tag data may then be used for trending and widespread distribution of results via standard desktop tools. In addition, writeback tags can be configured for any measured or calculated value in the Production Balance database tables, for individual equipment items, equipment lineups, balance cases or products. The configuration is done in the Writeback displays. The writeback tag must be a manual tag. The unit of the tags must be consistent with the value written back. For example, to write back net volume, configure a manual tag with volume units. NOTE: Writeback to a non-PHD process historian is supported. The short tagnames configured for the writeback tags are automatically mapped to the corresponding long tagnames as part of the writeback operation. Automatic Writeback Mechanism The Automatic Writeback mechanism enables a balance group for writeback of the required results to be written back to process historian tags automatically, when the PLINVENTORY background process executes the balance case. This feature eliminates the need to writeback manually, each time a balance case is processed. Access To access the Writeback displays, open the Production Management workspace in the Production Balance Web environment and select PB Configuration > Writeback from the Production Balance menu. Then select either Equipment, PBCase, or Product, depending on the type of value you are configuring. The Add, Modify, Delete, Store and Cancel buttons in the Details subtab for each display are used for controlling writeback tag configuration. 106 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Equipment Display The Equipment Writeback display contains two tabs: Equipment and Transfer. When the Equipment Writeback display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance family and inventory group hierarchies defined for the system, including the associated balance groups and equipment. Equipment Tab
The Equipment Writeback - Equipment tab is used for configuring the writeback tags for individual equipment items configured for use with Production Balance.
The Details subtab is used for configuring the following fields: In this field...
Do this...
Equipment Name Enter or select the name of the equipment whose value is to be written to the process historian. The selection list includes all of the equipment in the hierarchy selected in the Balance Family/Equipment Tree. If the equipment item to be configured was selected in the tree, then the selection list only includes that equipment item.
Production Balance Configuration Guide• 107
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
In this field...
Do this...
Writeback Tag
Enter the process historian tagname that the value is to be written to. Click the browse button to select the tagname using the Search Tag dialog box.
Table/View
Enter or select the name of the database table or view, which is the source of the writeback data.
Name of Enter or select the name of the column or attribute, which contains the Column/Attribute data to be collected. Group Type
Displays the selected equipment item's group type. This field cannot be changed.
Group Name
Enter or select the name of the balance or inventory group associated with the equipment.
Start/End of Period
Indicate whether the value is taken from the start or the end of the balance or inventory calculation case.
Id
Displays the internal ID for the writeback configuration record. This field cannot be changed.
NOTE: The automatic write back is controlled through a lookup, AUTOWRITEBCK. If the value of this lookup is True, then the automatic write back is enabled. If the value of the lookup is False, the automatic write back is disabled. When you select IP_INVNTRY_CMPSTN in the Table/View field of the equipment write back, the composition related attributes are displayed in the Column field and a new field ‘Composition product name’ is displayed. You have to select the particular component name for which the write back is required. You have to mainly select the equipment name, component product name, tag and related attributes of IP_INVNTRY_CMPSTN in order to perform write back for composition equipments. Note that only when you select IP_INVNTRY_CMPSTN in the Table/View field, the composition product name field is displayed. Otherwise, this field is hidden. Transfer Tab
The Equipment Writeback - Transfer tab is used for configuring the writeback tags for the lineups configured in Production Balance. NOTE: Lineups are created using the Lineup Editor available from the Production Balance Logging - Movement/Mode Entry display. Writeback tag configuration for transfer lineups cannot be performed until after lineups have 108 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
been created in the Production Balance Logging user interface. Refer to the Production Balance Web User Guide for details.
The Transfer tab contains a number of filter controls across the top of the display that are used for filtering the table in the top pane of the Transfer tab. The following controls are available: In this field…
Do this…
View
Select the desired view (as defined in Site Settings).
Source Equipment
Select the source equipment name to be used for filtering the set of existing lineup writeback configuration records or set of writeback configuration records that can be added.
Destination Equipment
Select the destination equipment name to be used for filtering the set of existing lineup writeback configuration records or set of writeback configuration records that can be added.
Node Name
Enter the lineup node name to be used for filtering the set of existing lineup writeback configuration records or set of writeback configuration records that can be added.
Browse Button
Opens the Lineup Selector Dialog to ensure that the user can select the lineup that is to be used for filtering the writeback configuration records. The source and destination equipment and node name fields will then get filled in.
Reset
Resets the filter settings.
The Details subtab is used for configuring the following fields: In this field…
Do this…
Node Name
The name of the lineup whose lineup is to be written to the process historian. This field is entered automatically based on the selection in the summary view.
Writeback Tag
Enter the process historian tagname that the value is to be written to. Click the browse button to select the tagname using the Search Tag dialog box.
Table/View
Enter or select the name of the database table or view, which is the source of the writeback data.
Name of Enter or select the name of the column or attribute, which contains the Column/Attribute data to be collected.
Production Balance Configuration Guide• 109
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
In this field…
Do this…
Group Type
Displays the selected lineup's group type. This field cannot be changed.
Group Name
Enter or select the name of the balance or inventory group associated with the lineup.
Start/End of Period
Indicate whether the value is taken from the start or the end of the balance or inventory calculation case.
Id
Displays the internal ID for the writeback configuration record. This field cannot be changed.
PBCase Writeback Display The PBCase Writeback display is used for configuring the writeback tags for balance case-related values.
When the PB Case Writeback display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance families and balance groups defined for the system. As this is a Production Balance Analysis configuration, the inventory groups do not appear in the tree. The Details subtab is used for configuring the following fields: In this field…
Do this…
Balance Family
Enter or select the name of the balance family whose value is to be written to the process historian. The selection list includes the balance family name in the hierarchy selected in the Balance Family/Equipment Tree.
Writeback Tag
Enter the process historian tagname that the value is to be written to. Click the browse button to select the tagname using the Search Tag dialog box.
Table/View
Enter or select the name of the database table or view, which is the source of the writeback data. The only table available is PB_CASE.
110 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
In this field…
Do this…
Name of Enter or select the name of the column or attribute, which contains the Column/Attribute data to be collected. Group Type
Displays the selected balance family's group type. This field cannot be changed.
Start/End of Period
Indicate whether the value is taken from the start or the end of the balance case.
Id
Displays the internal ID for the writeback configuration record. This field cannot be changed.
Product Writeback Display The Product Writeback display is used for configuring the writeback tags for product-related values.
When the Product Writeback display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance families, balance groups and inventory groups defined for the system. The associated equipment is not displayed. The Details subtab is used for configuring the following fields: In this field…
Do this…
Product
Enter or select the name of the product whose value is to be written to the process historian. The selection list includes all of the products assigned to the hierarchy selected in the Balance Family/Equipment Tree.
Writeback Tag
Enter the process historian tagname that the value is to be written to. Click the browse button to select the tagname using the Search Tag dialog box.
Production Balance Configuration Guide• 111
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
In this field…
Do this…
Table/View
Enter or select the name of the database table or view, which is the source of the writeback data.
Name of Enter or select the name of the column or attribute, which contains the Column/Attribute data to be collected. Group Type
Displays the selected product's group type. This field cannot be changed.
Group Name
Enter or select the name of the balance or inventory group associated with the product. The selection list includes all of the balance or inventory groups in the hierarchy selected in the Balance Family/Equipment Tree.
Start/End of Period
Indicate whether the value is taken from the start or the end of the balance or inventory calculation case. This field cannot be changed for products associated with inventory groups.
Id
Displays the internal ID for the writeback configuration record. This field cannot be changed.
Balance Family and Group Access Configuration If desired, access to specific balance families, balance groups or inventory groups can be restricted to identified Web roles. Users who are assigned to these Web roles will be able to view the Production Balance Web displays and reports for these balance families, balance groups and inventory groups via the Balance Family/Equipment Tree. When a user who is not assigned to one of these Web roles opens the Production Balance Web displays, the balance families, balance groups and inventory groups that are not assigned to them are disabled in the Balance Family/Equipment Tree, thus denying user access to the associated information. If nothing is configured all users have access to all balance families, balance groups and inventory groups. This functionality can be used for restricting different groups of users to view and edit only records associated with certain balance families or groups.
112 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Role Security Display The Role Security display is used for configuring the mapping between Web roles and the configured balance families, balance groups and inventory groups.
Access
To access the Role Security display, open the Production Management workspace in the Production Balance Web environment and select PB Configuration > Roles/Areas from the Production Balance menu. When the Role Security display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance families, balance groups and inventory groups defined for the system. The associated equipment is not displayed. The Add, Modify, Delete, Store and Cancel buttons in the Details subtab for each display are used for controlling role security configuration.
Production Balance Configuration Guide• 113
Part 2 – Production Balance Analysis Configuration Production Balance Analysis Configuration in Production Balance Web
Contents
The Details subtab is used for configuring the following fields: In this field…
Do this…
Parent Equipment
Displays the name of the selected entity's parent in the hierarchy. If a balance group is selected in the Balance Family/Equipment Tree, this field displays the associated balance family name. If the selected entity is at the top of the hierarchy (for example, a balance family is selected), then this field displays the selected entity name. If an inventory subgroup is selected in the Balance Family/Equipment Tree, this field displays the name of the inventory group directly ahead of the selected group in the hierarchy.
Equipment Name Displays the name of the entity selected in the tree. NOTE: If a balance family is selected, the users with the selected role will have the right to view all balance groups belonging to that balance family. Similarly, if an inventory group is selected, the users with the selected role will have the right to view all inventory subgroups belonging to the selected inventory group. Role
Select the Web role that is to have access to the selected hierarchy. NOTE: All of the Web roles in the system are available for selection. Users can create specific roles for different groups of users if needed.
Application Name
Displays the application name associated with the entity selected in the Balance Family/Equipment Tree hierarchy. This field cannot be changed.
Hierarchy Type
Displays the hierarchy type for the entity selected in the Balance Family/Equipment Tree. This field cannot be changed.
114 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Tune the Reconciliation Solver Settings
Tune the Reconciliation Solver Settings Introduction The last step in Production Balance Analysis configuration is to tune the Reconciliation Solver settings in Production Balance Client. The Solver Settings dialog box is used for adjusting the settings used by the solver.
To access the Solver Settings dialog box, proceed as follows: 1. On a computer where Production Balance Client is installed, launch the Production Balance Client application from the Windows Start menu by selecting Programs > Honeywell > Business FLEX > Production Balance. 2. Connect to the Business FLEX database in Oracle. 3. In the Select Family to Edit dialog box select a balance family for tuning. (If you have multiple balance families, you may need to tune the Reconciliation Solver for each one.) 4. In the Run menu select Options.
Production Balance Configuration Guide• 115
Part 2 – Production Balance Analysis Configuration Tune the Reconciliation Solver Settings
The following subsections provide recommendations for the solver settings for linear and simultaneous balance models. See the Production Balance User Guide for a description of the Production Balance Client application and how it works, and for additional information about the settings in the Solver Settings dialog box.
Settings for Linear Models Selection of Solver A number of different solver techniques are provided as some methods may perform better for certain configurations. There is no way to predict in advance what the best option is and it is likely that some will be equivalent, trial and error is required. Single Value Decomposition (SVD) is the method of choice and must be used in preference to other methods. Together with the Single Value Decomposition method, the Newton Method and URV Decomposition methods are all rigorous methods from a solution perspective and are the preferred methods. The Ridge Regression #1 method is provided for speed on large models but use a less rigorous approach in determining the critical objective threshold. It tends to calculate a critical objective function below the true value and it is recommended that this method not be used unless the model is very large and solve times are an issue. This method together with Ridge Regression #2 and Ridge Regression #3 are approximate methods. In addition, they are not preferred unless they outperform the rigorous methods. In general the reconciled values for measured and observable quantities will be very similar between all the solvers. Therefore, in some ways the selection of solver may not be that critical. The objective function can vary between the methods in spite of having similar results largely because of numerical issues inherent in optimization. Note that the unobservable values can be greatly different from the different solvers. This must be expected as unobservable values have infinite solutions and don’t affect the objective function. Therefore, any solver simply returns whatever values it had when the objective function was minimized.
116 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Tune the Reconciliation Solver Settings
Balance Scale Factor The Balance Scale factor does not normally need to be adjusted and can be set to 1. If a site has quantities in balance units that are very small such that loss of significant digits might be occurring then the amounts can be scaled up (or down for large values) by changing this factor. For example, if balances on a unit show total inputs and outputs of 0.00000000023 units, then scaling factor of 10000000 might be employed to ensure significant digits are not lost in the optimization. Most sites employ engineering units that appropriately scale the numbers and this is not normally a problem. Lambda Multiplier The Lambda Multiplier is a factor used by the approximate methods to develop a solution. It is also employed in the generation of diagnostics for the rigorous methods. Therefore, some effort must be taken to tuning the value. Tuning is accomplished by solving the model with SVD and then with Ridge Regression #2. If the objective function is the same (must be very close but may not be exactly the same) then the value is acceptable. If the objective function differs try increasing the Lambda Multiplier by a factor of 10, if still different try increasing it again. If increasing doesn’t work try decreasing it. Typical settings are 0.001, 0.01, 0.1, 1, 10, 100, and 1000. Global Tolerance The Global Tolerance value describes the number of standard deviations that the tolerances entered actually represent. This is not a solver setting, just a definition of what the tolerances for that site mean. It must not be changed to attempt to improve the solution or convergence. A value of 2 is normally used, when the client provides data based on experience factors. A different value may be employed at a specific site if that site sets tolerances based on meter manufacturing data which has a different basis. Epsilon Values The Epsilon Value settings must not be adjusted. Reconcile Flows with Tolerance Greater than Value as Unmeasured This option is a site preference, and does not greatly impact on the solution. If there are a lot of flows such as 5 units plus or minus 40 units then it is debatable whether the value of 5 units means anything. This setting enables flows to be globally treated as unmeasured if desired.
Production Balance Configuration Guide• 117
Part 2 – Production Balance Analysis Configuration Tune the Reconciliation Solver Settings
Advanced Error Analysis These settings do not affect the normal operation of the solver and do not normally need to be changed.
Settings for Simultaneous Balance Models In general, simultaneous balances are much more difficult to solve than linear balances and may take more manipulation of settings. Simultaneous balance is typically more sensitive to starting estimates for unmeasured flows. Selection of Solver See the Selection of Solver discussion for linear models previously mentioned. The best approach is to try solving the model with the rigorous methods and see if they all converge to the same value. If not then the Use QR Factorization QR Factorization has proved to be helpful in providing solution for simultaneous balances. If there are convergence problems, this can be turned off to see if it improves the situation. Use Automatic Scaling Automatic scaling has proved to be helpful in providing solution for bilinear balances. If there are convergence problems, this can be turned off to see if it improves the situation. Unmeasured Value Initialization The Default Values are important numbers to set. If they are set to zero, the typical result is converged cases at a local optimum. This has generally been seen to result in a lot of measurements (not unmeasured) being reconciled to negative flows. Consequently, the Default Values must never be set to zero. It has been observed with the single default used for both factor and quantity defaults, that if the value is similar to the factors (say a value of 1 with factors of 0.5 to 0.9 like specific gravity) and the flows are very large 1000000 tons per day, that the factor is effectively so small relative to the flows that it is mathematically zero. The key here is to set these values to a larger value say 1000 to avoid the problem.
118 • Production Balance Configuration Guide
Part 2 – Production Balance Analysis Configuration Tune the Reconciliation Solver Settings
When the Mode is set to use default values, the default is used each time the solver is set. Sometimes the Last Value Mode is preferred. This Mode causes the solver to use the default values on the first run but on subsequent runs the solver uses the previous calculated flow. Other settings for Mode may be tried. A site may find more stable convergence using one of the value estimation methods. Iteration Limits Try increasing the iterations on the solver if the case doesn’t converge, in general though 25 must be sufficient. There must be no need to change the Starting Value Generator iteration limit.
Production Balance Configuration Guide• 119
Part 2 – Production Balance Analysis Configuration Tune the Reconciliation Solver Settings
This page is intentionally left blank
120 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Part 3 – Production Balance Logging Configuration Update the Production Balance Model Introduction Production Balance Logging collects movement and mode data from the site. It then generates balance group records that define the movements between a specified subset of the equipment within a specified time window (for example, midnight to midnight). This is handled by the PLTransfer background process. The PLTransfer data is then moved by the PL2PB background process into the standard Production Balance tables in the Business FLEX database. ATTENTION: 1. Any attributes used on equipment for Production Balance Logging and Production Balance Analysis must not have an attribute owner of AMM. (AMM is the Production Tracker attribute owner.) 2. If Production Balance Logging is being integrated with Production Tracker and the Real-Time Application Environment (RAE) is being used, all equipment names are limited to 31 characters.
Modes
In Production Balance Logging, mode changes on a unit are represented by mode activities that are created on that unit.
Units of Measure The units of measure used throughout the application must be configured in Uniformance or TPI. For mass or volume based balance groups, if the source or destination instruments return flow rates, the unit of measure used must be of type Mass or Volume.
Production Balance Configuration Guide• 121
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Both quantity and flow rate units must be configured within the Unit Types “Volume” and “Mass”. The flow rate based unit of measure must have the Rate Units entered (for example, for barrels per day (BPD) the rate unit is DAY). The multiplication factor must convert the volume part of the unit to the base units (for example, for BPD the multiplier is 0.158987 to convert barrels (B) to m3 which is the base unit). This enables the application to integrate rate units over a balance period time interval and calculate the total quantity of material moved. NOTE: In addition, standard gas volumes may be used but must be configured as a different type than “Volume”. The type “Volume_SCF” is provided but is measured in ft3. A type called “Volume_Gas” may be more appropriate. Also, the UOM of Density should be configured under the Unit Type ‘General’ in order for PB to work properly with factor units of Balance groups.
Balance Group and Equipment Attribute Configuration The following attributes must be configured in addition to the standard Production Balance Analysis balance group and equipment attributes. This configuration can be performed using the Business FLEX TPI forms. Balance Group Attributes Attribute Name
Attribute Required
Default Value
Equipment Type
Description
SDR_OVERLAPTM
No
0
Balance Group
Used for specifying the overlap tolerance in minutes. If omitted the tolerance defaults to 0. This causes overlaps to produce a running gauge condition for the affected movements. (See Running Gauge for details.) If SDR_SWINGTM_SRC and SDR_SWINGTM_DEST are configured for the balance group in Production Balance, then SDR_OVERLAPTM must be set to the same value. Units are ignored.
SDR_ADDROUTES
No
FALSE
Balance Group
If true, PLTRANSFER checks that each transfer has a corresponding active route, and adds or activates a route if required. NOTE: If this attribute is set to false and the route does not match the movement record, the record will not be transferred to Production Balance.
122 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Equipment Attributes Attribute Name
Attribute Required
PRDCTN_TYPE
Default Value
Equipment Type
Description
Yes
Source equipment, destination equipment and intermediate nodes
Value is either “POOL”, “PROCESS”, or “PERIMETER”. Defines the type of the equipment when creating a route to or from the equipment. (See Production Type for details.)
INTERMEDIATE
No
Intermediate node
Defines the equipment item as an intermediate node. (See Intermediate Node Equipment for details.)
INTERMEDIATE_ SRC_NAME
No
Intermediate node
Defines the transfer source equipment or mode for an intermediate node. (See Intermediate Node Equipment for details.) The value is entered in the Value field.
INTERMEDIATE_ DEST_NAME
No
Intermediate node
Defines the transfer destination equipment or mode for an intermediate node. (See Intermediate Node Equipment for details.) The value is entered in the Value field.
INTERMEDIATE_ SRC_INSTRUMENT
No
Intermediate node
Defines the source instrument tagname for an intermediate node. (See Intermediate Node Equipment for details.) The value is entered in the Tagname field.
INTERMEDIATE_ No DEST_INSTRUMENT
Intermediate node
Defines the destination instrument tagname for an intermediate node. (See Intermediate Node Equipment for details.) The value is entered in the Tagname field.
Production Balance Configuration Guide• 123
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Intermediate Node Equipment ATTENTION: Branching at intermediate nodes or links is not supported by Production Balance Logging. Direct connections between source and destination equipment must be used instead.
An intermediate node defines a logical midpoint for a connection between a source/instrument and a destination/instrument. NOTE: An instrument is not required and may be omitted. When the PLTransfer background process generates a transfer record, it checks to see if the source/instrument and destination/instrument of the transfer match the source and destination attributes of an intermediate node. If yes, the transfer is broken into two transfers: •
One from the source to the intermediate node (with no destination quantity or rate fields defined).
•
One from the intermediate node to the destination (with no source quantities or rate fields defined).
This break down is done because Production Balance can only handle one quantity for a transfer. In cases where there are two valid quantity readings (one for the source and one for the destination), Production Balance ignores the destination readings. An example would be a metered transfer from a unit directly to a metered input on another unit. To balance around these units, it is preferable that both readings be preserved. The routes between the intermediate nodes do not have to be preconfigured. Production Balance Logging generates them automatically if needed. The intermediate nodes must be defined in the balance group. They are treated as one-in/one-out units with no inventory. If an intermediate node is defined for a connection then there will be two routes defined in the IP_PRDCT_RTG tables: one to the intermediate node and one from it. In addition, if modes have been defined for either the route source or destination, routes for every possible combination of mode to intermediate node and intermediate node to mode must also be configured.
124 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Running Gauge A running gauge condition exists when two or more movements are being monitored by a single meter at the same time. For example: •
Flow from a pipeline going to two tanks in parallel produces a running gauge condition on the pipeline's outflow meter.
•
Two parallel feeds to a blend stream produces a running gauge condition on the stream's meter.
•
A movement into a tank in parallel with a movement out of a tank produces a running gauge condition on the tank gauging meter.
When running gauge occurs, the flow measurements from the affected meter must be ignored because the meter gives the total flow for all movements instead of properly apportioned flows for each individual movement. The affected ends of the movements are marked as being in running gauge and are treated as being unmeasured. When a swing operation is carried out, there is normally a small period of time when a running gauge condition exists. It is normal to ensure that the swing-in movement is flowing before stopping the swing-out movement. In this situation it is not appropriate to mark the movements as being in running gauge because the time period is small relative to the total time (and total volume) of the movements as a whole. The running gauge check enables for a "running gauge overlap tolerance" time period. If the period of overlap is less than the tolerance then running gauge is not declared. The balance group attribute SDR_OVERLAPTM is used for specifying the overlap tolerance in minutes. NOTE: If SDR_SWINGTM_SRC and SDR_SWINGTM_DEST are configured for the balance group in Production Balance, then SDR_OVERLAPTM must be set to the same value.
Production Balance Configuration Guide• 125
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Production Type A production type is defined on all equipment that is part of a balance group. This type is specified by the equipment attribute PRDCTN_TYPE. If the production type is left blank, Production Balance Logging uses the default values from POOL (MOVE TO and MOVE FROM). The user may then revise them later. The possible production types are: •
POOL defines a tank or other inventory equipment item.
•
PERIMETER defines a receipt or shipment point at the boundary of the plant.
•
PROCESS defines a blender, manifold or unit in the plant.
Where modes are defined, it is not necessary to define this attribute on the modes. Routes are automatically generated to and from the modes, but the PRDCTN_TYPE attribute is taken from the original equipment. Where intermediate nodes are defined, this attribute must be defined for them. In this case PRDCTN_TYPE must be set to POOL. When Production Balance Logging creates routes, the OP_TYPE and ACCT_TYPE is generated from the PRDCTN_TYPE defined on the equipment. For lineups with SRC_DST = S, the OP_TYPE and ACCT_TYPE generated by Production Balance Logging are: PRDCTN_TYPE
OP_TYPE
ACCT_TYPE
PERIMETER
MOVE
RCPT
POOL
MOVE
FROM
PROCESS
YIELD
PROD
For lineups with SRC_DST = D, the OP_TYPE and ACCT_TYPE generated by Production Balance Logging are: PRDCTN_TYPE
OP_TYPE
ACCT_TYPE
PERIMETER
MOVE
SHIP
POOL
MOVE
TO
PROCESS
CHRG
CONS
126 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
Production Balance Logging Equipment Tree Configuration The equipment hierarchy in the Balance Family/Equipment Tree for Production Balance Logging must be configured to include all of the equipment, modes, ports and instruments that are needed for Production Balance Logging. Optionally it can include hierarchy root and branch nodes for grouping the equipment within the tree (for example, areas). The hierarchy is used for identifying the records that are displayed in the Production Balance Logging Web displays and to seed the equipment and mode selection list boxes. If an equipment item, unit or mode is not included in the equipment hierarchy, any associated movement, mode, inventory and transfer records will not appear in the Production Balance Logging displays. Similarly, if the ports and instruments for a given equipment item are not configured, they will not be available for selection in the Lineup Builder. Procedure
1. Use the Business FLEX TPI Equipment Hierarchy Configuration form to set up the Equipment Tree structure for the root, branch, equipment and port nodes. Use the following HIERARCHY_TYP values to define the type of the node in the tree: HIERARCHY_TYP
Description
PL_ROOT
Defines a root node as an overall inventory group. In this record PARENT_EQ_NAME must equal EQ_NAME. A root points at itself.
PL_BRANCH
Defines an inventory group or subgroup. PARENT_EQ_NAME points at a root node or another branch node. A branch can point at itself in which case it defines a root.
PL_EQUIPMENT
Defines an equipment node. PARENT_EQ_NAME points at a branch.
PL_MODE or MODE
Defines a mode. PARENT_EQ_NAME points at an item of equipment. Using MODE means that Production Balance Logging automatically collects MODE records from Production Tracker.
PL_PORT
Defines a port. PARENT_EQ_NAME is the equipment.
Set the APPL_NAME for each record to SITE or PBAPP.
Production Balance Configuration Guide• 127
Part 3 – Production Balance Logging Configuration Update the Production Balance Model
2. After the Equipment Tree configured has been loaded, the application determines if there are elements of a Production Tracker configuration (if present) that can be added to the tree. The application searches the Production Tracker equipment hierarchy configuration for Production Tracker ports that are associated with equipment in the Production Balance Logging Equipment Tree. This is done by searching for Production Tracker hierarchy records (APPL_NAME = GTR) for records whose parent is an equipment item in the Production Balance Logging Equipment Tree and which have the application entity type of "GTR_PORT". Any Production Tracker ports found that meet this criteria are then added to the Production Balance Logging Equipment Tree. NOTE: This means that if Production Tracker is already configured, then you do not have to configure the PL_PORT nodes in the hierarchy table. The ports will be loaded automatically from Production Tracker. For a description of the Production Tracker equipment hierarchy configuration see Equipment Hierarchy Configuration for Production Balance Logging. 3. The application then loads the instrument names associated with each port or associated directly with the equipment if no port is defined. This data cannot be configured in the hierarchy table because the items being loaded are tagnames, not equipment names. As a result, the instrument names are loaded from the equipment attribute table where the equipment name is the name of the equipment or port, the tagname is the name of the instrument, and the attribute name is FLOW, NET_LIQUID_VOLUME_FLOW or FLOWTAG. NOTE: For Production Tracker, the instrument attribute names are FLOW or NET_LIQUID_VOLUME_FLOW, and the attribute owner is AMM. If Production Tracker is configured, the instrument data is loaded automatically if defined. If Production Tracker is not present, the FLOWTAG instrument attribute must be configured in the equipment attribute table for the equipment or ports.
128 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Background Processes Configuration Introduction Production Balance Logging makes use of several background processes to pass information from Production Tracker to Production Balance. In addition, these background processes are used for transferring manual movement, mode and inventory entries created in the Production Balance Logging displays to Production Balance Analysis. As a prerequisite, the background processes used in Production Balance Analysis must be configured. See the Background Processes Configuration section in Part 2 of this guide for details. In addition, the Production Balance Logging background processes listed in the following table must also be configured. Name
Purpose
Required
PLTransfer
Generates balance group records that define the movements between a specified subset of the equipment within a specified time window.
Yes
PL2PB
Moves the PLTransfer data into the standard Production Yes Balance Analysis tables in the Business FLEX database.
PLCleanup
Periodically cleans up the PL_MOVE, PL_MODE and PL_TRANSFER tables to remove old data. (Note: This background process is not responsible for cleaning up the Production Balance or Production Tracker tables.)
Yes
PLInventory
Periodically calculates the inventory values for the inventory equipment in the balance group using the Inventory Calculation utility.
Yes
PbUpdate
Ties together the individual balance groups in each balance family.
Yes
PbWriteback
Writes back the values to the database or historian.
No
Production Balance Configuration Guide• 129
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Production Balance Logging Background Processes For all of the Production Balance Logging background processes, use the Infrastructure Management application's Application Server Configuration form in Business FLEX TPI to configure when and how to run each background process. PLTransfer The PLTransfer background process generates balance group records that define the movements between a specified subset of the equipment within a specified time window.
Main Form Parameter
Value
Program Type
OS Program
Execution Type
C (Continuous)
Parameters Tab Parameter
Parameter Seq Value Default
CONNECT_STRING
Parameter Required
Value Parameter Value Required Description
1
Yes
No
Database connection string. If left NULL, the Scheduler defaults to the account and database that it connects with.
SCAN_FREQ
1
2
No
Yes
Time interval in minutes at which the background process runs.
EQ_ATTRIBUTE
SDR_ BALGROUP
4
No
No
The name of an attribute that must exist on the Balance Group equipment item. If not present the Production Balance case is ignored.
FIRST_PRC_SEQ
0
5
No
No
Limits the processing to cases above a specified number.
130 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Parameter
Parameter Seq Value Default
Parameter Required
Value Parameter Value Required Description
ENABLE_BMA2PL
6
No
No
Enables the transfer of movements and mode data from the BMA system to PB system.
SAVEFILE
7
No
No
Saves the processed files to the Processed folder.
AUTO_CLEANPL
8
No
No
Cleans all the existing BMA movements with non-null END_DT and all modes from PL_MOVE and PL_MODE before processing.
BMA_DIR
9
No
No
Specifies the path (directory) where the BMA system copies all the movements and mode data in the form of XML files. The PLTransfer background process moves the same files for processing this movement and mode data to PL tables. NOTE: The Production Balance background process user should have Read/Write access to this folder.
PL_DIR
10
No
No
Specifies the path (directory) where the PLTRANSFER moves all the files from the BMA_DIR during processing.
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
Honeywell.HPI.ProductionLogger.PLTransferExe.exe
Production Balance Configuration Guide• 131
Part 3 – Production Balance Logging Configuration Background Processes Configuration
PL2PB The PL2PB background process moves the PLTransfer data into the standard Production Balance Analysis tables in the Business FLEX database
Main Form Parameter
Value
Program Type
OS Program
Execution Type
C (Continuous)
Parameters Tab Parameter
Parameter Value Default
CONNECT_STRING
Seq
Parameter Required
Value Require d
Parameter Value Description
1
Yes
No
Database connection string. If left NULL, the Scheduler defaults to the account and database that it connects with.
SCAN_FREQ
1
2
No
No
Time interval in minutes at which the background process runs.
EQ_ATTRIBUTE
SDR_ BALGROUP
4
No
No
The name of an attribute that must exist on the Balance Group equipment item. If not present the Production Balance case is ignored.
FIRST_PRC_SEQ
0
5
No
No
Limits the processing to cases above a specified number.
6
No
No
PHD Host for PL2PB to connect to. If left NULL, the Scheduler defaults to the host that it connects with.
PHD_HOST
132 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
Honeywell.HPI.ProductionLogger.PL2PBExe.exe
PLCleanup The PLCleanup background process periodically cleans up the PL_MOVE, PL_MODE and PL_TRANSFER tables to remove old data.
Main Form Parameter
Value
Program Type
OS Program
Execution Type
P (Periodic)
Parameters Tab Parameter
Parameter Seq Value Default
CONNECT_STRING
Parameter Required
Value Parameter Value Required Description
1
Yes
No
Database connection string. If left NULL, the Scheduler defaults to the account and database that it connects with.
SCAN_FREQ
1
2
Yes
No
Time interval in minutes at which the background process runs.
MV_MD_KEEP_DAYS
60
3
Yes
No
Determines how many days to keep the data in the PL_MOVE and PL_MODE tables.
TRNSFR_KEEP_ DAYS
60
4
Yes
No
Determines how many days to keep the data in the PL_TRANSFER table.
Production Balance Configuration Guide• 133
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
Honeywell.HPI.ProductionLogger.PLCleanupExe.exe
PLInventory The PLInventory background process periodically calculates the closing inventory values for the inventory equipment in the balance group using the Inventory Calculation utility. NOTE: The inventory calculations are only performed for equipment that has been configured with the CALC_INV attribute set to TRUE. It is recommended that the PLInventory background process be enabled in all cases, even if there is no equipment configured to run the Inventory Calculation utility.
Main Form Parameter
Value
Program Type
OS Program
Execution Type
P (Periodic)
134 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Parameters Tab Parameter
Parameter Seq Value Default
CONNECT_STRING
SCAN_FREQ
1
Parameter Required
Value Parameter Value Description Required
1
Yes
Yes
Database connection string in following format, /@. If the NT authentication is used for connecting to Oracle, the following connection string must be provided, /@.
2
Yes
No
Time interval in minutes at which the background process runs. Used only if the execution type is C (Continuous). If the execution type is P (Periodic), then the main form Execution Frequency is used. NOTE: PLInventory is configured to run after a day.
PRIOR_STEP
3
Yes
No
The values for this parameter must be left blank.
4
Yes
Yes
IM Equipment Attribute name.
FIRST_PRC_SEQ
5
Yes
Yes
The Minimum Case ID from which the processing has to be performed.
DENSITY
6
Yes
Yes
Measured density value units of measure.
TEMPERATURE
7
Yes
Yes
Measured temperature value units of measure.
VOLUME
8
Yes
Yes
Calculated volume value units of measure.
PRESSURE
9
Yes
Yes
Measured pressure value units of measure.
LENGTH
10
Yes
Yes
Measured length value units of measure.
MASS
11
Yes
Yes
Calculated mass value units of measure.
EQ_ATTRIBUTE
IMEQGRP
NOTE: Do not change the sequence numbers. The values for parameters are taken from sequence numbers. Therefore, the sequence numbers are very important. If the order is incorrect, different parameters will have different values.
Production Balance Configuration Guide• 135
Part 3 – Production Balance Logging Configuration Background Processes Configuration
Execution Statements Tab Parameter
Value
Operating System Name
NT
Start Statement
Honeywell.HPI.ProductionLogger.PLInventoryExe.exe
PbUpdate PbUpdate ties together the individual balance groups in each balance family.
Main Form Parameter
Value
Program Type
DB Proc
Execution Type
P (Periodic)
Parameters Tab Parameter
Parameter Seq Value Default
PARAM1
1
CONNECT_STRING
Parameter Required
Value Parameter Value Required Description
No
Yes
No
No
The parameter value represents the minimum sequence number to start processing from. The sequence field must be set to 1 for this parameter. The name of the parameter is irrelevant. Database connections string. If left NULL the Scheduler defaults to the account and database that it connects with.
Execution Statements Tab Parameter
Value
Start Statement
PbInterface.ExecPbUpdate
136 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Background Processes Configuration
PbWriteback PbWriteback writes the values to the database or historian.
Main Form Parameter
Value
Program Type
DB Proc
Execution Type
P (Periodic)
Execution Statements Tab Parameter
Value
Start Statement
PbInterface.ExecPbWriteback
Production Balance Configuration Guide• 137
Part 3 – Production Balance Logging Configuration Background Processes Configuration
This page is intentionally left blank
138 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Balance Logging Configuration in Production Balance Web
Production Balance Logging Configuration in Production Balance Web Automated Processing Configuration Auto Processing Display When Production Balance Logging is used in conjunction with Production Balance Analysis, the Auto Processing display is used for extending the automated processing configuration for the balance families to include the automated data collection and processing for Production Balance Logging functions. (The Logging functions include passing information from Production Tracker to Production Balance, and transferring movement, mode and inventory entries created in the Production Balance Logging displays to Production Balance Analysis.)
Production Balance Configuration Guide• 139
Part 3 – Production Balance Logging Configuration Production Balance Logging Configuration in Production Balance Web
Access
To access this display, select PB Configuration > Auto Processing from the Production Balance menu. When the Auto Processing display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance families and inventory groups defined for the system. The associated balance groups and equipment are not displayed. Automated Processing Configuration Procedure 1. Open the Auto Processing display in Production Balance Web. 2. In the Balance Family/Equipment Tree, select the balance family you want to configure. (Note: The configuration applies to every balance group in the selected balance family.) 3. If the balance family was previously configured for Production Balance Analysis automated processing, select the balance case in Master Data pane and proceed directly to Step 7. NOTE: In the Steps subtab, you cannot change the steps or sequences if the balance case has been submitted for processing. 4. For a new balance family case, click Add in the Scheduling sub-tab and fill in the following fields. In this field...
Do this...
Area
Displays the balance family to be configured. Leave this field unchanged.
Type
Configure the length of the balance period by selecting the calculation frequency (for example, Hourly, Daily, Weekly, and so on.). For Ad Hoc cases (Repeating option is cleared) this field is disabled.
Repeating
Select this option for normal (that is, automatic) balance case processing. Clear this option to create an Ad Hoc balance case for the balance family.
Status
Displays the current status for the balance case. This field cannot be changed.
Start Date Time
Enter the start date and time for the first balance period to be reconciled. For an Ad Hoc balance case, enter the desired start date and time for the Ad Hoc case.
End Date Time
For Ad Hoc balance cases only, enter the desired end date and time for the Ad Hoc case. This field is hidden if the Repeating option is selected (that is, for normal balance case processing).
Cycle Type
140 • Production Balance Configuration Guide
Select the Cycle Type for the balance family as Mass Balance, Volume Balance or Other. (This is a legacy attribute.)
Part 3 – Production Balance Logging Configuration Production Balance Logging Configuration in Production Balance Web
In this field...
Do this...
Units
Select the unit of measure that the balance is to be recorded in. The units are validated to exist in the Lookup Configuration information with the lookup name of UNITS. A list of values is available.
5. After all of the fields have been filled in, click Store to save the Auto Processing entry to the database. 6. Saving the entry causes the Auto Processing display's Steps subtab to be populated with the default steps performed by the PA Auto Process background process, as well as the Production Balance Logging steps.
The Steps subtab contains the following information: This field…
Does this…
Step Name
Identifies the background processing module executed for this balance group. The values are defined in the Lookup Configuration procedure with the lookup name of AUTOSTEP.
Sequence
Sets the order in which the automated processing steps are to be performed. NOTE: The sequence numbers do not have to be contiguous.
Run Check
Indicates if the step is to be executed. Automated processing runs the step if the Run Check option is selected ( ).
7. By default all of the steps are checked. Be sure to clear the steps that are not required. See Step Configuration for the Auto Processing Steps for Production Balance Analysis in Part 2 of this guide for a list of the recommended steps for Production Balance Analysis. See Step Configuration for the Auto Processing Steps for Production Balance Logging for a list of the recommended steps for Production Balance Logging.
Production Balance Configuration Guide• 141
Part 3 – Production Balance Logging Configuration Production Balance Logging Configuration in Production Balance Web
8. Add any additional automated processing steps by clicking the Add button in the Steps sub-tab. Enter the background processing module name, the desired processing sequence number and select the Run Check option for the new step if it is to run. 9. Click Store in the Steps subtab to save the automated processing steps configuration to the database. Deleting an Automated Processing Entry
Automated processing entries can be deleted from the database by selecting the associated row in the top half of the display and clicking Delete in the Schedule subtab. Deletions can only be performed if the balance case has not yet been submitted for processing. After this has occurred, the automated processing entry cannot be deleted. Step Configuration for the Auto Processing Steps for Production Balance Logging The following table indicates whether the individual steps need to be included in the automated processing operations. Auto Processing Step
Recommended Configuration
PLTRANSFER
Required step.
PL2PB
Required step.
PBUPDATE
Required step.
Writeback Configuration The Writeback displays may be used for configuring Production Balance Logging data writeback to process historian tags. The Writeback Equipment, PBCase and Product displays, described in the Writeback Configuration section in Part 2 of this guide, can be used for this purpose.
Balance Family, Balance Group and Inventory Group Access Configuration The configuration of balance family or balance group access restrictions based on Web roles also impacts a user’s ability to see the balance families and groups (and inventory groups) in the Production Balance Logging displays. The Role Security display, described in the Balance Family and Group Access section in Part 2 of this guide, is used for this configuration step.
142 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Production Tracker Configuration Introduction Production Balance Logging may be used for automating the transfer of material movement records from Production Tracker to Production Balance. To support this optional feature, Production Tracker must be reconfigured as described in this section. The Production Tracker Plant Reference Model Configuration Guide describes how to configure the Plant Reference Model (PRM) tables in the Business FLEX database that are of interest to Production Tracker. The following sections describe the configuration necessary for Production Tracker to interface with Production Balance Logging. AMMTables Workbook
As an aid to configuring the interface between Production Tracker and Production Balance Logging, Production Balance Logging-specific worksheets have been added to Production Tracker's AMMTables.xls workbook. These worksheets include a sample configuration and are identified by a “_PL” extension to differentiate them from the standard Production Tracker worksheets. When EDI is used for populating either the Business FLEX database (in Oracle®) or the Browser database (in SQL Server), be sure to select the ‘OptionalTableMapping’ populate options for the Production Balance Loggingspecific worksheets. (The Production Balance Logging ‘OptionalTableMapping’ populate options must be selected in addition to the standard Production Tracker 'PrimaryTableMapping' populate options.)
Activity Configuration Extensions for Production Balance Logging Activity Data Collection Configuration
The Activity Data Capture section in the Production Tracker Plant Reference Model Configuration Guide describes how to configure activity data collection for Production Tracker. In order for Production Balance Logging to capture mode change data, the Business FLEX database tables used by Production Tracker must be configured to store mode change information. The following table identifies the Business FLEX database tables that need to be configured and provides sample activity types and activity names that could be used for mode change data storage. Production Balance Configuration Guide• 143
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Business FLEX Database Example Activity Types Table and Activity Names
Description
IP_APPL_ENTITY_TYP & GT_APPL_ENTITY_TYP
BLEND_MODE Activity Type
Configure mode activity types.
IP_ACTVTY
TANK_BLEND_MODE Mode Activity
Configure mode activities.
IP_ACTVTY_ENTITY_TYP TANK_BLEND_MODE Mode Activity associated with the BLEND_MODE Activity Type
Associate each mode activity to a mode activity type.
IP_ACTVTY_HIERARCHY
Configure each mode activity into the activity hierarchy table.
TANK_BLEND_MODE Mode Activity as the Child of the TANK_BLEND Parent Activity
NOTE: Ensure that each mode activity type has the string “MODE” as part of its name. Activity Attribute Configuration
The Activity Attribute Configuration section in the Production Tracker Plant Reference Model Configuration Guide describes how to configure activity attributes for Production Tracker. In order for Production Balance Logging to properly capture movement data, specific activity attributes must be configured in the Business FLEX database tables as shown in the following table. Business FLEX Database Table
Attribute Name
Description
IP_ATTR_DFNTN & GT_ATTR_DFNTN
MANUAL_RATE
This activity attribute enables for the manual entry of an activity’s flow rate. Configured once in each table.
IP_ATTR_DFNTN & GT_ATTR_DFNTN
TRANSFERRED _QUANTITY
This activity attribute allows for the manual entry of an activity’s quantity. Configured once in each table.
IP_APPL_ENTITY_ ATTR
MANUAL_RATE
Used by Production Balance Logging when no instrumentation is available for determining a movement's rate. Configure this attribute on all order level and intermediate parent level activity types that may require a manually entered flow rate.
IP_APPL_ENTITY_ ATTR
TRANSFERRED _QUANTITY
Used by Production Balance Logging when no instrumentation is available for determining a movement's quantity. Configure this attribute on all order level and intermediate parent level activity types that may require a manually entered quantity.
144 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Business FLEX Database Table
Attribute Name
IP_ACTVTY_ATTR MANUAL_RATE & GT_ACTVTY_ATTR
Description Used by Production Balance Logging when no instrumentation is available for determining a movement's rate. Configure this attribute on all order level and intermediate parent level activities that may require a manually entered flow rate.
IP_ACTVTY_ATTR TRANSFERRED & _QUANTITY GT_ACTVTY_ATTR
Used by Production Balance Logging when no instrumentation is available for determining a movement's quantity. Configure this attribute on all order level and intermediate parent level activities that may require a manually entered quantity.
NOTE: It is recommended that each site use the attribute naming convention shown here. If a different naming convention is used, then the Activity Engine's Visual J (VJ) script file (AEPLInterface.vjs) must be modified to match the new attribute names. In order for Production Balance Logging to capture mode change data, the following attributes must be configured in the IP_APPL_ENTITY_ATTR, IP_ACTVTY_ATTR and GT_ACTVTY_ATTR tables in the Business FLEX database. This set of attributes must be configured for all mode activities and activity types. Example Activity Type and Activity Name
Attribute Name
Description/Comment
BLEND_MODE Activity ACTIVITY_CLASS Type and TANK_BLEND_MODE ACTIVITY_MATERIAL Mode Activity ACTIVITY_NAME
Mandatory activity attribute. Mandatory activity attribute. Mandatory activity attribute.
BLENDER_NAME
Attribute required if the activity type is a blend mode activity type.
EXTERNAL_ACTIVITY_ID
Mandatory activity attribute.
EXTERNAL_PARENT_ID
Mandatory activity attribute.
MODE
Mandatory activity attribute.
SCHEDULED_END_TIME
Mandatory activity attribute.
SCHEDULED_START_TIME
Mandatory activity attribute.
STATUS
Mandatory activity attribute.
UNIT_NAME
Attribute required if the activity type is a unit mode activity type.
NOTE: This set of attributes is the minimum required for mode change activity types. Other site specific attributes may be added to this set.
Production Balance Configuration Guide• 145
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
The STATUS attribute in the IP_ACTVTY_ATTR table must be configured with the VALUE field set to the text “IN_CREATION”. This enables Production Tracker to create a “childless” activity. Production Tracker enables up to 10 custom attributes to be associated with each PT activity. These site-specific attributes are carried forward from the PT tables through the PL tables to the PB tables. Carrying forward the PT tables facilitates the display of the custom attributes in the PT and PB tables. In this way there is a common set of attributes that are traced through the integrated applications. Activity Method Configuration
The Activity Methods section in the Production Tracker Plant Reference Model Configuration Guide describes how to configure activity methods for Production Tracker. In order for Production Balance Logging to capture mode change data, the following state-method pairs must be configured in the GT_ACTVTY_STATE_METHOD table. This set of state-method pairs must be configured for all mode activity types. Example Activity Type
State
Method
BLEND_MODE
CANCELLED
ENABLE
COMPLETED
SNAPSHOT
IN_CREATION
CREATE
PENDING
CANCEL
PENDING
MODIFY
PENDING
RESERVE
RELEASED
COMPLETE
RELEASED
MODIFY
RESERVED
CANCEL
RESERVED
MODIFY
RESERVED
MODIFY
ACTIVE
MODIFY
ACTIVE
COMPLETE
ACTIVE
MODIFY
CANCELLED
ENABLE
COMPLETED
SNAPSHOT
IN_CREATION
CREATE
PENDING
CANCEL
PENDING
MODIFY
PENDING
RESERVE
RESERVED
CANCEL
RESERVED
MODIFY
PROCESS_UNIT_INSTRUCTION
146 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Example Activity Type
PROCESS_UNIT_MODE
State
Method
RESERVED
START
ACTIVE
COMPLETE
ACTIVE
MODIFY
CANCELLED
ENABLE
COMPLETED
SNAPSHOT
IN_CREATION
CREATE
PENDING
CANCEL
PENDING
MODIFY
PENDING
RESERVE
RESERVED
CANCEL
RESERVED
MODIFY
RESERVED
START
Event Configuration Extensions for Production Balance Logging The Event Data Capture section in the Production Tracker Plant Reference Model Configuration Guide describes how to configure event data collection for Production Tracker. In order for Production Balance Logging to capture mode change data, the following event-method pairs need to be configured in the GT_ACTVTY_EVNT table. This set of events needs to be configured for all mode activity types. Example Activity Type
EVNT_NAME METHOD
ATTR
BLEND_MODE
COMPLETE
COMPLETE
BLENDER_NAME 5
SNAPSHOT
CREATE
BLENDER_NAME 3
OPEN
START
BLENDER_NAME 5
CLOSE
STOP
BLENDER_NAME 5
COMPLETE
COMPLETE
UNIT_NAME
5
SNAPSHOT
CREATE
UNIT_NAME
3
CLOSE
STOP
UNIT_NAME
4
COMPLETE
COMPLETE
UNIT_NAME
5
SNAPSHOT
CREATE
UNIT_NAME
3
CLOSE
STOP
UNIT_NAME
4
PROCESS_UNIT_ INSTRUCTION
PROCESS_UNIT_ MODE
EQ_NO_FLAG
A configured value of “3” in the EQ_NO_FLAG field indicates that the ATTR field value is the identifying attribute for the activity. All activity types must have an identifying attribute configured.
Production Balance Configuration Guide• 147
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
A configured value of “5” in the EQ_NO_FLAG field indicates that the activity tracks its root activity. As mode type activities are not transferred to the RealTime Data Repository (RTDR) on the RTEXEC Server, they must be forced to track the state of the root activity.
Equipment Configuration Extensions for Production Balance Logging The Equipment and Product Attribute Configuration section in the Production Tracker Plant Reference Model Configuration Guide describes how to configure equipment (and product) attributes for Production Tracker. In order for Production Balance Logging to capture mode change data, the following attribute must be configured in the IP_EQUIP_ATTR table. Example EQ_NAME
ATTR
TAGNAME
DISTILLATE_BLENDER
OP_MODE
DISTILLATE_BLENDER.MODE
NOTES: 1. The OP_MODE attribute needs to be configured for all equipment that require mode change detection. 2. The parent equipment of boundaries as represented in Production Tracker must belong to the balance group.
Hierarchy Configuration Mode Hierarchy Configuration for Production Tracker The Equipment and Product Data Capture section in the Production Tracker Plant Reference Model Configuration Guide describes how to gather the equipment and product data for Production Tracker. It includes instructions for configuring the Production Tracker Equipment Tree hierarchies. The mode hierarchy must be configured in the IP_EQUIP_HIERARCHY table. Only if configured, the equipment modes appear in the order Creation/Modification window in Production Tracker. This is done by using the IP_EQUIP_HIERARCHY_PL worksheet (in the AMMTables.xls workbook) to construct the hierarchies. Insert one or more records where the fields contain the following values: •
HIERARCHY_TYP is MODE
148 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
•
PARENT_EQ_NAME is the process unit name (for example, GASOLINE_BLENDER)
•
EQ_NAME is the process unit's mode (for example, PREMIUM or REGULAR).
Use the samples in the supplied IP_EQUIP_HIERARCHY_PL worksheet as a guide. Equipment Hierarchy Configuration for Production Balance Logging The Production Tracker equipment must be configured in the Production Balance Logging hierarchy. Only if configured, the equipment appears in the Production Balance Logging Equipment Tree. As described in the Production Balance Logging Equipment Tree Configuration section, the hierarchy is used for identifying the records that are displayed in the Balance Logging user interface and to seed the equipment and mode selection list boxes. Procedure
Use the Business FLEX TPI Equipment Hierarchy Configuration form to set up the Equipment Tree structure for the root, branch, equipment and port nodes. Use the following HIERARCHY_TYP values to define the type of the node in the tree: HIERARCHY_TYP
Description
PL_ROOT
Defines a root node. In this record PARENT_EQ_NAME must equal EQ_NAME. A root points at itself.
PL_BRANCH
Defines a branch. PARENT_EQ_NAME points at a root node or another branch node. A branch can point at itself in which case it defines a root.
PL_EQUIPMENT
Defines a equipment node. PARENT_EQ_NAME points at a branch.
PL_PORT
Defines a port. PARENT_EQ_NAME is the equipment.
NOTES: 1. The Production Tracker mode hierarchy does not have to be reconfigured for Production Balance Logging. This is because Production Balance Logging will find any modes that are configured with a HIERARCHY_TYP of MODE, as described in the previous subsection. 2. Production Balance Logging uses the instruments defined in the Production Tracker PRM. 3. The Production Balance Logging equipment hierarchy can differ from the Production Tracker hierarchy. It may be advisable, however, to make the two Equipment Trees the same. This is because it is easier for users to locate the equipment of interested in both user interfaces.
Production Balance Configuration Guide• 149
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Miscellaneous Configuration for Production Balance Logging PL_MOVE and PL_MODE Table Field Mapping The following table describes the mapping of Production Tracker attributes to PL_MOVE and PL_MODE table fields. Attribute
PL_MOVE / PL_MODE Field
Description
NET_LIQUID_VOLUME or FLOW on the equipment.
DEST_INSTRUMENT / Name of the instrument or tag SRC_INSTRUMENT that is used for measuring volume or flow on the source or destination.
ACTIVITY_MATERIAL on the DEST_MATL / activity or MATERIAL on the SRC_MATL equipment.
Material for the destination or source.
TRANSFERRED_QUANTITY DEST_QUANTITY / SRC_QUANTITY
User specified quantity for a movement.
MANUAL_RATE
DEST_RATE / SRC_RATE
User specified average flow rate for a movement.
--
SYSTEM
Name of the application that delivered data. Use “PT” in all cases.
ORDER_NUMBER
SYSTEM_REF
Production Tracker Reference ID for the movement.
NOTE: It is recommended that each site use the attribute naming convention displayed here. If a different naming convention is used, then the Activity Engine's VJ script file (AEPLInterface.vjs) must be modified to match the new attribute names. Mode Entity/Group Relationships Configuration The Activity Configuration Extensions for Production Balance Logging section of this document describes the creation and configuration of mode type activities. These activity types must be assigned to Production Tracker groups. The procedure for adding activity types to groups is described in the Production Tracker Installation Guide. (See the section called "Configure the Entity/Group Relationships", which is part of Production Tracker Information System Configuration, for details.) Inferring the Equipment Name Before movement information can be transferred to Production Balance by Production Balance Logging, Production Tracker must infer the correct equipment name for the movement source and destination. When the movement source or destination for a Production Tracker activity is an equipment item like a tank or blender, the inferred source or destination equipment name is the same as the activity's source or destination equipment name. 150 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
However, when the activity's source or destination is a port connected to another equipment item, the equipment name to be inferred is not the port. Instead, the connected "parent" equipment name must be used. For example, for a movement that feeds material from a tank to a blender, the Production Tracker activity's source would be the tank and the destination would be a port on the blender. For the record to be sent to Production Balance, the inferred source equipment name would be the tank name, but the inferred destination equipment name would be the blender name not the port name. To ensure that the correct equipment name is inferred by Production Tracker, the IP_EQUIP_HIERACHY table must be configured correctly. Ports must be assigned to the correct "parent" equipment in the hierarchies. In addition a new PRDCTN_TYPE attribute must be added to each equipment item that is not a port. When a movement record for Production Balance is created by Production Tracker, Production Tracker checks the movement activity's source and destination equipment for the PRDCTN_TYPE attribute. If this attribute exists for the source or destination equipment, then the source or destination's equipment name is used. If the PRDCTN_TYPE attribute does not exist for the source or destination equipment, then Production Tracker uses the "parent" equipment name one level up the equipment hierarchy. For further clarification three examples are provided. Example 1 Equipment: FCC Boundary Points: FCC Charge FCC Bottoms FCC Overheadd FCC LCN FCC LCGO
You must configure the following to enable Production Tracker to correctly record the movements that involve boundary points: •
The equipment FCC (which could be a process unit) must be configured in the hierarchy as the immediate parent of the boundary points.
•
The equipment FCC must have the equipment attribute PRDCTN_TYPE.
•
Boundary points that belong to a single equipment item must not have the PRDCTN_TYPE attribute.
Production Balance Configuration Guide• 151
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Example 2 Equipment: TK102 Boundary Points: (none)
To enable Production Tracker correctly record the movements that involve the tank, configure the following: •
TK102 must have the attribute PRDCTN_TYPE.
Example 3 Equipment: Pipeline102 Boundary Points: Pipeline102
To enable Production Tracker correctly record the movements that involve the pipeline, configure the following: •
Pipeline102 is both an equipment item of interest to Production Balance and a boundary point in Production Tracker. In this case the boundary point would be configured with the attribute PRDCTN_TYPE.
Additional Configuration Requirements
In addition to configuring the PRDCTN_TYPE attribute, the Production Balance equipment attributes must be configured correctly. In the Balance Group and Equipment Attribute Configuration section of this document see the Equipment Attributes table for more information about configuring this attribute. PB-BMA integration The PB-BMA integration is implemented in the PL Transfer background process. You can enable the PB-BMA integration by setting the command line parameter ENABLE_BMA2PL as True in the Application Server Configuration form in TPI. If this parameter is set to True, the transferring of movements and mode data is enabled from the BMA system to the PB system. If this command line parameter is not enabled, then the normal PL Transfer workflow continues. The communication mechanism between BMA and PB is through file sharing. The movement and modes data (XML files) from the BMA system (PL_MOVE and PL_MODE xml) are copied to a shared folder (BMA_DIR). The BMA_DIR specifies the path (directory) where the BMA system generates the PL_MOVE and PL_MODE xml files. The PB system processes the same XML files to update the PL tables with the movements and modes respectively. The PL_DIR folder exists on the local PB system. The PL_DIR specifies the path (directory) where the PLTRANSFER moves all the files from the BMA_DIR during processing. The BMA_DIR and PL_DIR folders are configurable and must have read/write permissions for the user who runs the PL Transfer background process. These folders can exist across machines in the network. You can create the PL_DIR folder manually. If this folder is not found, the PL 152 • Production Balance Configuration Guide
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
Transfer background process automatically creates this folder during configuration. The PL_DIR folder consists of three sub folders namely: Data, Processed, and Error. The PL Transfer background process moves all the XML files from the BMA_DIR to the Data folder under the PL_DIR folder. The processed files are saved under the Processed folder by enabling the command line parameter SAVEFILE. If this parameter is not enabled, then the processed files are deleted immediately. If there is an error while processing the files, the files are moved to the Error folder under the PL_DIR folder. You can modify the files with errors based on the PL Transfer log files and copy the files back to the Data folder. The PL Transfer background process processes this file in the next execution. NOTES: •
Set the AUTO_CLEANPL parameter to True, to clean all the existing BMA movements with non-null END_DT and all modes from PL_MOVE and PL_MODE before processing. NOTE: If the command line parameters are not available, you can add all the parameters using the Lookup Value Configuration Form in TPI.
•
Select BP_PARAMETERS as Lookup Type and configure each of the parameters as the Lookup values. All the configured parameters are added to the PLTransfer background process parameter list.
•
The data in the XML files from BMA must be in uppercase. For example, the PHD tag names must be configured in uppercase.
•
A movement and its respective mode start date must have the same timestamp and must not have any difference. For instance, a movement that started at 01/08/2011 03:00:00 PM and a mode that started at 01/08/2011 3:00:01 PM for the same movement ID results in PB to create one more transfer with a running gauge.
•
Different PHD tag names must be used for different movements to avoid running gauge in PB.
•
PLCleanup background process cleans up the PL_MOVE, PL_MODE, and PL_TRANSFER tables periodically. This background process takes preference over the auto cleanup parameter, even if it is configured as FALSE and cleans up the existing BMA movements from the table.
Production Balance Configuration Guide• 153
Part 3 – Production Balance Logging Configuration Production Tracker Configuration
This page is intentionally left blank
154 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Model Configuration
Part 4 – Inventory Calculation Configuration Model Configuration Overview For customers who do not use the Production Balance reconciliation functionality, inventory groups can be configured to manage the calculation, correction and release of inventory data. These inventory groups can be the same as or a subset of the groups created for logging purposes. Configuration Sequence To support the inventory calculations, an inventory equipment and product model needs to be configured in the Business FLEX database. The following order of configuration is recommended: Step Description 1.
Plan your inventory calculation model.
2.
Configure the inventory groups.
3.
Configure the inventory equipment.
4.
Configure the inventory equipment hierarchy.
5.
Configure the products that will be involved in the inventory calculations and associated product groups.
6.
Configure the product hierarchy.
Production Balance Configuration Guide• 155
Part 4 – Inventory Calculation Configuration Model Configuration
Step 1 – Plan the Inventory Calculation Model In much the same way as the model configuration for Production Balance Analysis, you must plan your inventory calculation model before you proceed with detailed configuration. In general multiple inventory groups are used where inventory is managed by different business groups with different staff for each line of business. •
Decide which inventory equipment items require inventory calculations to be performed on them.
•
Determine which materials and products will be stored in the inventory equipment and will be involved in the inventory calculations.
•
Decide how the inventory equipment and products will be grouped. – For each group of inventory equipment, determine which products need to be associated with the same group. (The products involved in the inventory calculations for a given inventory group must be grouped into an associated product group.) – Decide on a name for each inventory equipment and associated product group.
•
Decide on the type of inventory calculation that will be performed for each inventory equipment group. (See Appendix A for a list of the supported inventory calculation types. The inventory calculation types are identified by the equipment class assigned to the inventory equipment.)
•
Identify the data sources to be used for the inventory calculation input data (for example, field data or process historian tags).
•
If the inventory calculation results are going to be written back to a process historian, the output tags must also be identified.
NOTE: The inventory equipment assigned to balance groups in the Production Balance Analysis model can be used for performing inventory calculations.
156 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Model Configuration
Step 2 – Inventory Group Configuration Create the Inventory Groups For each inventory group, create a separate equipment entity in the Business FLEX TPI Equipment Configuration form. (An equipment type is not required.) The equipment that belongs to each inventory group is assigned in Step 4. Inventory Group Attributes After the inventory groups have been defined, use the Business FLEX TPI Equipment Configuration form to configure the inventory group attributes listed in the following table. Attribute
Req’d Default
IMEQGRP
Y
Description Identifies the object as an inventory group for the Inventory Management application. No value is required for this attribute.
IMERRSTATUSMAX
Used for setting the lower level mapping between the confidence values and the status value. If this value is 0, then a confidence less than or equal to 0% would result in a status of 2.
IMOKSTATUSMIN
Used for setting the upper mapping between the confidence values and the status value. If this value is 90, then a confidence greater than or equal to 90% would result in a status of 0.
Step 3 – Inventory Equipment Configuration Create the Equipment For every inventory equipment item in the model, create a separate equipment entity in the Business FLEX database. The inventory equipment and the associated equipment attributes can be configured in the Business FLEX TPI Equipment Configuration form or using the Inventory Calculation Configuration forms in the Production Balance Client application. (See the Inventory Calculation Attribute Configuration section which follows this one for details.)
Production Balance Configuration Guide• 157
Part 4 – Inventory Calculation Configuration Model Configuration
Step 4 – Inventory Equipment Hierarchy Configuration Configure the Inventory Group - Equipment Hierarchy Assign the inventory equipment to the associated inventory group, by creating a separate record for each inventory group - equipment entity pair with the type PL_BRANCH or PL_EQUIPMENT. Parent Equipment Name
Equipment Name
Hierarchy Type
PL_EQUIPMENT or PL_BRANCH
The inventory group - equipment hierarchy can be configured either in the Business FLEX TPI Equipment Hierarchy Configuration form or in the Production Balance Client application's Configure Equipment form. NOTES: 1. You can create hierarchies of inventory groups. Separate inventory group equipment entities must be created for each inventory group and the equipment hierarchies must be created with the PL_BRANCH or PL_EQUIPMENT hierarchy types. 2. If a multi-level inventory hierarchy is created, be sure that the sequence numbers are unique. This is required to support inventory group report sequencing. 3. Individual inventory equipment items can be assigned to multiple inventory groups.
Step 5 – Product Configuration Create the Products For every product in the model, create a separate product entity in the Business FLEX database. The product and the associated product attributes for the inventory calculations can be configured in the Business FLEX TPI Product Configuration form or using the Production Balance Client application's Configure Products form. Create the Product Groups Using the Business FLEX TPI Product Configuration form, create a product entity for each product group in the model. There are no attributes or type assignments required for the product groups.
158 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Model Configuration
Step 6 – Product Hierarchy Configuration Configure the Product Group - Product Hierarchy Assign the products to the associated product group, by creating a separate record for each product group - product entity pair with the type IM_GRP. Parent Product Name
Product Name
Hierarchy Type
IM_GRP
The product group - product hierarchy can be configured either in the Business FLEX TPI Product Hierarchy Configuration form or in the Production Balance Client application's Configure Products form. Product Reporting Sequence
As part of the product hierarchy configuration the hierarchy sequence must be configured for product groups. The sequence is used for controlling the order in which the products appear in the Production Balance Analysis reports (in Production Balance Web) for a given product group. NOTE: Each SEQ value in a given product group - product hierarchy must be unique. Assign the Product Group to the Inventory Group In the Business FLEX TPI Equipment Configuration form, create an IMPRDCTGRP attribute for the inventory group equipment entity whose value is the associated product group name.
Step 7 – Display Units Configuration To view the water levels, you must configure the display units. To display level in FIE or FIS units, perform the following steps for configuration in the EDS Administration – Configuration display: 1. Select the tab Path Admin. 2. Select HPI>Production Logger in the tree-view. 3. Click Create. The Production Logger application path details are displayed.
Production Balance Configuration Guide• 159
Part 4 – Inventory Calculation Configuration Model Configuration
4. Add /FTConversion to the path in the Path field. The FTConversion configuration item is added to Production Logger.
5. Click the Values tab in Path Admin. 6. Select String from the Type list. 7. Specify FIE/FIS as the value. 8. Select Client from the Source list. The details are displayed.
9. Click Update. Perform the following steps in the TPI display: 10. Select Application Server Configuration>Production Logger Inventory. 160 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Model Configuration
11. In the Parameters column, ensure that the parameter length value configured is FT as illustrated:
Perform the following steps to verify the configuration: 12. Schedule a case for PLInventory calculations. 13. Run the PLInventory Background Processor. 14. Open EDS. 15. Select Production Balance>Logging> Inventory Entry.
Production Balance Configuration Guide• 161
Part 4 – Inventory Calculation Configuration Model Configuration
16. In the Measurements tab, ensure that FIE or FIS is the unit configured for Level and Free Water Level. Following is an illustration:
162 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Inventory Calculation Attribute Configuration Introduction The Production Balance Client application provides access to three forms that are used for configuring the equipment and product attribute values, as well as strapping table data, used in the Production Balance inventory calculations. These forms are provided for configuration purposes and are described in the following sections. NOTE: These forms can only be accessed if you are connected to the Business FLEX database in Oracle. You can access these forms even if a balance case has not been selected. Access
To access the inventory calculation forms, start the Production Balance Client application on a computer that has a working connection to the Business FLEX database in Oracle. In the Windows Start menu, select Programs > Honeywell > Business FLEX > Production Balance. In the Production Balance Login dialog box access the Oracle database by entering the following information.
In this field...
Do this to access an Oracle database...
Server Type
Select Oracle to connect to the Business FLEX database and to the automated Production Balance processing.
Use OS Authentication
Select this option to enable automatic user authentication. In a Windows operating system, the current Windows user name and password are used.
Production Balance Configuration Guide• 163
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
In this field...
Do this to access an Oracle database...
User Name
Enter the user name required for the Business FLEX database in Oracle. (This field is disabled, if the Use OS Authentication option has been selected.)
Password
Enter the password required for the Business FLEX database in Oracle. (This field is disabled, if the Use OS Authentication option has been selected.)
Database
Enter the Business FLEX database name.
Click OK to connect to the selected database. NOTE: You must be connected to the Business FLEX database in Oracle to use the inventory calculation forms in the Production Balance Client user interface. The forms are not available if you are connected to a Microsoft Access database. The Oracle user you connect as must have read-write access to the tables being configured. For strapping data entry, you will need access to the IP_CORRLTN_TBL and IP_CORRLTN_TBL_DETAIL tables. To configure equipment, you will need access to the IP_EQ and IP_EQUIP_ATTR tables. To configure products, you will need access to the IP_PRDCT and IP_PROD_ATTR tables.
Configure Strapping Data Form Introduction Purpose
Strapping table data is used for calculating the volume or mass of material in an inventory equipment item. The Configure Strapping Data form is used for configuring the strapping table data if that data is not configured through PHD. In addition, this configuration can be performed in the Uniformance PHD, 1D Correlation Configuration form (if PHD is present), in the BFLX TPI, Process History, 1D Correlation Configuration form (if a non-PHD process historian is being used) or through the database IP_CORRLTN_TBL and IP_CORRLTN_TBL_DETAIL tables. If the data is synchronized with PHD, any edits made in the Configure Strapping Data form is lost during the next synchronization. NOTE: In Business FLEX Release 230, 1D correlation is not synchronized with PHD. It contains only the data configured through TPI.
164 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Refer to the Production Balance User Guide from more details on this form.
Interactions Strapping table data is associated with a particular equipment item by assigning the IMSTRAPSRCID attribute to that equipment item in the Configure Equipment form (described later in this section) or in the Business FLEX TPI Equipment Configuration form. Use this field or button to...
Do this...
Tank
Select the strapped equipment item you are interested in. The list contains the names of the existing equipment items that have been assigned the IMSTRAPSRCID attribute in the Configure Equipment Form.
Function – Name
View the name of the strapping table instance associated with the selected equipment item. NOTE: The function name is set when the IMSTRAPSRCID attribute is specified for the equipment in the Configure Equipment Form.
Function – Description
Add or edit a description of the strapping table instance for easier and more accurate identification.
Production Balance Configuration Guide• 165
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Use this field or button to...
Do this...
UOM – Level and Volume
View the units of measurement for level and volume defined for the current equipment item. NOTE: The content of the fields are set when the Strap Level UOM and the Strap Vol UOM attributes are specified for the equipment item in the Configure Equipment Form.
Strapping Data – X Value and Resultant Value
Enter pairs of data that correspond to equipment level (X Value) and the associated volume at that level (Resultant Value).
Level Limits – Minimum and Maximum
Edit the minimum and maximum equipment level limits for the strapping table instance.
Add Button
Insert a new record in the Strapping Data table. You can then enter a new X Value and Resultant Value pair.
Remove Button
Remove the selected X Value and Resultant Value pair from the strapping table.
Save Button
Save the changes made to the strapping table. NOTE: The strapping data levels are validated against the minimum and maximum level limits defined for the table. If you enter an X Value higher or lower than the level limits, the following message is displayed.
Revert Button
Undo the changes that were made to the strapping table in the current session.
Close Button
Close the Configure Strapping Data form NOTE: If the modified strapping table data has not been saved, you will be given the option of saving the data prior to closing the form.
Click Yes to save your data and close the form. Click No to close the form without saving your changes.
166 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Creating a Strapping Table Instance for PHD Process Historians
You can create a new strapping table instance using the Configure Strapping Data form. Perform the following steps: 1. Select the required tank from the list. NOTE: The value for the attribute configured for the tank in the Equipment Configuration form is displayed in the list. 2. Enter a Name and Description in the Function section. 3. Enter the X Value and Resultant Value in the Strapping Data section. 4. Click Save. Creating a Strapping Table Instance for non-PHD Process Historians
You cannot create a new strapping table instance from the Configure Strapping Data for non-PHD Process Historians. Perform the following steps to configure a strapping data for a non-PHD Process Historian data: 1. Select Start>Programs>Honeywell>Business FLEX>TPI to access the TPI application. 2. Login with the user name and password. 3. Select Process History>1-D Correlation Configuration. The 1D Correlation Configuration form is displayed.
4. Provide the following details: a. Function Name b. Description
Production Balance Configuration Guide• 167
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
c. Minimum and Maximum Source Value 5. Enter the Source Value and the Result Value. 6. Click the Save option in the menu bar to save the record OR Click the arrow in the left corner of the form as illustrated to save the record.
168 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Configure Equipment Form Introduction Purpose
The Configure Equipment form is used for configuring the inventory calculation configuration data for those equipment items that have been identified as inventory equipment. In addition, this configuration can be performed in the Business FLEX TPI Equipment Configuration form.
Refer to the Production Balance User Guide from more details on this form.
Production Balance Configuration Guide• 169
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Equipment Attribute Definitions It is important to realize that the set of attributes that appear in the Equipment Attributes table are data-driven, as is the notion of whether an attribute requires a value. Where the value is represented by a selection list, the content of the list is also data-driven. Even the displayed names of these attributes are driven by data. The attributes are defined in the IM_EQ_CONFIG_TEMPLATE table (which identifies the attributes to be displayed) and the IM_EQ_CONFIG_TEMPLATE_VALUES table (which defines the list of allowable values for each attribute where required). There are three types of attributes in the Equipment Attributes table: •
Standard equipment attributes that apply in all cases (even for non-inventory equipment).
•
Inventory calculation attributes which depend on the inventory equipment class to which the equipment item is assigned. These attributes appear in the TCLCalculations.xml file and are described in Appendix A. Only those attributes which apply to the inventory calculation to be performed need to be configured. NOTE: The attribute names that appear in the Equipment Attributes table will differ from the internal attribute names listed in Appendix A. The Equipment Attributes table labels can be changed in the IM_EQ_CONFIG_TEMPLATE table if needed.
•
Additional inventory attributes that are not included in the TCLCalculations.xml file and which are generally supplied for information purposes only.
The following table describes the equipment attributes that do not appear in Appendix A. Attribute
Description
Required
Name
Standard equipment attribute which uniquely identifies the equipment within the database.
Y
Note: You cannot edit the name of an existing equipment item. You can only enter a name for a new equipment or for a copy of an existing equipment. Description
Standard equipment description attribute.
N
Plant
Standard equipment attribute which identifies the location of the equipment.
N
Company
Standard equipment attribute which identifies the owner of the equipment.
N
Active
Standard equipment attribute which indicates whether the equipment item is available for processing in the Business FLEX applications.
Y
Available
Standard equipment attribute which indicates whether the equipment item is available for use in the Production Balance application.
Y
170 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Attribute
Description
Required
Service
Standard equipment attribute which sets the equipment item into or out of service.
Y
Manual Entry
Indicates whether the equipment item can accept manual data entry or not.
Y
Pseudo
Indicates whether the equipment item is pseudo equipment Y item or not. A pseudo equipment item has the following properties: • It cannot have any strapping attributes. • It cannot have Level as a data type.
Export
Indicates whether the equipment item is to be considered for product roll-up.
Y
Volume UOM
Defines the units of measure to be used for display purposes for all volume-based columns.
Y
Mass UOM
Defines the units of measure to be used for display purposes for all the mass-based columns.
Y
Strapped Eq
Identifies the equipment item as being strapped.
Y
NOTE: If the equipment has a strapping table, then the following attributes are required: • Strap Func Name • Strap Data Type • Strap Grv • Strap Vol UOM • Strap Level UOM • Strap Offset • Level Data Type Strap Func Name
Defines the strapping table instance for level equipment. The value specified for this attribute becomes the name of the strapping table instance which can then be edited in the Configure Strapping Data form.
N
Data Type
Defines the data entry mechanism for the equipment item. Valid values are
Y
• LEVEL • MASS • NETVOLUME • GROSSVOLUME • EXTDATA (External data source) Attribute 1 to 6 Read only, user defined attributes that can be configured with process historian reference tags or values.
N
IMCFGDTTM
N
Defines the configuration timestamp for the equipment item.
Production Balance Configuration Guide• 171
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Attribute
Description
Required
Eq Diameter
Specifies the diameter of the equipment. If a value is provided, then the units of measure must be specified.
N
Eq Height
Specifies the height of the equipment. If a value is provided, then the units of measure must be specified.
N
Inspection Cmpny
Specifies the name of the company that inspected the equipment.
N
Inspection Date
Specifies the inspection date for the equipment.
N
Inspector ID
Specifies the ID of the individual who inspected the equipment.
N
Install Date
Specifies the equipment installation date.
N
Max Fill Hght
Specifies the maximum fill height for the equipment. If a value is provided, then the units of measure must be specified.
N
Min Fill Hght
Specifies the minimum fill height for the equipment. If a value is provided, then the units of measure must be specified.
N
Max Design Temp
Defines the maximum design temperature for the equipment. If a value is provided, then the units of measure must be specified.
N
Min Design Temp
Defines the minimum design temperature for the equipment. If a value is provided, then the units of measure must be specified.
N
Tolerance
Defines the tolerance for the level or input measurement.
N
Tolerance Type
Defines the tolerance type as ABSOLUTE or PERCENT.
N
Safe Fill Hght
Specifies the safe fill height for the equipment. If a value is provided, then the units of measure must be specified.
N
172 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Configure Products Form Introduction Purpose
The Configure Products form is used for configuring the inventory calculation configuration data for the products in the Plant Reference Model that belong to inventory group calculations. In addition, this configuration can be performed in the Business FLEX TPI Product Configuration form.
Refer to the Production Balance User Guide from more details on this form. Product Attribute Definitions It is important to realize that the set of attributes that appear in the Product Attributes table are data-driven, as is the notion of whether an attribute requires a value. Where the value is represented by a selection list, the content of the list is also data-driven. Even the displayed names of these attributes are driven by data. The attributes are defined in the IM_PRDCT_CONFIG_TEMPLATE table (which identifies the attributes to be displayed) and the IM_PRDCT_CFG_TEMPLATE_VALUES table (which defines the list of allowable values for each attribute where required).
Production Balance Configuration Guide• 173
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
There are three types of attributes in the Product Attributes table: •
Standard product attributes that apply in all cases.
•
Inventory calculation attributes which depend on the inventory equipment class for the equipment items that will be used for storing the product. These attributes appear in the TCLCalculations.xml file and are described in Appendix A. Only those attributes which apply to the inventory calculation to be performed need to be configured. NOTE: The attribute names that appear in the Product Attributes table differ from the internal attribute names listed in Appendix A. The Product Attributes table labels can be changed in the IM_PRDCT_CONFIG_TEMPLATE table if needed. )
•
Additional inventory attributes that are not included in the TCLCalculations.xml file and which are generally supplied for information purposes only.
The following table describes the product attributes that do not appear in Appendix A. Attribute
Description
Required
Name
Standard product attribute which uniquely identifies the product within the database.
Y
Note: You cannot edit the name of an existing product. You can only enter a name for a new product or for a copy of an existing product. Description
Standard product description attribute.
N
Active
Standard product attribute which indicates whether the product is available for processing in the Business FLEX applications.
Y
IMPRDCT
Indicates whether the product can be used in the inventory calculations or not.
Y
Component
Indicates whether the product is a component or not.
Y
Expansion Coeff.
Specifies the expansion coefficient for the product. This is required for products that refer to API for VCF corrections. If a value is provided, the units of measure must be set in the Expansion Coeff UOM attribute below.
Only required if the product's API table attribute is set to C and if VCF is applied to the inventory calculation.
Expansion Coeff UOM
Specifies the units of measure for the product's Only required if a expansion coefficient. The valid values are value is entered for DEGF or DEGC. the Expansion Coeff. attribute.
Product UOM
Defines the units of measure to be used for display purposes for the product.
174 • Production Balance Configuration Guide
N
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
Attribute
Description
Required
Default Density Defines the default density for a product. If a value is provided, then the units of measure must be specified.
N
Attribute 1 to 3 Read only, user defined attributes that can be configured with process historian reference tags or values.
N
Production Balance Configuration Guide• 175
Part 4 – Inventory Calculation Configuration Inventory Calculation Attribute Configuration
This page is intentionally left blank
176 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Other Inventory Calculation Configuration Operations
Other Inventory Calculation Configuration Operations Automated Processing Configuration Auto Processing Display For the Inventory Calculation utility, the Auto Processing display is used for configuring automated data collection and inventory calculations for the inventory groups.
Access
To access this display, select PB Configuration > Auto Processing from the Production Balance menu. When the Auto Processing display is selected, the Balance Family/Equipment Tree in the navigation pane displays the balance families and inventory groups defined for the system. The associated balance groups and equipment are not displayed.
Production Balance Configuration Guide• 177
Part 4 – Inventory Calculation Configuration Other Inventory Calculation Configuration Operations
Automated Processing Configuration Procedure 1. Before you configure automated processing for the Inventory Calculation utility, the inventory groups must be preconfigured. 2. For each inventory group decide on the following: – Frequency of the inventory calculations – Start time for the first inventory calculation Having this information ahead of time is helpful. This is because the settings cannot be changed after the automated processing is configured for a given inventory group and saved to the database. 3. Open the Auto Processing display in Production Balance Web. 4. In the Balance Family/Equipment Tree, select the inventory group you want to configure. NOTE: The configuration applies to every inventory subgroup in the selected inventory group, if there are any subgroups in the hierarchy. 5. In the Scheduling subtab, click Add, and fill in the following fields. In this field...
Do this...
Area
Displays the inventory group to be configured. Leave this field unchanged.
Type
Configure the calculation frequency (for example, Hourly, Daily, Weekly, and so on.). For Ad Hoc inventory group calculation cases (Repeating option is cleared) this field is disabled.
Repeating
Select this option for normal (that is, automatic) inventory calculation processing. Clear this option to create an Ad Hoc inventory group calculation case for an existing inventory group.
Status
Displays the current status for the inventory calculation case. This field cannot be changed.
Inventory Date Time
Enter the date and time for the first inventory calculation to be performed for the inventory group. For an Ad Hoc inventory group calculation case, enter the desired inventory calculation date and time for the Ad Hoc case.
Cycle Type
This field does not apply to inventory calculations and is disabled.
Units
This field does not apply to inventory calculations and is disabled.
6. After all of the fields have been filled in, click Store to save the Auto Processing entry to the database.
178 • Production Balance Configuration Guide
Part 4 – Inventory Calculation Configuration Other Inventory Calculation Configuration Operations
7. Saving the entry causes the Auto Processing display's Steps sub-tab to be populated with the default inventory calculation steps.
The Steps sub-tab contains the following information: This field…
Does this…
Step Name
Identifies the background processing module executed for this inventory group. The values are defined in the Lookup Configuration procedure with the lookup name of AUTOSTEP_IM.
Sequence
Sets the order in which the automated processing steps are to be performed. NOTE: The sequence numbers do not have to be contiguous.
Run Check
Indicates if the step is to be executed. Automated processing runs the step if the Run Check option is selected ( ).
8. By default the two inventory calculation steps, PLInventory and PLWriteback, are checked. If writeback to process historian tags is not going to be configured for the inventory group, clear the Run Check option for the PLWriteback step. 9. Add any additional automated processing steps by clicking the Add button in the Steps sub-tab. Enter the background processing module name, the desired processing sequence number and select the Run Check option for the new step if it is to run. 10. Click Store in the Steps sub-tab to save the automated processing steps configuration to the database. ATTENTION: In the Steps sub-tab, you cannot change the steps or sequences if the inventory group calculation case has been submitted for processing.
Production Balance Configuration Guide• 179
Part 4 – Inventory Calculation Configuration Other Inventory Calculation Configuration Operations
Deleting an Automated Processing Entry
Automated processing entries can be deleted from the database by selecting the associated row in the top half of the display and clicking Delete in the Schedule sub-tab. Deletions can only be performed if the inventory group calculation case has not yet been submitted for processing. After this has occurred, the automated processing entry cannot be deleted. PLInventory Background Process Information
When processing inventory groups, the PLInventory background process performs the inventory calculations for the set of equipment and products assigned to the inventory group. The calculations are performed at one time only. This differs from how the PLInventory background process behaves for the balance groups, where it performs the inventory calculations for the equipment in the balance group at the beginning and the end of the balance case period.
Writeback Configuration The Writeback displays may be used for configuring inventory calculation data writeback to process historian tags. The Writeback Equipment and Product displays, described in the Writeback Configuration section in Part 2 of this guide, can be used for this purpose. NOTE: The Writeback PBCase display does not apply to inventory calculation data.
Inventory Group Access Configuration If desired, access to specific inventory groups can be restricted to identified Web roles. Users who are assigned to these Web roles will be able to view the Production Balance Web displays and reports for these inventory groups via the Balance Family/Equipment Tree. When a user who is not assigned to one of these Web roles opens the Production Balance Web displays, the inventory groups that are not assigned to them are disabled in the Balance Family/Equipment Tree. In addition, they will not have access to associated information. The Role Security display, described in the Balance Family and Group Access section in Part 2 of this guide, is used for this configuration step.
180 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
Part 5 – User Interface Configuration Customize the Web User Interface in the Web Administration - Configuration Display Overview The Configuration display that is accessed from the Web Administration workspace is used for configuring general Web user interface settings that apply to all of the Business FLEX Web applications. In addition, it includes Web display customization settings that apply to the set of Production Balance Web displays.
Production Balance Configuration Guide• 181
Part 5 – User Interface Configuration
Access
To access the Web Administration - Configuration display, open the Administration workspace in Experion Desktop, then select the Administration > Configuration menu. Configuration is then performed in the Path Admin tab, by selecting the appropriate node in the HPI tree. Only users that have been assigned the CoreAdmin Web role can access this display. NOTE: Ensure to click the Update button whenever you change one of these settings. Customize the Production Balance Web Display Settings The following settings in the HPI > ProductionLogger tree can be customized for Production Balance Web. Settings not listed here must only be changed when directed by Honeywell Staff. Setting
Description
Format/Example
EndTime
Sets the default end time (in hours:minutes:seconds) for the Date Range Selector. When one of the Production Balance Web displays that require the Date Range Selector is opened, the default end date is the next day at the time configured here.
If the current date is November 30, 2005 and the configured EndTime is 13:00:00, the END date and time in the Date Range Selector will be 11/30/2005 1:00 PM.)
The default end time is noon of the next day (12:00:00). StartDay
Sets the number of days prior to the current date to use as the default start date in the Date Range Selector. The default start day count is 5 days.
StartTime
Sets the default start time (in hours:minutes:seconds) for the Date Range Selector. The default start time is noon (12:00:00).
ProductRollupUnits
Sets the density, mass and volume units of measurement that the values are converted to in the Product Rollup view and that are displayed at the top of the Product Rollup display. The default units of measurement are density = KG/M3, mass = KG and volume = M3. These values are text strings only and are not tied to the set available units of measurement configured for the system.
182 • Production Balance Configuration Guide
If the current date is October 28, 2005 and the configured StartDay is a value of 6 and the StartTime is 11:00:00, the START date and time in the Date Range Selector will be 10/22/2005 11:00 AM.)
Part 5 – User Interface Configuration
Customize the Web Reports The following Web report settings in the HPI > CC > Reports > WebReportViewer tree can be customized for all of the Business FLEX Web reports. These settings apply to all of the Business FLEX Web applications at the site. Setting
Description
NumberofRetries
When a user attempts to view a report in Crystal Viewer, the system needs to connect to the Crystal Reports Server to display the report. The NumberofRetries value sets the maximum number of retries for connecting to the Crystal Reports Server, before reporting an error.
TimeToWait
When a user attempts to view a report in Crystal Viewer, the system needs to connect to the Crystal Reports Server to display the report. The TimeToWait value sets the time interval between two successive Crystal Reports Server connection attempts. (This setting is implemented in conjunction with the NumberofRetries settings.)
ATTENTION: 1. For changes to come into effect, reboot the Experion Desktop Server. 2. The Crystal Reports Server only supports three concurrent requests for report data. TIP: The Production Balance Web reports are designed using Crystal Reports from Business Objects, Inc. (www.businessobjects.com). This document does not describe how to modify the standard Web reports or how to add new reports.
Customize the Web User Interface in the PB Configuration Site Settings Display Overview For each of the Production Balance Analysis and Logging Web displays, large quantities of information is collected and generated by the application. In general, only a subset of the available information will be relevant to you. The Site Settings facility may be used for customizing the data that appears in these displays to suit your needs. Site Settings provides control over the following: – – – – – –
Left to right sequence of grid columns Columns to be displayed Numeric field formatting Number of records which can be displayed in a single table page Number of links which can be displayed in the page control Custom view creation
All changes are global for the site, meaning that the user interface settings configured in Site Settings will apply to all users.
Production Balance Configuration Guide• 183
Part 5 – User Interface Configuration
ATTENTION—Migration Note: For Business Flex release 210 onwards, all site settings can be migrated. The site settings prior to Business Flex 210 cannot be migrated.
Access
To access the Site Settings display open the Production Management workspace in Experion Desktop, then select the Production Balance > PB Configuration > Site Settings menu. Only users that have been assigned the PLAdmin Web role can access this display.
Configuration Tree
The Configuration Tree in the lower-left portion of the display enables you to select the display, window or view you want to configure. Much like the Equipment Tree in the Production Balance Analysis and Logging displays, the Configuration Tree lets you drill down to the item whose configuration settings you want to view or modify. When you click an item in the Configuration Tree, the right pane of the Site Settings display changes accordingly.
184 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
Within the Configuration Tree, there are three main configuration selections for each Production Balance display or a window: BCGridBase, BCGridView and PLPageSettings.
BCGridBase is used for configuring the column labels, as well as the format for numeric fields. Refer to the section Customizing the Grid Format for details. BCGridView is used for controlling the grid column sequences, column widths and the columns which are to be displayed (turning on or off the display of a given column). For the Production Balance Analysis and Logging displays only, BCGridView can also be used for creating or remove custom views. Refer to the section Customizing the Grid Contents for details. PLPageSettings is used for controlling the number of records which can be displayed in a single table page. This configuration only applies to tables in the Production Balance Analysis and Logging displays. Refer to the section Customizing the Table Page Limits for details.
Available Buttons
The following buttons are used within Site Settings (depending on what display you are viewing you may not see all of these buttons): This button…
Does this…
Add
Displays the View Configuration Editor which may be used for adding a new view for the associated Production Balance Analysis or Logging display. Refer to the section Adding or Modifying a Display View for details. This button is only available when you select the BCGridView node in the Configuration Tree for one of the Production Balance Analysis or Logging displays.
Production Balance Configuration Guide• 185
Part 5 – User Interface Configuration
This button…
Does this…
Modify
Displays the View Configuration Editor which may be used for modifying the general view settings (for example, name, description and modification permission) for the currently selected view. This button is only available when you select one of the BCGridBase, BCGridView or PLPageSettings nodes in the Configuration Tree.
Delete
Deletes the currently selected view. This button is only available when you select the BCGridView node in the Configuration Tree for one of the Production Balance Production Balance Analysis or Logging displays. Refer to the section Deleting a View for details.
Restore Defaults Restores the default settings for the current view. Submit
Stores your modified view settings.
Customize the Grid Format (BCGridBase) BCGridBase is used for configuring the column labels and numeric field formats in each Production Balance Analysis and Logging displays, and in the Lineup Editor, Movement Composition and Group Operations windows. NOTE: For the Production Balance Analysis and Logging displays, any changes you make to the table column labels in the Master Data pane (top portion of the display), will also appear in the field labels in the sub-tabs. For the Lineup Editor, any changes you make to the column labels will also appear in the Lineup Builder's field labels. The BCGridBase node in the Configuration Tree only ever includes one view, view1. The configuration settings for a given Production Balance Analysis or Logging display or window made in view1, apply to every view created for that display. When you select view1 in BCGridBase node for a given Production Balance Analysis or Logging display, the right pane changes accordingly. An example is illustrated:
186 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
Expand the grid to show the associated subgrid (the subgrid lists the individual fields in the selected view) by clicking on the + button. The expanded grid is displayed:
In the current release of Production Balance Web, only a subset of the fields in the BCGridBase display may be configured. In this field…
Do this…
Name
This is the system name for the entry in the Production Balance Analysis or Logging display or window being configured. This field cannot be changed.
Caption
Double-click the caption name you want to change and enter the label that is to be displayed in the table grid being configured. The caption controls the column heading in the Master Data pane and the field label in the Details pane.
DataFormat
For entries with a DataType of "Double", you can configure the number of decimal places that are to be displayed for the associated values in the display or window. The data format must be entered as "f#", where # is the number of decimal places to be displayed. (For example, enter f3 to display the value with three decimal places.) Production Balance Analysis or Logging display or window entries with a data type other than double, should not be changed. NOTE: The maximum number of decimal places is six. If more than six decimals is entered in a field, the value is automatically rounded down.
The remaining fields in the BCGridBase display must not be changed. NOTE: It may be necessary to re-launch Production Balance Web in Internet Explorer before the changes can come into effect.
Production Balance Configuration Guide• 187
Part 5 – User Interface Configuration
Customize the Grid Contents (BCGridView) BCGridView is used for configuring the grid column sequences. In addition, it is used to identify which columns are to be displayed in each Production Balance Analysis and Logging displays, and in the Lineup Editor, Movement Composition and Group Operations windows. For the Production Balance Analysis and Logging displays, new views can be added to the BCGridView node in the Configuration Tree. Refer to the section Adding or Modifying a Display View for details. For the Lineup Editor, Movement Composition and Group Operations windows, the BCGridView node in the Configuration Tree only ever includes one view, view1. (You cannot add new views for the Lineup Editor, Movement Composition or Group Operations windows.) The BCGridView configuration settings for these windows are applicable in all cases. When you select a view, for example, view1, in the BCGridView node for a given Production Balance Analysis or Logging display, the right pane changes accordingly. An example of right-pane contents is displayed:
Expand the grid to show the associated subgrid (the subgrid lists the individual fields in the selected view) by clicking on the + button. The expanded grid is displayed:
188 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
In the current release of Production Balance Web, only a sub-set of the fields in the BCGridView display may be configured. In this field…
Do this…
Name
This is the system name for the entry in the Production Balance Analysis or Logging display or window being configured. This field cannot be changed.
Sequence
Double-click in this field and edit the value to change the sequence for the associated column in the grid. The grid columns are sorted numerically starting with the lowest sequence value. If the same sequence value is entered for multiple columns, the affected columns are displayed in the same order as they appear in the BCGridView table. NOTE: A value must be entered in this field.
Visibility
Check this check box to have the associated column displayed in the display or window. Clear the check box to hide the associated column.
Width
Double-click in this field to change the width (in pixels) for the associated column in the grid. NOTE: A value must be entered in this field.
The Style field in the BCGridView display must not be changed. NOTE: It may be necessary to relaunch Production Balance Web in Internet Explorer before the changes take effect. Customize the Table Page Limits (PLPageSettings) PLPageSettings is used for controlling the number of records which can be displayed in a single table page, as well as the maximum number of page links. This configuration only applies to tables in the Production Balance Analysis and Logging displays. The following is an illustration that displays the page control.
The PLPageSettings node in the Configuration Tree only ever includes one view, view1. The page settings for a given Production Balance Analysis or Logging display made in view1, applies to every view created for that display.
Production Balance Configuration Guide• 189
Part 5 – User Interface Configuration
When you select view1 in the PLPageSettings node for a given display, the right pane changes accordingly. Following is an illustration:
The following fields may be configured in the PLPageSettings display. In this field…
Do this…
MaxDisplayed Links
Double-click in this field to enter the number of page links that can be displayed below the grid. The page links are the numbers which appear below the table when it is broken down into pages. Each number represents a different page of records. If the number of pages exceeds the MaxDisplayedLinks value, the arrow controls can be used for accessing these pages.
RecordsPerPage Double-click in this field to enter the maximum number of records that can be displayed in the grid at any given time. When this number of records is exceeded, the table is broken up into pages.
NOTE: It may be necessary to re-launch Production Balance Web in Internet Explorer before the changes can come into effect. Create Custom Views Adding or Modifying a Display View
You may add new views to the Production Balance Analysis and Logging displays that can be used for customizing the table format and contents for different users. Each new view appears in the View list box for the associated display and is available to all Production Balance Analysis and Logging users at the site. Existing views may also be modified.
190 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
Follow this procedure to add a new view or modify an existing one: 1. In the Site Settings Configuration Tree navigate to the display you want to create a new view for or that includes the view you want to change (for example, Movements display). 2. Select the associated BCGridView node. An example is illustrated:
3. In the right pane, click Add to add a new view. To modify an existing view, select it in the table and click Modify. The View Configuration Editor window is displayed:
4. In the Name field, enter the name of the view you want to add.
Production Balance Configuration Guide• 191
Part 5 – User Interface Configuration
5. If you want to make this view the default view, select the Is Default View check box. 6. In the RO field, select the security that you want to apply to the configuration of this view. For example, selecting Modify enables users to modify the view in Site Settings, but not delete it; Modify_Delete enables users to modify and/or delete the view; ReadOnly prevents users from altering the configuration of the view. 7. From the Template View list, select the view that you want to use as a template for the new view. 8. Click OK. Deleting a View
To delete a view, follow these steps: 1. In the Site Settings Configuration Tree navigate to the display which includes the view you want to delete (for example, Movements tab). 2. Select the associated BCGridView node. 3. In the right pane, select the view you want to delete by clicking in the associated row. 4. Click Delete. The View Configuration Editor appears, prompting you to confirm the deletion. 5. Click OK.
Customize the Report Headers and Logo All of the standard Web and TPI reports include a common report header and subheader. Two lines are displayed in each report. The standard Web reports display both lines in the report footer, and the standard TPI reports put one line in the report header and one in the report footer. A corporate logo can also be included in the reports. NOTE: Only one report header entry is required and supported for each TPI installation.
192 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
The Report Header Configuration form in the Business FLEX TPI Plant Reference Model application is used for configuring the report headers and corporate logo. Refer to the Business FLEX TPI Plant Reference Model User Guide for details.
The following fields appear on the Report Header Configuration form. The asterisk (*) indicates mandatory fields. In this field…
Do this…
*Report Header
Enter the main header to appear on the reports.
Sub Header
Enter the secondary header to appear on the reports.
Corporate Logo
Enter the corporate logo image that is to appear on the reports. Any OLE image is supported for insert, such as Paint, PowerPoint, and Microsoft Draw. Double-click in this field to update or insert the image. The OLE application starts and the image is saved when you exit the application. NOTE: If an image file is not included here, the Honeywell logo will appear in the reports.
Create Links from the Production Balance Client to Custom Equipment and Lineup Displays Custom Equipment and Lineup Displays For those customers who want to create their own Web-based Equipment or Lineup displays, Production Balance Client can be used for launching the display from within the Production Balance Client application forms. Equipment Display
Users can launch the Equipment display for a specific node from the following forms: • Node Summary form • Transaction Summary form - Inventory grid (for inventory nodes only) • Node Balance form - Node Summary and Inventory grids (for the current node)
Production Balance Configuration Guide• 193
Part 5 – User Interface Configuration
When requested, Production Balance Client launches the user-supplied display in Internet Explorer and provides the following information: • Selected equipment name • Current case start time • Current case end time It is up to the customer to define the Equipment display contents, and to carry out tag resolution. All that is passed is the equipment name and case times. Lineup Display
Users can launch the Lineup display for a specific movement from the following forms: • Transaction Summary form - Movements grid • Node Balance form - Inputs and Outputs grids (for the movement between the current node, and the selected input source or output destination) • Missing Movements form When requested, Production Balance Client launches the user-supplied display in Internet Explorer and provides the following information: • Movement source name • Movement destination name • Current case start time • Current case end time It is up to the customer to define the Lineup display contents, and to carry out tag resolution. All that is passed is the equipment names and case times. Launch Command Configuration
The launch commands for the Equipment and Lineup displays are controlled by the following database records in the BF_LINK table in the Business FLEX database. Display
Record Contents APPL_NAME APP_ROW_ID LINKURL
LINKNAME
Equipment
PBAPP
EQUIPMENT
http://somewhere/trending/equipment.aspx? eq={EqName}&start={StartTime}&end={EndTime}
Equipment
Lineup
PBAPP
LINEUP
http://somewhere/trending/lineup.aspx? src={SrcEqName}&dst={DstEqName}& start={StartTime}&end={EndTime}
LineUp
If custom Equipment and/or Lineup displays are going to be supplied, the path and command name in the LINKURL field must be updated to suit. The specified URL is entered in the Internet Explorer Address field when the display is requested. 194 • Production Balance Configuration Guide
Part 5 – User Interface Configuration
For the Equipment display, the {EqName}, {StartTime} and {EndTime} fields are filled in automatically with the equipment name and case times for the selected node when Internet Explorer is launched. Similarly for the Lineup display, the {SrcEqName}, {DstEqName}, {StartTime} and {EndTime} fields are filled in with the equipment names and case times for the selected movement. Optionally, the LINKNAME, which defines the text which appears in the Production Balance Form shortcut menu's Launch command, may also be configured. NOTE: The data which appears in the LINKTIP and LAST_MODIFIED fields for these records is not used and can be ignored. Disabling the Equipment and Lineup Display Launch Commands
If custom Equipment and/or Lineup displays are not going to be supplied, simply null the contents of the corresponding LINKNAME field in the BF_LINK table in the Business FLEX database.
Production Balance Configuration Guide• 195
Part 5 – User Interface Configuration
This page is intentionally left blank
196 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
Appendix A – Inventory Calculation Attributes Introduction The Inventory Calculation utilities (including the Tank Calculator), supplied with Production Balance, can be used for calculating inventory equipment, volume and mass values based on data collected from the process historian and manual data supplied by the user. NOTE: The Inventory Calculation utilities only apply to Petroleum industry products. NOTE: If East Asian language characters such as Chinese are used in inventory equipment names, the Tank Calculator does not process the associated cases. Hence, do not use East Asian language characters for inventory equipment names. The calculations performed, and the associated input and output attributes, depend on the class configured for the equipment item. The following subsections list the equipment and product attributes required for each equipment class. The Inventory Calculation equipment attributes can be configured either in TPI (using the Business FLEX TPI Equipment Configuration form) or in the Configure Equipment form (in the Production Balance Client application). 7 With the exception of the CALC_INV attribute, these equipment attributes only need to be configured if the Inventory Calculation utilities are going to be used. The Inventory Calculation product attributes can be configured either in TPI (using the Business FLEX TPI Product Configuration form) or in the Configure Products form (in the Production Balance Client application).7 These attributes only need to be configured if the Inventory Calculation utilities are going to be used. If new or custom attributes are required, they must be added to the TCLCalculations.xml file stored in the Program Files\Honeywell\Amm \Tank Calculator\Bin folder on the Experion Desktop Server. They must also be configured in the Business FLEX database in the attribute definition table for the affected equipment and products. If the attributes need to be configured in the Production Balance Client application's Configure Equipment or Configure Product forms, then the IM_EQ_CONFIG_TEMPLATE,
Production Balance Configuration Guide• 197
Appendix A – Inventory Calculation Attributes
IM_EQ_CONFIG_TEMPLATE_VALUES, IM_PRDCT_CONFIG_TEMPLATE and IM_PRDCT_CFG_TEMPLATE_VALUES tables also need to be updated.
Common Equipment Attributes No matter which class of equipment you are setting up the following equipment input attributes are required. EQUIPMENT INPUT ATTRIBUTES FOR CONFIGURATION Attribute ID
Required
Description
CALC_INV
Y
Indicates whether inventory is calculated using the Inventory Calculation utilities for this equipment (TRUE) or not (FALSE).
IMEQUIPMENTCLASS
Y
Equipment class for inventory calculations. Select either: Tank
Calculates volume and mass inventory values from level measurements.
GrossVolume
Calculates volume and mass inventory values from gross observed volume measurements.
NetVolume
Calculates volume and mass inventory values from net standard volume measurements.
Mass
Calculates volume and mass inventory values from net mass measurements.
CompGrossVolume Calculates volume and mass inventory values for each component in the equipment, based on the total inventory values generated by the GrossVolume calculation and the percentage of each component in the equipment. CompNetVolume
Calculates volume and mass inventory values for each component in the equipment, based on the total inventory values generated by the NetVolume calculation and the percentage of each component in the equipment.
CompMass
Calculates volume and mass inventory values for each component in the equipment, based on the total inventory values generated by the Mass calculation and the percentage of each component in the equipment.
The equipment and product attributes for each class of inventory calculation are different. They are listed in the following sections. IMEQUIPMENTCLASS comp* is automatically associated with the equipment when set COMPEQ=true.
198 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES FOR CONFIGURATION Attribute ID
Required
Description
TCATTRPREFIX
N
Attribute ID/name prefix assigned to each equipment and product attribute associated with the inventory calculations in the Business FLEX database tables. When you configure the attributes listed in the following tables in the Business FLEX database, the prefix must appear at the beginning of each attribute name. For the Production Balance Inventory calculations, the required prefix is "IM". NOTE: This prefix does not apply to the common equipment attributes identified in this table.
VCFITNNUM
N
The maximum number of iterations that the API VCF calculations need to go through before no VCF value is found.
VCFTOL
N
Volume Correction Factor tolerance value. VCF values that are outside of the configured tolerance are considered invalid.
IMINUSE
Y
Specify Yes or no. Specify if the equipment is in use or not.
IMEXPFLAG
Y
Required for inventory records to be displayed in the Product Roll Up form.
Equipment Class – Tank For equipment that is configured with an IMEQUIPMENTCLASS of Tank, volume and mass inventory values are calculated from level measurements. NOTE: To calculate the mass and volume inventory values for each component in the equipment, the IMEQUIPMENTCLASS attribute should be set to Tank and IMCOMPEQ attribute should be set to True. Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID ADDBCKVOL
Units required Yes
Required Only required if ADDBCKMASS is to be calculated.
Description An attribute used for storing a manually entered “addback” net volume that is added to, or subtracted from, the calculated net standard volume in the equipment item. The entry of an addback volume is treated as a correction to the equipment inventory.
AMBIENTTEMP
Yes
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Ambient air temperature at the time of the measurement. Used for calculating the shell temperature.
CALCDIR
NA
Y
Calculation direction. If the value is 0, the reference density (REFDENSITY) is used as an input and the tank density (TANKDENSITY) is calculated. If it is 1, the tank density is an input and the reference density is calculated. NOTE: At present this attribute must be set to 0.
Production Balance Configuration Guide• 199
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required
Required
Description
CIRCUM1
Yes
Only required if the tank type is Spherical.
The first perpendicular circumference of the sphere.
CIRCUM2
Yes
Only required if the tank type is Spherical.
The second perpendicular circumference of the sphere.
CIRCUM3
Yes
Only required if the tank type is Spherical.
The third perpendicular circumference of the sphere.
COMPEQ
NA
Y
Indicate whether the equipment is capable of holding components. Select either: TRUE
For composition equipment
OR FALSE For non-composition equipment CRTZONEHIGH
Yes
Only required if the roof type is Floating.
The higher level of the critical zone.
CRTZONELOW
Yes
Only required if the roof type is Floating.
The lower level of the critical zone. If the level of the tank is less than the low critical level, then the floating roof adjustment volume (FRAVOL) is not calculated. If the level of the tank is between the high and low critical levels, then the floating roof adjustment volume (FRAVOL) is calculated with a lower confidence level.
FREEWATERLEV Yes EL
Y
Free water level. This is the water level at the bottom of the equipment.
GRVADJCNST1
Only required if the roof type is Floating.
A correction factor used in the calculation of the floating roof adjustment volume (FRAVOL) when ROOFWTSTRP = RoofAPI and when the tank density is greater than the density at which the strapping table was measured (that is, TANKDENSITY > STRPGRV).
Yes
This attribute specifies the adjusted volume for gravities per degree change below STRPGRV. This quantity would be a positive value when the density is less than the reference density. This constant is measured in volume/density units. The two possible units are bbl/API or m3/kg/m3. If bbl/API is given then the calculations must be done in API. If the SI unit is given then the calculations can be done in SI. In the unit field, select either: API - If the value is measured in bbl/API. kg/m3 - If the value is measured in m3/kg/m3. GRVADJCNST2
Yes
Only required if the roof type is Floating.
200 • Production Balance Configuration Guide
A correction factor used in the calculation of the floating roof adjustment volume (FRAVOL) when ROOFWTSTRP = RoofAPI and when the tank density is less than the density at which the strapping table was measured (that is,
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required
Required
Description TANKDENSITY < STRPGRV). This attribute specifies the adjusted volume for gravities per degree change above STRPGRV. This quantity would be a negative value when the density is greater than the reference density. As with GRVADJCNST1, this constant must be measured in volume/density units. In the unit field, select either: API - If the value is measured in bbl/API. kg/m3 - If the value is measured in m3/kg/m3. NOTE: GRVADJCNST1 = GRVADJCNST2 for some refineries
HIGHLEVEL
Yes
Y
Maximum safe operating level.
INSULSHL
NA
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Indicates whether the equipment shell is insulated.
INVCALCMTHD
NA
Not required for nonpressurized tanks.
Based on this attribute value, it is decided as to which volume or mass is reported as measured inventory for pressurized tanks.
The attribute configuration value is used only in case of pressurized tanks. Even in case of pressurized tanks, this attribute configuration is not mandatory for volume or mass balance group.
For volume balance groups, the recommended values for this attribute are TOTALSTDVOL or NETSTDVOL. If it is not configured, TOTALSTDVOL is reported as default measured inventory for pressurized tanks. For mass balance groups, the recommended values are TOTALMASS or NETMASS. If it is not configured, TOTALMASS is reported as default measured inventory for pressurized tanks.
But, for other balance Other than mass or volume balance groups, groups, it is mandatory based on the attribute configuration, the measured to configure even for inventory is reported. non-pressurized tanks. LEVEL
Yes
Y
Level of the liquid in the equipment.
LEVELCALCTYPE NA
Y
Level calculation type. If set to 1 then spherical tank calculations need to be performed. If any other value is set, strapping tables must be used for level to volume conversion.
LEVELTYPE
Y
Tank level type. Select either: Outage or Innage.
NA
Indicates whether an innage or outage measurement was used for the level measurement. It is used with the strap type to make sure both readings are the same when the volume calculation is done. LOWLEVEL
Yes
Y
Minimum safe operating level.
Production Balance Configuration Guide• 201
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required
Required
Description
MAXTEMP
Yes
Y
Maximum design temperature for the equipment. TANKTEMP value is validated by checking whether its value is lesser than MAXTEMP value. If it is not lesser, then confidence of TANKTEMP is set to lower than 50% and input confidence level of TANKTEMP.
MINCAP
Yes
Y
Tank heel. Used for calculating the available volume in the tank — the volume between the minimum capacity and the total observed volume.
MINTEMP
Yes
Y
Minimum design temperature for the equipment. TANKTEMP value is validated by checking whether its value is higher than MINTEMP value. If it is not higher, then confidence of TANKTEMP is set to lower than 50% and input confidence level of TANKTEMP.
MTRLCONST
NA
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Tank shell material. Select either: LowCarbon, MildCarbon, 304Stainless, 316Stainless or 17-4PHStainless. Follow the specified combination: For Horizontal or Vertical: MildCarbon/316stainless/304Stainless/17 4PHStainless For Spherical: Low Carbon For Bullet: Mild Carbon.
PCTSW
NA
Y
Percentage of sediment and water suspended in the product.
PRESSTANK
NA
Y
Indicates whether the equipment is pressurized (TRUE) or not (FALSE).
PRESSURE
Yes
Only required if the equipment is pressurized (PRESSTANK = TRUE).
Tank pressure. If no value is given, the pressure at equilibrium value (PRESSUREEQ) is used and a warning message is generated.
PRODUCTCODE
NA
Y
Product code. Used for getting the correct values from the IP_PRDCT_ATTR table for APITABLE, ALPHA, AROMNAME and MW.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
REFGAUGEHGHT Yes
Y
Reference gauge height. The vertical distance between the reference point on the gauge and the striking point on the tank floor. Usually supplied with the strapping table information. Used for outage/innage level transformation calculations.
REFTEMP
Yes
Y
202 • Production Balance Configuration Guide
Reference temperature. Select either: 68F, 60F, 20C or 15C.
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required
Required
Description
ROOFTYPE
NA
Y
Tank roof type. Select either: Floating or Fixed.
ROOFWEIGHT
Yes
Only required if the roof type is Floating.
Roof weight. Used for calculating the floating roof adjustment volume.
ROOFWTSTRP
NA
Only required if the roof type is Floating.
Roof weight in strapping table and calculation type indicator. Select either: NoRoof - Used if roof weight is not included in the strapping table measurements. RoofAPI - Used if the roof weight is included in the strapping table measurements and the API calculation method is used. RoofTech - Indicates that the technical calculation method is to be used. Leave this field blank, if the roof type is Fixed.
SHLCRCTN
NA
Y
Shell correction factor calculation indicator. If the value is TRUE, the shell temperature is calculated. If the value is FALSE, the shell temperature is not calculated and the shell temperature correction (CORRTEMPSHELL) is set to 1.
STRAPLEVELUNI T
Yes
Y
Length unit for the strapping table level measurements. If a unit is supplied, it is used for converting the level measurement to the correct unit when calculating volume.
STRAPMEASTEM Yes P
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Temperature at which the strapping table measurements were made.
STRAPOFFSET
Yes
Y
A bias for strapping table level. The strap offset value is subtracted from the tank level after converting the level to the strap level units.
STRAPSRCID
NA
Y
Name of the strapping table or 1d correlation table. Enter the name of the function in the IP_CORRLTN_TBL table which contains the tank strapping table data.
STRAPTYPE
NA
Y
Strap type. Select either: Outage or Innage. Indicates whether the strapping table readings were done on an innage or an outage basis. It is used with the level type to make sure both readings are the same when the volume calculation is done.
STRAPVOLUNIT
Yes
Y
Volume unit for the strapping table volume measurements. If a unit is supplied, it is used for converting the calculated volume to the correct unit for output.
Production Balance Configuration Guide• 203
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required
Required
Description
STRPGRV
Yes
Y
The density at which the strapping table was measured.
TANKCAP
Yes
Y
The total capacity of liquid allowed in the equipment.
TANKTEMP
Yes
Y
Tank temperature.
TANKTYPE
NA
Y
Tank type. Select either: Bullet, Horizontal, Spherical or Vertical.
USECALCGRV
NA
Only required for composition equipment (COMPEQ=TRUE).
Indicate whether the density must be backcalculated from the component densities for composition equipment (TRUE) or not (FALSE). If this attribute is set to FALSE for composition equipment, the equipment density is propagated to all the components.
VAPORTEMP
Yes
Only required if the equipment is pressurized (PRESSTANK = TRUE).
Vapor temperature. Used for calculating the vapor density in pressurized equipment only.
VCFCRCTN
NA
Y
Volume Correction Factor calculation indicator. A value of FALSE causes VCF (VCF) to be set to 1.0.
VERTHEIGHT
Yes
Only required if the tank type is Spherical.
Vertical height of the sphere.
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required Required
Description
ADDBCKMASS
No
N
Addback net mass calculated from the manually entered addback volume.
AVAILCAP
No
N
Available capacity. The volume between the high volume and the total observed volume.
AVAILROOM
No
N
Available room. The volume between the total observed volume and the tank capacity.
AVAILVOL
No
N
Available volume. The volume between the minimum capacity and the total observed volume.
BSWVOL
No
N
Volume of the suspended sediment and water, plus the water volume at the bottom of the equipment.
COMPDENSITY
No
Only calculated for composition equipment when USECALCGRV = TRUE.
Density calculated from the individual component densities in the equipment.
204 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required Required
Description
COMPRESSFACTOR
No
Compressibility factor. Only calculated if the following conditions are met:
CORRPRESSURE
No
Only applies to pressurized equipment (PRESSTANK = TRUE).
Only applies to pressurized equipment (PRESSTANK = TRUE).
•
The equipment is pressurized (PRESSTANK = TRUE).
•
The equipment is filled to 100%.
•
The pressure at equilibrium is less than the tank pressure.
Pressure correction for the equipment. Only calculated if the following conditions are met: •
The equipment is pressurized (PRESSTANK = TRUE).
•
The equipment is filled to 100%.
•
The pressure at equilibrium is less than the tank pressure.
CORRSW
No
N
Corrected sediment and water factor. This value accounts for the percent sediment and water, suspended in the oil. It is used in the net standard volume calculation.
CORRTEMPSHELL
No
Only calculated if SHLCRCTN = TRUE.
Shell temperature correction. This calculation is based on the product in the equipment and the shell temperature.
FRAVOL
No
N
Floating roof adjustment volume. The volume correction due to the mass of the floating roof. This value is 0, if the roof type is Fixed.
FREEWATERVOL
No
N
Free water volume. This value is calculated from the free water level using the strapping table. If the free water level is 0, the free water volume is 0.
GROSSMASS
No
N
Gross mass of the product in the equipment.
GROSSOBSVOL
No
N
Gross observed volume. This is a calculated volume value that takes the tank temperature correction, floating roof volume adjustment and pressure volume correction into account (if applicable). In addition, the volume of free water is removed.
GROSSSTDVOL
No
N
Gross standard volume. The gross observed volume corrected to standard conditions.
HIGHVOL
No
N
High volume. This value is calculated from the high level using the strapping table.
Production Balance Configuration Guide• 205
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required Required
Description
LOWVOL
No
N
Low volume. This value is calculated from the low level using the strapping table.
NETACCTNGMASS
No
N
Net accounting mass. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume. This value is the total of the net standard volume and the addback volume.
NETMASS
No
N
Net mass of the product in the equipment.
NETSTDVOL
No
N
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
PRESSUREEQ
No
Only calculated if the equipment is pressurized.
Pressure at equilibrium. Used in the pressure correction calculation.
PUMPVOL
No
N
Pumpable volume. The volume between the low volume and the total observed volume.
SHELLTEMP
No
Only calculated if SHLCRCTN is TRUE.
Shell temperature. This calculation is based on the product in the equipment and the equipment insulation.
SPHERECONST1
No
Only applies to spherical tanks.
Sphere constant.
SPHERECONST2
No
Only applies to spherical tanks.
Sphere constant.
SWVOL
No
N
Volume of the sediment and water. The difference between the gross standard volume and the net standard volume.
TANKDENSITY
No
N
Tank density at observed or tank temperature.
TOTALCALCVOL
No
N
Total calculated volume of the product in the equipment.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. NOTE: Total Mass = Net Mass (NETMASS), if the equipment is not pressurized (PRESSTANK = FALSE).
TOTALOBSVOL
No
206 • Production Balance Configuration Guide
N
Total observed volume. This value is calculated from the level using the strapping tables.
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = Tank) Attribute ID
Units required Required
Description
TOTALSTDVOL
No
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL).
N
NOTE: Total Standard Volume = Net Standard Volume (NETSTDVOL), if the equipment is not pressurized (PRESSTANK = FALSE). TOTALVOL
No
Only applies to spherical tanks.
Total volume calculated for the spherical level to volume calculations.
VAPORDENSITY
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Vapor density. Used for calculating the vapor mass.
VAPORLIQVOL
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Liquid volume equivalent to the vapor in the tank.
VAPORMASS
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Vapor mass.
VAPORVOL
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Vapor volume in the equipment.
VCF
No
N
Volume Correction Factor value.
NOTE: You can configure the units for the output Equipment attributes if required. Product Attributes Attribute
Units required
Required
Description
ALPHA
No
Only required if the product's API Table (APITABLE) = C.
Temperature value (in DegC or DegF) for use in the special products table (API Table C). For example, MTBE uses the specified alpha value instead of the k0, k1, k2 values. The alpha unit is 1/DegF or 1/DegC.
APITABLE
No
Y
API Table identification. Used for determining the VCF calculation method for the product. Select either: A, B, C, D, E, D1555, D1550 or D4311. NOTE: If you want to use the API table version 2004, specify A2004, B2004, C2004, D2004, E2004, D155504, and D431104 instead of A, B, C, D, E, D1555, and D4311 respectively.
Production Balance Configuration Guide• 207
Appendix A – Inventory Calculation Attributes
Attribute
Units required
Required
Description
AROMNAME
No
Only required if the product’s API table (APITABLE) = D1555 or D155504.
Aromatic name. Used for calculating the VCF for API Table D1555 and D155504. Select either: benzene, toluene, m_xylene, styrene, o_xylene, p_xylene, cyclohexane, ethylbenzene, cumene, 300 Arom or 400 Arom.
DENSITYDFLT
Yes
Only required for composition equipment (COMPEQ=TRUE)
Default density for the product. Used when COMPEQ is set to TRUE and PRDCTDENSITY is not configured or null.
DENSITYHI
Yes
N
High density limit for the product. For information only.
DENSITYLO
Yes
N
Low density limit for the product. For information only.
MW
No
Only required if the equipment Molecular weight of the product. Used for where the product is stored is calculating the vapor density in pressurized pressurized (PRESSTANK = equipment only. TRUE).
PRDCTDENSITY Yes
Only required for composition equipment (COMPEQ=TRUE)
Density of each component in the equipment. These values are used for calculating the overall density of the material in the equipment if USECALCGRV=TRUE. If USECALCGRV=FALSE, the equipment density is propagated to all the components.
Equipment Class – Gross Volume For equipment that is configured with an IMEQUIPMENTCLASS of GrossVolume, volume and mass inventory values are calculated from gross observed volume measurements. NOTE: To calculate the mass and volume inventory values for each component in the equipment, the IMEQUIPMENTCLASS attribute should be set to GrossVolume and IMCOMPEQ attribute should be set to True. Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = GrossVolume) Attribute ID
Units required
Required
Description
ADDBCKVOL
Yes
Only required if ADDBCKMASS is to be calculated.
An attribute used for storing a manually entered “addback” net volume that is added to, or subtracted from, the calculated net standard volume in the equipment item. The entry of an addback volume is treated as a correction to the equipment inventory.
208 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = GrossVolume) Attribute ID
Units required
Required
Description
CALCDIR
NA
Y
Calculation direction. If the value is 0, the reference density (REFDENSITY) is used as an input and the tank density (TANKDENSITY) is calculated. If it is 1, the tank density is an input and the reference density is calculated. NOTE: At present this attribute must be set to 0.
COMPEQ
NA
Y
Indicate whether the equipment is capable of holding components. Select either: TRUE
For composition equipment
FALSE For non-composition equipment GROSSOBSVOL
Yes
Y
Gross observed volume. This is a calculated volume value that takes the tank temperature correction, floating roof volume adjustment and pressure volume correction into account (if applicable). The volume of free water is also removed.
MAXTEMP
Yes
Y
Maximum design temperature for the equipment. TANKTEMP value is validated by checking whether its value is lesser than MAXTEMP value. If it is not lesser, then confidence of TANKTEMP is set to lower than 50% and input confidence level of TANKTEMP.
MINTEMP
Yes
Y
Minimum design temperature for the equipment. TANKTEMP value is validated by checking whether its value is higher than MINTEMP value. If it is not higher, then confidence of TANKTEMP is set to lower than 50% and input confidence level of TANKTEMP.
PCTSW
NA
Y
Percentage of sediment and water suspended in the product.
PRODUCTCODE
NA
Y
Product code. Used for getting the correct values from the IP_PRDCT_ATTR table for APITABLE and ALPHA.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
REFTEMP
Yes
Y
Reference temperature. Select either: 68F, 60F, 20C or 15C.
TANKTEMP
Yes
Y
Tank temperature.
USECALCGRV
NA
Only required for composition equipment (COMPEQ=TRUE).
Indicate whether the density must be backcalculated from the component densities for composition equipment (TRUE) or not (FALSE). If this attribute is set to FALSE for composition equipment, the equipment density is propagated to all the components.
VCFCRCTN
NA
Y
Volume Correction Factor calculation indicator. A value of FALSE causes VCF (VCF) to be set to 1.0.
Production Balance Configuration Guide• 209
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = GrossVolume) Attribute ID
Units required
Required
Description
ADDBCKMASS
No
N
Addback net mass calculated from the manually entered addback volume.
BSWVOL
No
N
Volume of the suspended sediment and water, plus the water volume at the bottom of the equipment.
COMPDENSITY
No
Only calculated for composition equipment when USECALCGRV = TRUE.
Density calculated from the individual component densities in the equipment.
CORRSW
No
N
Corrected sediment and water factor. This value accounts for the percent sediment and water, suspended in the oil. It is used in the net standard volume calculation.
FREEWATERVOL
No
N
Free water volume. This value is calculated from the free water level using the strapping table. If the free water level is 0, the free water volume is 0.
GROSSSTDVOL
No
N
Gross standard volume. The gross observed volume corrected to standard conditions.
NETACCTNGMASS
No
N
Net accounting mass. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume. This value is the total of the net standard volume and the addback volume.
NETMASS
No
N
Net mass of the product in the equipment.
NETSTDVOL
No
N
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
SWVOL
No
N
Volume of the sediment and water. The difference between the gross standard volume and the net standard volume.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. For this equipment class it is the same as the Net Mass.
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). For this equipment class it is the same as the Net Standard Volume (NETSTDVOL).
VCF
No
N
Volume Correction Factor value.
NOTE: You can configure the units for the output Equipment attributes if required.
210 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
Product Attributes PRODUCT INPUT ATTRIBUTES (EquipmentClass = GrossVolume) Attribute
Units required
Required
Description
ALPHA
No
Only required if the product's API Table (APITABLE) = C.
Temperature value (in DegC or DegF) for use in the special products table (API Table C). For example, MTBE uses the specified alpha value instead of the k0, k1, k2 values. The alpha unit is 1/DegF or 1/DegC.
APITABLE
No
Y
API Table identification. Used for determining the VCF calculation method for the product. Select either: A, B, C, D, E, D1555, D1550 or D4311. NOTE: If you want to use the API table version 2004, specify A2004, B2004, C2004, D2004, E2004, D155504, and D431104 instead of A, B, C, D, E, D1555, and D4311 respectively
AROMNAME
No
Only required if the product's API Table (APITABLE) = D1555 or D155504.
Aromatic name. Used for calculating the VCF for API Table D1555 and D155504. Select either: benzene, toluene, m_xylene, styrene, o_xylene, p_xylene, cyclohexane, ethylbenzene, cumene, 300Arom or 400Arom.
DENSITYDFLT
Yes
Only required for composition equipment (COMPEQ=TRUE)
Default density for the product. Used when COMPEQ is set to TRUE and PRDCTDENSITY is not configured or null.
DENSITYHI
Yes
Y
High density limit for the product. For information only.
DENSITYLO
Yes
Y
Low density limit for the product. For information only.
MW
No
Only required if the Molecular weight of the product. Used for equipment where the calculating the vapor density in the product is stored is pressurized equipment only. pressurized (PRESSTANK=TRU E).
PRDCTDENSITY
Yes
Only required for composition equipment (COMPEQ=TRUE).
Density of each component in the equipment. These values are used for calculating the overall density of the material in the equipment if USECALCGRV=TRUE. If USECALCGRV=FALSE, the equipment density is propagated to all the components.
Production Balance Configuration Guide• 211
Appendix A – Inventory Calculation Attributes
Equipment Class – Net Volume For equipment that is configured with an IMEQUIPMENTCLASS of NetVolume, volume and mass inventory values are calculated from net standard volume measurements. NOTE: To calculate the mass and volume inventory values for each component in the equipment, the attribute should be set to NetVolume and IMCOMPEQ attribute should be set to True.
IMEQUIPMENTCLASS
Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = NetVolume) Attribute ID
Units required
Required
Description
ADDBCKVOL
Yes
Only required if An attribute used for storing a manually entered ADDBCKMASS is to “addback” net volume that is added to, or be calculated. subtracted from, the calculated net standard volume in the equipment item. The entry of an addback volume is treated as a correction to the equipment inventory.
COMPEQ
NA
Y
Indicate whether the equipment is capable of holding components. Select either: TRUE
For composition equipment
FALSE For non-composition equipment NETSTDVOL
Yes
Y
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
USECALCGRV
NA
Only required for composition equipment (COMPEQ=TRUE).
Indicate whether the density must be backcalculated from the component densities for the composition equipment (TRUE) or not (FALSE). If this attribute is set to FALSE for composition equipment, the equipment density is propagated to all the components.
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = NetVolume) Attribute ID
Units required
Required
Description
ADDBCKMASS
No
N
Addback net mass calculated from the manually entered addback volume.
COMPDENSITY
No
Only calculated for composition equipment when USECALCGRV = TRUE.
Density calculated from the individual component densities in the equipment.
NETACCTNGMASS
No
N
Net accounting mass. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume. This value is the total of the net standard volume and the addback volume.
Production Balance Configuration Guide• 213
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = NetVolume) Attribute ID
Units required
Required
Description
NETMASS
No
N
Net mass of the product in the equipment.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. For this equipment class it is the same as the Net Mass.
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). For this equipment class it is the same as the Net Standard Volume (NETSTDVOL).
NOTE: You can configure the units for the output Equipment attributes if required Product Attributes PRODUCT INPUT ATTRIBUTES (EquipmentClass = NetVolume) Attribute
Units Required required
Description
DENSITYDFLT
Yes
Only required for composition equipment (COMPEQ=TRUE).
Default density for the product. Used when COMPEQ is set to TRUE and PRDCTDENSITY is not configured or null.
DENSITYHI
Yes
N
High density limit for the product. For information only.
DENSITYLO
Yes
N
Low density limit for the product. For information only.
PRDCTDENSITY
Yes
Only required for composition equipment (COMPEQ=TRUE)
Density of each component in the equipment. These values are used for calculating the overall density of the material in the equipment if USECALCGRV = TRUE. If USECALCGRV = FALSE, the equipment density is propagated to all the components
214 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
Equipment Class – Mass For equipment that is configured with an IMEQUIPMENTCLASS of Mass, volume and mass inventory values are calculated from net mass measurements. NOTE: To calculate the mass and volume inventory values for each component in the equipment, the attribute should be set to Mass and IMCOMPEQ attribute should be set to True.
IMEQUIPMENTCLASS
Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = Mass) Attribute ID
Units required
Required
Description
ADDBCKMASS
Yes
Only required if ADDBCKVOL is to be calculated.
An attribute used for storing a manually entered “addback” net mass that is added to, or subtracted from, the calculated net mass in the equipment item.
COMPEQ
NA
Y
Indicate whether the equipment is capable of holding components. Select either: TRUE
For composition equipment
FALSE For non-composition equipment NETMASS
Yes
Y
Net mass of the product in the equipment.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
USECALCGRV
NA
Only required for composition equipment (COMPEQ=TRU E).
Indicate whether the density must be backcalculated from the component densities for the composition equipment (TRUE) or not (FALSE). If this attribute is set to FALSE for composition equipment, the equipment density is propagated to all the components.
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = Mass) Attribute ID
Units required
Required
Description
ADDBCKVOL
No
N
Addback net volume calculated from the manually entered addback mass.
COMPDENSITY
No
Only calculated Density calculated from the individual component for composition densities in the equipment. equipment when USECALCGRV = TRUE.
NETACCTNGMASS
No
N
Net accounting mass. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume. This value is the total of the net standard volume and the addback volume.
NETSTDVOL
No
N
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. For this equipment class it is the same as the Net Mass.
Production Balance Configuration Guide• 215
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = Mass) Attribute ID
Units required
Required
Description
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). For this equipment class it is the same as the Net Standard Volume (NETSTDVOL).
NOTE: You can configure the units for the output Equipment attributes if required Product Attributes Attribute ID
Units required
Required
Description
DENSITYDFLT
Yes
Only required for composition equipment. (COMPEQ=TRUE)
Default density for the product. Used when COMPEQ is set to TRUE and PRDCTDENSITY is not configured or null.
DENSITYHI
Yes
Y
High density limit for the product. For information only.
DENSITYLO
Yes
Y
Low density limit for the product. For information only.
PRDCTDENSITY
Yes
Only required for composition equipment (COMPEQ=TRUE).
Density of each component in the equipment. These values are used for calculating the overall density of the material in the equipment if USECALCGRV = TRUE. If USECALCGRV = FALSE, the equipment density is propagated to all of the components.
Equipment Class – Composition Gross Volume For equipment that is configured with an IMEQUIPMENTCLASS of CompGrossVolume and with COMPEQ set to YES, volume and mass inventory values are calculated for each component in the equipment, based on the total inventory values generated by the GrossVolume calculation and the percentage of each component in the equipment. For this equipment class, all of the equipment and product attributes identified for the Equipment Class – Gross Volume are required in addition to the attributes listed. When a Composition Gross Volume calculation is performed the equipment and product attributes listed are generated for every component in the equipment. Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = CompGrossVolume) Attribute ID
Units required
Required
ADDBCKVOL
Yes
Only required if An attribute used for storing a manually entered ADDBCKMASS is to “addback” net volume for the component that is be calculated. added to, or subtracted from, the calculated net standard volume in the equipment item. The entry of an addback volume is treated as a correction to the equipment inventory.
216 • Production Balance Configuration Guide
Description
Appendix A – Inventory Calculation Attributes
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = CompGrossVolume) Attribute ID
Units required
Required
Description
CALCDIR
NA
Y
Calculation direction. If the value is 0, the reference density (REFDENSITY) is used as an input and the tank density (TANKDENSITY) is calculated. If it is 1, the tank density is an input and the reference density is calculated. NOTE: At present this attribute must be set to 0.
CORRSW
Yes
Y
Corrected sediment and water factor for each component. This value accounts for the percent sediment and water, suspended in the oil. It is used in the net standard volume calculation.
PRODUCTCODE
NA
Y
Product code. Used for getting the correct values from the IP_PRDCT_ATTR table for APITABLE and ALPHA.
REFDENSITY
Yes
Y
The density of the liquid component in the equipment at the reference temperature.
REFTEMP
Yes
Y
Reference temperature. Select either: 68F, 60F, 20C or 15C.
TANKTEMP
Yes
Y
Tank temperature.
VCFCRCTN
NA
Y
Volume Correction Factor calculation indicator. A value of FALSE causes VCF (VCF) to be set to 1.0.
GROSSOBSVOL
Yes
Y
Gross observed volume for the component. This is a calculated volume value that takes the tank temperature correction, floating roof volume adjustment and pressure volume correction into account (if applicable). In addition, the volume of free water is removed.
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = CompGrossVolume) Attribute ID
Units Required Description required
ADDBCKMASS
No
N
Addback net mass calculated from the manually entered addback volume for the component.
GROSSSTDVOL
No
N
Gross standard volume for the component. The gross observed volume corrected to standard conditions.
NETACCTNGMASS
No
N
Net accounting mass for the component. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume for the component. This value is the total of the net standard volume and the addback volume.
NETMASS
No
N
Net mass of the component in the equipment.
NETSTDVOL
No
N
Net standard volume for the component. The gross standard volume corrected for the suspended sediment and water.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment for the component. For this equipment class it is the same as the Net Mass.
Production Balance Configuration Guide• 217
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = CompGrossVolume) Attribute ID
Units Required Description required
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). For this equipment class it is the same as the Net Standard Volume (NETSTDVOL).
VCF
No
N
Volume Correction Factor value.
NOTE: You can configure the units for the output Equipment attributes if required Product Attributes Attribute
Units required
Required
Description
ALPHA
No
Only required if the product's API Table (APITABLE) = C.
Temperature value (in DegC or DegF) for use in the special products table (API Table C). For example, MTBE uses the specified alpha value instead of the k0, k1, k2 values. The alpha unit is 1/DegF or 1/DegC.
APITABLE
No
Y
API Table identification. Used for determining the VCF calculation method for the product. Select either: A, B, C, D, E, D1555, D1550 or D4311. NOTE: If you want to use the API table version 2004, specify A2004, B2004, C2004, D2004, E2004, D155504, and D431104 instead of A, B, C, D, E, D1555, and D4311 respectively
AROMNAME
No
Only required if the product's API Table (APITABLE) = D1555 or D155504.
Aromatic name. Used for calculating the VCF for API Table D1555 or D155504. Select either: benzene, toluene, m_xylene, styrene, o_xylene, p_xylene, cyclohexane, ethylbenzene, cumene, 300Arom or 400Arom.
DENSITYDFLT
Yes
Only required for Default density for the product. Used when composition equipment COMPEQ is set to TRUE and PRDCTDENSITY is (COMPEQ=TRUE). not configured or null.
DENSITYHI
Yes
Y
High density limit for the product. For information only.
DENSITYLO
Yes
Y
Low density limit for the product. For information only.
MW
No
Only required if the Molecular weight of the product. Used for calculating equipment where the the vapor density in pressurized equipment only. product is stored is pressurized (PRESSTANK=TRUE).
PRDCTDENSITY
Yes
Only required for Density of each component in the equipment. These composition equipment values are used for calculating the overall density of (COMPEQ=TRUE). the material in the equipment if USECALCGRV = TRUE. If USECALCGRV = FALSE, the equipment density is propagated to all the components.
218 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
Equipment Class – Composition Net Volume For equipment that is configured with an IMEQUIPMENTCLASS of CompNetVolume and with COMPEQ set to YES, volume and mass inventory values are calculated for each component in the equipment, based on the total inventory values generated by the NetVolume calculation and the percentage of each component in the equipment. For this equipment class, all of the equipment and product attributes identified for the Equipment Class – Net Volume are required in addition to the attributes listed. When a Composition Net Volume calculation is performed the equipment and product attributes listed are generated for every component in the equipment. Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = CompNetVolume) Attribute ID
Units required
Required
Description
ADDBCKVOL
Yes
Only required if ADDBCKMASS is to be calculated.
An attribute used for storing a manually entered “addback” net volume for the component that is added to, or subtracted from, the calculated net standard volume in the equipment item.
PRODUCTCODE
NA
Y
Product code. Used for getting the correct values from the IP_PRDCT_ATTR table for APITABLE, ALPHA and MW.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = CompNetVolume) Attribute ID
Units required
Required
Description
ADDBCKMASS
No
N
Addback net mass calculated from the manually entered addback volume.
NETACCTNGMASS
No
N
Net accounting mass. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume. This value is the total of the net standard volume and the addback volume.
NETMASS
No
N
Net mass of the product in the equipment.
NETSTDVOL
No
N
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. For this equipment class it is the same as the Net Mass.
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). For this equipment class it is the same as the Net Standard Volume (NETSTDVOL).
Production Balance Configuration Guide• 219
Appendix A – Inventory Calculation Attributes
NOTE: You can configure the units for the output Equipment attributes if required Product Attributes PRODUCT INPUT ATTRIBUTES (EquipmentClass = CompNetVolume) Attribute
Units required
Required
Description
DENSITYDFLT
Yes
Only required for composition equipment. (COMPEQ=TRUE)
Default density for the product. Used when COMPEQ is set to TRUE and PRDCTDENSITY is not configured or null.
DENSITYHI
Yes
Y
High density limit for the product. For information only.
DENSITYLO
Yes
Y
Low density limit for the product. For information only.
PRDCTDENSITY
Yes
Only required for composition equipment (COMPEQ=TRUE).
Density of each component in the equipment. These values are used for calculating the overall density of the material in the equipment if USECALCGRV = TRUE. If USECALCGRV = FALSE, the equipment density is propagated to all of the components.
Equipment Class – Composition Mass For equipment that is configured with an IMEQUIPMENTCLASS of CompMass and with COMPEQ set to YES, volume and mass inventory values are calculated for each component in the equipment, based on the total inventory values generated by the Mass calculation and the percentage of each component in the equipment. For this equipment class, all of the equipment and product attributes identified for the Equipment Class – Mass are required in addition to the attributes listed. When a Composition Mass calculation is performed the equipment and product attributes listed are generated for every component in the equipment. Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = CompMass) Attribute ID
Units required
Required
Description
ADDBCKMASS
Yes
Only required if ADDBCKVOL is to be calculated.
An attribute used for storing a manually entered “addback” net mass for the component that is added to, or subtracted from, the calculated net mass in the equipment item.
PRODUCTCODE
NA
Y
Product code. Used for getting the correct values from the IP_PRDCT_ATTR table for APITABLE, ALPHA and MW.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
NETMASS
No
N
Net mass of the product in the equipment.
220 • Production Balance Configuration Guide
Appendix A – Inventory Calculation Attributes
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = CompMass) Attribute ID
Units required
Required
Description
ADDBCKVOL
No
N
Addback net volume calculated from the manually entered addback mass.
NETACCTNGMASS
No
N
Net accounting mass. This value is the total of the net mass and the addback mass.
NETACCTNGVOL
No
N
Net accounting volume. This value is the total of the net standard volume and the addback volume.
NETSTDVOL
No
N
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. For this equipment class it is the same as the Net Mass.
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). For this equipment class it is the same as the Net Standard Volume (NETSTDVOL).
NOTE: You can configure the units for the output Equipment attributes if required Product Attributes Attribute ID
Units
Required
Description
DENSITYDFLT
Yes
Only required for composition equipment (COMPEQ=TRUE).
Default density for the product. Used when COMPEQ is set to TRUE and PRDCTDENSITY is not configured or null.
DENSITYHI
Yes
Y
High density limit for the product. For information only.
DENSITYLO
Yes
Y
Low density limit for the product. For information only.
PRDCTDENSITY
Yes
Only required for composition equipment (COMPEQ = TRUE).
Density of each component in the equipment. These values are used for calculating the overall density of the material in the equipment if USECALCGRV = TRUE. If USECALCGRV = FALSE, the equipment density is propagated to all the components.
Production Balance Configuration Guide• 221
Appendix A – Inventory Calculation Attributes
This page is intentionally left blank
222 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
Appendix B – Tank Calculator extension for Japanese standards Introduction The Tank Calculator utility supplied with Production Balance can also be used for calculating inventories according to Japanese standards. These standards are derived specific to Japanese sites. NOTE: The Japanese standard for equipment is done by assigning the equipment class attribute value as ‘JTANK’. This equipment class is an extension of standard equipment class ‘TANK’ in terms of attributes configuration and calculations. Some of the attributes required to configure ‘JTANK’ equipment class are already part of the ‘TANK’ equipment class, with only a few more attributes required for ‘JTANK’. The equipment class should be mentioned as ‘JTANK’ only if the Japanese standards are required. Otherwise, the equipment class ‘TANK’ is enough to perform the standard inventory calculations. Following subsections list the equipment and product attributes required for ‘JTANK’ equipment class. The inventory calculation equipment attributes can be configured either in TPI (using the Business FLEX TPI Equipment Configuration Form) or in the Configure Equipment Form (in the Production Balance Client application). With the exception of the CALC_INV attribute, this equipment attributes needs to be configured only if the Inventory Calculation utilities are to be used. The inventory calculation product attributes can be configured either in TPI (using the Business FLEX TPI Product Configuration Form) or in the Configure Products Form (in the Production Balance Client application). These attributes need to be configured only if the Inventory Calculation utilities are to be used. If new or custom attributes are required, they must be added to the TCLCalculations.xml file stored in the Program Files\Honeywell\Amm\Tank Calculator\Bin folder located on the Experion Desktop Server machine or Business FLEX Application server machine. They must also be configured in the Business FLEX database in the attribute definition table for the affected equipment and products. If the attribute needs to be configured in the Production Balance Client application’s Configure Equipment or Configure Product Forms, then the IM_EQ_CONFIG_TEMPLATE, IM_EQ_CONFIG_TEMPLATE_VALUES, IM_PRDCT_CONFIG_TEMPLATE, and IM_PRDCT_CFG_TEMPLATE_VALUES tables also need to be updated.
Production Balance Configuration Guide• 223
Appendix B – Tank Calculator extension for Japanese standards
Common Equipment Attributes Attribute ID
Required
Description
CALC_INV
Y
Indicates whether inventory is calculated using the Inventory Calculation utilities for this equipment (TRUE) or not (FALSE).
IMEQUIPMENTCLASS
Y
Equipment class for inventory calculations. Configure it as: JTANK – Calculates volume and mass inventory values from level measurement as per Japanese standards.
TCATTRPREFIX
N
Attribute ID/name prefix assigned to the equipment and product attribute associated with the inventory calculations in the Business FLEX database tables. When you configure the attributes listed in the following tables in the Business FLEX database, the prefix must appear at the beginning of each attribute name. For the Production Balance Inventory calculations, the required prefix is "IM". NOTE: This prefix does not apply to the common equipment attributes identified in this table.
VCFITNNUM
N
The maximum number of iterations that the API VCF calculations need to go through before no VCF value is found.
VCFTOL
N
Volume Correction Factor tolerance value. VCF values that are outside the configured tolerance are considered invalid.
IMINUSE
Y
Specify Yes or No. Specify if the equipment is in use or not.
IMEXPFLAG
Y
Specify Yes or No. Required for inventory records to be displayed in the Product Roll up Form.
Equipment Class – JTANK For equipment that is configured with an IMEQUIPMENTCLASS of JTANK, volume and mass inventory values are calculated from level measurements. Equipment Attributes EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
AMBIENTTEMP
Yes
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE)
Ambient air temperature at the time of measurement. Used for calculating the shell temperatures.
CALCDIR
NA
Y
Calculation direction. If the value is 0, the reference density (REFDENSITY) is used as an input and the tank density (TANKDENSITY) is calculated. If the value is 1, the tank density is an input and the reference density is calculated. NOTE: At present this attribute must be set to 0.
CIRCUM1
Yes
Only required if the tank type is Spherical.
224 • Production Balance Configuration Guide
The first perpendicular circumference of the sphere.
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
CIRCUM2
Yes
Only required if the tank type is Spherical.
The second perpendicular circumference of the sphere.
CIRCUM3
Yes
Only required if the tank type is Spherical.
The third perpendicular circumference of the sphere.
COMPEQ
NA
Y
Indicate whether the equipment is capable of holding components. Select either: TRUE – For composition equipment OR FALSE – For non-composition equipment
CRTZONEHIGH
Yes
Only required if the roof type is Floating.
The higher level of the critical zone.
CRTZONELOW
Yes
Only required if the roof type is Floating.
The lower level of the critical zone. If the level of the tank is less than the low critical level, then the floating roof adjustment volume (FRAVOL) is not calculated. If the level of the tank is between the high and low critical levels, then the floating roof adjustment volume (FRAVOL) is calculated with a lower confidence level.
FREEWATERLEVEL
Yes
Y
Free water level. This is the water level at the bottom of the equipment.
GRVADJCNST1
Yes
Only required if the roof type is Floating.
A correction factor used in the calculation of the floating roof adjustment volume (FRAVOL) when ROOFWTSTRP = RoofAPI and when the tank density is greater than the density at which the strapping table was measured (that is, TANKDENSITY > STRPGRV). This attribute specifies the adjusted volume for gravities per degree change below STRPGRV. This quantity would be a positive value when the density is less than the reference density. This constant is measured in volume/density units. The two possible units are bbl/API or m3/kg/m3. If bbl/API is given then the calculations must be done in API. If the SI unit is given then the calculations can be done in SI. In the unit field, select either: API – If the value is measured in bbl/API. kg/m3 – If the value is measured in m3/kg/m3.
Production Balance Configuration Guide• 225
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
GRVADJCNST2
Yes
Only required if the roof type is Floating.
A correction factor used in the calculation of the floating roof adjustment volume (FRAVOL) when ROOFWTSTRP = RoofAPI and when the tank density is less than the density at which the strapping table was measured (that is, TANKDENSITY < STRPGRV). This attribute specifies the adjusted volume for gravities per degree change above STRPGRV. This quantity would be a negative value when the density is greater than the reference density. As with GRVADJCNST1, this constant must be measured in volume/density units. In the unit field, select either: API – If the value is measured in bbl/API. kg/m3 – If the value is measured in m3/kg/m3. NOTE: GRVADJCNST1 = GRVADJCNST2 for some refineries
HIGHLEVEL
Yes
Y
Maximum safe operating level.
INSULSHL
NA
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Indicates whether the equipment shell is insulated.
INVCALCMTHD
NA
Not required for nonpressurized tanks.
Based on this attribute value, it is decided as to which volume or mass is reported as measured inventory for pressurized tanks.
The attribute configuration value is used only in case of pressurized tanks. Even in case of pressurized tanks, this attribute configuration is not mandatory for volume or mass balance group. But, for other balance groups, it is mandatory to configure even for non-pressurized tanks. LEVEL
Yes
Y
226 • Production Balance Configuration Guide
For volume balance groups, the recommended values for this attribute are TOTALSTDVOL or NETSTDVOL. If it is not configured, TOTALSTDVOL is reported as default measured inventory for pressurized tanks. For mass balance groups, the recommended values are TOTALMASS or NETMASS. If it is not configured, TOTALMASS is reported as default measured inventory for pressurized tanks. Other than mass or volume balance groups, based on the attribute configuration, the measured inventory is reported. Level of the liquid in the equipment.
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
LEVELCALCTYPE
NA
Y
This attribute specifies the liquid phase calculation (Total Observed Volume) to be applied to the Equipment. The valid values for this attribute includes
TANKSTRAPCALCTYPE
NA
•
1 (Spherical tank calculation takes place)
•
STRAP (strapping tables is used for level to volume conversion)
•
EQUATION_1
•
EQUATION_2
•
EQUATION_3
•
EQUATION_4
•
EQUATION_5
Only required if This attribute defines the interpolation method to LevelCalcType=’STRAP’ be used when the volume calculations are based on strapping tables. INTERP –based on the standard linear interpolation method CUSTOM – based on the interpolation used by JIS NOTE: The value of this attribute affects the interpolation method used for volume calculations.
EQDIA
Y
Only required if LevelCalcType = ‘EQUATION =1’
This attribute specifies the diameter of the equipment. If a value is provided, then the unit of measure needs to be specified.
SP_FACTOR0
NA
Only required if LevelCalcType = ‘EQUATION_2’
This attribute defines the constant to be used for Equation 2, if specified for IMLEVELCALCTYPE.
SP_FACTOR1
NA
Only required if LevelCalcType = ‘EQUATION_2’
This attribute defines the constant to be used for Equation 2, if specified for IMLEVELCALCTYPE.
SP_FACTOR2
NA
Only required if LevelCalcType = ‘EQUATION_2’
This attribute defines the constant to be used for Equation 2, if specified for IMLEVELCALCTYPE.
SP_FACTOR3
NA
Only required if LevelCalcType = ‘EQUATION_2’
This attribute defines the constant to be used for Equation 2, if specified for IMLEVELCALCTYPE.
SP_COEFFICIENT
NA
Only required if LevelCalcType = ‘EQUATION_3’
This attribute defines the constant to be used for Equation 3 if specified for IMLEVELCALCTYPE.
DEADWOODVOL
Y
Only required if LevelCalcType = ‘EQUATION_3’
This attribute defines the constant to be used for Equation 3 if specified for IMLEVELCALCTYPE.
Production Balance Configuration Guide• 227
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
HGHTABVBTM
Y
Only required if LevelCalcType = ‘EQUATION_3’
This attribute defines the constant to be used for Equation 3 if specified for IMLEVELCALCTYPE.
LIQMASS
Y
Only required if LevelCalcType = ‘EQUATION_4’
This attribute defines the constant to be used for Equation 4 if specified for IMLEVELCALCTYPE. Units of measure are to be provided.
LIQVOL
Y
Only required if LevelCalcType = ‘EQUATION_5’
This attribute defines the constant to be used for Equation 5 if specified for IMLEVELCALCTYPE. Unit of measure is to be provided.
LEVELTYPE
NA
Y
Tank level type. Select either Outage or Innage. Indicates whether an innage or outage measurement was used for the level measurement. It is used with the strap type to make sure both readings are the same when the volume calculation is done.
LOWLEVEL
Yes
Y
Minimum safe operating level.
MAXTEMP
Yes
Y
Maximum design temperature for the equipment. TANKTEMP value is validated by checking whether its value is lesser than MAXTEMP value. If it is not lesser, then confidence of TANKTEMP is set to lower than 50% and input confidence level of TANKTEMP.
MINCAP
Yes
Y
Tank heel. Used for calculating the available volume in the tank — the volume between the minimum capacity and the total observed volume.
MINTEMP
Yes
Y
Minimum design temperature for the equipment. TANKTEMP value is validated by checking whether its value is higher than MINTEMP value. If it is not higher, then confidence of TANKTEMP is set to lower than 50% and input confidence level of TANKTEMP.
MTRLCONST
NA
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Tank shell material. Select from the following: LowCarbon, MildCarbon, 304Stainless, 316Stainless or 17 4PHStainless. Follow the specified combination: For Horizontal or Vertical: MildCarbon/316stainless/304Stainless/17 4PHStainless For Spherical: Low Carbon For Bullet: Mild Carbon.
PCTSW
NA
Y
Percentage of sediment and water suspended in the product.
PCTWAXSW
NA
Y
This attribute defines the sediment and water present in the wax layer, as an equipment attribute.
228 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
PRESSTANK
NA
Y
Indicates whether the equipment is pressurized (TRUE) or not (FALSE).
PRESSURE
Yes
Only required if the Tank pressure. If no value is given, the pressure equipment is pressurized at equilibrium value (PRESSUREEQ) is used (PRESSTANK = TRUE). and a warning message is generated.
PRODUCTCODE
NA
Y
Product code. Used for getting the correct values from the IP_PRDCT_ATTR table for APITABLE, ALPHA and MW.
REFDENSITY
Yes
Y
The density of the liquid in the equipment at the reference temperature.
REFGAUGEHGHT
Yes
Y
Reference gauge height. The vertical distance between the reference point on the gauge and the striking point on the tank floor. Usually supplied with the strapping table information. Used for outage/innage level transformation calculations.
REFTEMP
Yes
Y
Reference temperature. Select 68F, 60F, 20C or 15C.
ROOFTYPE
NA
Y
Tank roof type. Select either Floating or Fixed.
ROOFWEIGHT
Yes
Only required if the roof type is Floating.
Roof weight. Used for calculating the floating roof adjustment volume.
ROOFWTSTRP
NA
Only required if the roof type is Floating.
Roof weight in strapping table and calculation type indicator. Select from the following: •
NoRoof – Used if roof weight is not included in the strapping table measurements.
•
RoofAPI – Used if the roof weight is included in the strapping table measurements and the API calculation method is used.
•
RoofTech – Indicates that the technical calculation method is to be used.
•
Leave this field blank, if the roof type is Fixed.
ROUNDINGTYPE
NA
Y
This attribute is used to set the rounding type to be applied. Setting the value of this attribute to ‘JIS’ enables JIS rounding based on the following related attributes.
VCFPRCN
Y
Only required if the rounding type is JIS.
This attribute is used to set the rounding to be applied to VCF results, provided the rounding type is JIS.
VOLPRCN
Y
Only required if the rounding type is JIS.
This attribute is used to set the rounding to be applied to Volume results, provided the rounding type is JIS. A unit of measure is required for this setting.
Production Balance Configuration Guide• 229
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
TEMPPRCN
Y
Only required if the rounding type is JIS.
This attribute is used to set the rounding to be applied to temperature results, provided the rounding type is JIS. A unit of measure is required for this setting.
DENSITYPRCN
Y
Only required if the rounding type is JIS.
This attribute is used to set the rounding to be applied to Density results, provided the rounding type is JIS. A unit of measure is required for this setting.
MASSPRCN
Y
Only required if the rounding type is JIS.
This attribute is used to set the rounding to be applied to Mass results, provided the rounding type is JIS. A unit of measure is required for this setting.
PRESSPRCN
Y
Only required if the rounding type is JIS.
This attribute is used to set the rounding to be applied to Pressure results, provided the rounding type is JIS. A unit of measure is required for this setting.
LEVELPRCN
Y
Only required if the rounding type is JIS
This attribute is used to set the rounding to be applied to level results, provided the rounding type is JIS. A unit of measure is required for this setting.
SITENAME
NA
Y
This attribute defines the local site code for the balance group. Custom Japan calculations are supported for the following site codes:
SHLCRCTN
NA
Y
•
WAK – Wakayama Refinery
•
ICH – Chiba Refinery
•
KAW – Kawasaki Refinery
•
SAK – Sakai Refinery
•
SMZ – Shimizu Refinery
Shell correction factor calculation indicator. If the value is TRUE, the shell temperature is calculated. If the value is FALSE, the shell temperature is not calculated and the shell temperature correction (CORRTEMPSHELL) is set to 1.
SHLCRCTN_CUSTOM
NA
Y
This attribute specifies if custom shell correction calculations are to be applied to equipment. The valid values are JAPAN_GOM NOTE: The setting of this attribute requires providing additional values for ALPHA2.
230 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
ALPHA2
NA
Only required if SHLCRCTN_CUSTOM = ‘JAPAN_GOM’
The thermal expansion coefficient for the product needs to be specified for Products with equipment SHLCRCTN_CUSTOM attribute as JAPAN_GOM and if Shell Correction is to be applied. This attribute specifies alpha coefficient per Deg C. 1+(2*alpha2)( Ts) + (alpha2^2)(Ts)^2 where Ts = Ts – StrapMeasTemp •
For non-insulated metal tanks, the temperature of the tank shell is:
Ts= [(7xTL) +Ta] /8 Where TL =liquid temperature Ta = ambient temperature •
STRAPLEVELUNIT
Yes
Y
For insulated metal tanks, the temperature of the tank shell is taken as the liquid temperature Ts = TL
Length unit for the strapping table level measurements. If a unit is supplied, it is used for converting the level measurement to the correct unit when calculating volume.
STRAPMEASTEMP
Yes
Only required if the shell correction factor is to be calculated (SHLCRCTN = TRUE).
Temperature at which the strapping table measurements were made.
STRAPOFFSET
Yes
Y
A bias for strapping table level. The strap offset value is subtracted from the tank level after converting the level to the strap level units.
STRAPSRCID
NA
Y
Name of the strapping table or 1d correlation table. Enter the name of the function in the IP_CORRLTN_TBL table that contains the tank strapping table data.
STRAPTYPE
NA
Y
Strap type. Select either Outage or Innage. Indicates whether the strapping table readings were done on an innage or an outage basis. It is used with the level type to make sure both readings are the same when the volume calculation is done.
STRAPVOLUNIT
Yes
Y
Volume unit for the strapping table volume measurements. If a unit is supplied, it is used for converting the calculated volume to the correct unit for output.
STRPGRV
Yes
Y
The density at which the strapping table was measured.
Production Balance Configuration Guide• 231
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
TANKCAP
Yes
Y
The total capacity of liquid allowed in the equipment.
TANKTEMP
Yes
Y
Tank temperature.
TANKTYPE
NA
Y
Tank type. Select either Bullet, Horizontal, Spherical, or Vertical.
USECALCGRV
NA
Only required for composition equipment (COMPEQ = TRUE).
Indicate whether density must be backcalculated from the component densities for the composition equipment (TRUE) or not (FALSE). If this attribute is set to FALSE for composition equipment, the equipment density is propagated to all the components.
VAPORDENSITYCALCT YPE
NA
Only required if PRESSTANK = ‘TRUE’
This attribute specifies the vapor phase volume calculation to be applied to the Equipment. The valid values for this attribute includes: •
STANDARD
•
EQUATION_1
•
EQUATION_2
•
EQUATION_3
•
F_C3_VAPOR_DENS_COND
•
F_C30_VAPOR_DENS_COND
•
F_C4_VAPOR_DENS_COND
•
F_C40_VAPOR_DENS_COND
VAPC3FACTOR
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT Equation_1 or Equation_2, if specified for YPE = ‘EQUATION_1’ or VAPORDENSITYCALCTYPE. ‘EQUATION_2’
VAPC3FACTOR_D1
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT Equation_1, if specified for VAPORDENSITYCALCTYPE. YPE = ‘EQUATION_1’
VAPC3FACTOR_D2
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT Equation_1, if specified for VAPORDENSITYCALCTYPE. YPE = ‘EQUATION_1’
DENSITYGAS
Y
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT Equation_3, if specified for YPE = ‘EQUATION_3’ VAPORDENSITYCALCTYPE. Units of measure are to be provided.
M_C3_VAPOR_C2_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C3_VAPOR_DENS_ COND
232 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
M_C3_VAPOR_C3_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C3_VAPOR_DENS_ COND
M_C3_VAPOR_C3_O_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C3_VAPOR_DENS_ COND
M_C3_VAPOR_iC4_PCN NA T
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C3_VAPOR_DENS_ COND
M_C3_VAPOR_nC4_PC NT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C3_VAPOR_DENS_ COND
M_C3_VAPOR_iC4_O_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C3_VAPOR_DENS_ COND
M_C3_VAPOR_nC4_O_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C3_VAPOR_DENS_ COND
M_C3_VAPOR_C5_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C3_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C3_VAPOR_DENS_ COND’
M_C3_O_VAPOR_C2_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C30_VAPOR_DENS_ COND’
M_C3_O_VAPOR_C3_P CNT
NA
Only required if Only required if VAPORDENSITYCALCTYPE = VAPORDENSITYCALCT ‘F_C30_VAPOR_DENS_COND’. YPE = ‘F_C30_VAPOR_DENS_ COND’
M_C3_O_VAPOR_C3_O _PCNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C30_VAPOR_DENS_ COND’
Production Balance Configuration Guide• 233
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
M_C3_O_VAPOR_iC4_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C30_VAPOR_DENS_ COND’
M_C3_O_VAPOR_nC4_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C30_VAPOR_DENS_ COND’
M_C3_O_VAPOR_iC4_O NA _PCNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C30_VAPOR_DENS_ COND’
M_C3_O_VAPOR_nC4_ O_PCNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C30_VAPOR_DENS_ COND’
M_C3_O_VAPOR_C5_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C30_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C30_VAPOR_DENS_ COND’
M_C4_VAPOR_C2_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_C3_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_C3_O_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_iC4_PCN NA T
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_nC4_PC NT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
NA
234 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
M_C4_VAPOR_iC4_O_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_nC4_O_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_C5_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C4_VAPOR_DENS_ COND’
M_C4_VAPOR_C2_PCN T
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C4_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C4_VAPOR_DENS_ COND’
M_C4_O_VAPOR_C2_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
M_C4_O_VAPOR_C3_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
M_C4_O_VAPOR_C3_O _PCNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
M_C4_O_VAPOR_iC4_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for YPE = VAPORDENSITYCALCTYPE. ‘F_C40_VAPOR_DENS_ COND’
M_C4_O_VAPOR_nC4_P NA CNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
M_C4_O_VAPOR_iC4_O NA _PCNT
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
Production Balance Configuration Guide• 235
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT INPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required
Required
Description
M_C4_O_VAPOR_nC4_ O_PCNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
M_C4_O_VAPOR_C5_P CNT
NA
Only required if This attribute defines the constant to be used for VAPORDENSITYCALCT F_C40_VAPOR_DENS_COND, if specified for VAPORDENSITYCALCTYPE. YPE = ‘F_C40_VAPOR_DENS_ COND’
VAPORTEMP
Yes
Only required if the Vapor temperature. Used for calculating the equipment is pressurized vapor density in pressurized equipment only. (PRESSTANK = TRUE).
VCFCRCTN
NA
Y
Volume correction factor calculation indicator. A value of FALSE causes VCF (VCF) to be set to 1.0.
VERTHEIGHT
Yes
Only required if the tank type is Spherical.
Vertical height of the sphere.
WAXVOL
Yes
Y
This attribute specifies the volume of wax deposit layer in equipment. This attribute value is used for calculating the Net Standard volume. If a value is provided, then the unit of measure needs to be specified (BBL).
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required Required
Description
AVAILCAP
No
N
Available capacity. The volume between the high volume and the total observed volume.
AVAILROOM
No
N
Available room. The volume between the total observed volume and the tank capacity.
AVAILVOL
No
N
Available volume. The volume between the minimum capacity and the total observed volume.
BSWVOL
No
N
Volume of the suspended sediment and water, plus the water volume at the bottom of the equipment.
COMPDENSITY
No
Only required for composition equipment when USECALCGRV = TRUE.
Density calculated from the individual component densities in the equipment.
236 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required Required
COMPRESSFACT No OR
CORRPRESSUR E
No
Description
Only applies to pressurized Compressibility factor. Only calculated if the equipment (PRESSTANK = following conditions are met. TRUE). • The equipment is pressurized (PRESSTANK = TRUE). •
The equipment is filled to 100%.
•
The pressure at equilibrium is less than the tank pressure.
Only applies to pressurized Pressure correction for the equipment. Only equipment (PRESSTANK = calculated if the following conditions are met. TRUE). • The equipment is pressurized (PRESSTANK = TRUE). •
The equipment is filled to 100%.
•
The pressure at equilibrium is less than the tank pressure.
CORRSW
No
N
Corrected sediment and water factor. This value accounts for the percent sediment and water, suspended in the oil. It is used in the net standard volume calculation.
CORRWAXSW
No
N
Corrected wax in sediment and water.
CORRTEMPSHEL No L
Only calculated if SHLCRCTN = TRUE.
Shell temperature correction. This calculation is based on the product in the equipment and the shell temperature.
FRAVOL
No
N
Floating roof adjustment volume. The volume correction due to the mass of the floating roof. This value is 0, if the roof type is Fixed.
FREEWATERVOL No
N
Free water volume. This value is calculated from the free water level using the strapping table. If the free water level is 0, the free water volume is 0.
GROSSMASS
No
N
Gross mass of the product in the equipment.
GROSSOBSVOL
No
N
Gross observed volume. This is a calculated volume value that takes the tank temperature correction, floating roof volume adjustment and pressure volume correction into account (if applicable). In addition, the volume of free water is removed.
GROSSSTDVOL
No
N
Gross standard volume. The gross observed volume corrected to standard conditions.
HIGHVOL
No
N
High volume. This value is calculated from the high level using the strapping table.
LOWVOL
No
N
Low volume. This value is calculated from the low level using the strapping table.
NETMASS
No
N
Net mass of the product in the equipment.
NETSTDVOL
No
N
Net standard volume. The gross standard volume corrected for the suspended sediment and water.
Production Balance Configuration Guide• 237
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required Required
Description
PRESSUREEQ
No
Only calculated if the equipment is pressurized.
Pressure at equilibrium. Used in the pressure correction calculations.
PUMPVOL
No
N
Pumpable volume. The volume between the low volume and the total observed volume.
SHELLTEMP
No
Only calculated if SHLCRCTN is TRUE.
Shell temperature. This calculation is based on the product in the equipment and the equipment insulation.
SPHERECONST1 No
Only applies to spherical tanks
Sphere constant
SPHERECONST2 No
Only applies to spherical tanks
Sphere constant
SWVOL
No
N
Volume of the sediment and water. The difference between the gross standard volume and the net standard volume.
SWWAXVOL
No
N
Sediment water wax volume
TANKDENSITY
No
N
Tank density at observed or tank temperature.
TOTALCALCVOL
No
N
Total calculated volume of the product in the equipment.
TOTALMASS
No
N
Total mass including the mass of the vapor in the equipment. NOTE: Total Mass = Net Mass (NETMASS), if the equipment is not pressurized (PRESSTANK=FALSE)/
TOTALOBSVOL
No
N
Total observed volume. This value is calculated from the level using the strapping tables.
TOTALSTDVOL
No
N
Total standard volume. The total volume in the equipment, including both the net liquid volume (NETSTDVOL) and the liquid equivalent of vapor volume (VAPORLIQVOL). NOTE: Total Standard Volume = Net Standard Volume (NETSTDVOL), if the equipment is not pressurized (PRESSTANK = FALSE).
TOTALVOL
No
Only applies to spherical tanks.
Total volume calculated for the spherical level to volume calculations.
VAPORDENSITY
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Vapor density. Used for calculating the vapor mass.
VAPORLIQVOL
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Liquid volume equivalent to the vapor in the tank.
VAPORMASS
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Vapor mass
VAPORVOL
No
Only calculated if the equipment is pressurized (PRESSTANK = TRUE).
Vapor volume in the equipment.
238 • Production Balance Configuration Guide
Appendix B – Tank Calculator extension for Japanese standards
EQUIPMENT OUTPUT ATTRIBUTES (EquipmentClass = JTank) Attribute ID
Units required Required
Description
VCF
No
Volume correction factor value
N
NOTE: You can configure the units for the output Equipment attributes if required
Production Balance Configuration Guide• 239
Appendix B – Tank Calculator extension for Japanese standards
Product Attributes Attribute ID
Units required
Required
Description
ALPHA
No
Only required if the product's API Table (APITABLE) = JC.
Temperature value (in Deg C or Deg F) for use in the special products table (API Table C). For example, MTBE uses the specified alpha value instead of the k0, k1, k2 values. The alpha unit is 1/DegF or 1/DegC.
APITABLE
No
Y
API Table identification. Used for determining the VCF calculation method for the product. Select JA, JB, JC, JD, E, D1555, D1550, JD4311 or D4311_JIS_K2207_1996. NOTE: If you want to use the API table version 2004, specify A2004, B2004, C2004, D2004, E2004, D155504, and JD431104 instead of JA, JB, JC, JD, E, D1555, and JD4311 respectively.
AROMNAME
No
Only required if the product's API Table (APITABLE) = D1555 or D155504.
Aromatic name. Used for calculating the VCF for API Table D1555 and D155504. Select either: benzene, toluene, m_xylene, styrene, o_xylene, p_xylene, cyclohexane, ethylbenzene, cumene, 300Arom or 400Arom.
DENSITYHI
Yes
Y
High density limit for the product. For information only.
DENSITYLO
Yes
Y
Low density limit for the product. For information only.
MW
No
Only required if the equipment where the product is stored is pressurized (PRESSTANK = TRUE).
Molecular weight of the product. Used for calculating the vapor density in pressurized equipment only.
PRODUCTCODE
NA
Y
For Japanese standards, some specific products are required in VCF calculation for APITable NEWTCC based on the SITENAME. If SITENAME=WAK or KAW, the possible product values are •
BENZENE
•
TOLUENE
•
MXYLENE
•
OXYLENE
•
PXYLENE
•
MOLTEN_SULFUR
If SITENAME=SAK, the possible product values are
240 • Production Balance Configuration Guide
•
BENZENE
•
TOLUENE
•
MXYLENE
•
PXYLENE
Appendix B – Tank Calculator extension for Japanese standards
Attribute ID
Units required
Required
Description •
TBA_ALCOHOL
If SITENAME=ICH, the possible product values are •
METHANOL
•
MTBE
•
TOLUENE
•
SULFUR
•
MOLTEN_SULFUR
•
PELLET_SULFUR
•
XYLENE
•
BENZENE
For Japanese standards, some specific products are required based on the VAPORDENSITYCALCTYPE value. If VAPORDENSITYCALCTYPE= F_C3_VAPOR_DENS_COND, the possible values are •
PROPANE
•
PROPANE I-GO
•
COGEN FUEL LPG
If VAPORDENSITYCALCTYPE = F_C30_VAPOR_DENS_COND, the possible values are •
PROPYLENE CHEM
•
PROPYLENE POLY 1
•
PROPYLENE POLY 2
If VAPORDENSITYCALCTYPE = F_C4_VAPOR_DENS_COND, the possible values are •
BUTANE 10 GENERAL
•
BUTANE 15 GENERAL
•
BUTANE 20 GENERAL
•
BUTANE 23 GENERAL
•
BUTANE 25 GENERAL
•
BUTANE 30 GENERAL
•
BUTANE 40 GENERAL
•
BUTANE 50 GENERAL
•
BUTANE 34 MBK
•
BUTANE 35 MBK
•
BUTANE NO 3
•
BUTANE 4
Production Balance Configuration Guide• 241
Appendix B – Tank Calculator extension for Japanese standards
Attribute ID
Units required
Required
Description •
BUTANE NA
•
BUTANE 90 MOGC
•
BUTANE COSMO LPG
If VAPORDENSITYCALCTYPE = F_C40_VAPOR_DENS_COND, the possible values are •
RFCC BUTENE
Changes in VCF from ASTM standards With respect to VCF, Japanese standards have some differences in calculations as compared to ASTM standards. The ASTM API table values that have differences from Japanese VCF calculations are A, B, C, D, D4311, and D431104. In order to support the Japanese VCF calculations, new API table values JA, JB, JC, JD, J4311, and JD431104 are created to corresponding ASTM API table values. Since other API table values have similar calculation procedures to ASTM calculations, they do not require new API table values. In addition, a few new calculation procedures are introduced specific to Japanese standards. The new calculations are given values as ASTM_54X, XOM_LPG2, D4311_JIS_K2207_1996 and NewTCC. NOTE: All the new Japanese API table values (JA, JB, JC, JD, J4311, and JD431104) have the same density range values as the corresponding ASTM API table values. The following table explains the differences between the standard ASTM standard and Japanese standard for APITable values – A, B, C, and D. Changes from ASTM standards
Applicable to APITables
Modified the K0 constant defined for the jet fuel density range to match the SM module value. Modified K0 values are 2680.3206, 186.9696, 594.5418 and 346.4228.
JA, JB, JC, JD
Modified the table 54B (fuels) boundary values used in calculating VCF within the Tank Calculator software to match the SAP SM module version. Modified values are 770.36, 787.53, 610.5, 787.53, 838. 3.
JA, JB
Applied regular rounding to the alpha constant prior to its use in the VCF JA, JB, JC, JD calculations.
Since APITable D4311 internally uses A, B boundary values and since the changes are present in boundary values for Japanese standards, a new APITable value ‘JD4311’ is used for Japanese standards corresponding to D4311. Similarly, APITable D4311 of 2004 Japanese standards has some differences from ASTM. A new APITable value ‘JD431104’ is used for Japanese standards corresponding to D431104.
242 • Production Balance Configuration Guide
Appendix C – Lookup and User Attribute Reference
Appendix C – Lookup and User Attribute Reference Production Balance makes extensive use of the lookup types and values configured in the Business FLEX database. The required lookup types and values are listed here for reference purposes. Lookups are configured in the Business FLEX TPI, Plant Reference Model application's Lookup Value Configuration form.
Lookup Table Lookup Type (LKP_NAME)
Lookup Value List
Description
ACCREPORT
ALLOCATION
Lookup value associated with the legacy production allocation calculations. NOTE: This lookup value is not related to the Production Allocation feature available from the Production Balance user interface.
MASSBALFACTOR
Identifies the factor for Statistical Data Reconciliation (SDR) for routes.
MASS_BAL
Mass balance for the route
RECONPUT
Indicates that the reconciled value is to be sent to the tag assigned to route.
SDR_FCTRAVERAGE
Use a calculated weighted average for the factors for the route.
SDR_FCTRLAST
Use the last good factor value for the route.
SDR_PUTMEASBALQ
Old route attributes originally configured for Writeback to PHD, which no longer apply. Writeback is configured in the Production Balance Web environment. See Writeback Configuration for details.
SDR_PUTMEASQTY SDR_PUTRECONBALQ SDR_PUTRECONQTY SDR_PUTSMRBALQ SDR_PUTSMRQTY
ATTR_ENTITY_TYP
ATTR_PROC_TYP
SDR_RTG_FIXED
Indicates that transfers on a route are FIXED.
SDR_RTG_MEAS
Indicates that transfers on a route are MEASURED.
SDR_RTG_UNMEAS
Indicates that transfers on a route are UNMEASURED.
EQUIPMENT
Equipment
PRODUCT
Product
TANKCALC
Tank Calculator
Production Balance Configuration Guide• 243
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
ATTR_TYP
REFACT
Attribute references an activity type.
REFEQUIP
Attribute references an equipment.
REFEVENT
Attribute references an event type.
REFPRDCT
Attribute references a product.
REFTAG
Attribute references a tag.
REFUNITS
Attribute references an engineering unit.
PLInventory_10
Inventory Calculation auto processing step called PL Inventory.
PLWRITEBACK_20
Inventory Calculation auto processing step called PL Writeback.
DEPENDANT_20
Production Balance Analysis auto processing step called DEPENDANT.
INSTRUCT_10
Production Balance Analysis auto processing step called INSTRUCT.
INVENTORY_50
Production Balance Analysis auto processing step called INVENTORY.
PBInterface_110
Production Balance Analysis auto processing step called PB Interface.
PBUPDATE_140
Production Balance Logging auto processing step called PB Update.
PBWRITEBACK_145
Optional writeback auto processing step for legacy implementations of Production Accounting, Net Production and Tank Composition Tracking writeback functionality.
PL2PB_130
Production Balance Logging auto processing step called PL2PB.
PLTransfer_115
Production Balance Logging auto processing step called PL Transfer.
PLWRITEBACK_150
Optional Production Balance Analysis auto processing step for the writeback settings configured in the PB Configuration Writeback display
PRODMOVE_30
Production Balance Analysis auto processing step called PRODMOVE.
RECON_70
Legacy Production Balance Analysis auto processing step called RECON.
AUTOSTEP_IM
AUTOSTEP_PB
NOTE: It is recommended that the RECON step be disabled, except for use with legacy systems.
AUTOTYPE
SWITCH_40
Production Balance Analysis auto processing step called SWITCH.
TRANSFER_60
Production Balance Analysis auto processing step called TRANSFER.
M
Legacy attributes that identify the cycle type for the balance family as mass balance (M), volume balance (V) or other (O).
O V
244 • Production Balance Configuration Guide
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
BP_PARAMETERS
CMDLINE_SWITCHES
Background process parameter which specifies the command line switches for executables.
CONNECT_STRING
Background process parameter which specifies the database connection string in the format:
user/password@database DENSITY
Background process parameter which specifies the unit of measure used for density.
EQ_ATTRIBUTE
Background process parameter which specifies the name of the attribute on the balance group.
ERROR_DELAY
Background process parameter which specifies the delay for error download with recipe download.
FIRST_PRC_SEQ
Background process parameter which limits processing to cases more than this number.
INI_FILE
Background process parameter which specifies the initialization file.
KEEP_DAYS
Background process parameter which specifies the number of days to keep data.
LENGTH
Background process parameter which specifies the unit of measure used for length.
MASS
Background process parameter which specifies the unit of measure used for mass.
MV_MD_KEEP_DAYS
Background process parameter which specifies the number of days the move and mode records are kept.
OFFSET_DAYS
Background process parameter which specifies the offset in number of days. This can be positive or negative value.
PARAM1
Background process parameter which specifies the first command line parameter.
PARAM2
Background process parameter which specifies the second command line parameter.
PARAM3
Background process parameter which specifies the third command line parameter.
PARAM4
Background process parameter which specifies the fourth command line parameter.
PARAM5
Background process parameter which specifies the fifth command line parameter.
PARAM6
Background process parameter which specifies the sixth command line parameter.
PHD_HOST
Background process parameter which specifies the PHD host name.
PHD_PASSWORD
Background process parameter which specifies the PHD password.
PHD_USERNAME
Background process parameter which specifies the PHD user name.
Production Balance Configuration Guide• 245
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
PRESSURE
Background process parameter which specifies the unit of measure used for pressure.
PRIOR_STEP
Background process parameter that controls which auto processing step triggers the process.
PROCESSED_DIR
Background process parameter which specifies the directory where processed files are stored.
SCAN_FREQ
Background process parameter which specifies the process scan frequency.
SCHEDULE_TYPE
Background process parameter which specifies the type of scheduled data being created.
SDR_PRIOR_STEP
Background process parameter which controls which auto processing step triggers the execution of the background process.
TEMPERATURE
Background process parameter which specifies the unit of measure used for temperature.
VOLUME
Background process parameter which specifies the unit of measure used for volume.
BTCH_PRCSS_UNIT
TONNE
Report unit conversions. Do not change. (Default = TONNE)
EQATTR
ALLOCATE
Lookup value associated with the legacy production allocation calculations. (Note: This lookup value is not related to the Production Allocation feature available from the Production Balance user interface.)
ALLOCFACTORTAG
Lookup value associated with the legacy production allocation calculations. (Note: This lookup value is not related to the Production Allocation feature available from the Production Balance user interface.)
CAPACITY
Equipment capacity.
CUTINV
Equipment attribute which causes the inventory equipment item or node to be included in the Cutoff Inventory Report.
CUTINVTAG
Specifies the tag to be used for looking up the cutoff inventory amount for the equipment item.
EQUIP
Identifies the equipment item as equipment.
INV
Equipment attribute which causes normal inventory data collection to occur for the equipment item.
INVTAG
Specifies the tag to be used for normal inventory data collection for the equipment item.
MASSBALFACTOR
Identifies the factor for Statistical Data Reconciliation (SDR) for equipment.
MODE
Identifies the item is an operating mode for equipment rather than a piece of equipment.
BP_PARAMETERS (cont.)
246 • Production Balance Configuration Guide
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
EQATTR (cont.)
MOVEDEST
Attribute which can be used for causing a list box in the Business FLEX TPI Product Movement Entry form to be populated. If this TPI form is going to be used for manual movement entry, it is recommended that all equipment be assigned as MOVEDEST.
MOVESRC
Attribute which can be used for causing a list box in the Business FLEX TPI Product Movement Entry form to be populated. If this TPI form is going to be used for manual movement entry, it is recommended that all equipment be assigned as MOVESRC.
PRODUCT_TAG
Specifies the tag which returns the name of the product in the equipment.
SDR_BNDRY
Identifies the artificial balance group name used as parent for writeback in balanced units to the IP_MTRL_TRNSFR and IP_CUT_INV tables.
SDR_FCTRBALGRP
Legacy lookup value which identifies the equipment name used as the pseudo balance group for factor balance results in PA tables.
SDR_FCTRBALUNIT
Specifies the balanced units of measure (for example, TON). Each measurements factor must be capable of converting from measured units to balanced units.
SDR_FCTRDFLTATTR
Identifies the product attribute name to be used for specifying default product factors (for example, DFLT_DENSITY or DFLT_GRAVITY).
SDR_FCTRDFLTUNIT
Specifies the unit of measure for default factor values entered as product attributes (for example, G/ML or API). All default factors specified as product attributes must be in these units.
SDR_FCTRTYPE
Label for the balance type (for example, V or VOLUME for volume, M or MASS for mass, and so on.). Used for information only.
SDR_FCTRVALATTR
Identifies the attribute name to be used for specifying equipment and route factors.
SDR_FIXCLOS_DFLT
Specifies the default measurement type for closing inventory measurements. In general, closing inventory must be treated as Measured, by setting this attribute to FALSE. The tolerance then controls the degree of adjustability.
SDR_FIXCONS_DFLT
Specifies the default measurement type for transfers on routes of accounting type CONS (consumed). Set to TRUE for a Fixed measurement type and to FALSE for a Measured measurement type.
SDR_FIXOPEN_DFLT
Specifies the default measurement type for open inventory measurements. In general, open inventory must be treated as Fixed, by setting this attribute to TRUE.
Production Balance Configuration Guide• 247
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
EQATTR (cont.)
SDR_FIXPROD_DFLT
Specifies the default measurement type for transfers on routes of accounting type PROD (produced). Set to TRUE for a Fixed measurement type and to FALSE for a Measured measurement type.
SDR_FIXRCPT_DFLT
Specifies the default measurement type for receipts. Normally the receipts are treated as Fixed, by setting this attribute to TRUE.
SDR_FIXSHIP_DFLT
Specifies the default measurement type for shipments. Normally the shipments are treated as Fixed, by setting this attribute to TRUE.
SDR_FIXTRN_DFLT
Specifies the default measurement type for transfers on routes of other accounting types (for example, FROM, TO or OTH). Set to TRUE for a Fixed measurement type and to FALSE for a Measured measurement type.
SDR_FLOW_MIN
If the absolute value of the quantity transferred is less than this threshold (in measured units), the transfer is treated as Unmeasured rather than Measured.
SDR_MEASTOL_MIN
Specifies the tolerance, in percent, to use for transfers and inventory measurements with a measurement type of Measured and a tolerance of zero.
SDR_MEAS_TYP_CLO
Specify FIXED, MEASURED or UNMEASURED to override the default configuration for closing inventory measurement type.
SDR_MEAS_TYP_OPE
Specify FIXED, MEASURED or UNMEASURED to override the default configuration for opening inventory measurement type.
SDR_MM_RT_FIXED
Old balance group attributes originally configured for missing movements which no longer apply.
SDR_MM_RT_MEAS SDR_MM_RT_UNMEAS SDR_MM_RT_UNUSED SDR_OVERLAP_DEST
Indicates whether to check for overlapping movements with the same destination.
SDR_OVERLAP_SRC
Indicates whether to check for overlapping movements with the same source.
SDR_PUTMEASBALQ
Old balance group attributes originally configured for Writeback to PHD which only apply to legacy sites. Writeback is configured in the Production Balance Web environment. See Writeback Configuration for details.
SDR_PUTMEASQTY SDR_PUTRECONBALQ SDR_PUTRECONQTY SDR_PUTSMRBALQ SDR_PUTSMRQTY
248 • Production Balance Configuration Guide
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
EQATTR (cont.)
SDR_SWINGTM_DEST
Specifies the allowable destination overlap in minutes.
SDR_SWINGTM_SRC
Specifies the allowable source overlap in minutes.
SDR_USE_RESOLVED
By default, the measured quantities used for SDR are the raw measurements. If this attribute is set to TRUE, resolved values from Production Accounting are used instead. Changing the default setting is not recommended.
SDR_WRITEBCK_INV
Legacy lookup value which indicates the type of inventory data to be written to the IP_MTRL_TRNSFR, IP_CUT_INV and/or IP_NET_PRDCTN tables. Valid values are: SPEC - Writeback specified close inventory quantities only. SPEC/RECON - Writeback all specified values and reconciled values for close inventory records marked as Unmeasured. RECON - Writeback reconciled inventory quantities to the SPEC_QTY field.
SDR_WRITEBCK_NP
Legacy lookup value which enables writeback to the Net Production IP_NET_PRDCTN table if set to TRUE.
SDR_WRITEBCK_PA
Legacy Lookup which enables writeback to the IP_MTRL_TRNSFR and IP_CUT_INV tables if set to TRUE.
SDR_WRITEBCK_PHD
Legacy lookup value which enabled writeback to PHD. NOTE: This lookup value is no longer used.
SDR_WRITEBCK_TRN
Legacy lookup value which indicates the type of transaction data to be written to the IP_MTRL_TRNSFR, IP_CUT_INV and/or IP_NET_PRDCTN tables. Valid values are: SPEC - Writeback specified material transaction quantities. For Measured or Fixed quantities, the measured quantity is written to the column IP_MTRL_TRNSFR.RES_QTY to support Production Accounting reports. SPEC/RECON - Same as above plus writeback reconciled values for transactions marked as Unmeasured. RECON - Writeback reconciled transaction quantities to the RES_QTY field. NULL - If this attribute is omitted, or no value is specified, no transaction writeback occurs.
TANK_COMP
Tank composition equipment
TANK_COMP_BYPASS
Tank composition bypass calculation percentage
TANK_COMP_SRC
Tank composition source equipment
Production Balance Configuration Guide• 249
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
EQGRPTYPE
BALBNDRY
Defines a balance boundary group in the Balance Family/Equipment Tree for Production Balance Analysis.
BALFAM
Defines a balance family in the Balance Family/Equipment Tree for Production Balance Analysis.
BALGROUP
Defines a balance group in the Balance Family/Equipment Tree for Production Balance Analysis.
BALROOT
Defines a balance family root node in the Balance Family/Equipment Tree for Production Balance Analysis.
COMPONENT
Defines a component in the Balance Family/Equipment Tree for Production Balance Analysis.
PL_BRANCH
Defines an inventory group or subgroup in the Balance Family/Equipment Tree for Production Balance Logging.
PL_EQUIPMENT
Defines an equipment node in the Balance Family/Equipment Tree for Production Balance Logging.
PL_INSTRUMENT
Defines an instrument node in the Balance Family/Equipment Tree for Production Balance Logging.
PL_MODE
Defines a mode in the Balance Family/Equipment Tree for Production Balance Logging.
PL_PORT
Defines a port in the Balance Family/Equipment Tree for Production Balance Logging.
PL_ROOT
Defines a root node as an overall inventory group in the Balance Family/Equipment Tree for Production Balance Logging.
PORT
Defines an equipment port node in the Balance Family/Equipment Tree for Production Balance Analysis.
BALBNDRY
Equipment type used for representing balance boundaries.
BALFAM
Equipment type used for representing balance families.
ALLOCFACTORTAG
Lookup value associated with the legacy production allocation calculations.
EQTYPE
PRODATTR
NOTE: This lookup value is not related to the Production Allocation feature available from the Production Balance user interface. DFLT_MASSBALFCTR
Identifies the factor for Statistical Data Reconciliation (SDR) for products.
PRDCT_COMPONENT
Product component
PRDCTUNIT
Product quantity input units of measure required if the quantity input units in PA (which come from the legacy cut off inventory workflow in TPI) are different than the balance units. (For example if the input units are BBL but the balance units are TONNE, then create a unit of BBL in IP_LKP with LKP_NAME = PRDCTUNIT and LKP_VALUE = BBL.)
PROD_VOLUNITS
All volume units supported by Historian
Defines the volume units for the display in the Product Summary Report.
PROD_MASSUNITS
All mass units supported by Historian
Defines the mass units for the display in the Product Summary Report.
250 • Production Balance Configuration Guide
Appendix C – Lookup and User Attribute Reference
Lookup Type (LKP_NAME)
Lookup Value List
Description
PSWDTYPE
PRODACCT
Production accounting reports
SDRDATTREC
SDR_PUTMEASBALQ
Old balance group attributes originally configured for Writeback to PHD which only apply to legacy sites. Writeback is configured in the Production Balance Web environment. See Writeback Configuration for details.
SDR_PUTMEASFCTR SDR_PUTMEASQTY SDR_PUTRECONBALQ SDR_PUTRECONFCTR SDR_PUTRECONQTY SDR_PUTSMRBALQ SDR_PUTSMRFCTR SDR_PUTSMRQTY SDR_FCTRVALATTR
Identifies the attribute name to be used for specifying equipment and route factors.
SDR_FCTRDFLTATTR
Identifies the product attribute name to be used for specifying default product factors (for example, DFLT_DENSITY or DFLT_GRAVITY).
User Attributes User Attribute
Value
Description
BACKGROUND PROCESS USER
TRUE FALSE
User that is used by the background processor to connect to the database.
Inventory management related lookups Lookup type (LKP_NAME)
Lookup value
Description
IMERRSTATUSMAX
Lower mapping value
Used for setting the lower level mapping between the confidence values and the status values. If this value is 0, then a confidence less than or equal to 0% would result in a status of 2.
IMOKSTATUSMIN
Upper mapping value
Used for setting the upper mapping between the confidence values and the status values. If this value is 90, then a confidence greater than or equal to 90% would result in a status of 0.
AUTOWRITEBCK
TRUE
Used to enable or disable the automatic write back. If the automatic write back is enabled, the release button is disabled in the Inventory page. If the automatic write back is disabled, the release button is enabled to perform the manual write back mechanism.
FALSE
Production Balance Configuration Guide• 251
Appendix C – Lookup and User Attribute Reference
Configuration of unit types To configure different unit types corresponding to VOLUME, MASS, LENGTH, TEMPERATURE, DENSITY, and PRESSURE, the following lookup types must be configured. To add each unit type, add it as a new lookup under each unit type group. For example, Volume related unit types. Lookup type (LKP_NAME)
Lookup value
Default value
Description
VOLUME_UNITTYPES
Unit type for volume
VOLUME
Defines the volume unit types.
LENGTH_UNITTYPES
Unit type for length
LENGTH
Defines the length unit types.
MASS_UNITTYPES
Unit type for mass
MASS
Defines the mass unit types.
TEMPERATURE_UNITTYPES Unit type for temperature
TEMPERATURE
Defines the temperature unit types.
DENSITY_UNITTYPES
Unit type for density
DENSITY
Defines the density unit types.
PRESSURE_UNITTYPES
Unit type for pressure
PRESSURE
Defines the pressure unit types.
For example, a unit type VOLUME_M3 related to volume measurements should be configured as follows. In LOOKUP configuration, configure LKP_NAME=VOLUME_UNITTYPES and LKP_VALUE=VOLUME_M3. NOTE: If no unit types are configured, then the default units will be considered.
Configuration of Tank Composition Propagation Tank Composition Propagation is a feature of propagating the updated percentage bulk composition values for the components changed to future time periods, particular to equipment. The composition propagation is done by the PLINVENTORY background process. This background process propagates the updated percentage bulk composition value when the propagation feature is enabled. The propagation feature is enabled through a lookup called ENABLE_PROPAGATION. The lookup value is set to False by default. When the value of this lookup is set to TRUE, the propagation feature is enabled. Else, the propagation is disabled. Lookup type (LKP_NAME) ENABLE_PROPAGATION
Lookup value TRUE/FALSE
252 • Production Balance Configuration Guide
Default value FALSE
Description Enables the tank composition propagation feature when set to TRUE.
Appendix C – Lookup and User Attribute Reference
COMPPRPGFREQ
Composition frequency type
DAILY
Specifies the composition frequency for propagating the newly inserted composition records. DAILY – Daily case HOURLY – Hourly case WEEKLY – Weekly case MONTHLY – Monthly case
The most recently updated bulk composition percentage value is propagated forward. NOTE: For a component, if the bulk composition percentage value is updated more than once, then the most recently updated bulk composition percentage value is propagated forward and any updations prior to this are overwritten. Only non-zero bulk composition percentage values are carried forward. Bulk composition percentage with zero value is propagated till prior date to system time. If a new component is added at a timestamp along with existing components, then the new component is also carried forward to all future timestamp records till current date, if only a record exist for the equipment or balance case exist on the timestamp. The composition frequency for propagating the newly inserted composition records is specified through the lookup COMPPRGFREQ. NOTE: For a new component, if the bulk composition percentage values are updated before reprocessing, then the bulk composition percentage value with the oldest timestamp is propagated to future time periods till current date.
Production Balance Configuration Guide• 253
Appendix C – Lookup and User Attribute Reference
This page is intentionally left blank
254 • Production Balance Configuration Guide
Appendix D – Configuring MSGLOGSERVER and PHDSQL for RAC Environment
Appendix D – Configuring MSGLOGSERVER and PHDSQL for RAC Environment Real Application Clusters is a database clustering solution. It is an option for the Oracle Enterprise Edition. Using shared disk architecture, RAC enables applications to exploit cluster availability, scalability, and performance with very minimum modifications. Following are some of the features of RAC: •
Supports multiple instances of Oracle.
•
Supports multiple instances sharing a single physical database.
•
Supports multiple instances simultaneously transacting from a single database.
•
Synchronizes cache, using Oracle’s Global Cache Management technology.
•
Improves performance, using CPU resources across multiple nodes of a single cluster.
•
Retains data even when some nodes fail. Failure of a node results only in the loss of scalability and not in the loss of any data. The high availability of data is possible as all the instances or nodes access the same database file simultaneously.
Refer the Business Flex Oracle Real Application Clusters Guide for more information. The Message Log Server process (called MSGLOGSERVER in Application Server configuration) is responsible for saving messages generated by other background processes as they run. The MSGLOGSERVER and PHDSQL should run on all the instances of RAC environment to access oracle pipes. To achieve this, a number of nodes will be configured for MSGLOGSERVER BG process in TPI. The application server will read the node configuration and submit the oracle jobs with instance number. Two PHDSQL BG processes (PHDSQL NODE 1 and PHDSQL NODE 2) will be configured in TPI. For PHDSQL NODE 1, the connection string should point to instance 1 and for PHDSQL NODE 2, the connection string should point to instance 2.
Production Balance Configuration Guide• 255
Appendix D – Configuring MSGLOGSERVER and PHDSQL for RAC Environment
Perform the following steps to configure this background process in RAC environment: 1. Configure two parameters for the MSGLOGSERVER BG process. The parameters are stored in the IP_APP_PROCESS_CNTRL_PARAM table.
2. Configure the new packaged procedure MSGLOGSERVER_PK.STARTMSG, instead of MSGLOGSERVER.
The Business Flex application server will submit the oracle job to run the MSGLOGSERVER with instance argument value from IP_APP_PROCESS_CNTRL_PARAM table. 3. Configure two PHDSQL BG process and parameters for CONNECT_STRING in tnsnames.ora. Refer to the example given below for the sample tnsnames.ora CONNECT_STRING entries. BFLEX1 = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = bfxorasrv3.global.ds.honeywell.com)(PORT = 1521)) (CONNECT_DATA = (SERVER = DEDICATED) (SERVICE_NAME = BFLEX) (INSTANCE_NAME = BFLEX1)
256 • Production Balance Configuration Guide
Appendix D – Configuring MSGLOGSERVER and PHDSQL for RAC Environment
) ) BFLEX2 = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = bfxorasrv4.global.ds.honeywell.com)(PORT = 1521)) (CONNECT_DATA = (SERVER = DEDICATED) (SERVICE_NAME = BFLEX) (INSTANCE_NAME = BFLEX2) ) )
Following screens provide the PHDSQL configuration changes:
Production Balance Configuration Guide• 257
Appendix D – Configuring MSGLOGSERVER and PHDSQL for RAC Environment
258 • Production Balance Configuration Guide
Notices
Documentation feedback You can find the most up-to-date documents on the Honeywell Process Solutions support website at: http://www.honeywellprocess.com/support If you have comments about Honeywell Process Solutions documentation, send your feedback to: [email protected] Use this email address to provide feedback, or to report errors and omissions in the documentation. For immediate help with a technical problem, contact your local Honeywell Process Solutions Customer Contact Center (CCC) or Honeywell Technical Assistance Center (TAC) listed in the “Support and other contacts” section of this document.
How to report a security vulnerability For the purpose of submission, a security vulnerability is defined as a software defect or weakness that can be exploited to reduce the operational or security capabilities of the software. Honeywell investigates all reports of security vulnerabilities affecting Honeywell products and services. To report a potential security vulnerability against any Honeywell product, please follow the instructions at: https://honeywell.com/pages/vulnerabilityreporting.aspx Submit the requested information to Honeywell using one of the following methods:
Send an email to [email protected]. or
Contact your local Honeywell Process Solutions Customer Contact Center (CCC) or Honeywell Technical Assistance Center (TAC) listed in the “Support and other contacts” section of this document.
Support and other contacts For support and other contact details, go to http://www.honeywell.com/ps .
World Wide Web Honeywell Process Solutions website: http://www.honeywellprocess.com/support
Elsewhere Contact your nearest Honeywell office.
For more information To learn more about Honeywell’s products or solutions visit www.honeywellprocess.com or contact your Honeywell account manager. Honeywell Process Solutions 1250 West Sam Houston Parkway South Houston, TX 77042 Honeywell House, Skimped Hill Lane Bracknell, RG12 1EB Shanghai City Centre, 100 Junyi Road Shanghai, China 20051 www.honeywellprocess.com
