User Guide Part 11. Tools and Utilities

Transcription

1 User Guide Part 11 Tools and Utilities

2 Contents 1 OVERVIEW DATA SIMULATOR Introduction Using the Data Simulator DATABASE UTILITY About the Database Utility CREATING A BACKUP Configuring a Backup Creating a Backup Backup History Full Backup Renew DB Testing a Backup Scheduling a Backup CREATING A RESTORE Configuring a Restore Creating a Restore Testing Restore SQL SERVER CONFIGURATION Attaching database to SQL Server LOCALIZATION UTILITY About the Localization Utility CREATING A LOCALIZATION Configuring a Localization Utility Menu Buttons Language Selections Testing Localization CONFIGURATION EDITOR Basic Editing Advanced Editing AUDIT VIEWER Launching Audit Viewer Audit Viewer Menu Viewing Logs AUTO LOGON UTILITY Launching the Auto Logon Utility Auto Logon Settings ADDITIONAL INFORMATION AND SUPPORT

3 Figures and Tables Figure 1 - Data Simulator... 5 Figure 2 - Status Enterprise Restore Utility... 7 Figure 3 - Connection Provider selection is disabled if only one provider is installed Figure 4 - Browse SQLite Database Button... 8 Figure 5 - Select Database Dialog Box... 8 Figure 6 - Configured SQLite Connection... 9 Figure 7 - Connect to Database... 9 Figure 8 - Backup Tab... 9 Figure 9 - Browse Save Database Button... 9 Figure 10 - Save Backup Database Window Figure 11 - The Quick Selection Drop-down Figure 12 - The Start and End Date Figure 13 - SQLite Full Database Backup Option Figure 14 - The Backup Button Figure 15 - Connect to the Server Figure 16 - Backup Scheduler Figure 17 - Create Basic Task Figure 18 - Basic Task Name Figure 19 - Task Trigger Figure 20 - Task Schedule Figure 21 Action Figure 22 - Start a Program Figure 23 - Summary Figure 24 - Connect to Database Figure 25 - Restore Tab Figure 26 - Data Selection Figure 27 - Restore Points Window Figure 28 - Preview and Restore Button Enabled Figure 29 - Updated Restore Point List after Restore Operation Figure 30 - The Attach Menu Figure 31 - The Attach Databases Dialog Figure 32 - The Locate Database Files Dialog Figure 33 - The Attach Databases Dialog with Status Enterprise selected Figure 34 - Successfully attached Status Enterprise database Figure 35 - Status Enterprise Localization Utility Figure 36 - Connection Provider selection is disabled if only one provider is installed Figure 37 - Browse SQLite Database Button Figure 38 - Select Database Dialog Box Figure 39 - Configured SQLite Connection

4 Figure 40 - Connect or Cancel Button Figure 41 - The Menu Buttons Figure 42 - The Refresh Menu Button Figure 43 - The Add Menu Button Figure 44 - Add Key Word Window Figure 45 - The Rename Button Figure 46 - Rename English Key Window Figure 47 - The Delete Menu Button Figure 48 - Microsoft Translator Configuration Button Figure 49 - Microsoft Translation Configuration Window Figure 50 - The Language Selection Check Boxes Figure 51 - Adding Type Figure 52 - Creating a Property Figure 53 - Creating an Asset Figure 54 - Logging In to Localization Utility Figure 55 - Adding Key Word Figure 56- Sample Localization Entry Figure 57 - Selecting Language Figure 58 - Selecting a Configuration Figure 59 - Editable Fields in Basic Mode Figure 60 Unlocking Advanced Mode Figure 61 - Audit Viewer on the Application Launcher Figure 62 - AuditViewer.exe Figure 63 SQL Audit Viewer Login Figure 64 - SQLite Audit Viewer Login Figure 65 - Audit Viewer File Menu Figure 66 - Audit Viewer Help Menu Figure 67 - Audit Viewer Date Range Figure 68 - Audit Viewer Logs Figure 69 - AutoLogonConfiguration.exe Figure 70 - Login Dialog Figure 71 - Enable Auto Logon Figure 72 - Default Startup Mimic Figure 73 - Default User Logon

