Performance Dashboard DELMIA Apriso 2017 Technical Guide

Transcription

1 Performance Dashboard DELMIA Apriso 2017 Technical Guide 2016 Dassault Systèmes. Apriso, 3DEXPERIENCE, the Compass logo and the 3DS logo, CATIA, SOLIDWORKS, ENOVIA, DELMIA, SIMULIA, GEOVIA, EXALEAD, 3D VIA, BIOVIA, NETVIBES, and 3DXCITE are commercial trademarks or registered trademarks of Dassault Systèmes or its subsidiaries in the U.S. and/or other countries. All other trademarks are owned by their respective owners. Use of any Dassault Systèmes or its subsidiaries trademarks is subject to their express written approval.

2 Performance Dashboard DELMIA Apriso 2017 Technical Guide 2 Contents Introduction Purpose Scope Intended Audience Performance Dashboard Overview What Is a KPI and What Is It Made Of? What Makes Up a KPI in DELMIA Apriso? Tolerance Client 9 2 Configuration Prerequisites Portal Administrator Rights SQL Server/Oracle Access Central Configuration 12 3 Administration Maintaining Clients Maintaining Grids Tree KPI Grid Maintaining KPIs KPI Detail Screen Properties Query Tolerance Time Configuration Display Linked Grid Maintaining KPI Terms KPI Term Detail Screen 26 4 Usage KPI Calculation Process Storing KPI Calculation Entity KPI Calculation Component Production and Order Fact Calculation Production Facts Order Facts Generating Production Schedule Data Configuring KPIs for Automatic Calculation Starting the Job Calculating Facts Prerequisites 45

3 Performance Dashboard DELMIA Apriso 2017 Technical Guide Creating a Job to Populate New Facts Creating a Client Adding a KPI Grid Creating New KPI s Adding Stored Procedures for Calculation Creating Terms Steps 56 5 Displaying the Results KPI Value Screen Column Description Tolerance Icons Trend Percentage and Icons Available Icons KPI History Screen Column Description KPI Term History Column Description 63 6 Other Actions Cleaning the Job Action History Table Deploying the KPI and Its Dependencies 64 7 Glossary 65 8 References 66 Figures Figure 1 Elements of Performance Dashboard 6 Figure 2 A KPI in DELMIA Apriso 9 Figure 3 Sample ABC company scenario 10 Figure 4 Clients grid 13 Figure 5 Client details screen 13 Figure 6 KPI Explorer 14 Figure 7 KPI tree 15 Figure 8 KPI Grid list 16 Figure 9 KPI Grid 16 Figure 10 Grid details 17 Figure 11 KPI list 18 Figure 12 KPI properties screen 19 Figure 13 Expression Mapping 20 Figure 14 KPI Query 21 Figure 15 Input Mapping grid 21 Figure 16 Validation options 22 Figure 17 KPI Tolerance 22 Figure 18 Time Configuration 23 Figure 19 KPI Display grid 25

4 Performance Dashboard DELMIA Apriso 2017 Technical Guide 4 Figure 20 Linked Grid 25 Figure 21 KPI Terms grid 26 Figure 22 KPI Term properties Expression 27 Figure 23 KPI Term properties Stored Procedure 28 Figure 24 KPI Term properties Business Component 29 Figure 25 Overall KPI calculation flow 30 Figure 26 Detailed KPI calculation flow 31 Figure 27 Determining the from/to times for a KPI Term 32 Figure 28 KPI Term calculation flow 33 Figure 29 KPI persistence flow 35 Figure 30 Generating production schedule data flow 40 Figure 31 Job Header properties (KPI Test) 41 Figure 32 Job Schedule properties (KPI Test) 42 Figure 33 Job Action screen (KPI Test, part 1) 43 Figure 34 Job Action screen (KPI test, part 2) 43 Figure 35 Job Action Business Component parameters (KPI Test) 44 Figure 36 List of jobs screen 44 Figure 37 Enable and run the job 45 Figure 38 Job Execution History 45 Figure 39 Job Header properties (Production Fact) 46 Figure 40 Job Schedule properties (Production Fact) 47 Figure 41 Job Action screen (Production Fact, part 1) 48 Figure 42 Job Action screen (Production Fact, part 2) 49 Figure 43 KPI Value screen 59 Figure 44 KPI Value History screen 61 Figure 45 KPI Term History screen 63

5 Performance Dashboard DELMIA Apriso 2017 Technical Guide 5 Introduction 1.1 Purpose The purpose of this document is to provide details on Performance Dashboard Administration (PDA) and Key Performance Indicator (KPI) calculation. The document serves as a guide for System Administrators who configure and enable KPIs. It is recommended that the DELMIA Apriso training on Performance Dashboard be undertaken before using this technical guide as this gives a good basic understanding of many of the terms used in this document. 1.2 Scope The scope of this document includes definitions of the elements that are required for KPI calculation and for displaying results. The following details are addressed: Configuration of a KPI Defining a KPI and its subcomponents KPI KPI Term KPI Tolerance Calculation of a KPI KPI calculation method Defining the KPI Context Query Override options Displaying KPI results in the Dashboard Defining a KPI Grid to display KPI values Personalization and security Define columns to display Filtering results 1.3 Intended Audience Administration of KPI s persons (Administrators) who define KPI Grids, KPIs, KPI Terms, and KPI Tolerances. Calculating a KPI persons who will trigger the calculation of KPIs within a Process or Job Scheduler. Viewing KPI Results in Performance Dashboard from Supervisors to the Shop Floor Workers who view KPI results in a dashboard.

6 Performance Dashboard DELMIA Apriso 2017 Technical Guide Performance Dashboard Overview Administration Performance Dashboard Administrator Setting up Display Grids Defining Key Performance Indicators KPI TERMS Tolerances Calculation Job Scheduler Within DELMIA Apriso Operations KPI Calculate Business Component Defining Key Performance Indicators Viewing KPI Grids Tolerance Performance Dashboard Monitoring Screen Figure 1 Elements of Performance Dashboard The Performance Dashboard consists of a set of tools and a runtime framework for calculating and storing KPIs in the DELMIA Apriso system What Is a KPI and What Is It Made Of? KPI stands for Key Performance Indicator, which is defined as a human or machine process, operation, task, or other performance-related item that can be measured and that is used to monitor and control performance. KPIs help an organization define and measure their progress against metrics and towards goals. An example of a KPI is Quality, which is the percentage of material produced at a machine that is good. This can be expressed in the following equation: QUALITY = Quantity Good / Total Quantity Produced * 100

