Database Backup for EnergyCAP Enterprise

The User Manual provides information about using Energy CAP Enterprise.

• To access the User Manual, navigate to http://help.energycap.com.

The HELP interface is divided into two panes:

• Left Pane:

  • Table of Contents Displays books and pages representing the categories of information. When you click a closed book, it opens to display its content (sub-books and pages). When you click an open book, it closes. When you click pages, you select topics to view in the right pane.

    NOTE: After clicking a topic folder, it is possible to view all pages associated with the selected folder by clicking the All Content on One Page... link or appending the following to the topic link: /show-all-pages

  • Search User's Manual (bottom of left pane): Click on the Search User Manual topic to open the search page: http://help.energycap.com/search_help. This page enables a word search using the text string input in the Search Text field. Note that AND and OR operators are available to refine the search. When the search is completed, a list of topics will be displayed based on the input search criteria.

• Right Pane Displays the selected topic page or link.

Once the topic is displayed, use your browser options to print the topic or perform additional text searches if desired.

Topics in the User Manual may contain additional tools:

• Links to other topics (including web videos): When you click some links, the destination topic replaces the current topic. Click the Back button/arrow to return to the original topic.

• Icons are used to make you aware of additional information:

   

Technical support is ordinarily available Monday through Friday, 8:00AM to 5:00PM EST (except holidays).

• Phone: 877-327-3702
• KnowledgeBase: http://support.energycap.com/index.php?_m=knowledgebase&_a=view
• HELP Videos: http://www.energycap.com/support/techvideos 

You may also create your own HELP ticket through our Support Suite application: http://support.energycap.com.

When contacting the technical support group, please have the following information available:

• Your company name
• Your phone number and email address
• The version of EnergyCAP Enterprise you are using
• Your database connection type (LAN, MSDE/SQL Express, Internet DB, Web)
• Your web browser and version number
• The operating system version you are using
• An explanation of the problem incurred, including any error messages you received

The following HELP options are available from the EnergyCAP Help menu:

User Manual: Click to link to the User Manual.

Find the Best Reports: Click to open an information window regarding report availability. See Also: Sample Report Page.

EnergyCAP Tech Support: Click to open an information window regarding Technical Support. See Also: Support Suite.

VB Script Reference Manual: Opens the VB Script Reference HELP file.

Check for Updates: Click to open the Checking Upgrade Availaiblity window. EnergyCAP will check for availability of a newer EnergyCAP software version. Software status information will be displayed at the bottom of the window. If your version of EnergyCAP is outdated, a link to the upgrade product release information and instructions will be provided.

NOTE: Beginning with Release 6.0, EnergyCAP automatically checks for software updates every two weeks upon startup unless this feature is disabled by unchecking the checkbox accessible from the Checking Upgrade Availability window. The automated check feature simply provides a way for EnergyCAP to notify users of available updates—NO software is downloaded or installed.

Piracy Protection: Click to open the System Information window, which provides anti-piracy information. When done, click OK to close the window.

The EnergyCAP Quick Start Guide, in conjunction with training and implementation support, is designed to help you get EnergyCAP up and running fast. EnergyCAP is an advanced, complex program with many options; this Guide does not cover all scenarios or address all options, but rather is intended to assist with the basics of the initial setup leading up to bill entry.

Click here to download and/or view the Quick Start Guide.

To identify your current EnergyCAP Enterprise Release and related information, log into EnergyCAP and click Help/About ... from the menu options. The About window will open, displaying the current release details.

• The number to the left of the first decimal point is the Major Release number.
• The number to the left of the second decimal point is the Minor Release number.
• The number to the left of the third decimal point is the earliest compatible Database Version. Your database structure must be the indicated number or higher for optimal function of the software.
• The number to the right of the third decimal is the associated application Build.
• The bracketed number is your current database (DB) version.

EXAMPLE: Release 5.0.49.135 [DB49]

• 5 is the Major Release number
• 0 is the Minor Release number
• 49 is the Database version number
• 135 is the Build number.