5 1 Overview This document outlines the basic functions of some additional utilities included in the Status Enterprise package. These utilities include: The Data Simulator, the Database Utility, and the Localization Utility. For a list of frequently used terms, definitions, and abbreviations, see Part 1 Overview and concepts. 4

6 2 Data Simulator The Data Simulator is a testing utility installed with the Status Enterprise Server install set. Figure 1 - Data Simulator 2.1 Introduction The Data Simulator works by writing random property values to your data model. The application will interrogate your data model; it will then update the analog and discrete property values with periodic random data. This allows live data updating in client applications and in mimics that are being developed, and is useful for testing and demonstrating your system to other stakeholders 2.2 Using the Data Simulator To use the Data Simulator, start the utility and log into the Status Server using a valid user account. Select the <Start> button. The application will start reading through your object model looking for property values that need updating. Once it collects all the information it needs, it will start randomly writing values to those properties. All activity is displayed to the user as the application is running. 5

7 3 Database Utility Status Enterprise runs as a Windows service and should be stopped in the Task Manager before continuing with any of the Database Utility options to avoid any complications. 3.1 About the Database Utility Database Utility is a utility for managing a Status Server database for backup and restore. Backup the database either historically by archiving and freeing historical data on the running database, or perform a full backup to create a new copy of the database. Restore will return the database to a previous state when the Model Designer was configured. 6

8 Figure 2 - Status Enterprise Restore Utility 7

9 4 Creating a Backup Creating a backup is creating a copy of the existing database. Backup Utility has two options: Historical Backup and Full Database Backup. 4.1 Configuring a Backup Backup needs a connection to a database. Connection Provider will have the same provider as the Status Enterprise Server. Figure 3 - Connection Provider selection is disabled if only one provider is installed. Different providers will have different connection configuration. SQLite provider needs to select a database to connect. To connect click the 'Browse Database' button. The SQLite default version is Version 3. Figure 4 - Browse SQLite Database Button Figure 5 - Select Database Dialog Box 8

10 Go to C:\ProgramData\B-Scada\StatusEnterprise\StatusEnterprise.db3. Select the Status Enterprise Database file then click <Open>. Figure 6 - Configured SQLite Connection 4.2 Creating a Backup Click the <Connect> button to connect to the database. Figure 7 - Connect to Database When connected, ensure the Backup tab is selected. Figure 8 - Backup Tab Click the 'Browse Save Database' button to browse for a location where to save the backup. Figure 9 - Browse Save Database Button 9

11 Select a folder in which to place the backup database, create a name for your backup, and click the <Save> button. Figure 10 - Save Backup Database Window Backup History Backup History archives the historical data to a new database. This frees up the main Enterprise Status Server database of the historical data. An optional history parameter is the 'Quick Select' drop-down list, with which the system automatically gets the first Historical entry to get the range of dates to backup. Figure 11 - The Quick Selection Drop-down The system gets the first Historical entry then calculates the End date based on the selection. Provide Start date and End date for the range of historical data to archive. 10

12 Figure 12 - The Start and End Date Full Backup Full Backup creates an exact copy of the database to a new location. Different providers can have different backup options. For our sample we are using SQLite with 2 options: Simple Backup and Database Dump. Simple Backup creates a copy of the existing database. Database Dump re-creates a new database and re-inserts existing data. This creates a compact database size making the database smaller. Figure 13 - SQLite Full Database Backup Option Renew DB Selecting the Renew DB option will create a new database without any historical data. Figure 14 Renew DB Option Your data model, mapping configurations and data binding will be retained, along with the current property values, but all historical property values will be removed from the database. This significantly reduces the size of your database, essentially compacting it to the size it was when your Status solution was first implemented. To be certain you are not eliminating important data, you should consider performing a full backup before renewing your database. 4.3 Testing a Backup Backup copies are functional databases which can be used to view data outside a production database. Creating an archive database helps keep the Status Enterprise Database from growing too big. 11