7 Performance Dashboard DELMIA Apriso 2017 Technical Guide 7 Quantity Good and Total Quantity Produced will need to be calculated before the KPI can be assigned a value. In DELMIA Apriso nomenclature, these are referred to as KPI Terms. To define KPI Terms and KPIs as well as to manage and control their use during runtime, DELMIA Apriso includes a configuration tool and a framework of core runtime components that are referred to as the Metric Panel/Analytics Administration Tool & Engine. DELMIA Apriso also includes numerous KPIs and underlying KPI Terms that span all operational areas of a plant or warehouse including inbound/outbound logistics, material control, quality, maintenance, and manufacturing. The KPIs are based on industry best practices and are packaged into three major areas called Metric Panels. The Metric Panels and KPIs supported in DELMIA Apriso are as follows: Metric Panel Lean/Six-Sigma Material & Logistics Execution Cost KPIs Availability Capable Equipment OEE Productivity Quality Rate Not OTIF Not In Spec Not OTIF Quantity Incorrect Not Right-First-Time (Not RTF) On-Time-In-Full (OTIF) Supplier Not OTIF Not In Spec Supplier Not OTIF Quantity Incorrect Supplier On-Time-In-Full Standard Rate Variance Standard Usage Variance Standard Yield Variance Total Rate Variance The configuration tool, runtime engine, KPIs, and KPI Terms can also be referred to collectively as Performance Dashboard (abbreviated as PD or DELMIA Apriso PD ). To simplify the definition of KPIs and improve the availability of KPI data in real-time, the PD engine extracts, transforms, and in some cases aggregates data from the various DELMIA Apriso operational database tables and caches them using two fact tables. The cached data is referred to as facts, and there are four types of facts: Production Facts stored in the PRODUCTION_FACT table Outbound Order Facts stored in the ORDER_FACT table Inbound Order Facts stored in the ORDER_FACT table Inventory Facts stored in the INVENTORY_FACT table Facts are atomic data elements that are used by PD to directly calculate KPI Terms and KPIs. For example, if a machine is producing work for multiple work orders for multiple products over various days, getting the production information requires a number of queries that access multiple tables. Fact KPIs run the calculation and store the information in one table and, in some cases, one record. The facts and fact tables also serve a useful purpose in the area of analytics, data warehousing, and data mining purposes.

8 Performance Dashboard DELMIA Apriso 2017 Technical Guide What Makes Up a KPI in DELMIA Apriso? To summarize, KPIs are numerical values that are based on a mathematical equation of KPI Terms, which in turn calculate values based on production or logistics fact tables that cache information for performance and usability purposes. The elements that comprise KPIs and KPI Terms are as follows: The KPI itself This contains the KPI expression or the formula made up of KPI Terms. A KPI also has a From Term and a To Term. A KPI is linked to the KPI_CONTEXT table and is stored in the KPI_VALUE table. To calculate a KPI, the KPI must be supplied with a CONTEXT_QUERY. Terms These are what make up a KPI. All KPI Terms must be calculated and return values before a KPI can be calculated. The KPI must return a single value that is of the DateTime or Decimal type. Terms are usually calculated from a FACT Table. A term can be any of the following: Stored Procedure Business Component Expression (basically a KPI within a KPI) From Term This is the KPI Term used to calculate the point at which the KPI Terms are required to be calculated. This could be the start of a shift, the start of a month, etc. This term must return a single date. To Term This is the KPI Term used to calculate the point to which the KPI Terms are required to be calculated. This could be the end of a shift, the end of a month, etc. This term must return a single date. Context Query This is the SQL query that is supplied when calculating a KPI. This query returns rows of information. The KPI is calculated and stored for each row in the context.

9 Performance Dashboard DELMIA Apriso 2017 Technical Guide 9 KPI Grid Lower Spec Limit Lower Control Limit Tolerance Calculations Tolerances Target Value Lower Spec Limit Lower Control Limit Key Performance Indicator Calculation Terms KPI Term 1 Stored Procedure Time Terms KPI Term 2 Business Component Time From Term Time To Term KPI Term 23 Expression KPI Term n Tolerance Figure 2 A KPI in DELMIA Apriso Tolerances are applied to the calculated KPI values and are persisted in the KPI_VALUE and KPI_VALUE_HISTORY tables. Tolerances are applied by first checking for any tolerances for the key combination of the KPI value record. If tolerances are not defined for the specific entity, then the default tolerance for the KPI is used Client Clients are used in the DELMIA Apriso environment to address for these two reasons: What other DELMIA Apriso systems are out there?

10 Performance Dashboard DELMIA Apriso 2017 Technical Guide 10 Data can be sent from other DELMIA Apriso systems via XML Manager; therefore, data can exist in a system that is required to be sent to another system or was sent from another system. This is valid in the KPI calculation results. What system am I? A stamp is applied to the records that the system generated when there exists many systems in the CLIENT table. This is done by a single record in the CLIENT table that has its Master flag set to True. This is an example scenario for a company called ABC: COMPANY ABC KPI Value results from Plant1 sent to the Main Plant Main Plant Child Plant1 Quality KPI sent down to Plant1 KPI Value results from Plant2 sent to the Main Plant KPI Value results from Plant3 sent to the Main Plant Quality KPI sent down to Plant2 Quality KPI sent down to Plant3 Child Plant3 Sending Master PD Data Child Plant2 Figure 3 Sample ABC company scenario In the main plant corporate office, decisions are made, processes are defined, and performance analysis takes place. This performance is monitored not only at the main plant but at the three child plants. This structure will be reflected in the client table as follows (from the main plant) system: Client Name Main Plant Plant 1 Plant 2 Plant 3 Master Y/N Y N N N

11 Performance Dashboard DELMIA Apriso 2017 Technical Guide 11 Because this is the client table of the main plant, its master flag is set to true. Alternatively, for plant 2 the following client structure is found: Client Name Main Plant Plant 1 Plant 2 Plant 3 Master Y/N N N Y N One of the most important metrics that ABC requires is the amount of stock produced at each plant. This is then added as a KPI in the main plant using the PD Administration screen. When any KPI administration record is created, it is assigned the client name that is flagged as master. For example, the following record is in the KPI table: KPI Name Quantity Client MAIN PLANT After this has been tested, the KPI is sent to the other plants using the Data Extractor Business Component (for details, please see the COE Data Replication Using Data Extractor Business Component Technical Guide). When sending the KPI data, the client is sent as well so that this reflects the source of the data. For example, the KPI records in plant 2 will look like this: Sending KPI Results KPI Name Client Quantity MAIN PLANT KPI Plant2 Attendance Plant 2 TestKPI Plant 2 When KPI results are generated, all of the records generated are assigned the master client name. So in the above scenario, plant 2 has run the Quantity KPI at the end of the week. The result will be stored in the KPI value table as follows: KPI Name Value Date Client Quantity /06/2005 Plant 2 These results are then sent to the main plant for analysis, again using the Data Extractor Business Component. This is then reflected in the main plant s system for all of the plants so that analysis can be performed by all items: KPI Name Value Date Client Quantity /06/2005 Plant 2 Quantity /06/2005 Plant 1 Quantity /06/2005 Plant 3 Quantity /06/2005 Main Plant From these results it becomes easier to view the results (that plant 3 is not producing) from using tolerances (see Tolerance) and the client name.