The above information should be provided to EnergyCAP technical staff when troubleshooting support issues.

This topic describes the EnergyCAP Login process and behind-the-scenes actions and processes

1. To access EnergyCAP Enterprise, either:

   • From the Start > Programs menu, select EnergyCAP Enterprise.

   • Double-click the EnergyCAP Enterprise desktop shortcut icon.The EnergyCAP Enterprise Login window will open.
     
     

1. In the User ID field, type your user ID.

2. In the Password field, type your password.

3. To access EnergyCAP Enterprise using the datasource catalog server (recommended):

   NOTES:
   The catalog server is a web service that centralizes datasource management through a single point.
   When Active Directory is used along with Internet connection (not LAN) Web Reports may not work.

   1. Select the Use catalog server check box.

   2. Click on the Datasource drop-down list and select the desired EnergyCAP database.

      • (optional) Click to view a description of the selected datasource (if available).

   3. Go to step 5.

4. To access EnergyCAP Enterprise using an ODBC - Open DataBase Connectivity connection:
   
   Note: An ODBC is an interface that makes it possible to access different database systems with a common language.

   1. Clear the Use catalog server check box.

   2. Select the database to access from the Datasource drop-down list.

   3. Go to step 5.

5. Click OK.

The EnergyCAP application window will open.

Many of the tasks in EnergyCAP are accomplished using the navigation bar on the left side of the screen, and the associated workspace on the right. For example, to view facility information, select the Setup module, then click the Facility icon. The workspace displays the Facility Manager.

The Preferences option allows you to save certain application options.

1. From the Tools menu, select Options. The Options window appears.

2. Select the Preferences tab.

3. In the Autosave section, select any of the following options:

   • Login parameters - At your next log in, EnergyCAP Enterprise automatically displays the datasource last accessed and the user ID used.

   • Window state - At your next log in, EnergyCAP Enterprise remembers the application window size.
     NOTE: For dual-monitor users, EnergyCAP is now aware when the user has switched between a single- and dual-monitor environment.  The application will auto-position itself so that a user on a single monitor setup will always see the application even if it was last opened on the second monitor in a dual monitor setup.

   • Last view in workspace - At your next log in, EnergyCAP Enterprise automatically displays the module and view you last accessed.

4. In the Catalog Server section, type the URL link to the XML list of available databases. Example: http://servername/catalogservice/catalog.asp

After making your selections, click OK.

To access and use the application, your system should be equipped with the following:

• 400 MHz processor (minimum) or faster (recommended)
• 128 MB RAM (minimum) or more (recommended)
• 500 MB free disk space (minimum) or more (recommended for reports)
• 800 x 600 display setting

Recommended:

• Small font size
• 1024x768 pixels desktop area

One of the following operating systems:

• Windows 7
• Windows 2000 Professional
• Windows XP Home/Professional
• Windows Vista Home Basic/Business/Ultimate
• Windows 2003 Server
• Windows Server 2008

Recommended Browser:

• Microsoft^® Internet Explorer  7.0 or later; Firefox^® 3.5 or later; Google^® Chrome

NOTE: Minimum system requirements may vary depending on the operating platform installation (Desktop or Network), and antcipated size of the organization database. Contact EnergyCAP, Inc. with specific questions regarding your implementation.

Database Management

Required: SQL Server 2005 or later

• 32 or 64 bit supported
• Local user authentication or mixed mode required

Hardware specifications are dependent upon database size, features utilized, and desired performance. Database server should not host any applications besides SQL.

RAID Drive Setup:

In accordance with Microsoft’s suggested SQL Server setup, EnergyCAP, Inc recommends that the operating system, the log files, and the data files all exist on separate independent disk channels.  Although the database server will likely perform adequately in a less optimal configuration, better performance will be observed when adhering to the basic guidelines below.  Consult with your organization DBA regarding requirements or setup configurations that enhance this basic standard.

DB Performance Guidelines

Fewer than 1,500 meters:

• Xeon Dual/Quad-core, 2.0  GHz or better, 2 GB RAM, 5 GB* hard drive space

Over 1,500 and fewer than 3,000 meters

• Xeon Dual/Quad Core, 2.5 GHz or better, 3 GB RAM, 10 GB* hard drive

Over 3,000 meters

• Dual Xeon processors, Dual/Quad Core, 2.5GHz or better, 4+ GB RAM, 30 GB* hard drive, suggested RAID configuration

A more capable server will be needed for organizations with:

• Over five years of historical bills
• Over 50 interval data channels
• Frequent data imports

*Analyzing numerous client databases with historical and active data, a general “rule of thumb” shows that an EnergyCAP database will grow at approximately 20Kb/bill for bill data only.  This translates to rough estimates of:

• 500 bills/month   = 6,000/year   = ~120MB/year
• 1000 bills/month = 12,000/year = ~240MB/year
• 1500 bills/month = 18,000/year = ~360MB/year
• 2000 bills/month = 24,000/year = ~480MB/year
• 5000 bills/month = 60,000/year = ~1.2GB/year

Performance Guidelines

For best performance on a server, SQL Server should be the only application running on the server, other than management utilities. Don't locate IIS or MTS server on the same server as SQL Server. Not only does this hurt SQL Server's performance, but it also makes it more difficult to performance tune and troubleshoot SQL Server.

RAM - This is probably the most significant piece of hardware that affects SQL Server's performance.  Ideally, the entire database should fit into RAM; therefore, ECI recommends installing all the RAM the server can handle. There is no such thing as too much RAM.

I/O Subsystem - After RAM, the I/O subsystem is the most important piece of hardware to affect SQL Server's performance.  At the very minimum, purchase hardware-based RAID for the database.  As a rule of thumb, ECI recommends installing more, smaller drives, not fewer, larger drives in the array.

Network Connection - At the server, have at least one 1GB network card, and it should be connected to a switch.

Hardware specifications are dependent upon database size, features utilized, and desired performance.  The database server should not host any applications other than SQL.

Web Server Minimum Specifications

• Windows 2003 Web/Standard/Enterprise or greater
• 1GB RAM
• Xeon Dual/Quad core, 1.6GHz or better
• ASP enabled
• .NET 3.5 or greater
• IIS 6.0 or greater
• Port determined by web admin

The web server can be shared with other web services or on the database server; however, network/security administration standards usually recommend not having the application/Web server running on a database server.

NOTE: EnergyCAP uses the Crystal Report Runtime engine, which may interfere with other Web applications.  Although many clients have successfully installed EnergyCAP online alongside other web applications, ECI cannot support issues caused by other applications running on the same server.

When multiple users are entering information into your organization's dataset, it is recommended that you periodically refresh (update) your session in order to view and access any information other users may have entered.

To update your session, select Refresh from the Edit menu.

EnergyCAP is a multiple-module software application with a wide variety of features. Our development team provides multiple EnergyCAP releases yearly. Your annual EnergyCAP Maintenance Agreement (ECMA) includes any/all software or database updates/upgrades and technical support related to installation processes for these updates/upgrades. Installation details vary with the nature of your EnergyCAP application (client-server, web-based, desktop).

After the EnergyCAP Enterprise Windows/LAN Client has been installed, it requires a connection to the EnergyCAP database.

Authentication and Authorization in EnergyCAP Enterprise is accomplished in a two-step process.  All program-specific users are stored in the EnergyCAP database. But a connection must first be established to the database before EnergyCAP can authenticate the user.  This topic describes the ODBC and Active Directory authentication and authorization options and processes.

Connection to the database - LAN:
When connecting to an EnergyCAP database in LAN mode, either set up an ODBC System DSN or use a Catalog Server.

