Excel Add-In User Guide - Ekhosoft

Ekhosoft TabExtraction by Event (All Tools)An extraction By Event is based on one or moreevent IDs. The event ID can either be entered intothe spreadsheet manually or selected from a tablecreated from a previous extraction.This section covers the By Event extraction optionfor the Event Extraction tool and the CommentExtraction tool. Unless specified otherwise, theinformation in the text applies to both tools.Information specific to one tool will be identified byan icon:Figure 2-11. By Event Extraction Event Extraction. Indicates information and steps exclusive to the Event Extraction tool. Comment Extraction. Indicates information and steps exclusive to the Comment Extraction tool.To use the By Event extraction:1. Click on the extraction tool icon. The Extraction panel will open.2. In the Extraction panel, select By Event.3.Select a condition from the drop-down menu in the Filter box. The conditions are defined asfollows: Genealogy: Extracts the selected event’s child events. Start time: Extracts all the events that start within the selected event’s duration. End time: Extracts all the events that end within the selected event’s duration. Start or end time: Extracts all the events that begin or end within the selected event’s duration. Start or end time or overlap: Extracts all the events whose duration overlaps with the selectedevent’s duration. Start time and end time: Extracts all the events that occur within the span of the selectedevent’s duration.Start Time:End Time:TimelineTimelineReference EventReference EventAdmissable EventStart or End Time:Admissable EventTimelineReference EventReference EventAdmissable EventAdmissable EventAdmissable EventAdmissable EventFigure 2-12. Time Selection DiagramContinued on next page2-6Reference EventAdmissable EventStart or End Time or Overlap:TimelineAdmissable EventStart and End Time:Timeline

Ekhosoft TabContinued Extraction by Event (All Tools)4.Select the event ID: Click on the Cell Selector icon beside theinformation field. Select a reference cell on a spreadsheet in theworkbook containing the event ID. Note that thecell must not be selected prior to the Extractionpanel selection. The cell coordinates will appear in the informationfield.5.Figure 2-13. Event ID SelectionSelect the assets or asset types. The selection can be made in the following ways:Note: This option is not available if the Event ID selection is set to Genealogy. Click on the drop-down menu arrow and select the elements you want to include. Note thatright-clicking on an item gives you access to options such as: Check All/ Uncheck All/ CollapseAll. Select a reference cell on the spreadsheet that contains an asset or asset type system name.To use this option:- In the Extraction panel, click on the Cell Selector icon beside the information field.- Select the reference cell containing the asset or the asset type system name. Note that thecell must not be selected prior to the Extraction panel selection.- The cell coordinates will appear in the information field.6.Select the Event Type. The selection can be made in the following ways: Click on the drop-down menu arrow to access the available event types. Select a reference cell on a spreadsheet in the workbook that contains an event type systemname. To use this option:- In the Extraction panel, click on the Cell Selector icon beside the information field.- Select the reference cell containing the event type system name. Note that the cell must notbe selected prior to the Extraction panel selection.- The cell coordinates will appear in the information field.Day11KPI-DayReference Cell SelectionDrop-Down SelectionFigure 2-14. Event SelectionContinued on next page2-7

Ekhosoft TabContinued Extraction by Event (All Tools)7. Go to the Properties box and select the event details that you want to extract into thespreadsheet. Parent: Will display the parent events of the selected event. Event: Will display the selected event header. Marker: Will display the marker value attributed to the event. Tag: Will display the tags assigned to the event. Comment: Will display the selected comment details.8. Go to the Columns box. This box allows you to edit the order in which the columns will appear onthe spreadsheet. This is done by selecting an entry and using the buttons on the side of the boxto move it or remove it.Moves to FirstPerformance level 1Moves Up by OneFirst FloorMoves Down by OneMoves to LastRemoves from listFigure 2-15. Columns Box9. Use the options in the Output box to configure the appearance of the data. Select the Style box to import the marker colors. Select the Specifications box to import the tag colors associated to their activespecifications. Select the Comments box to import the comments made on either the Last Comment,Event ID or Event Name columns. The comments will be merged and identified by a redtriangle in the corner of the cell. The comments will appear when the user places the cursorover the cell. Select As Excel Table to have the data output in an editable Excel table. If this is not selectedthe data will appear in a data matrix that cannot be modified. In the Cell field, click the Cell Selector icon and select the cell in the spreadsheet that willdisplay the first data cell. Take note that the column header will appear above the selected cell. Select As Row for the information to be displayed in rows and the headers in columns. Thisoption is not available if the As Excel Table button is selected. Select As Column for the information to be displayed in columns and the headers in rows.Thisoption is not available if the As Excel Table button is selected.Continued on next page2-8