12 Performance Dashboard DELMIA Apriso 2017 Technical Guide 12 2 Configuration 2.1 Prerequisites Portal Administrator Rights Ensure that the user you are logged in as has a Portal Administrator role assigned. By default, the Performance Dashboard Administrator screen can be accessed in DELMIA Apriso Desktop Client (ADC) SQL Server/Oracle Access Having SQL Server/Oracle access is not required unless changes to a KPI Term Stored Procedure are needed. However, database access is required to view the inputs of a KPI Term Stored Procedure or implementation details, including how KPIs are calculated. 2.2 Central Configuration The Performance Dashboard Administrator server uses the DELMIA Apriso Central Configuration for all configuration parameters, including database connection and logging configuration. Performance Dashboard is also configured using MinimumRefreshRateInSecond key located in the PerformanceDashboard section of the Central Configuration file (for details, see Central Configuration Documentation).

13 Performance Dashboard DELMIA Apriso 2017 Technical Guide 13 3 Administration This chapter describes the steps involved in defining KPIs and configuring KPI Grids to display the values. 3.1 Maintaining Clients The Client Configuration can be accessed in the ADC. Figure 4 Clients grid To add a new Client, click existing details of the grid. (Add) or use the standard functionality to filter or edit the Figure 5 Client details screen Field Name Master Flag Type Description The client Name. It is recommended that the name be easily recognizable and not generic (e.g., Plant). True if the client belongs to this system. The type of client such as Production, Development, or Test.

14 Performance Dashboard DELMIA Apriso 2017 Technical Guide 14 Description The description of the client. Message Processor URL This is the location of the message processor. This is used in the Data Extract BC to send information to other systems (for details, see the COE Data Replication Using Data Extractor Business Component Technical Guide). Export Data Allowed Flag Determines if this master client can export data to other systems. 3.2 Maintaining Grids The Performance Dashboard Administrator (PDA) screen is accessible through the ADC. The screen consists of a tree view in the left pane with content appropriate to the item selected in the tree in the right pane Tree The tree view can be grouped by KPI Grid, KPI Context, or KPI Category. Initially the tree is loaded with the child nodes collapsed. The structure of the tree is: Selected grouping KPI KPI terms Child terms Figure 6 KPI Explorer The tree also has an Unassigned node to which the KPIs that are not added to a KPI Grid are added. Right-click commands are disabled for this node. The tree also consists of the All KPI Grids, All KPIs, and All KPI Terms nodes. When one of these nodes is selected, a grid which lists all of the KPI Grids, KPIs, or KPI Terms will be loaded based on the selected node. The following actions can be performed by right-clicking the node: Level KPI Grids KPI Grid Action Add New Grid Preview Copy Grid (and linked KPIs) Link KPI Preview

15 Performance Dashboard DELMIA Apriso 2017 Technical Guide 15 KPI KPI Term Delete Grid Copy KPI (Tolerances and Term Association) Preview KPI Delete KPI Copy KPI Term (and Term Association) Delete KPI Term Figure 7 KPI tree The items in the tree can be searched by entering a name in the Find text box and clicking the Prev (previous) or Next button. Pressing the Enter key or F3 key has the same effect as clicking Next, and pressing Shift + Enter or Shift + F3 has the same effect as clicking Prev KPI Grid When PDA is loaded, the initial screen shows the list of KPI Grids. The KPI Grid is to define the properties that will be used by the Performance Dashboard in runtime when displaying the KPI values. The Key Column captions and the rate at which the KPI values needs to be

16 Performance Dashboard DELMIA Apriso 2017 Technical Guide 16 refreshed are set in the KPI Grid. The Sequence No property sets the sequence in which these grids are to be loaded. The KPIs are linked to one or more KPI Grid(s) and this determines the KPI values that are loaded in each grid. The purpose of a KPI Grid is to group different KPIs and display their values in the grid with common settings such as Key Column captions and refresh rate. When a KPI is linked to a grid, it is important that they all have the same meaning for the Key Columns that they use (e.g., if Key1 is meant to display Facility, then all of the linked KPIs should have a Facility value stored in KPI_VALUE.Key1). It is not necessary that all KPIs use all of the Key Columns, but the common columns must be the same for the displayed values to look meaningful. An example set of KPIs linked to a grid would be OEE_Facility, OEE_WorkCenter, and OEE_Resource, with the Key Columns Facility, WorkCenter, and ResourceName. Figure 8 KPI Grid list When a grid is selected on the tree or (Properties) is clicked, the following screen appears: Figure 9 KPI Grid The above screen shows the list of KPIs linked to the grid. KPIs can be added or removed using (Link) and (Unlink). The General properties tab provides a screen for editing the KPI Grid.

17 Performance Dashboard DELMIA Apriso 2017 Technical Guide 17 Figure 10 Grid details Field Name Description Column 1-10 Sequence Enable Grid Refresh Rate Description The grid name that will appear in the bottom portion of the PD Administration. The description of the grid. The text that is displayed for that column of the grid within the Performance Dashboard. The sequence in which the grids are displayed on the screen. This flag is set to state that a grid can be displayed. If it is turned off, then the grid (and the KPI values) will not be displayed. The rate at which the Dashboard is refreshed for that active grid. 3.3 Maintaining KPIs The list of all KPIs can be loaded by selecting the KPI node on the tree.

18 Performance Dashboard DELMIA Apriso 2017 Technical Guide 18 Figure 11 KPI list Action Preview Add Delete Copy Properties Description The PD runtime is loaded with the selected KPI. Opens the KPI properties screen for adding a KPI. Deletes the selected KPI and the links in the KPI_GRID_KPI table. Copies the KPI, tolerances, and term associations. Opens the KPI properties screen for editing the selected KPI KPI Detail Screen The KPI maintenance screens are loaded by clicking selecting a KPI or by selecting a KPI on the tree. The following fields can be set using the KPI details screen. Field Name Client Description Context Category (Properties) on the KPI list after Description The KPI name, which is the primary key used to reference the KPI in both calculation and display. Describes who owns the KPI in the system. For more information, see Client as well as the COE Data Replication Using Data Extractor Business Component Technical Guide. The short, medium, and extended description. The KPI Context that filters the KPI Terms so that certain terms can be used for calculation. For example, if the production context is used, then only production KPI Terms can be used in calculation. A grouping of KPIs.

19 Performance Dashboard DELMIA Apriso 2017 Technical Guide 19 Design Mode When this value is True, no validations are performed when the KPI is saved. This provides the ability to save the KPI without setting all of the required values. A KPI will be calculated only when the Design Mode is False. KPI Expression Context Query Statement Time From Term Time To Term The mathematical formula used in calculating the KPI. This is made up of KPI Terms and must be valid JSCRIPT. The default KPI Context statement to be used for the specified KPI. The default KPI Context statement can be overridden by a KPI Business Component. For more details, see 4.1 KPI Calculation Process. The KPI Term that returns the start/from time for the KPI calculation. The KPI Term that returns the end/to time for the KPI calculation Properties Figure 12 KPI properties screen The KPI Expression is defined in the properties tab. The list of terms available based on the KPI Context is shown in the grid, and by double-clicking a row, the term can be copied to the expression. The context is an optional field, and if set, then only terms of the same context or terms with no context can be used.

20 Performance Dashboard DELMIA Apriso 2017 Technical Guide 20 Figure 13 Expression Mapping When the Validate link is clicked or the KPI is saved, if the KPI Expression contains terms that do not exist, then a pop-up dialog is shown with the list of terms that are not available. If the required terms are checked and the Add Kpi Terms button is clicked, then a term of the script type with that name is created. This term can later be edited to perform the required calculation.