If the Catalog Server is used, then there is no need to create an ODBC System DSN on the client PC.  When an ODBC System DSN is setup, it can be setup to use EITHER SQL OR Windows NT authentication.  If SQL authentication is selected, in most cases, the user account esuser will be used to make the connection to the database.  If an alternate user is desired, please contact Technical Support for assistance with the configuration of the client.ini in the EnergyCAP installation directory.

IMPORTANT NOTE: If NT authentication is used for the ODBC System DSN connection, the NT User cannot be part of a GROUP that is assigned a privilege to SQL Server. Each user will need to be assigned INDIVIDUALLY with security privileges to the EnergyCAP SQL Server database. This is because EnergyCAP verifies the SQL privileges of the user making the connection to the database itself before it allows them to Update Reports or create User Defined Fields, in order to determine if the necessary security roles are present.  This method does NOT work if the user making the connection is within a GROUP.  If the user is part of a GROUP with access, EnergyCAP does not grant the necessary permissions and will prevent those actions from occurring.

Connection to the database - WLAN:
EnergyCAP also offers a WLAN option which allows a connection using a Catalog Server and XML Data Provider to establish connection between the client and the SQL Server.  In this case, Active Directory users should NOT be used.

Database Authentication:
Once a connection to the database is established, the EnergyCAP Enterprise client can then authenticate the user to the database.  In case of Active Directory, the UserID is first compared to UserIDs in the EnergyCAP database.  If a match is found, the UserID and password are then compared to the user’s local Active Directory server to make sure they match.  In all other cases, the UserID and Password are compared to what is in the EnergyCAP database itself.

Database Authorization:
After a user is successfully authenticated to the database, the application checks the defined user authorization.  The authorization scheme is very granular, allowing for access/denied access to each “manager” in the program, and where applicable, each sub-authorization for those modules.  For example, a user can be given access to view reports, but not access to edit the settings on the reports. These authorizations are loaded into memory at runtime and destroyed when the program is terminated.

Active Directory Authentication with EnergyCAP

When using EnergyCAP there are two stages of authentication that must occur for the user to gain access to the database and begin using the program.

1. The database connection used by the EnergyCAP application is authenticated by the database server.
2. The EnergyCAP application authenticates the user in the database itself.

Both of these processes are now Active Directory-compliant. It is assumed that Active Directory authentication, whether to the SQL server or into EnergyCAP, will only be attempted on a computer that is already trusted by the domain, ie. a computer that is joined to the domain.

Database Authentication:

EnergyCAP user names are stored in the SQL database. Therefore, for the login process to occur, the application must first gain access to the database and check that the username exists before determining how to authenticate the user. If enabled on the database server, the client machine can be configured to connect to the database server with NT Authentication, preventing need for a SQL user. Although EnergyCAP uses ADO connections for most data, ODBC connections are still required for Crystal Reports. Because of this, EnergyCAP retrieves the database, server name and whether the connection should be treated as "Trusted" from the ODBC properties when preparing the ADO connection. Therefore, if the ODBC DSN is set to use NT Authentication, the ADO connection will follow suit.

Application Authentication:

Usernames are set up inside of the EnergyCAP application. As users are set up, they can either be given an EnergyCAP password (Caesar Cipher) or be authenticated against an Active Directory domain. If the username is listed as being an Active Directory user, then that is the only way they can successfully authenticate to use the program.

To set up a NEW EnergyCAP user with Active Directory authentication:

1. Add a new user from the Setup menu
2. For the UserID, enter the users exact Active Directory username without the domain suffix. This is case sensitive (limit 32 characters).
3. Check the "Active Directory User" box below the users full name
4. Set EnergyCAP permissions as usual and press "OK" when complete.

The user is added, but authentication will be done via AD.

To change an EXISTING EnergyCAP user with Active Directory authentication:

1. Edit the properties of the current EnergyCAP user
2. Check the "Active Directory User" box below the users full name
3. Set EnergyCAP permissions as usual and press "OK" when complete.

The user's EnergyCAP password in the database is deleted and set to use AD for authentication going forward. If the user is ever switched back to non-AD authentication, their password will have to be reset in the database using the "Password" button.