13 Clicking on the <Backup> button begins the backup process. Figure 14 - The Backup Button 4.4 Scheduling a Backup The Database Utility allows users to schedule backup of the Database. 1. Click the <Connect> button to connect to the database. Figure 15 - Connect to the Server 2. Click the Scheduler Tab. Figure 16 - Backup Scheduler 3. Destination The location where the backup will be saved 4. File Name The name of the backup file 5. File Format The date format of the backup file name 6. Full - Schedule a full backup 7. Historical Schedule a backup on a specified period 12

14 Relative End Date This is the end date of the backup. Backup Length This is the length date of the back e.g. If Relative End Date is set to 1day and Backup Length is set to 1month, this means that the backup that will be saved will start from the same date a month before to today s date. If the date today is 7/23/201, the backup file will contain 6/23/2015 7/23/ Click the <Save> button. 9. Give this backup schedule configuration a name. This will save two files an xml file and a batch file. 10. Open Windows Task Scheduler. 11. Under Actions, click Create Basic Task. This will launch the Create Basic Task Wizard. Figure 17 - Create Basic Task 12. Type the Name for this Task, then click Next. 13

15 Figure 18 - Basic Task Name 13. Select the Task Trigger which is how often you want it to perform the backup task (daily, weekly, monthly etc.). Then, click Next. Figure 19 - Task Trigger 14. Further customizations the schedule can be done here. Then, click Next. 14

16 Figure 20 - Task Schedule 15. Select Start a program as the action. Then, click Next. Figure 21 Action 16. Select the batch file it that we created. Then, click Next. 15

17 Figure 22 - Start a Program 17. Click the Finish button. Figure 23 - Summary 16

18 5 Creating a Restore A restore is restoring from a current state to a previous state. The Restore Utility allows a user to go back to previous values created under Model Designer. 5.1 Configuring a Restore Restore points are set automatically when your Data Model is configured or updated. If you would like to restore to a backup of a database you created manually, see the 'Configuring a Backup' section. 5.2 Creating a Restore To create a restore, connect to the database in the same way you would to create a Backup. Figure 24 - Connect to Database When connected, click on the Restore tab. Figure 25 - Restore Tab Type or click on the calendar to set a Date to pick up restore points. 17

19 Figure 26 - Data Selection The default source is your Attributes tables history. Optionally, you can choose your References tables history or you can choose All. If a selected date has restore points, they will be displayed in the Restore Points window. Figure 27 - Restore Points Window Select a restore point on the Restore Points window list. A high-level preview will be displayed to see current entry of the restore point. The <Restore> button will be enabled if the restore point is safe to restore. Figure 28 - Preview and Restore Button Enabled 18

20 If the selected restore point is not safe, the Output window beneath will inform you of the next safe restore point that can be selected. Figure 20 Output Window Showing Next Safe Restore Point 5.3 Testing Restore Restore Utility will go back to a state where the restore point is selected. The sample will go back to the time when a House (Type/Asset) is created. All the entries after the selected restore point will be discarded including the values. Once done you cannot restore forward. Restore points are also updated up to the selected restore point. Figure 29 - Updated Restore Point List after Restore Operation 19

21 6 SQL Server Configuration When using SQL Server with Status Enterprise, this configuration process is necessary to create the database. Note that Status Enterprise is only compatible with SQL Server 2008 or later. The first thing step in the process is to stop the Status Enterprise Service. Status Enterprise runs as a Windows service and must be stopped in the Task Manager before the database can be created. Figure 22 Stopping Status Service The next step is to create a default user in SQL Server named SEUser by running this script: USE [master] GO CREATE LOGIN [SEUser] WITH PASSWORD=N'StatusEnterprise!2013', DEFAULT_DATABASE=[master], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF GO EXEC = = N'bulkadmin' GO EXEC = = N'dbcreator' GO You can specify another user name and password here, but it must match the configuration in \RecordSerializer\Status.StatusServer.SQLRecordSerializer.dll.config. 20