21 Performance Dashboard DELMIA Apriso 2017 Technical Guide Query Figure 14 KPI Query The Key Column Mapping is used to map the context query results and the Key Columns of the KPI value table. In the above example, Default Facility will be stored in Key1, Department in Key2, etc. Specifying the key values explicitly in the context query is no longer required as it was in the earlier version. The result of the query is displayed in the grid in order to provide an idea of the entities for which the KPIs will be calculated. Input Mapping Figure 15 Input Mapping grid

22 Performance Dashboard DELMIA Apriso 2017 Technical Guide 22 The Input Mapping grid lists all of the inputs required by the KPI Terms. If the input is found in the context query, then Mapped is set to True. Validations Figure 16 Validation options Button Validate Query Validate Expression Validate KPI Calculate KPI Action Validates the context query. A pop-up message will show if the query is valid. Validates if the KPI expression is valid. A pop-up message will show if the expression is valid. Validates the KPI configuration. The KPI is calculated but not persisted to determine any configuration issue. Calculates and stores the KPI values. The KPI should not be in Design Mode for calculation to occur Tolerance The KPI Tolerance screen is as shown below. Figure 17 KPI Tolerance The default and override KPI Tolerance can be configured in the Tolerance tab. The override tolerance is created or modified using the editable grid. The Key Column headers are changed to the appropriate mapped columns. These are the properties:

23 Performance Dashboard DELMIA Apriso 2017 Technical Guide 23 Field Description Key1 Key10 Lower Spec Limit Lower Control Limit Target Value/display Upper Control Limit Description The description of the tolerance. The KPI Tolerance keys. These are used when performing calculations on the KPI. The lower spec limit for the KPI. Any value recorded lower than this limit is out of the spec and will be displayed as a red indicator on the Dashboard. The lower control limit for the KPI. Any value recorded lower than this limit and higher than the out of spec limit is out of control and will be displayed as a yellow indicator on the Dashboard. This is the ideal value of the KPI. This is the upper control limit for the KPI. Any value recorded higher than this limit and lower than the out of spec limit is out of control and will be displayed as a yellow indicator on the Dashboard Time Configuration Figure 18 Time Configuration The Time From and Time To values can use KPI Terms or time expressions. The time expressions consist of time literals, which can be used to specify the time and to add or subtract (days, hours, minutes, etc.) from that in order to set the Time From and Time To values.

24 Performance Dashboard DELMIA Apriso 2017 Technical Guide 24 The list of available time literals is provided in the grid, and double-clicking a row will add to the input field based on the last input in focus. The Evaluate link will calculate and display the value. This will provide an idea of what the start time and end time values will be when the KPI is calculated. The Evaluate button is useful in order to test and understand the time literals and expressions. An expression must always start with a time value literal such as CurrentTime, and it must have only one time value literal. The expression can only have an addition or subtraction operator. Time Value Current local time Current UTC Time Current Minute Current Hour Current Day Current Day End Start of Current Week End of Current Week Start of Current Month End of Current Month Start of Current Year End of Current Year Second Minute Hour Day Literal CurrentTime * CurrentUTCTime ^ CurrentMinute CMin CurrentHour CH CurrentDay CD CurrentDayEnd CurrentWeek CW CurrentWeekEnd CurrentMonth CM CurrentMonthEnd CurrentYear CY CurrentYearEnd Second S Sec Secs Seconds Minute M Min Mins Minutes Hour H Hrs Hours Day D

25 Performance Dashboard DELMIA Apriso 2017 Technical Guide 25 Month Year Month MM MTH MTHS Months Year Y Years Display The Display tab consists of a grid which will display KPI values when the refresh button is clicked. Figure 19 KPI Display grid The KPI values are calculated based on the saved configuration and are not persisted. All the required fields must be set and the terms must be correctly configured for the values to be calculated. This provides an idea of the values that will be calculated and helps to identify any errors in the configuration Linked Grid The KPI must be linked to a KPI Grid for the values to be rendered by the Performance Dashboard in runtime. Figure 20 Linked Grid When the link button is clicked, the KPI Grid selection screen is displayed. The grid in which the KPI needs to be displayed can be selected.

26 Performance Dashboard DELMIA Apriso 2017 Technical Guide 26 This adds a record in the KPI_GRID_ KPI table for the KPI and the KPI Grid. A KPI can be displayed in multiple grids. Clicking (Unlink) removes the KPI grid link. 3.4 Maintaining KPI Terms The list of KPI Terms can be loaded by selecting KPI Term in the tree KPI Term Detail Screen Figure 21 KPI Terms grid KPIs within PD are mathematical formulas consisting of one or more KPI Terms. KPI Terms in turn invoke either Business Components or directly invoke Stored Procedures to calculate a numeric value representing a component of the KPI. KPI Terms are managed from this screen whether or not they are referenced within the default context query and overridden by a Business Component. The screen layout of the detail screen changes depending on the KPI Term type Expression, Stored Procedure, or Business Component. The following values should be set for all KPI Term types:

27 Performance Dashboard DELMIA Apriso 2017 Technical Guide 27 Field Name Context Type Description Description The term name, which is the primary key used for reference in the calculation and in other KPI Terms of the Expression type. The KPI Term context which will be used to calculate terms of a similar context. For example, if the PRODUCTION context is used, then only production KPI Terms can be used in calculation. The type of KPI Term that determines how it will be calculated. Valid types are: Expression Stored Procedure Business Component method The short, medium, and extended description. Expression Type This is the properties screen for KPI Terms of the Expression type: Figure 22 KPI Term properties Expression

28 Performance Dashboard DELMIA Apriso 2017 Technical Guide 28 The list of terms available based on the context is shown in the grid, and by double clicking a row the term can be copied to the expression. The context is an optional field, and if set, then only terms of the same context or terms with no context can be used. The expression can be validated using the Validate Expression link. A pop-up message will show if the expression is valid or not. Field Term Expression Description The mathematical formula used in calculating the KPI Term. This can be made up of other KPI Terms and must be valid JSCRIPT. Stored Procedure Type This is the properties screen for KPI Terms of the Stored Procedure type: Figure 23 KPI Term properties Stored Procedure Field Stored Procedure Description The Stored Procedure name to be executed when calculating the KPI Term. Business Component Type This is the properties screen for KPI Terms of the Business Component type:

29 Performance Dashboard DELMIA Apriso 2017 Technical Guide 29 Figure 24 KPI Term properties Business Component Field Business Component Method Business Component Method Name Description The Business Component method called when calculating the KPI Term. The Business Component that contains the method. The name of the method to be run.