Ekhosoft TabContinued Extraction by Event (All Tools)10. Click OK. The selected data will appear on the spreadsheet.BrianBrian Warren:Figure 2-16. Output Box Options(Event Extraction Menu Shown)Figure 2-17. View CommentsSpecificationsClick on the Specifications icon to display the active specification value of a tag as well as the valuedefinition.To use this tool:1. Click the Specifications icon. The Specifications panel will open.2. Select a cell in the spreadsheet containing data from a tag. The specifications associated withthe data in the cell will appear in the Specifications panel.3. The panel will display the different statuses applicable to the data as well as their thresholds. Thestatus of the selected cell will be highlighted.Note: The Specifications panel can be moved to any side of the spreadsheet.33Figure 2-18. Specifications Panel2-9

Ekhosoft TabDisplayClick on the Display icon to choose which property of thedefinition item will be displayed in the extraction panels andon the spreadsheets.IMPORTANT: Regardless of the display option chosen, whenselecting extraction items on the spreadsheet using the CellSelector icon, it is the item system name, and not the displayname, that must be used for the item to be recognized.Figure 2-19. Display IconTo select the display preferences for the Excel book:1. Click on the Display icon. This opens the Display Preferences window.2. Select the property that will be displayed for each definition item. The Assets, Asset Type, Tags, and Event Type fields have the following options:- System Name- Display Name The Markers field has the following options:- System Name- Display Name- Short Description- Long Description3. Click on the OK icon to confirm the selection.Refreshing and Editing ExtractionsOnce the data matrix or excel table has been generated it can be refreshed and edited easily.To refresh the data in the spreadsheet:1. Click on an element in the data matrix or in the generated table to open the Extraction window.The settings that appear in the Extraction window are those applied to the information in thespreadsheet.2. Click OK. This will refresh the information on the spreadsheet.To edit the data in the Extraction Panel:1. Click on an element in the data matrix or in the generated table to open the Extraction window.The settings that appear in the Extraction window are those applied to the information in thespreadsheet.2. Modify the information as required.3. Click OK. This will refresh the information on the spreadsheet.2-10

Ekhosoft TabTemplatesOnce settings have been entered in to the Extraction window they can be applied to differentspreadsheets to create a template effect.For example, to easily create a monthly report using the Event Extraction By Filter tool as illustratedin Figure 2-20:1. Create an initial monthly report: Open a blank spreadsheet.- In separate cells, enter a start date/time as well as an end date/time for the report. In thisexample, the first day and last day of April were entered.- Enter the system name of the asset or asset type.- Enter the system name of the event type. Open the Extraction panel and use the Spreadsheet icon next to the information fields to selectthe information in the spreadsheet cells. Configure the rest of the extraction options and click OK. The report for the month of April willbe generated.2. To create an identical extraction for another month: Navigate to the spreadsheet tabs at the bottom of the Excel window and duplicate thespreadsheet. Rename the new spreadsheet to avoid confusion. In the spreadsheet cells, modify the start and end date/time to correspond to the new monthyou want to run the extraction on. For example, enter the first day and last day of May. Click OK and an identical extraction will be produced for the new month.Start dateEvent nameEnd dateAsset names separatedby semicolons.Template ExampleFigure 2-20. Using Templates2-11Selected cells

Ekho Definition TabEkho Definition Tab IntroductionThe Ekho Definition tab allows users to import data from Ekhosoft into Excel and also allows them toupload new data from the spreadsheets into the Ekhosoft system.IMPORTANT: Users must not modify the content of the cells in the header row.Figure 3-1. Definition Tab ToolsTopics:Save All Sheets Tool .3-1Auto Selection Tool.3-2Error Tool.3-2Foundation Tool.3-3Advanced Configuration .3-6Translation .3-8Historian . 3-11Specification .3-15User Specification.3-17Custom .3-18Save All Sheets ToolThe Save All Sheets tool is used to upload data from Excel to the Ekhosoft system.To upload data:1. Activate the Auto Selection tool.2. Add or edit the data on the spreadsheet.3. Click on the add-in Save All Sheets icon to save the selection and upload new data. Select Save All Sheets if more than one sheet requires saving. Select Save Current Sheet to save the page that is displayed at the moment of the save.Figure 3-2. Save All Sheets Tool3-1