22 6.1.1 Attaching database to SQL Server This procedure should be done by a DBA or user with sa privileges to the SQL Server. The steps below can also be found on the Microsoft site ( a. In SQL Server Management Studio Object Explorer, connect to an instance of the SQL Server Database Engine, and then expand that instance. b. Right-click Databases and click Attach. Figure 30 - The Attach Menu 21

23 c. In the Attach Databases dialog box, to specify the database to be attached, click Add; Figure 31 - The Attach Databases Dialog In the Locate Database Files dialog box, select the disk drive where the database resides and expand the directory tree to find and select the.mdf file of the database; for example: C:\Program Files\Microsoft SQL Server\MSSQL11.MSSQLSERVER\MSSQL\DATA\StatusEnterprise.mdf Important Trying to select a database that is already attached generates an error. 22

24 Figure 32 - The Locate Database Files Dialog Databases to attach Displays information about the selected databases. Displays an icon indicating the status of the attach operation. The possible icons are described in the Status description, below). MDF File Location Displays the path and file name of the selected MDF file. Database Name Displays the name of the database. Attach As Optionally, specifies a different name for the database to attach as. Owner Provides a drop-down list of possible database owners from which you can optionally select a different owner. Status Displays the status of the database according to the following table. Icon Status text Description 23

25 (No icon) (No text) Attach operation has not been started or may be pending for this object. This is the default when the dialog is opened. Green, right-pointing triangle In progress Attach operation has been started but it is not complete. Green check mark Success The object has been attached successfully. Red circle containing a white cross Circle containing two black quadrants (on left and right) and two white quadrants (on top and bottom) Circle containing a curved arrow pointing counter-clockwise Error Stopped Rolled Back Attach operation encountered an error and did not complete successfully. Attach operation was not completed successfully because the user stopped the operation. Attach operation was successful but it has been rolled back due to an error during attachment of another object. Message Displays either a blank message or a "File not found" hyperlink. Add Find the necessary main database files. When the user selects an.mdf file, applicable information is automatically filled in the respective fields of the Databases to attach grid. Remove Removes the selected file from the Databases to attach grid. " <database_name> " database details Displays the names of the files to be attached. To verify or change the pathname of a file, click the Browse button ( ). Note If a file does not exist, the Message column displays "Not found." If a log file is not found, it exists in another directory or has been deleted. You need to either 24

26 update the file path in the database details grid to point to the correct location or remove the log file from the grid. If an.mdf data file is not found, you need to update its path in the grid to point to the correct location. Original File Name Displays the name of the attached file belonging to the database. File Type Indicates the type of file, Data or Log. Current File Path Displays the path to the selected database file. The path can be edited manually. Message Displays either a blank message or a "File not found" hyperlink. Figure 33 - The Attach Databases Dialog with Status Enterprise selected Click <OK> to attach database. If successful, Status Enterprise database should now appear in the list of databases in Microsoft SQL Server Management Studio. 25

27 Figure 34 - Successfully attached Status Enterprise database 26

28 7 Localization Utility 7.1 About the Localization Utility Localization Utility is for managing words translation into different languages. Figure 35 - Status Enterprise Localization Utility 27

29 8 Creating a Localization 8.1 Configuring a Localization Utility Localization needs a connection to a database. Connection Provider will have the same provider as the Status Enterprise Server. Figure 36 - Connection Provider selection is disabled if only one provider is installed. Different providers will have different connection configuration. SQLite provider needs to select a database to connect. To connect click the 'Browse Database' button. SQLite default version 3 Figure 37 - Browse SQLite Database Button Figure 38 - Select Database Dialog Box 28