30 Performance Dashboard DELMIA Apriso 2017 Technical Guide 30 4 Usage 4.1 KPI Calculation Process KPIs are calculated by calling the KpiCalculateAndPersist_v94 Business Component method (see KPI Calculation Component). This approach allows KPIs to be calculated according to a schedule (e.g., by a job running within the Job Scheduler framework) or ondemand from within a Standard Operation, a process, or anywhere else in DELMIA Apriso where a Business Component can be invoked. The flow chart below in Figure 25 describes the steps involved in calculating a KPI: KPI is entered with Context Query Context query is opened Check if the query returns any value No Yes Return without doing anything Loop for each row in the context statement Get Times Strip out each term. For each term: Calculate Term Calculate and store Figure 25 Overall KPI calculation flow

31 Performance Dashboard DELMIA Apriso 2017 Technical Guide 31 As the figure illustrates, the process starts with executing the context query. The program exits if no records are returned. The from and to times for a KPI are calculated for each row returned by the context SQL, since they are frequently dependent on the data elements contained in the returned row. Context Query runs and returns ROWS of data. Each row will be used and perform a single KPI Calculation. So if the result returned is 6 rows - then the KPI will be calculated 6 times. Each time subbing in valules from the KPI. Sub in Inputs for the Terms The inputs for the term calculation are substituted in. So if the Term GetQuantityProduced required ResourceName and ResourceType, this will be the inputs used for each row. Calculate KPI The KPI is calculated after each TERM is calculated. The KPI Results are then stored. Any Rows with Key in the name are stored (from 1 to 10). So in this case - Key1, Key2 and Key3 are stored on each row. So when calculating row 3 the KPI_VALUE record will have the Key1 = C1P1 Key2 = Drilling Department Key3 = Mixer1 Store KPI results PER row in the Query. The business component loops through every row in the context query. And will store the value of the calculated KPI. This allows for KPI data to be stored against any data. Figure 26 Detailed KPI calculation flow For example, the KPI could have a TimeFrom term defined as ResourceStartTime, which finds the first time a machine was turned on and uses that time. This time will be different for each resource. Figure 27 depicts the overall flow for calculating times.

32 Performance Dashboard DELMIA Apriso 2017 Technical Guide 32 Times are gathered from the TimeFrom and TimeTo terms stored against the KPI. These terms could be configured to be the start of a shift, the start of the current month - whatever. Time terms are calculated like any other terms - any inputs are substituted in from the context query. When complete then the term is executed and a date is outputted. Get Times Get date terms from the KPI Calculate Start Term Calculate Term Calculate End Term Calculate Term continue Figure 27 Determining the from/to times for a KPI Term

33 Performance Dashboard DELMIA Apriso 2017 Technical Guide 33 Calculate Term Get Term Type Stored Procedure Get Stored Procedure Inputs Business Component Get Input and match to the Row Value in the context Execute SP Return Value Get Stored Business Component Inputs Expression Get Input and match to the Row Value in the context Execute BC Return Value Execute Statement Run the KPI Calculate functionality for the TERM Figure 28 KPI Term calculation flow Understanding KPI Term calculations involves a discussion of input parameter substitution. As indicated earlier, KPI Terms are linked to either Business Components or directly to Stored Procedures. Both scenarios can involve one or more inputs and return a single numeric output. The base framework of the Performance Dashboard takes each named input for a particular KPI Term and substitutes a value from the set of rows returned after executing the context statement against the database. This is done for every named input except for TimeFrom and TimeTo, which are substituted in from the TimeFrom and TimeTo calculations discussed earlier.

34 Performance Dashboard DELMIA Apriso 2017 Technical Guide 34 For example, for a KPI Term linked to a Stored Procedure called CalculateResourceUpTime and with the following inputs: ResourceName ResourceType and with the following KPI Context Query: SELECT ResourceName, ResourceType From Resource_ where ResourceType = 6 type equipment the following rows will be returned: ResourceName ResourceType Grinder1 6 Grinder2 6 The term will be calculated twice for each row returned in the context statement. Row 1 will be called CalculateResourceUpTime (Grinder1, 6) and Performance Dashboard will calculate the entire KPI for this record. After this is completed, it gets the next row and CalculateResourceUpTime will be called with the next row inputs (Grinder2, 6). After each KPI Term is calculated, the overall KPI value is calculated according to the expression defined in the KPI properties screen (see Properties). It is persisted to the database for real-time retrieval by one or more operational users. As shown in Figure 6, KPIs are stored in the KPI_VALUE table, which in turn is linked to a fact in one of the FACT tables (Production, Order, etc.). This keeps the KPI value and history table generic and independent of specific context requirements.

35 Performance Dashboard DELMIA Apriso 2017 Technical Guide 35 Calculate and store Substitute all values from the KPI Expression with the term values Calculate the KPI Calculate the KPI Get the KPI Context and the SourceTableName Create the KPI_VALUE record and point record to the context table continue Figure 29 KPI persistence flow Storing KPI Calculation Entity The KPI calculation entity is stored in the key values of the KPI data. The columns Key1 Key10 in KPI_VALUE are used to store the attributes relevant to the calculated value. The data from the context query is stored in the key value columns as defined in the KPI configuration. Example There are two KPIs in two different grids: KPI1 measures the uptime of all of the Work Centers in the system KPI2 measures the amount of clocked-in employees in the Facilities The context query would need to be referenced differently in both: Context query for KPI1: SELECT Facility, WorkCenter FROM

36 Performance Dashboard DELMIA Apriso 2017 Technical Guide 36 WORK_CENTER The Facility and Work Center will be mapped from each of the context queries So if the result of the context query is: Then the KPI result table will look something like this: Context query for KPI2: SELECT Facility FROM WORK_CENTER Key1 Key2 Value_ Tempe Assembly Tempe Cutting Center 1044 Tempe Drilling Center 604 Tempe Grinding Center 734 These are the results that will be mapped in the KPI value table: Key1 Value_ C1P1 43 C1P2 22 C1P3 21 Chrlt KPI Calculation Component The KpiCalculateAndPersist_v94 method in the KpiController BC is used to calculate KPIs. Its detailed description is provided in the Business Components Documentation. The KPI Context Query is executed to retrieve the KPI calculation entities. If the start time and/or end time is provided, then that is used in the KPI calculation; otherwise, the start time and end time are determined from the time expressions or time terms. In the case of time terms, the time value is calculated for each record returned by the context query. The terms defined in the KPI Expressions are evaluated by passing the required input values to the configured term evaluator. The expression is then calculated using the term values.