Ekho Definition TabAuto Selection ToolWhen activated, the Auto Selection tool will automatically tag any edited line for uploading byplacing an X in the item’s Selection column. This ensures that no lines are forgotten when the sheetsare uploaded.Figure 3-3. Auto Selection ToolError ToolIf any errors occur the Error icon will become enabled. Click on the Errors icon to display the errorsat the top of the page.Figure 3-4. Error Tool3-2

Ekho Definition TabFoundation ToolThe Foundation tool is used to import definition and upload foundation items.Figure 3-5. Foundation ToolImporting Foundation ItemsTo import foundation items:1. Click on the Foundation import tool. The Foundation Import window will open.Figure 3-6. Foundation Import Tool2. Select the checkboxes of the items that will be imported: Asset:- Asset Type: Imports all the asset type definitions into one spreadsheet.- Asset: Imports all the asset definitions into one spreadsheet.- Asset/Asset Type: Imports all the asset type system names and the assets system names ofthe assets associate to them onto one spreadsheet.- Asset Genealogy: Imports the asset system names into one spreadsheet and displays themin their genealogy.Continued on next page3-3

Ekho Definition TabContinued Foundation Tool Marker:- Marker Family: Imports all the marker family definitions into one spreadsheet.- Marker Group: Imports all the marker group definitions into one spreadsheet.- Marker Def: Imports all the marker definitions into one spreadsheet.- Marker Genealogy: Imports all the marker genealogies and opens each one in its ownspreadsheet. The user can also select a single marker family by expanding the MarkerGenealogy menu and selecting the marker family.- Marker Partnership: Imports all the marker partnerships and opens each one in its ownspreadsheet. The user can also select a single marker family by expanding the MarkerGenealogy menu and selecting the marker family. Event Type: Imports all the event type definitions into one spreadsheet. Tag: Imports all the tag definitions into one spreadsheet. Asset Type/ Event Type/ Tag: Imports all the asset type system names as well as all the systemnames of the event types and tags associated with them. Asset Type/ Event Type/ Marker: Imports all the asset type system names as well as all thesystem names of the event types and marker families associated with them.3. Click on the OK button to import the selected items.Options BoxUse the item’s Options box to add extra import options when the Asset option is selected from theAsset drop-down. Filter Asset by Asset Type option: This box can be used when Asset is selected from the Assetmenu. Check this box to have each asset type open in its own spreadsheet and display all theassets associated to that asset type. Include Parent Asset Name for Asset: This box can be used when Asset is selected from theAsset menu. Check this box to add a column to the spreadsheet that will display the asset’sparent asset.Uploading Foundation ItemsNote: Unless mentioned otherwise, the columns requesting item names require the item’s systemname.Important: Ensure that all cells in the Selection column are deselected before uploading data.To upload a foundation Item:1. Click on the Foundation Import tool.2. Import the type of item that will be uploaded. For example, to add an asset, import the assets.3. Activate the Auto Selection tool (see page 3-2). This will automatically tag edited rows foruploading by adding an X to the Selection column.Continued on next page3-4

Ekho Definition TabContinued Foundation Tool4. Enter the required information in the item’s columns. For information on how to fill the columnsconsult the references table in Appendix A. Asset Type: Table B-1.Asset Type Upload Options Asset: Table B-2.Asset Upload Options Asset/Asset Type: Table B-3.Asset/Asset Type Upload Options Asset Genealogy: Table B-4.Asset Genealogy Upload Options Marker Family: Table B-5.Marker Family Upload Options Marker Group: Table B-6.Marker Group Upload Options Marker Def: Table B-7.Marker Definition Upload Options Event Type: Table B-8.Event Type Upload Options Tag: Table B-9.Tag Upload Options5. Click on the Save All Sheets tool and select either: Save all sheets Save current sheet6. Once the item is successfully uploaded the X will disappear from the Selection column. ĚĚ ƚŚĞ ŶĞǁ ŝŶĨŽƌŵĂƟŽŶ ƚŽ ƚŚĞ ƚĂďůĞ The x tags the row for the uploadFigure 3-7.Uploading Definition ItemsTo edit a foundation item:1. Import the item that requires editing.2. Activate the Auto Selection tool (see page 3-2). This will automatically tag edited rows foruploading by adding an X to the Selection column.3. Edit the data as required.4. Click on the Save All Sheets tool and select either: Sav

7005 Taschereau, suite 350 Brossard (QC) J4Z 1A7 tel 1.450.462.8105 fax 1.450.462.8205 WWW.EKHOSOFT.COM Excel Add-In User Guide. i Table of Contents . Open Excel and verify that the Ekhosoft tab appears at the top of the page with the standard tabs. Figure 1-2. Installing the Ekhosoft Excel Add-In Software. 1-3