30 Go to C:\ProgramData\B-Scada\StatusEnterprise\StatusEnterprise.db3. Select the Status Enterprise Database file then click <Open>. Figure 39 - Configured SQLite Connection Connect to the database using the <Connect> button. Figure 40 - Connect or Cancel Button 8.2 Menu Buttons Menu buttons are provided for localization maintenance. It consists of Refresh, Delete, Add, Rename, and Microsoft Translator Configuration. Figure 41 - The Menu Buttons <Refresh> button lets your refresh the contents in the localization table. Figure 42 - The Refresh Menu Button <Add> button lets you add a new word. Figure 43 - The Add Menu Button Click on the <Add> button brings up the Add Key Word window. 29

31 Figure 44 - Add Key Word Window Type in the Key Word usually an English word or a key to a sentence then click <OK>. <Rename> button lets you rename the English key word. Figure 45 - The Rename Button Click on the <Rename> button Brings up the Rename English Key window. Figure 46 - Rename English Key Window <Delete> button lets you delete a selected row, the English Key Word and the entire translation. Figure 47 - The Delete Menu Button <MS Translator Configuration> button allows you to configure the Microsoft Translation service. Figure 48 - Microsoft Translator Configuration Button 30

32 Click the <MS Translator Configuration> button to access the Microsoft Translation Configuration window. Figure 49 - Microsoft Translation Configuration Window 8.3 Language Selections The selection lets you choose which language column to display on the screen. Figure 50 - The Language Selection Check Boxes. All the check box names correspond to the language columns except for the All check box. The All check box is used to select or deselect all check boxes at once. 8.4 Testing Localization 1. First, we need to add a localization property in the Data Model. Go ahead and navigate to the Data Model Designer and create a New Type. For this demonstration, we will name it computer. Figure 51 - Adding Type 31

33 2. Select the type we just created and add a property. Select Localized Text as the data type property. For our purpose, we will name it localized text. Figure 52 - Creating a Property 3. Now that we have created our Type, we can now navigate towards the Asset tab and create an asset for this type. Let s name it computer 1 for this demonstration. Once created, the Asset should have inherited the localized text property. Figure 53 - Creating an Asset 4. Run the Localization Utility. 32

34 5. When logging in, make sure that the correct database has been selected. Click Connect. Figure 54 - Logging In to Localization Utility 6. To begin localization just add an English word or a Key word then key in all translation for each language column. If the Key word added has no translation the Key word will be used as the value. Click the Add button to add a key word. For this demonstration, we will use the word computer. Click OK Figure 55 - Adding Key Word 7. Translations of the key word will now appear in the Localization Utility. The translated languages will depend which ever language has been enabled in the Language Selection. For this demonstration, we will select All. 33

35 Figure 56- Sample Localization Entry 8. Now that we have already configured our key word, we can now test if this works. First, restart the Status Enterprise Server in services.msc. 9. Then, Open Mimic Designer. Create new or open existing mimic. 10. Drag a Text Block onto the design surface. 11. Browser over the Asset and bind it to the localized text that we have created in the Data Model. 12. Save the mimic. 13. Open the Data Model Browser and access the Property Table of the Asset that has the localized text. 14. Type the word computer in the value. 15. Open the mimic in Runtime. Click the Advanced Settings. Under Misc Settings, change the Language Selection. For this demonstration, let s change it into Swedish. Then, click Connect. 34

36 Figure 57 - Selecting Language 16. Runtime will display the word dator which is the Swedish translation of computer. If you see this, it means that the Localization Utility is working properly. 35

37 9 Configuration Editor The Configuration Editor is a tool used to simplify the editing process of Status Enterprise configurations. To select a configuration, expand the Configurations menu and select the Status Enterprise configuration that you intend to edit. 9.1 Basic Editing Figure 58 - Selecting a Configuration By default, the Configuration Editor starts in Basic Mode in which the user can only edit certain fields by changing the values in the text boxes. In this mode, the only fields that are available for editing are the fields that are the most commonly changed. Changing the data in the text boxes will automatically change and update the field in the configuration. Figure 59 - Editable Fields in Basic Mode 9.2 Advanced Editing The user is not limited to only operating in basic mode. The text editor itself can be unlocked by clicking on the Advanced menu and selecting Unlock Editor. Figure 60 Unlocking Advanced Mode 36

