Gas Scheduling Position RTPE Page Implementation Guide for
Transcription
Gas Scheduling Position RTPE Page Implementation Guide for
Gas Scheduling Position RTPE Page Implementation Guide for gMotion 1502 RXR Plaza 15th Floor, West Tower Uniondale, NY 11556 TEL: (516) 227-6600 FAX: (516) 227-1799 WEBSITE: http://www.olf.com Gas Scheduling Position RTPE Page Implementation Guide for gMotion REVISION HISTORY Implementing_the_Gas_Scheduling_Position_RTP E_Page_in_Endur V6.0.doc 4/2003 Initial Release Gas_Sched_Pos_RTPE_Page_Imp_Guide.doc 5/2005 Update Gas_Sched_Pos_RTPE_Page_Imp_Guide.doc 2/2007 Update gM_Gas_Sched_Pos_RTPE_Page_Imp_Guide.doc 3/2009 Updated to new doc format gM_Gas_Sched_Pos_RTPE_Page_Imp_Guide.doc 7/2010 Updated for V9.1r1 and up gM_Gas_Sched_Pos_RTPE_Page_Imp_Guide.doc 2/7/2013 Updated Copyright © 2003, 2013, OpenLink Financial LLC All rights reserved. Copyright 2003, 2013, OpenLink Financial LLC ii Gas Scheduling Position RTPE Page Implementation Guide for gMotion CONTENTS Section Page 1.0 INTRODUCTION.................................................................................................1 2.0 RTPE OVERVIEW................................................................................................4 3.0 IMPORT/EXPORT A POSITION PAGE CONFIGURATION......................................9 4.0 CONFIGURING RTP VIEWER FOR GAS SCHEDULING POSITION PAGE ..............16 5.0 CONFIGURING AN RTPE GAS POSITION PAGE DESKTOP ..................................34 6.0 CONFIGURING RTPE DEFINITIONS..................................................................36 7.0 APPENDIX: CONSOLE REPORTS.......................................................................42 Copyright 2003, 2013, OpenLink Financial LLC iii Gas Scheduling Position RTPE Page Implementation Guide for gMotion ILLUSTRATIONS Section Page Figure 1-1 gMotion Gas Scheduling Process Flow...............................................................................................1 Figure 2-2 Gas Scheduling Page Configuration Overview...................................................................................4 Figure 2-3 Real-Time Position Viewer - On-Demand..........................................................................................5 Figure 2-4 Real-Time Position Viewer - RTPE Reports......................................................................................5 Figure 2-5 Real-Time Page Viewer......................................................................................................................6 Figure 2-6 Real Time Position Module.................................................................................................................7 Figure 3-7 Importing a Position Page Configuration...........................................................................................9 Figure 3-8 Real-Time Position Viewer...............................................................................................................10 Figure 3-9 Import Configurations......................................................................................................................10 Figure 3-10 Select Configuration.......................................................................................................................11 Figure 3-11 RealTime Positions Import Window...............................................................................................11 Figure 3-12 Position Type Configuration Window............................................................................................12 Figure 3-13 Select Position Type........................................................................................................................12 Figure 3-14 Configure Positions Viewer - Populated.........................................................................................13 Figure 3-15 Exporting a Position Page Configuration.......................................................................................13 Figure 3-16 Real-Time Position Viewer - Expanded..........................................................................................14 Figure 3-17 Import Configurations....................................................................................................................14 Figure 3-18 RealTime Positions Export Window...............................................................................................15 Figure 4-19 Selecting Configure Positions from the RTPE Viewer...................................................................16 Figure 4-20 Gas Scheduling Position RTPE Overview......................................................................................17 Figure 4-21 Configuring Real-Time Position Viewer Using Demand Processing..............................................18 Figure 4-22 RTPE Viewer with Results.............................................................................................................19 Figure 4-23 Updating Status - Position Configuration.......................................................................................20 Figure 4-24 Completed Status - Position Configuration....................................................................................21 Figure 4-25 Filter Types.....................................................................................................................................22 Copyright 2003, 2013, OpenLink Financial LLC iv Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 4-26 Volume Type and BAV Filters........................................................................................................23 Figure 4-27 Save Pivot Configuration................................................................................................................25 Figure 4-28 Saving a Global Position View........................................................................................................26 Figure 4-29 Saving a Local Position View..........................................................................................................26 Figure 4-30 Using Update to Build the RTPE Page...........................................................................................27 Figure 4-31 Configuring RTPE Definitions Using the Real-Time Position Viewer...........................................28 Figure 4-32 Selecting Local Position Type and Position View...........................................................................29 Figure 4-33 Building Local Position View..........................................................................................................29 Figure 4-34 Completed Local Page.....................................................................................................................30 Figure 4-35 Local Page with Expanded Pivot....................................................................................................30 Figure 4-36 Global RTPE Page..........................................................................................................................31 Figure 4-37 Configuring Global RTPE Definitions Using the Real-Time Position Viewer...............................32 Figure 4-38 Real-time Position Viewer...............................................................................................................33 Figure 4-39 Real-time Position Viewer Expanded.............................................................................................33 Figure 5-40 Configured Desktop........................................................................................................................34 Figure 5-41 Desktop Tree Menu.........................................................................................................................34 Figure 6-42 Configuring an RTPE Definition....................................................................................................36 Figure 6-43 Real-Time Position Viewer.............................................................................................................36 Figure 6-44 Configured Definition.....................................................................................................................37 Figure 6-45 Missing Pivot Table Message..........................................................................................................37 Figure 6-46 Save Position View..........................................................................................................................38 Figure 6-47 RTPE Online Confirmation............................................................................................................38 Figure 6-48 Online RTPE Definition Process.....................................................................................................40 Figure 6-49 Operations Manager - Real-time Positions.....................................................................................41 Figure 7-50 Olisten Report Console – Demand Processing................................................................................42 Figure 7-51 Olisten Report Console – Local RTPE Report...............................................................................42 Figure 7-52 Olisten Report Console – Global RTPE Report.............................................................................43 Copyright 2003, 2013, OpenLink Financial LLC v Gas Scheduling Position RTPE Page Implementation Guide for gMotion TABLES Section Page Table 1-1 gMotion References..............................................................................................................................3 Table 2-2 RTPE Report Definitions.....................................................................................................................7 Table 2-3 RTPE Operation Modes.......................................................................................................................8 Table 3-4 Open the Real-Time Position Viewer...................................................................................................9 Table 4-5 Real-Time Page Viewer Filter Types..................................................................................................21 Table 4-6 Volume Type & BAV Filters - Value Implications.............................................................................23 Table 4-7 Pivot Function Views..........................................................................................................................24 Table 4-8 Pivot Table Setup...............................................................................................................................24 Table 5-9 Desktop Tree Menu Options..............................................................................................................35 Table 6-10 Position View Save Options..............................................................................................................38 Copyright 2003, 2013, OpenLink Financial LLC vi Gas Scheduling Position RTPE Page Implementation Guide for gMotion 1.0 1.1 INTRODUCTION Purpose The OpenLink System provides a means to configure the Page Viewer to display only relevant fields, or fields that change from trade to trade. The Gas Scheduling Position RTPE is a specific page that is used to view Gas Scheduling positions. This page allows access to review Real-time reports which are created using RTPE plug-ins/scripts. RTPE plug-ins/scripts are usually more complex than standard report plug-ins/scripts. OpenLink can create new custom RTPE reports for clients as an out-of-scope service. Standard Real-Time Reports are available with each version of the System. This page can be used to view on-demand results from RTPE plug-ins/scripts or automatic or realtime reports created through the Real-Time Position Engine (RTPE). 1.2 gMotion Gas Scheduling Process Flow The process diagram below (Figure 1-1) outlines the setup and configuration for gMotion as a series of logical steps. Gas Scheduling Position RTPE is used in Quantity Management. Figure 1-1 gMotion Gas Scheduling Process Flow 1.3 Personnel This document assumes that users are familiar with the Services Manager, specifically, how to pick run sites and set up engines. The person implementing the RTPE page should understand the Operations Manager, including how to start and stop RTPE. This person should also have a good working knowledge of the OpenLink Desktop. The Personnel responsible for the usage of the data contained in this text should also have familiarity with the Endur product, specifically the following: Trading Explorer Desktop/Trading Manager gMotion (Gas Scheduling) Copyright 2003, 2013, OpenLink Financial LLC Admin Manager 1 Gas Scheduling Position RTPE Page Implementation Guide for gMotion All users must have the appropriate Security Privileges assigned in order to use this functionality. 1.4 Configuration Considerations In order to use gMotion, the OpenLink System settings must be properly configured. Refer to the gM_Configuration_Guide for recommended settings. 1.5 gMotion References The documents and guides available as gMotion references are listed and described below. Documentation Description Online Help User Guide The Online Help User Guide describes general configuration information used to configure the System for gas scheduling. Most of the information is applicable to gMotion. The Online Help User Guide also provides full descriptions of windows, deals and transactions used in gas scheduling. Menus, panels, lists, buttons and fields are fully detailed. gM_Introduction_to_gMotion This document provides an overview of the gMotion Gas Scheduling Process Flow and a description of all the documents and guides provided by OpenLink as references. gM_Configuration_Guide This document describes specific configuration considerations for gMotion. Incorporates the former: gM_On_System_Configuration gM_Rate_Definitions gM_Transport_Contracts Formerly: gM_Create_Transport_Contracts gM_Storage_and_Park_ Loan_Templates Formerly: gM_Create_Storage_and_Park_ Loan_Templates gM_Nomination_Creation_ and_Management Incorporates the former: gM_Nom_Validation_Tech_Details gM_Auto_Nomination_in_gMotion gM_Measurement_Data_ and_Allocations This document describes how Transportation and Exchange (T&E) users may properly model a variety of contracts enabling new contracts to be created as quickly as possible on a day-to-day basis. This document describes Park and Loan contracts that charge for utilization based only on average daily balances and do not have reservation or fuel charges. Standard storage contracts have monthly reservation charges and daily usage charges based on the actual injection or withdrawal amounts. Fuel can be applied to injection and/or withdrawal amounts. This document describes the creation and management of nominations. The Nomination Creation module is used to create new nominations and to manage internal nominations (Off-System) while the Nomination Management module is primarily used for data entry of third party (OnSystem) nominations. This document describes the capture of measurement data and allocation methods. Copyright 2003, 2013, OpenLink Financial LLC 2 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Documentation Description gM_Quantity_Management_ and_Settlement The Back Office group of some companies is responsible for managing a variety of activities for the settlement of physical natural gas transactions. In some companies, the Gas Control or Volume Management group manages the activities that include reconciling Service Provider statements (quantities, imbalances, charges, etc.), generating invoices and remittance statements, and managing prior period adjustments (PPAs). This document describes how all of the essential activities are completed using gMotion screens and Endur functionality. gM_Gas_Sched_Pos_RTPE_ Page_Imp_Guide The Gas Scheduling Position RTPE is a specific page configured for Page Viewer that is used to view gas-scheduling positions. This page allows access to review real-time reports which are created using RTPE plug-ins/scripts. gM_Desktop_Configuration_ Guide This document describes desktops that gMotion employs to manage various aspects of gas scheduling. Table 1-1 gMotion References Copyright 2003, 2013, OpenLink Financial LLC 3 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 2.0 RTPE OVERVIEW RTPE is the real-time position engine, providing real-time trade information. It is a separate process launched through the Master Control Panel. Similar to the script engine (SCRENG), RTPE interacts with an RTPE task, the container around the plug-in/script that controls how the plug-in/script is run. Once the plug-in/script has been passed to the SCRENG, it runs the plugin/script and creates a report. RTPE can generate reports to update on a continuous basis. The RTPE Server is a separate process that constructs and caches real-time page images (Position Views). RTPE runs a batch plug-in/script to construct an initial page image (known as a Batch Run). It runs a deal plugin/script to keep the page up-to-date with newly booked deals (incremental run). It caches the detail records used to construct each of the page images. Finally, it delivers subsets of the records to subscribing clients whenever these clients request drill-down details. An RTPE client subscribes with interest in a specific RTPE Position View (or page image). Each time the page changes as either a batch or incremental run, all of the subscribers are notified to the new page content. The Position page is an example of an RTPE subscriber. Subscribers can request drill-down details relating to a specific page image or cell. The Script Engine (SCRENG) is responsible for running the RTPE plug-in/script to produce both the detail records and the page image. The plug-in/script assembles and submits a database query to the server. The plug-in/script derives additional columns of data, if required. It transforms the records into a report or page using the Pivot function, which aggregates the data from the detail records into a report. 2.1 RTPE Implementation Process As shown in Figure 2-2, the RTPE Implementation process starts with importing the configuration files that come with the System. The Real-Time Position Viewer is then configured followed by the RTPE Definition. The OpenLink Desktop Page is configured independently after the import is completed. The details of the configuration process will be covered in later sections of this document. Figure 2-2 Gas Scheduling Page Configuration Overview Copyright 2003, 2013, OpenLink Financial LLC 4 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 2.1.1 On-Demand vs. RTPE In on-demand processing, the Real-Time Position Page Viewer ( Figure 2-5) requests a position page image. The SCRENG runs a batch plug-in/script and returns the detail records. The RealTime Page Viewer pivots the details to produce the page image, and displays the pivot result in a tree-view. These detail records can be re-pivoted as required. Figure 2-3 Real-Time Position Viewer - On-Demand RTPE reports are similar. However, the Real-Time Page Viewer ( Figure 2-5) requests a position page image by subscribing to an RTPE definition. The page image is published by RTPE to the Real-Time Page Viewer that displays the results in a tree-view. Unlike on-demand processing, the details do not reside in the Real-Time Page Viewer so the data cannot be re-pivoted. RTPE sends updates as they become available to the Real-Time Page Viewer so the image is displayed with the most current data. Figure 2-4 Real-Time Position Viewer - RTPE Reports Copyright 2003, 2013, OpenLink Financial LLC 5 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 2-5 Real-Time Page Viewer 2.1.2 RTPE Reports RTPE (Real Time Position Engine) is an incremental reporting tool used to produce reports. The information on these reports is sensitive to the booking of new trades. The RTPE report utilizes a scripted report and runs it every time a new trade is booked, incrementing the original values with the values for the new trade. Reports are updated, as trades are booked. The RTPE report typically is run at startup and then again every time a new trade is booked or when an existing trade is amended. The Real Time Position module (Figure 2-5) enables the user to set up RTP monitoring. Once the required RTP Definition is created, monitoring may be turned on for that definition. Incremental report updating takes place whenever a deal is booked (the Deal plug-in/script is run automatically.) The monitoring process begins only after the RTP Engine starts. The RTP Engine is started through the Services Manager. In the Real Time Position module, there are three RTPE definition Types ( Figure 2-6). They are defined in the table below. RTPE Report Definition Description Custom Page – No Details Represents the old style RTPE custom definitions Existing old-style RTPE plug-ins/scripts are backwards compatible Copyright 2003, 2013, OpenLink Financial LLC 6 Gas Scheduling Position RTPE Page Implementation Guide for gMotion RTPE Report Definition Description Detailed Custom Page Power Page Existing page viewer is used (and is started from a display plugin/script) Must generate the report and its contents each time it is run Requires setup through the Real-Time Position Viewer page, plugin/script driven The viewer selects filter criteria, which in turn, controls the returned details Position pages constructed from a desktop can be saved as an RTPE page directly from the Desktop A standalone viewer can display from Openlink Central Launch Available Services View Real-Time Position Viewer No display plug-in/script is necessary Allows for drill-down in individual cells (fetching appropriate details) Power position pages configured in the Desktop can be built by RTPE, providing sharing of Power Position pages Power Position pages constructed from a desktop can be saved as RTPE pages directly from a desktop by selecting Configurations Save As RTPE Page A Position Page panel can be viewed in a standalone viewer Table 2-2 RTPE Report Definitions Figure 2-6 Real Time Position Module Copyright 2003, 2013, OpenLink Financial LLC 7 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 2.1.3 Modes of Operation for the RTPE Plug-in/Script RTPE can be run in two modes, detailed below. RTPE Operation Mode Description On-Demand (Local) On-Demand may be run once locally with the local database (not real-time with the current database). Users may choose to create a report manually. Each user would pull information from the database, run a plug-in/script, and generate a report. Note: On-Demand is available only while configuring. Real-Time (Global) RTPE utilizes Real-Time Page Management. Reports are kept up-to-date using this process. The clients subscribe to a page(s) of RTPE, and RTPE updates the client each time the data on the selected page changes. The steps involved in RTPE processing are: Starts and runs the RTPE batch plug-in/script, identified in the configuration Runs the plug-in/script on the SCRENG associated with the RTPE server on a centralized host Returns the details and pivoted view to the RTPE server where it is cached and made available to others Publishes only the page image in which the Real-Time Page Viewer has subscribed for interest. Table 2-3 RTPE Operation Modes Copyright 2003, 2013, OpenLink Financial LLC 8 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 3.0 IMPORT/EXPORT A POSITION PAGE CONFIGURATION This section breaks down the processes of importing/exporting position page configurations via the Real-Time Position Viewer. The first step in the implementation process is to import the gas scheduling position configuration file included with the System (see Section 3.1). Pivot Table setup will be discussed in a later section. Follow the steps below to open the Real-Time Position Viewer for import or export from the preferred starting point. From: Steps: OpenLink Central 1. Select Launch Available Services from the menu. 2. Select “Real Time Position Viewer” from the pick list and click the Launch button. The Real-Time Position Viewer window is displayed. Trading Explorer Desktop 1. Select OpenLink Central ® Configuration ® Launch Available Services from the main menu. 2. Select “Real Time Position Viewer” from the pick list and click the Launch button. The Real-Time Position Viewer window is displayed. Trading Manager 1. Select View ® Position Viewers ® Real-Time Position Viewer from the main menu. The Real-Time Position Viewer window is displayed. Table 3-4 Open the Real-Time Position Viewer 3.1 Importing a Position Page Configuration Importing configurations loads context into the Real-Time Position Viewer and saves the configuration from an external file in the file system to an internal Application File System (AFS) file. Associated plug-ins/scripts are also saved to the AFS database. Figure 3-7 Importing a Position Page Configuration Copyright 2003, 2013, OpenLink Financial LLC 9 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Follow the steps below to import a Position Page Configuration. 1. Open the Real-Time Position Viewer (see Section 3). 2. Click the Configure Positions button. If it is not visible, click the down arrow button to expose the fields in the top portion of the screen. Figure 3-8 Real-Time Position Viewer 3. Select Import Configurations from the Import/Export menu. Figure 3-9 Import Configurations Copyright 2003, 2013, OpenLink Financial LLC 10 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 4. Select the STD_IMPEXP_RealTimePosition.tgz file, and click the Open button. Figure 3-10 Select Configuration 5. Click the Process button on the RealTime Positions Import window. Figure 3-11 RealTime Positions Import Window Copyright 2003, 2013, OpenLink Financial LLC 11 Gas Scheduling Position RTPE Page Implementation Guide for gMotion The process will automatically import the Configuration Name, Plug-in/Script Name as well as display the details in the SQL field. 6. Review the import detail in the Position Type Configuration (Figure 3-12) window and if satisfied select close the window. This will return to the Configure Positions window. Figure 3-12 Position Type Configuration Window 7. Right click the Position Type field and select the newly imported configuration from the pick list (STD_GSPos). Click the Update button. Figure 3-13 Select Position Type Copyright 2003, 2013, OpenLink Financial LLC 12 Gas Scheduling Position RTPE Page Implementation Guide for gMotion If filters are associated with the configuration, they will appear in the viewer window. Save the imported position is not necessary until a pivot table is defined (covered in a later section). Figure 3-14 Configure Positions Viewer - Populated 3.2 Exporting a Position Page Configuration This function allows the user to export a Position Page configuration. The export function can be helpful when copying configurations for security/back-up purposes or when transferring configurations from one database to another. Exporting configurations unloads context from the Real-Time Position Viewer and saves the configuration as an external file. Figure 3-15 Exporting a Position Page Configuration Copyright 2003, 2013, OpenLink Financial LLC 13 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Note: The exported file is not in text format. It has embedded binary characters making the file unreadable as a text file. An export consists of the configuration that is currently in scope, and the plug-in/script selected in the configuration window. These elements are exported as one system file. Follow the steps below to export a Position Page Configuration. 1. Open the Real-Time Position Viewer (see Section 3). 2. Click the Configure Positions button. If it is not visible, click the down arrow button to expose the fields in the top portion of the screen. 3. Click the Configure Positions button. Figure 3-16 Real-Time Position Viewer - Expanded 4. Select Export Configurations from the Import/Export menu. Figure 3-17 Import Configurations Copyright 2003, 2013, OpenLink Financial LLC 14 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 5. Specify a new Output File Name and Export Path or use the pick list to select an existing configuration to replace. Click OK when finished. Figure 3-18 RealTime Positions Export Window Copyright 2003, 2013, OpenLink Financial LLC 15 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 4.0 CONFIGURING RTP VIEWER FOR GAS SCHEDULING POSITION PAGE As described in Section 2.1.1, the on-demand page is created on an ad hoc basis. The RTPE page is a canned page but provides the flexibility of creating reports. Reports are generated using pivoting techniques on different criteria such as specific Portfolios, Instrument Types, Status, etc. Note the following: There are practical applications for each category of reports Demand processing is useful when configuring position pages The RTPE version is useful for real-time reports and when a format has a long-term use RTPE pages have drill-down capabilities allowing users to retrieve the underlying detail data. This means users can view all the deals that contributed to producing the page. The RTPE task is created when the first RTPE Position Type is saved through the Real-Time Page Viewer. The RTPE Task and Position View are associated with the RTPE Definition and the RTPE Task runs the designated plug-in/script. All configuring steps involving selecting filter criteria and pivot definitions are done through the Configure Positions window that is accessed from the Real-Time Viewer Position Viewer. Figure 4-19 Selecting Configure Positions from the RTPE Viewer Copyright 2003, 2013, OpenLink Financial LLC 16 Gas Scheduling Position RTPE Page Implementation Guide for gMotion The RTPE Task is set to run once and terminate. RTPE updates only the new information for a page when a trade is booked. In the case where business logic dictates that the RTPE Page updates on a schedule, regardless of new information is entered for a deal, the RTPE Task can be modified via the Task Editor. The task can be modified to cause the RTPE Task to re-run on a user-defined schedule (this is considered an automatic RTPE Page). Figure 4-20 Gas Scheduling Position RTPE Overview Figure 4-21 breaks down the process depicted in the left leg of Figure 4-20. Copyright 2003, 2013, OpenLink Financial LLC 17 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 4-21 Configuring Real-Time Position Viewer Using Demand Processing Copyright 2003, 2013, OpenLink Financial LLC 18 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 4.1 Configuring Real-Time Position Viewer Using Demand Processing 4.1.1 Overview When clicking the Update button in the Real-Time Position Viewer a specific plug-in/script is invoked to run on the local script engine. The details (or results) are returned to the viewer. Figure 4-22 RTPE Viewer with Results On-demand reports contain information to meet needs that are not known ahead of time. Although they may be run on a group of trades, they contain information that a trader wants to see at that moment. Additional security has been added to the System limiting users to only the functions that their security privilege authorizes them to perform. Refer to the Online Help User Guide for full descriptions of security privilege settings for the Configure Position Page. One disadvantage to this process is the amount of memory needed to store the details. In some cases where the selected filters have large sets of data, there is a possibility that memory may run out on the local machine. The RTPE server will usually have more memory than user workstations. Copyright 2003, 2013, OpenLink Financial LLC 19 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 4.1.2 Configuration Demand Report Follow the steps below to create a demand report (Note: this page builds in the local SCRENG as a Demand Page.): 1. Open the Real-Time Position Viewer (see Section 3). 2. Choose Configure Positions from the Configure menu or expand the Real-Time Position Viewer and use the Configure Positions button. 3. Right click in the Position Type field to display a pick list of available choices. Select a Position Type. The filters will be enabled and allow modifications to any of the filters that are displayed. 4. After saving or selecting a pivot, right click the Position View field to select an existing position view or to create a new position view. For more details, please refer to Section 4.4 Saving a Position View . 5. Right click the Pivot field to select an existing pivot or to create a new pivot. For more information, refer to Section 4.2.1. 6. When configuration of this window is completed, click the Update button. It will take some time to build the page. As the plug-in/script is executing, the Task Status displays in the lower right. Note: If the Cancel button is clicked after the Update has started, the plug-in/script stops processing and does not complete. Figure 4-23 Updating Status - Position Configuration Copyright 2003, 2013, OpenLink Financial LLC 20 Gas Scheduling Position RTPE Page Implementation Guide for gMotion When the page is complete, the Status indicates that the plug-in/script is complete. Note: There are now column names in the Report section of the Real-Time Page Viewer. Note: The Status field always indicates the task status during Demand Page Processing. Figure 4-24 Completed Status - Position Configuration 4.2 Configuring Filters The fields located at the top of the window act as filters for displaying data retrieved from the database. These filters work in conjunction with the SQL statements in the configuration file used to produce the query. The query returns a result set of detail records. By selecting data to use in the Filter fields, the user is essentially modifying the Where Clause of the query and controlling the details in the result set returned from the database. The types of filters available for the Real-Time Page Viewer are: Filter Type Description Normal This controls conversions to be done on the data by the plug-in/script. Units cause the volumes to be converted for display as the selected volume units. Unit conversion factors must be setup before they can be used in the unit Normal filters SQL There are two columns of SQL filters available in the Real-Time Page Viewer. If the SQL filter is selected, the data in the record must be an exact match to be included in the result set. Pick-lists are available for each field, and more than one item from each pick list can be selected. Table 4-5 Real-Time Page Viewer Filter Types Copyright 2003, 2013, OpenLink Financial LLC 21 Gas Scheduling Position RTPE Page Implementation Guide for gMotion If no filter information is entered, the System returns the largest result set possible. Filters, SQL statements, and plug-ins/scripts all work together. The combination of all three functions provides a way for users to limit the size of the result set. Without filters, the System returns all available data to the machine. This creates a result set that is unwieldy in size. Filters are meant to help create smaller, more meaningful result sets. Normal Filters SQL Filters Figure 4-25 Filter Types Normal filters allow users to pre-configure the results so that all selected data displays the same way. Normal filters are initially entered in the Configure Positions Page Viewer window. Volume Units is a single-select pick list of units. Selecting one causes all of the volume values to be converted from the native deal units to the selected units. Daily View is a symbolic date string that controls how much of the report displays daily volumes vs. first-of-month (FOM) values. Setting it to 2LOM displays two months’ worth of daily volumes, and the rest display as FOM volumes. 0LD displays all FOM volumes, and blanks display in all daily volumes. 4.2.1 Using the Volume Type & BAV Filters The Volume Type and BAV (Best Available Volume) filters should be used in a mutually exclusive fashion. For instance, selecting a Volume Type will limit the positions returned to that particular volume type. Simultaneously selecting a BAV of Yes (along with a volume type selection) would result in a filter that displays the selected volumes ONLY when that volume happens to be the best available volume (i.e., the filters create a logical AND). Copyright 2003, 2013, OpenLink Financial LLC 22 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 4-26 Volume Type and BAV Filters Selection Implication Volume Type: Selected BAV: Yes The selected volume type will be displayed only if it is the best available volume for the position. Volume Type: Selected BAV: No The selected volume type will be returned if it is not the best available volume for the position. Volume Type: Selected BAV: No The selected volume type will be returned. Volume Type: Not Selected BAV: Yes Only the best available volume will be returned. Volume Type: Not Selected BAV: No The volume will be displayed if it is not the best available volume. Volume Type: Not Selected BAV: No Positions with all volume types will be returned, regardless of best available volume status. Table 4-6 Volume Type & BAV Filters - Value Implications 4.3 Creating a Pivot A pivot is a transformation of data from detail records in the database to the final image, or report view. The pivot configuration controls the look and the content of the position page image. The rows and columns that display in the page image are derived from the pivot row and pivot column configurations. The cell content of the resulting page image is either the raw data residing in the pivot column data-cells or the result of aggregating a single pivot data attribute from the input detail records. The pivot column specification controls the generation of columns in the resulting page image. Pivot columns describe how to create output columns. For example, it is possible to pivot on the deal-tracking number, which would add an arbitrarily large number of columns to the resulting page image. Copyright 2003, 2013, OpenLink Financial LLC 23 Gas Scheduling Position RTPE Page Implementation Guide for gMotion The pivot row specification controls the grouping (or sorting) of the resulting page image. It also controls the creation of group sum rows used to enhance the display of the pivoted result; thus, a “tree-view” can be imposed in the Real-Time Page Viewer. Inserting group summary rows between all groups could cause a seemingly small table of results to explode in size, based on the grouping (or pivot row) criteria. Great care must be taken when configuring pivots to ensure that the resulting page image yields a matrix of results that are manageable in the script engine (at the point of generation), RTPE (for caching), and the Real-Time Page Viewer (for viewing). RTPE caches both the detail records and the pivoted page result. There are two views in the pivot function: Function Description Pivot This function provides a cross-tabulation of the detail records. Group This function provides a grouping of detail records. Rows are summed to create summary rows, and columns are attributes that live in detail records. Table 4-7 Pivot Function Views Once the desired filter conditions are applied, the next step is to set up a pivot view of the returned data. The same information that displays in the global RTPE report can be transformed in many different ways. The current report details volume by date by pipeline. However, a subset of this report can be created by changing the pivot to display the same data in a different way. The following example illustrates how to define a pivot: Table 4-8 Pivot Table Setup Copyright 2003, 2013, OpenLink Financial LLC 24 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 1. From the Configure Positions window, with the returned data displayed, click the Pivots button. The Pivot Table Setup window for the selected global RTPE Page displays. 2. Information can be added to the columns, rows, and/or data columns by selecting the new information from the table on the left and clicking the button on the right to add it to the appropriate spot. Similarly, data can be removed from the page by selecting it in the spot in which it occurs, and clicking the appropriate remove button. This functionality is also available by utilizing the commands on the Tools menu. Information can be moved up or down the hierarchy of the pivot by clicking the up or the down arrow next to the data. 3. Click the Apply button to apply the changes made and view the results in the Configure Positions Page Viewer. 4. When modifications to the pivot table have been completed, select File Save. Alternately, select File Save Public to save this pivot table in the public scope for other logins to see. The system assumes the table is saved as a private table if File Save is selected. Either save the current pivot with the modifications entered, or create a new pivot by entering a different value in Pivot Name. 5. Click OK when finished. Figure 4-27 Save Pivot Configuration Note: If the user has chosen to save the same pivot name with modifications, a warning message displays indicating that a pivot with the selected Pivot Name already exists. Click OK to return to the Pivot Table Setup window. Panels, buttons and fields of the Pivot Table Setup window are described in detail in the Online Help User Guide. 4.4 Saving a Position View Once a pivot has been configured and saved, a Position View may be defined to store this definition. The Position View Configuration window is where users define and save personal Copyright 2003, 2013, OpenLink Financial LLC 25 Gas Scheduling Position RTPE Page Implementation Guide for gMotion definitions of Gas Scheduling Position RTPE Pages. In addition, this window allows symbolic date information to be entered and saved with the configuration. The position view can be saved as either local/private (available to only the person who defined it) or global/public (available to everyone in the System). Follow the steps below to save a position view: 1. From a global RTPE Page in the Configure Positions Viewer window, with the data configured to the saved pivot configuration, click Save As. The Position View Configuration window displays. Figure 4-28 Saving a Global Position View 2. Uncheck the Local Page checkbox. When this is done, the Security Groups field is enabled. 3. Enter a value in Position View Name. 4. Select the Security Groups from the drop down menu. 5. Select OK. The Position View the user defined is saved to the database. If a user prefers to save the position view as a Local Position configruation, then the Local Page checkbox must be selected. Fill in the Postion View Name and proceed to save the information. Figure 4-29 Saving a Local Position View Copyright 2003, 2013, OpenLink Financial LLC 26 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 4.5 Configuring RTPE Definitions Using the Real-Time Position Viewer As stated previously, Real-Time Position Page processing is available as Local and Global . For Local Pages, select a Page Type, a set of Filters, and a Pivot. Click the Update button to build the page on the local workstation. Filters and Pivots can also be selected by choosing a position view. Select a Position Type and a Position View (definition) for global pages. Figure 4-30 Using Update to Build the RTPE Page Click the Update button to display the report already built using the Global RTPE Engine. Global RTPE Pages require a definition describing how to build its pages. A position view must be created for each RTPE Page. Executing an RTPE report centralizes the consumption of resources, which allows it to work behind the scenes. Once completed, the page resides on the server; therefore, no extra resources are utilized. In addition, the data is refreshed automatically, so whenever the report is accessed, it contains the latest data. Not every report can be set up as a real-time report. RTPE reports are designed to contain information that is sensitive to new trades and important enough to justify the slight overhead on the system that each additional RTPE report incurs. Currently, RTPE is not infinitely scalable; therefore, the features and limitations must be carefully assessed. 4.5.1 Local RTPE By not providing a Position Type, the Local Engine builds a page image using the filter settings selected when Update is clicked. Figure 4-31 breaks down the process depicted as the Not Selected, Use Local leg of Figure 4-20. The procedure for this process follows the flowchart. Copyright 2003, 2013, OpenLink Financial LLC 27 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 4-31 Configuring RTPE Definitions Using the Real-Time Position Viewer 1. Open the Real-Time Position Viewer (see Section 3). 2. Select the Configure Configure Types to open to the Configure Positions window. Copyright 2003, 2013, OpenLink Financial LLC 28 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Note: The Position Type and Position View have not been selected. As a result, the Filters are not available. Figure 4-32 Selecting Local Position Type and Position View 3. Select a Position Type. Right click the field to display a pick list of available choices. 4. Once a Position Type is chosen, the filters (Date, SQL, and Normal) display. Modify any of the filters that display. 5. Right click the Position View field to select an existing position view. 6. Right click the Pivot field to select an existing pivot. A pivot must be selected, if there is no pivot name embedded in the selected position view. 7. Once the configuration is completed, click the Update button. Status displays towards the lower right corner. Figure 4-33 Building Local Position View Copyright 2003, 2013, OpenLink Financial LLC 29 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Note: When the Update button is clicked, the System starts a local RTPE Engine. **LOCAL** displays at the bottom of the page. If the Cancel button is clicked after selecting Update, the process disconnects itself from the Local engine and allows users to select a Global Position Type. It will take some time to build the page. When the page is complete, the data displays in the Report section. The local RTPE Page remains active and continues to update itself as long as there is at least one viewer open. Figure 4-34 Completed Local Page Expand the Pivot view by clicking any sign. Figure 4-35 Local Page with Expanded Pivot Copyright 2003, 2013, OpenLink Financial LLC 30 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Note: For additional information about navigating tree views, please refer to Section 5.1. 4.5.2 Global RTPE By selecting a specific Position Type and clicking Update, the user subscribes to a real-time report. Only Position Views that are “advertised” by RTPE (i.e., they are available on the pick list) are available to be selected. The response to a subscription is a copy of the page with pivoted results. Figure 4-36 Global RTPE Page In this case, the client holds only what is necessary. The details are held on the server. The client does not run the plug-in/script. Once subscribed to RTPE and the users receive a response from RTPE, the Real-Time Position Viewer keeps the page automatically up-to-date without having to solicit another update by the user. RTPE sends the update to the specific page. Note: Detail records are derived differently from those on the listing window. The details that display when a cell is double-clicked, (also known as drill-down details) may not match what is seen in the listing section. Just as with the local RTPE Page, users can double-click a specific report cell. This produces details for that cell. The System drills down to display the details (of all deals participating in the cell) that correspond to the report cell attribute that displays in the listing for that deal. Figure 4-37 breaks down the process depicted in the Not Selected, Use Global leg of Figure 4-20 Gas Scheduling Position RTPE Overview . The procedure for this process is shown below. Note: For more information on Global RTPE reports, please refer to Section 6. Copyright 2003, 2013, OpenLink Financial LLC 31 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 4-37 Configuring Global RTPE Definitions Using the Real-Time Position Viewer Follow the steps below to subscribe to a global RTPE Page: 1. Open the Real-Time Position Viewer (see Section 3). 2. Select a Position Type. Right click the field to display a list of available choices. Once a Position Type has been selected, the filters are available. Expand the down arrow ( ) to the right of the screen to see the filters. 3. Select a Position View. Right click the field to display a list of available choices. Note: Because a Position View has been selected, this is a Global RTPE report. Copyright 2003, 2013, OpenLink Financial LLC 32 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 4. When the configuration of this window is completed, click the Update button. This button connects the System to a global RTPE Page. The Status displays in the lower right corner. The Global RTPE report displays. Figure 4-38 Real-time Position Viewer Expand the Pivot view by clicking any views, please refer to Section 5.1. sign. (For additional information about navigating tree Note: If Cancel is selected, the process disconnects from the Global. Figure 4-39 Real-time Position Viewer Expanded Copyright 2003, 2013, OpenLink Financial LLC 33 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 5.0 CONFIGURING AN RTPE GAS POSITION PAGE DESKTOP Refer to the document titled gM_Desktop_Configuration_Guide for detailed instructions on setting up a Gas Position Page Desktop. Figure 5-40 Configured Desktop 5.1 Tree Menu There are other ways to expand and collapse groups within a report. Right clicking any group in a report displays the following menu: The user can select from the menu how they wish to see the different levels in a report. The following table lists each command and the display that results from its use: NOTE: The Expand menu is based on the pivot definition. As a result, the menu selection will change when alternative pivots are used. Copyright 2003, 2013, OpenLink Financial LLC Figure 5-41 Desktop Tree Menu 34 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Command Behavior Collapse Item Collapse only the selected row. If the selected row is the first row of a group, the entire group is collapsed. If the selected row is not the first row of a group, only the selected row is collapsed. If the selected row is already collapsed, this command has no effect on the behavior of the selected row. Expand Item Expand only the selected row. If the selected row is the first row of a group, the entire group is expanded. If the selected row is not the first row of a group, only the selected row is expanded. If the selected row is already expanded, this command has no effect on the behavior of the selected row. Collapse Entire Group Collapse only the selected group. If the selected group is the primary or first row of a group, the entire group is collapsed. If the selected row is not the primary or first row of a group, only the selected row is collapsed. If the selected row is already collapsed, this command has no effect on the behavior of the selected row. Expand Entire Group Expand only the selected group. If the selected group is the primary or first row of a group, the entire group is expanded. If the selected row is not the primary or first row of a group, only the selected row is expanded. If the selected row is already expanded, this command has no effect on the behavior of the selected row. Collapse All Collapses the entire report, regardless of which row the cursor is active on. If the entire report is already collapsed, this command has no effect on the display behavior of the report. Expand All Expands the entire report regardless of which row the cursor is active on. If the entire report is already expanded, this command has no effect on the display behavior of the report. Expand to Loc: Zone Expands the entire report to the Zone location of each row, regardless of which row the cursor is active on. If the entire report is already expanded, this command has no effect on the display behavior of the report. Expand to Deal: Contract Expands the entire report to the Contract of each row, regardless of which row the cursor is active on. If the entire report is already expanded, this command has no effect on the display behavior of the report. Table 5-9 Desktop Tree Menu Options Copyright 2003, 2013, OpenLink Financial LLC 35 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 6.0 CONFIGURING RTPE DEFINITIONS RTPE Definitions are created when multiple users subscribe to an RTPE report (all of the processing is handled by the server). Before configuring an RTPE Definition, the configuration of the Real-Time Position View with for all filters, pivots, and position views must be completed. There are three basic steps involved in configuring an RTPE Definition. They are illustrated in the following diagram: Pick a Page Type Select a Position View Save a Postion Type Repeating this process builds a list of Postion Types for the RTPE Definition. Figure 6-42 Configuring an RTPE Definition Note: The creation of an RTPE Definition is a database operation. This means Position Types will not display until RTPE generates the definition. No action takes place on the RTPE Server until the definition is brought online. Each time RTPE comes up, it reads the RTPE Definition table and builds pages for each definition that is online. The RTPE Service is started and stopped via the Services Manager. 6.1 Configure RTPE Definitions Follow the steps below to configure an RTPE Definition: 1. Open the Real-Time Position Viewer (see Section 3). Figure 6-43 Real-Time Position Viewer 2. Select Configure Configure Positions or expand and click the Configure Positions button. Copyright 2003, 2013, OpenLink Financial LLC 36 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 3. Right click Position Type to display a pick list of available choices. (This may take a few seconds.) Select STD_GSPos. 4. Right click the Position View field to select an existing position view. Figure 6-44 Configured Definition 5. Click the Save As button. Note: If the following message displays: Figure 6-45 Missing Pivot Table Message The user is being informed that the Position View will be saved without specifying a Pivot Name. RTPE requires a Pivot for each page it generates. Cancel or press No and reselect the Position View. Before clicking Save As, ensure that there is a value in the Pivot field. 6. The Save Position View RTPE box opens. Deselect the Local Page button to enable a Global RTPE Definition. 7. Enter a RTPE Position View Name. Copyright 2003, 2013, OpenLink Financial LLC 37 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 6-46 Save Position View Security Groups limit who can view the Position Type. The default Security Group is blank. This gives permission to everyone to view this Position Type. To apply more security, right click Security Group to display a list of groups. Only one may be selected. This will be the only group that can view the Position Type Page. Note: RTPE Defn ID initially displays as New. The System defines a unique ID to this RTPE Definition after it has been saved. The value in RTPE Defn Reference should be the name the user selected for Page Type in the Real-Time Position Viewer window. 8. When the information is completed, click the OK button. The following message displays: Figure 6-47 RTPE Online Confirmation Select one of two options: Option Definition Yes The definition will be saved and the RTP page will be built and updated. No The definition will be saved but the page will not be built. It is recommended that users creating multiple RTPE Pages should select no and change filters and pivots and save. Table 6-10 Position View Save Options 6.2 Viewing RTPE Local and Global RTPE Pages The RTPE Position Views listing is located at the bottom of the Configure Positions Viewer. By default, it is set to the Local Definition page. To view the Global RTPE Position View Listings that have been defined, deselect the Local Page check box. This will change the name to Global Position View and display all Global RTPE Pages. Copyright 2003, 2013, OpenLink Financial LLC 38 Gas Scheduling Position RTPE Page Implementation Guide for gMotion 6.2.1 RTPE Definitions Online As stated earlier, the creation of an RTPE Definition is a database operation. Each time RTPE comes up, it reads the RTPE Definition table and builds pages for each online definition. Position Views will not display until the following RTPE conditions are satisfied: The RTPE Definition is online The RTPE service is running RTPE generates the definition. Note: The RTPE Service is started and stopped via the Services Manager. If the RTPE Engine is running, the pages defined are brought online. If the RTPE Engine is not running, the pages defined are brought online when the RTPE Engine is started. The figure below illustrates the online RTPE Definition process. A discussion of the diagram follows with an explanation of the procedure. Copyright 2003, 2013, OpenLink Financial LLC 39 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 6-48 Online RTPE Definition Process 6.2.2 Online RTPE Definitions Legend/Procedure The Online RTPE Definitions Process is detailed as follows: Process Step Description 1. The Real-Time Position Viewer is used to configure and save Position Types and Views to an RTPE Definition. 2. The RTPE Definition exists as an entry in the database. 3. The Operations Manager can be used to view RTPE Definitions and to revise the online status (bring the RTPE Definition online and/or offline). 4. RTPE is launched via the Services Manager, which reads all of the RTPE Definitions and begins building pages for each online definition. 5. The page (Position Type) content is cached in RTPE to which other applications may subscribe. 6. RTPE publishes (advertises) the list of Position Types available to subscribers. 7. The Real-Time Position Viewer or Trader Desktop subscribes to and receives both the online Position Types and any pages to which it chooses to subscribe. Follow the steps below to bring an RTPE Definition online: 1. Start the Operations Manager. 2. Select the Services tab. 3. Select the Real Time Position icon. Copyright 2003, 2013, OpenLink Financial LLC 40 Gas Scheduling Position RTPE Page Implementation Guide for gMotion Figure 6-49 Operations Manager - Real-time Positions Any RTPE Definitions previously configured display in the bottom portion of the window. 4. Right click in any row of the Engine column to display a pick list of RTPE Engines available in the System. 5. Click the Online column to bring an RTPE Definition online; a check mark is placed in the column. Multiple selections may be made. When this is completed, click Save. If RTPE is running, RTPE begins to build pages for the online definition. A definition can also be brought offline by un-checking and saving. Note: The RTPE Engine and the RTPE Definition both play a role in determining if a page is online or offline. Anytime the RTPE Engine is not monitoring a definition, the page is stale and the Real-Time Position Viewer will denote that by displaying a “Stale” page message. 6. Select File Exit to exit this window. The Services tab of the Operations Manager displays. Copyright 2003, 2013, OpenLink Financial LLC 41 7.0 7.1 APPENDIX: CONSOLE REPORTS Demand Processing Report Console Details The following explains the details of the Olisten console log when Demand Processing is executing: Figure 7-50 Olisten Report Console – Demand Processing The name of the plug-in/script that was executed is called RTP_GSPos. The log indicates the plug-in/script beginning/end. It is executing in batch mode. The plug-in/script was called by the client (indicating a demand report). 51 details were returned. 51 summary rows were returned. The filter dates of 01-Feb-02 through 31-Mar-O2 are being used. The daily view end date is 31-Mar-02. 7.2 Local RTPE Report Console Details The Olisten console log for the execution of a local RTPE report shows the following: Figure 7-51 Olisten Report Console – Local RTPE Report The log indicates the plug-in/script beginning/end. 65 details were returned. 65 summary rows were returned. The filter dates of 31-Mar-02 through 30-Sep-03 are being used. The daily view end date is 31-Mar-02. The Local RTPE Engine has received the built pages (Engine 5 indicates the Local Engine). 7.3 Global RTPE Report Console Details The Olisten console log for configuring a global RTPE Definition shows the following: Figure 7-52 Olisten Report Console – Global RTPE Report The log indicates the plug-in/script beginning/end. 61 details were returned. 61 summary rows were returned. The filter dates of 31-Dec-03 to 31-Dec-03are being used. The daily view end date is 31-Dec-03. The Engine Number is 10,000 or greater (indicates a Global Engine).