Logging into EnergyCAP with an Active Directory User

1. From the login screen, enter the username and password of the active directory user (limit 32 characters for each).
2. Select the correct datasource from the dropdown list.
3. CHECK the box labeled Login using Active Directory.
4. Enter the domain name into the box that appears. This is not the fully qualified domain name, but the Active Directory domain name.
5. Press OK.

NOTE: All settings except the password will be saved for the next login to make the process easier.

Establishing an ODBC Connection

Requirements for ODBC connection to the database:

The EnergyCAP Enterprise database must be installed on instance of Microsoft SQL Server 2005 or higher. The client computer (LAN client), must have an ODBC connection established to the server in order to be connected. This can be done either by a static user setup with SQL Authentication (initially defined with the installed database) or via Active Directory Authentication, labeled as “NT Authentication” in SQL Server.

Below are the necessary steps to create an ODBC connection to an existing EnergyCAP Enterprise database that is being ‘served up’ by an SQL Server.

1. Click the Start button and select the Control Panel option. The Control Panel will open.
2. From the Control Panel, double-click Administrative Tools. The Administrative Tools window will open.
3. Double-click the Data Sources icon to open the ODBC Data Source Administrator.
4. Select the System DSN Tab. A list of current System Data Sources will appear. Verify that the EnergyCAP database to be connected is not one of them.
5. Click the Add button.
6. Select the SQL Server driver from the list of available database drivers (it may be necessary to scroll to the bottom of the list box to find it); then click the Finish button. The Create a New Data Source to SQL Server window will open.
7. Enter a Name and a Description for the data source.
8. Use the drop-down list to select the SQL Server that is ‘serving up’ the EnergyCAP Enterprise database. If the SQL Server is not listed, try typing in the SQL Server name. Be aware that there may be a firewall between the Client computer and the SQL Server which may need its settings updated to allow access.
9. Click the Next button.
10. Select the With SQL Server authentication… option.
11. Set the Login ID and the Password. If necessary, contact technical support for this information (http://support.energycap.com).
12. Click on the Next button.
13. In the Change the default database to: option, select the EnergyCAP Enterprise database name from the list of available databases.
14. Click on the Next button.
15. Click on the Finish button.
16. Click on the Test Datasource button to confirm the settings. A 'test was successful' message should be displayed.
17. Click on the OK button to close the Test window.
18. Click on the OK button to close the System DSN window.
19. Close the Administrative Tools window.

Verifying the connection

1. Start EnergyCAP Enterprise.
2. In the Login window, enter a valid User ID and Password.
3. Click the drop-down arrow for the ODBC datasource. The newly-created datasource should be included in the list.
4. Click to select the new datasource, and then click OK.
5. EnergyCAP Enterprise should open to the database selected.

If ODBC connection questions persist, complete a trouble ticket online at http://support.energycap.com/ or call 1-877-327-3702.

Once an ODBC connection to the database is made, the EnergyCAP Enterprise client can then authenticate the user to the database. EnergyCAP Enterprise does user authentication in the application database. Users and their passwords are created with the application. Passwords and user permissions are stored encrypted.

User Permissions

After a user is successfully authenticated to the database, the application checks the defined user Permissions. The authorization scheme is very granular, allowing for access/denied access to each “Manager” in the program, and where applicable, each sub-authorization for those modules. For example, a user can be given permission to view reports, but not to edit the settings on the reports.

EnergyCAP, Inc. recommends frequent periodic backup of your EnergyCAP Enterprise database.

The frequency of your backup process will depend on your level of risk tolerance for data loss.

Many/most EnergyCAP clients have IT processes in place to ensure daily backups.

Backup of the SQL-based EnergyCAP database is often accomplished using SQL tools such as SQL Server Management Studio Express.

Contact your IT staff to verify the nature and frequency of your current EnergyCAP backup procedures.

Organizations with large databases should take special care to ensure that data is not lost. Clients performing log shipping should ensure that appropriate procedures are in place.