38 In this mode, the user has the freedom to change the configuration the way they see fit. This mode is intended for advanced users whose need to edit the configuration exceeds the constraints of editing in Basic Mode. Making changes in Advanced Mode to a configuration will not automatically save the file. The user must save the file manually by clicking on File and then choosing Save from the menu. 37

39 10 Audit Viewer The Audit Viewer is a utility in the Status Enterprise that allows users to view the Audit Table in the database. It is primarily used to view error logs Launching Audit Viewer Launch the Audit Viewer using the Application Launcher. Figure 61 - Audit Viewer on the Application Launcher It can also be launched by double clicking the executable file located in Program Files/B-Scada/Status Enterprise. Figure 62 - AuditViewer.exe After launching the utility, users will be prompted with the Audit Viewer Login. Depending on the type of database the user has (SQL Server or SQLite), the login screen will display a set of fields that is applicable for that database. 38

40 Figure 63 SQL Audit Viewer Login For SQL Server database: Connection Provider This is automatically set to SQL Server Provider. Server Specify the name of the server to connect to. Database Specify the name of the database to use. Login Information This is the login credentials to connect to the database. If there are no username/password for the database Trusted Connection should be enabled. Figure 64 - SQLite Audit Viewer Login For SQLite Server database: Connection Provider This is automatically set to SQLite Server Provider. Database Browse and select the SQLite database to use. Version Specify the version of SQLite being used. Click Connect Audit Viewer Menu The Audit Viewer Menu has two items: File and Help. 39

41 Figure 65 - Audit Viewer File Menu Disconnect and Close are listed under the File menu. Disconnect is used to disconnect the current connection to the database. After disconnecting, it will prompt the user to login again. Use Close to disconnect from the database and close the Audit Viewer utility. Figure 66 - Audit Viewer Help Menu The Help menu has About and User Guide. Clicking About will display the copyright information and version of the Status Enterprise. User Guide will open up the User Guide documentation for the Audit Viewer utility Viewing Logs Figure 67 - Audit Viewer Date Range Pick out the date range of the logs to display. Then, click Go. 40

42 Figure 68 - Audit Viewer Logs The Audit Viewer logs will display information about the error message, create time, user and the source time. 41

43 11 Auto Logon Utility The Auto Logon Utility is used for presetting your default user logon information, server endpoint address, and default mimic or application runtime file. By enabling this utility; users will be able to simply execute the runtime and automatically be logged in, and brought to their default mimic Launching the Auto Logon Utility Figure 69 - AutoLogonConfiguration.exe Double click the AutoLogonConfiguration.exe The Status.Utilities.AutoLogonConfiguration.exe is located in the Status Enterprise install directory. By default it s installs to C:\Program Files\B-Scada\StatusEnterprise. Login into the Status Enterprise server with the standard logon dialog. Figure 70 - Login Dialog 11.2 Auto Logon Settings Check the Logon Automatically checkbox. Check whether this will apply to a Mimic runtime, an Application runtime, or both. Figure 71 - Enable Auto Logon 42

44 Next, in the Logon Screen field, click the browse dialog button and browse to the mimic that will be the start up mimic. If you are using a Mimic Template, select a startup asset also, in the Logon Asset field. If this is an Application runtime project, select the location of the Application Configuration file in the Status Client Configuration field. Figure 72 - Default Startup Mimic Next enter or browse to the Endpoint Url for the Status Enterprise server. Enter a user name and password that will be used to login. Figure 73 - Default User Logon Click OK. 43

45 12 Additional Information and Support For more information in using Status Enterprise, please visit us at This will give you access to instructional videos, documentation and our online forum. You can also B- Scada support at B-Scada, Inc W. Fort Island Trail Building 9 Crystal River, FL USA