37 Performance Dashboard DELMIA Apriso 2017 Technical Guide 37 If a KPI_VALUE record exists for the key values, then the calculated KPI value is updated; otherwise, a new record is inserted. The KPI value history and term history are inserted for each record based on the settings of the inputs AddKpiHistory and AddTermHistory. 4.2 Production and Order Fact Calculation Production and Order Facts are simplified breakdowns of the information required to calculate KPIs and contain contextual information that is similar yet substantially different between order-based KPIs and production-based KPIs. Hence, they are calculated and persisted in separate fact tables Production Facts Production Facts are calculated for resources in the system. Facts are broken up into production days and shifts. These production day shifts are calculated from the ROTATING_WORK_SCHEDULE table. This is explained in more detail below. Production Facts are calculated by calling the CalculateProductionFacts_94 method of the FactController BC. Its detailed description is provided in the Business Components Documentation. Every time the Production Facts are calculated, a PRODUCTION_DAY_SHIFT table is created if required. The important thing to remember is that Production Facts are stored on a resource and shift basis. Therefore, there will be only one Production Fact record for a resource in a shift. The fields in the PRODUCTION_FACT table are populated by calling the flx_spproductionfactcalculateselectbyresourcetime Stored Procedure. Descriptions of all the fields in the PRODUCTION_FACT table are as follows: Field ID ResourceName ResourceType TimeFrom TimeTo ClockTime UnplannedDownTime PlannedDownTime RunTime TotalOtherTime DurationUomCode Description ID of the field (Auto Increment). The name of the resource. The type of resource. The time from the start of the shift. This time should not be used but the time in the PRODUCTION_DAY_SHIFT table. The time from the start of the shift. This time should not be used but the time in the PRODUCTION_DAY_SHIFT table. The total time the resource was available in the shift (in seconds). The total unplanned downtime of the resource over the shift period (in seconds). Total planned downtime of the resource over the shift period (in seconds). Total runtime of the resource over the shift period (in seconds). Total other time of the resource over the shift period (in seconds). Not used (always in seconds).

38 Performance Dashboard DELMIA Apriso 2017 Technical Guide 38 GoodQuantity ScrapQuantity TotalOtherQuantity QuantityUomCode StdCycleTime StdParts WipOrderNo WipOrderType OprSequenceNo ProductionDay PayRule Shift WorkPeriod EffectiveDate Facility Department WorkCenter ProcessedOn NoOfReports Equipment EmployeeNo SetupTime TearDownTime IdleTime SetupQuantity TearDownQuantity ProductNo ProductionDayShiftID ProductionDayShift The amount of good quantity produced over the shift. The amount of scrap quantity produced over the shift. The amount of other quantity produced over the shift. The UOM of the quantity being reported. The rate of production of the machine for the shift. Standard parts. Not used. Not used. Not used. Not used. Not used. Not used. Not used. Not used. The Facility at which the reporting was being done. The Department of the resource. The Work Center associated with the resource. The data the Production Fact generated/updated. Not used. Not used. Not used. The total setup time for the shift. The total tear down time for the shift. The total idle time for the shift. The total setup quantity for the shift. The total tear down quantity for the shift. Not used. A link to the PRODUCTION_DAY_SHIFT record. Not used. Production Facts are made up of two parts: a PRODUCTION_DAY_SHIFT record and PRODUCTION_FACT record. PRODUCTION_DAY_SHIFT records are calculated off the ROTATING_WORK_SCHEDULE record for the Facility. It is important to note that every resource has to have a Facility assigned to it if using the PRODUCTION_FACT records! Order Facts Order Facts are used to calculate the processing of the orders in DELMIA Apriso. They are calculated on the basis of OrderNo, OrderType, and OrderLine. This is then used to calculate the order-based KPIs. Order Facts are calculated by calling the CalculateInboundOrderFacts method for Outbound Orders or CalculateOutboundOrderFacts for Inbound Orders of the

39 Performance Dashboard DELMIA Apriso 2017 Technical Guide 39 FactController BC. Outbound Orders are defined as Delivery Orders only. Inbound Orders are defined as PO Receipts and ASNs. Detailed descriptions of these is provided in the Business Components Documentation. The fields in the ORDER_FACT table are as follows: Field ID GoodQuantity ScrapQuantity TotalOtherQuantity QuantityUomCode QuantityOrdered OrderNo OrderType OrderLineNo ProductNo Facility TransactionDate Warehouse DueDate Account CountryCode PostalCode State City County Region District Generating Production Schedule Data Description An incremental field for the KPI_VALUE table. The amount of good quantity that was processed. The amount of scrap quantity that was processed. The amount of other quantity that was processed. The UOM quantity code. The quantity ordered. The order number. The order type. The order line. The product number. The Facility. The date the transaction was finished. The location where the order was shipped out/received. The date the order was due. The partner associated with the order. The country code of the order. The postal code. The state. The city. The country. The region. The district. A Production Fact is linked to one and only one PRODUCTION_DAY_SHIFT table. The production day shift records the start and end times of a shift for a particular production day. The ProductionDayShiftID record in the PRODUCTION_FACT table links the Production Facts associated to the production day and shift. The system dynamically generates production day and shift records according to the rotating schedule assigned to a Facility and the flow described in Figure 30. Additional details of this Business Component may be found in the flx_spproduction FactSelectByWipOrder Stored Procedure. Please note that it is imperative that a rotating schedule is setup for the Facility, otherwise PRODUCTION_DAY_SHIFT records cannot be created! Additional details for setting up a rotating schedule are covered in the Time and Labor Implementation Guide.

40 Performance Dashboard DELMIA Apriso 2017 Technical Guide 40 Get the facility from the Resource PRODUCTION DAY SHIFTS are calculated up to the current day from certain starting point. If no starting date is specified then the first day of the current Year is used. From the Facility get the Schedule Rotation Record From the Rotation Record - get all the rotation detail records. The system finds the corresponding Detail record for the start date Create a new production Day Shift record Assign shift start and end times in UTC times for the production day Check if the detail record is the last for the day Yes Increment Production Day No Exit Yes Check if the new production day is greater current day Check if the last record in the rotation No Yes Loop back to FIRST detail record for the schedule. No Go to Next Rotation Record Keep looping on the same rotation until the current day is reached. Figure 30 Generating production schedule data flow 4.3 Configuring KPIs for Automatic Calculation The following steps need to be followed to configure a KPI to be calculated automatically according to a scheduled frequency. This is accomplished using the DELMIA Apriso Job Scheduler. 1 Navigate to Job Scheduler: Scheduled Jobs screen in the ADC.

41 Performance Dashboard DELMIA Apriso 2017 Technical Guide 41 2 Click (Add) to create a new job. 3 Enter a name and description for the new job (as in Figure 31). Figure 31 Job Header properties (KPI Test) 4 Click Save, which will enable the Job Schedules and Job Action tabs. 5 Switch to the Job Schedules tab and click (Add) to create a new job schedule. This will bring up the Job Schedule screen. 6 Enter the information as shown in Figure 32. This will run the KPI calculation every minute. When finished, click Save then Close.

42 Performance Dashboard DELMIA Apriso 2017 Technical Guide 42 Figure 32 Job Schedule properties (KPI Test) 7 Go back and switch to the Job Actions tab. Click (Add) to create a new job to be run. This will bring up the Job Action screen. 8 Enter the information as shown in Figure Click (Link) to link a Business Component to the action.

43 Performance Dashboard DELMIA Apriso 2017 Technical Guide 43 Figure 33 Job Action screen (KPI Test, part 1) 10 Select the KPICalculatateAndPersist method. 11 The method details will be loaded to the Job Action screen (Figure 34). Figure 34 Job Action screen (KPI test, part 2) 12 Specify the values of the Business Component parameters (Value column): Kpi Name:

44 Performance Dashboard DELMIA Apriso 2017 Technical Guide 44 OEE92 KpiWhereClauseForLoopControl: (context query) SELECT ResourceName, ResourceType, 5 as DaysFrom FROM RESOURCE_ Where ResourceType = 6 and resourcename = ' ' The result should look similar to the one shown in Figure 35. Figure 35 Job Action Business Component parameters (KPI Test) 13 Click Save then Close. This will bring you back to the Jobs screen. 14 Click Close again to go back to the List of Jobs screen. The KpiTester job is now added to the list as presented in Figure 36. It may or may not show up on the list depending on the number of existing jobs and the filter selected. Changing the filter, sorting, or scrolling using page-up and page-down may be necessary to find the job. Figure 36 List of jobs screen You may want to start/enable the job for execution. To do this, follow the steps below Starting the Job 1 Select the new KpiTester job (highlight the line by clicking anywhere on it). 2 Click (Enable) to enable the job. After this action, the status of the job should change to Enabled and (Run) should become active (Figure 37).

45 Performance Dashboard DELMIA Apriso 2017 Technical Guide 45 3 Click (Run) to run the job. Figure 37 Enable and run the job Click (Job History) to view the status of the calculations. This brings up the Job Execution History screen where you can see the results (Figure 38). You can also view the results of the data directly in the database by checking the KPI_VALUE table. Figure 38 Job Execution History 4.4 Calculating Facts The following is an example of how to add the Production Fact calculation. This will calculate all of the Production Facts in the system for a Facility Prerequisites These are the prerequisites for calculating the Production Facts: 1 A valid ROTATING_WORK_SCHEDULE should be defined. This schedule should include all of the information for the work schedule. The following is an example of the work schedule used for this example: Sequence No Day Sequence No Work Period Shift Pay rule

46 Performance Dashboard DELMIA Apriso 2017 Technical Guide The Facility of the Production Facts should point to this schedule ID. 3 There must be NO overlapping times for the work schedule of a Facility! KPIs use these work schedule times and if there is an overlap, this will result in incorrect calculations Creating a Job to Populate New Facts 1 Navigate to Job Scheduler: Scheduled Jobs screen in the ADC. 2 When the Jobs grid is displayed, click (Add) to add a new job. 3 Enter the name and description of the new job (as in example Figure 39). Figure 39 Job Header properties (Production Fact) 4 Click Save, which will enable the Job Schedules and Job Action tabs. 5 Switch to Job Schedule tab and click + to add a new job schedule. This will bring up a Job Schedule screen.

47 Performance Dashboard DELMIA Apriso 2017 Technical Guide 47 6 Enter in the information as shown in Figure 40 below. This will run the Production Fact calculation once. When finished, click Save then Close. Figure 40 Job Schedule properties (Production Fact) 7 Switch to the Job Action tab and click + to add a new job to be run. This will bring up the Job Action screen. 8 Enter the information as shown in Figure 41.

48 Performance Dashboard DELMIA Apriso 2017 Technical Guide 48 Figure 41 Job Action screen (Production Fact, part 1) 9 Click (Link) to link a Business Component to the action. 10 Select the CalculateProductionFact_v94 method from the Apriso KPI FactController Business Component. 11 The method details will be loaded to the Job Action screen (Figure 42).

49 Performance Dashboard DELMIA Apriso 2017 Technical Guide 49 Figure 42 Job Action screen (Production Fact, part 2) 12 Specify the values of the Business Component parameters (Value column): facility: C1P1 resourceid: <blank> resourcename: <blank> resourcetype: <blank> 13 Click Save then Close. This will bring you back to the Jobs screen. 14 Click Close again to go back to the List of Jobs screen. The ProdFact job is now added to the list. It may or may not show up on the list depending on the number of existing jobs and the filter selected. Changing the filter, sorting, or scrolling using page-up and page-down may be necessary to find the job.

50 Performance Dashboard DELMIA Apriso 2017 Technical Guide 50 You may want to start/enable the job for execution. To do this, follow a similar procedure to the one described for KPITest in 4.3 Configuring KPIs for Automatic Calculation. This exact same process can be configured for both inbound and Outbound Order Facts. The only change is that both of the Order Fact Business Components need to be selected and that these Business Components do not require inputs. 4.5 Creating a Client Clients are used to identify the new systems that the current system should use. Clients should be configured manually to ensure that the correct validation of the master flag is followed. 15 Navigate to the Client Configuration screen in the ADC. 16 Select (Add) to add a new client. This will bring up the client screen where the client information is added. 17 Enter the information as follows. If this is the owner of system, then the Master flag should be set to True.

51 Performance Dashboard DELMIA Apriso 2017 Technical Guide 51 If you are exporting data, please make sure that the message processor is set. For more information, refer to the COE Data Replication Using Data Extractor Business Component Technical Guide. Click Save then Close. This will add the record and take you back to the grid. 4.6 Adding a KPI Grid These steps are for adding a new KPI Grid in the tree: 1 Click (Add) to create a new display grid. 2 Fill in the Name field and define the grid columns.

52 Performance Dashboard DELMIA Apriso 2017 Technical Guide 52 3 Click Save and go back to the 4.7 Creating New KPI s The following section explains how to create a new KPI. The example is a KPI that calculates the percentage of products in a Facility that are in inventory. The KPI is defined for the MS SQL server environment. In the case of Oracle database use, the syntax needs to be changed accordingly. The prerequisites are: A FlexNet 9.3 environment (or higher) Access to a database with administration/create rights Experience writing SQL Queries and Stored Procedures Access to the Performance Dashboard Administrator M&M screen A Product KPI not already added in the system A valid Facility, product, and inventory setup in the system

53 Performance Dashboard DELMIA Apriso 2017 Technical Guide 53 The best way to create a KPI is to create the KPI Terms first. Create the source, create the source terms, and then create the KPI. These are the steps used for creating the ProductsAvailable KPI Adding Stored Procedures for Calculation There are two Stored Procedures required for this KPI: one to calculate the number of products and another to count the number of products that are in the Facility s inventory. We will create the Stored Procedure for calculating the number of products first. A sample of this Stored Procedure is described below. Calculate Total Products Stored Procedure CREATE PROCEDURE decimal(15,6) output AS = Count(1) FROM PRODUCT WHERE Active = 1 = ISNULL(@value,0) This will create the Stored Procedure called TempCalcTotalProducts. As you can see, there is one input and one output. The most important input as this will be mapped from the SQL context record. Total Products with Inventory Stored Procedure The second Stored Procedure is used to calculate the total number of products that have inventory: CREATE PROCEDURE decimal(15,6) output AS = Count(ID) FROM PRODUCT A WHERE Active = 1 AND EXISTS (Select 1 FROM INVENTORY B where B.ProductID = A.ID and A.Facility and (B.QuantityAllocated > 0 or B.QuantityOnHand > 0)) = ISNULL(@value,0) This is essentially the same query but with the Exists statement tacked on the end. The Stored Procedures need to have permissions configured in order to link them to KPI terms.

54 Performance Dashboard DELMIA Apriso 2017 Technical Guide Creating Terms This section shows how to add the required terms. The KPI Terms screen is loaded by clicking KPI Term on the tree: 1 Click (Add) to add a new KPI Term. Change the Type to Stored Procedure. This changes the screen to allow for linking to a Stored Procedure. 2 Enter the info shown below for the KPI Term:

55 Performance Dashboard DELMIA Apriso 2017 Technical Guide 55 3 Click (Link) to link the Stored Procedure. This will bring up all of the Stored Procedures in the database with configured permissions. 4 Select the TempCalcTotalProducts Stored Procedure. This then returns the inputs and outputs of the Stored Procedure. 5 Click Save and then Close.

56 Performance Dashboard DELMIA Apriso 2017 Technical Guide 56 Following the same steps as above, create the ProdWithInv KPI term and link the TempCalcTotalProdWithInv Stored Procedure Steps 1 Navigate to the Performance Dashboard Administrator screen in the ADC. 2 In the tree view, right-click the KPI node and select Add KPI. This screen is used for entering the details of the new KPI that is loaded. 3 Enter the name, context, and category. Changing the context will change the list of available terms.

57 Performance Dashboard DELMIA Apriso 2017 Technical Guide 57 4 Double-click the terms in the Available Terms grid to add them into the expression. The formula to calculate is: OUTPUT = (ProdWithInv / TotalProducts) * 100 The validate expression checks if the formula expression is correct. 5 On the Query tab, enter the context query. To perform the calculation on all of the Facilities in the system, enter the following context query: SELECT Facility FROM Facility Click the Validate Query button to check if the query is correct. 6 On the Tolerance tab, enter the default tolerance values. The TimeFrom and Timeto fields are required, but because they are not used in this calculation, they can be set as CurrentTime. 7 Select the Display tab and click the Refresh button. If the KPI configuration is correct, then the KPI will be calculated and displayed. These values are not persisted in KPI_VALUE table. 8 Select the Linked Grid tab and click (Link) to link the KPI to a KPI Grid. This grid will be used during runtime to display the KPI results.

58 Performance Dashboard DELMIA Apriso 2017 Technical Guide 58 9 Select the Properties tab, uncheck the Design Mode check box, and save the KPI. Then select the Query tab and click the Calculate KPI button. This will calculate the KPI and persist the values. 10 Right click on the KPI in the tree view, choose Preview to view the runtime values. This provides a quick way of calculating and displaying the KPI while configuring the KPI.

59 Performance Dashboard DELMIA Apriso 2017 Technical Guide 59 5 Displaying the Results The calculated KPI values are displayed by the Performance Dashboard during runtime. The following steps are involved: 1 The Dashboard reads the KPI Grid list and sorts according to Sequence Number. 2 After Selecting a KPI Grid the KPI Values associated with that KPI Grid are displayed. For example, if the system has three KPI grids the initial M&M Screen will contain three rows representing these grids. Select a row and click (Preview) to open the KPI Value screen. This screen will contain all KPI values for the selected KPI grid. 5.1 KPI Value Screen The below KPI Value screen displays productivity of employees measured using the ratio of completed Orders to assigned Orders. Figure 43 KPI Value screen The column captions for Key1 Key10 are set with the values defined in the configured KPI Grid. In this case, the columns are defined as Facility and Employee. The Key Columns that have no values are removed. All of the columns in the grid can be sorted, including the indicators and the trend icons Column Description Field Key1 10 Description This is the key value. The description assigned in the KPI Grid screen is used.

60 Performance Dashboard DELMIA Apriso 2017 Technical Guide 60 KPI Name Value Indicator Trend Previous Value Lower Spec Limit Target Value Upper Control Limit Upper Spec Limit Client Name KPI Grid Name Who Columns The name of the KPI. The latest recorded value of the KPI for the instance. Displays whether the item is in spec or out of spec for the KPI and the entity. The icon description is described in detail below. Displays what the trend is between this calculation and the previous calculation. The previous value that was recorded for the KPI and its entity. The lower spec record of the tolerance that was calculated. For details on how this is performed, see Tolerance. This is the target value of the KPI. This is the upper control limit for the KPI. Any value recorded higher than this control limit and lower than the out of spec limit is out of control and will be displayed as a yellow indicator on the Dashboard. For details on how this is performed, refer to the section on tolerance calculations. This is the upper spec limit for the KPI. Any value recorded higher than this spec limit is out of spec and will be displayed as a red indicator on the Dashboard. For details on how this is performed, refer to the section on tolerance calculations. This is the system that performed the calculations, which can be very helpful in sorting and filtering when the Dashboard is displaying information from multiple systems. The name of the current grid. This is to be used with the Security framework. The who columns of the KPI value table Tolerance Icons The tolerance display is different if the item is within or outside of the tolerance. This is used to show quickly if the item being calculated is in spec or out of spec. This is explained in detail in Tolerance. Tolerance In Tolerance Out of Control Limit Out of Spec Limit Icon Description The value falls within both the control limit and the spec limits. The value falls outside of the control limits but is within the spec limits. The value falls outside of the spec limits Trend Percentage and Icons This is a quick way to see if the item being calculated has changed while running the KPI more than once. By default, on a first run the trend and trend percentage are set as No Change. On the second run, the system calculates if the value has changed and by what percentage. This is then reflected in the database.

61 Performance Dashboard DELMIA Apriso 2017 Technical Guide 61 Trend Icon Description Up The value of the KPI for the entity went up since the last calculation. Down The value of the KPI for the entity went down since the last calculation. Neutral or No Change The value of the KPI for the entity stayed the same since the last calculation Available Icons The following icons are available on the KPI value Dashboard. Icon 5.2 KPI History Screen Description The term history screen appears and displays the terms that were used to calculate the KPI. Displays the history of the calculations in the KPI Value History. This screen is displayed when clicking the history button or double clicking a row in the KPI value main Dashboard screen. Figure 44 KPI Value History screen The key for the KPI value is displayed at the top of the screen.

62 Performance Dashboard DELMIA Apriso 2017 Technical Guide 62 A line graph is displayed that maps the values in the grid. Users can turn the tolerance levels display on or off. A history record is created for every calculation of the item. The KPI value history chart has the calculation time in the X-axis You can zoom in on the chart by right-clicking and dragging the mouse over the desired area Column Description Field Description Time From The start time of the KPI calculation. Time To The end time of the KPI calculation. Value The record value at the time of the calculation. Previous Value The previous value of the KPI for the element. Trend The trend of the current and previous values. Calculation Time The current calculation time of the KPI. Icon Description The term history screen appears and displays the terms that were used to calculate the KPI history record. Closes the grid. Shows/hides the tolerances. Prints the graph. Clicking (Print) brings up the print dialog for all of the printers on the client machine. By default, printouts are on a standard letter page with portrait settings. Many other print formats are also supported. 5.3 KPI Term History This screen is used to display the history of the KPI value record. This record gets created whenever the calculation is performed.

63 Performance Dashboard DELMIA Apriso 2017 Technical Guide 63 Figure 45 KPI Term History screen The expression for the KPI or for the parent KPI Term is displayed at the top of the screen. This screen allows for drilling down on terms of the Expression type Column Description Field Description Name The term name. Description The description of the term. Value The term value at the time of the calculation. Last Update On The date when the term was updated. Icon Description The KPI Term History screen appears with the child terms. This is only valid for terms of the Expression type.