Welcome to ER/Studio Portal 2.0

Last updated: December 21, 2012

ER/Studio Portal Home | ER/Studio Portal Documentation | Embarcadero Technical Support | www.embarcadero.com


Thank you for using Embarcadero's ER/Studio Portal. ER/Studio Portal brings collaborative functionality and activity support to the existing ER/Studio Portal platform. This tool allows you follow changes to ER/Studio Repository metadata and to manage business glossaries and terms across the Enterprise in a browser-based reporting tool. It also supports activity streams and discussions on business glossaries, terms, and repository objects. This solution allows organizations to search, browse, and report on the information contained in the ER/Studio Repository.

ER/Studio Portal:


WHAT'S NEW IN ER/Studio Portal

What's New in ER/Studio Portal 2.0

Release Notes

Bug Fixes

System Requirements

Important Installation Notes

Installing ER/Studio Portal

Starting ER/Studio Portal

Changing Configuration Parameters

Additional Resources

What's New in ER/Studio Portal 2.0

New UI

The user interface has been improved to be more intuitive. It is based on interface of ER/Connect, a product still in development that will be released in 2013.

Expanded Repository Object Support

Nested Submodels, Dictionary objects and Enterprise Data Dictionaries, as well as indexes and keys, attachments, and security properties are now fully supported in the object browser.

New Search Engine

ER/Studio Portal is built on the Solr search engine. Substring searches can be carried out without wild card characters.

Email Notifications

Users can be notified via email of changes to their objects.

Bug Fixes

Bugs Fixed in ER/Studio Portal 2.0
ERS-16901 When you enter Grid Steps Per Line you now see the specified cell per sub grid.
RWP-2193TS: The image for a submodel and hover over information within model is not being fully updated in the ER/Studio Portal.
RWP-1944TS - Due to the definition limitations some submodels are not listed in the Explorer
RWP-1934Enable Comment Moderation not functioning
RWP-1783TS: The Windows Admin password used during the Portal installation it is not encrypted in Synchronize log file
RWP-960Show hierarchy of nested submodels
RWP-697User names should be case insensitive on all DBMS platforms

System Requirements

This section covers the installation requirements for the Embarcadero’s ER/Studio Portal. ER/Studio Portal is a 32-bit application that runs in a Microsoft Windows environment. Before installing ER/Studio Portal, verify that your environment meets the hardware and operating system requirements.

ER/Studio Repository Requirements

ER/Studio Portal 2.0 supports versions 5.5, 6.0, and 6.5 of ER/Studio Repository.

Hardware Requirements

The minimum recommended hardware requirements:

Hardware

Minimum Requirements

CPU

Pentium Class 4-CPU or higher

RAM

3 GB minimum

Disk Space

Hard Drive space - 611 MB minimum for installation

Supported Database Platforms

The Reporting database is the database ER/Studio Portal uses to store the information it gathers. It is also the location where the reports from queries and the metadata they rely on is stored and maintained.

The supported database platforms for the Reporting database are listed below:

NOTE: Ensure that the SQL Server Configuration Properties is set to allow SQL Server authentication. ER/Studio Portal only supports SQL Server Authentication.

Operating System Requirements

ER/Studio Portal is compatible with the following operating system environments:

NOTE: We recommend that the ER/Studio Portal Reporting database be located on a separate machine from the one containing the ER/Studio Repository database. The ideal setup would be for the ER/Studio Portal application server to be installed on the same machine as the ER/Studio Repository server, as long as it has enough RAM.

NOTE: FOR TESTING PURPOSE ONLY: ER/Studio Portal will run on Windows XP and Windows 7 but this is not recommended for an operational system. If installing on Windows 7 you need to run the installer in Windows XP or Windows Vista compatability mode.

Client System Requirements

Important Installation Notes

Installing ER/Studio Portal

This section helps you install ER/Studio Portal. The ER/Studio Portal wizard-based installer guides you quickly through the installation process. This section describes the Installation Wizard. It also provides some information about basic decisions you must make during installation

Installation Wizard - Welcome

To start the installation process:

  1. Download the zip file from the web page to your local hard drive.
  2. Unzip the installation file.
  3. Double-click setupwin32.exe and the InstallShield Wizard dialog is displayed.
  4. Click Next to view the Software License and Support Agreement panel.

    NOTE: There may be a slight delay between when you double-click the file and when the InstallShield wizard opens.

    The Welcome panel of the Installation Wizard offers introductory information.

Installation Wizard - Software License and Support Agreement

The Software License and Support Agreement panel of the Installation Wizard displays the Embarcadero Technologies license agreement. You must accept the agreement to proceed with the installation.

  1. Click I accept the terms of the license agreement option and then click Next to open the Directory Name panel.

Installation Wizard - Directory

  1. Choose the destination directory where you want to install ER/Studio Portal.

    NOTE: If the selected directory contains other files, an error dialog appears. The installation cannot continue unless the destination directory is empty. Click OK to close the dialog and ensure that the selected directory is empty.

  2. Optional. If you want users to be able to send results of searches and reports to an email address, click Enable sending of Email. You can also enable email through the configuration manager, which is described in the “Administrator’s Guide” section of the online help. Additional fields appear on this page of the installer where you must specify the following:

    Enable sending of Email

    You will also have the option to use Authenticated SMTP (Simple Mail Transfer Protocol). If you select this option, more fields appear for you to specify the particulars of the SMTP sever.

    Use Authenticated SMTP

  3. Click Next to advance to the Host and Port panel.

Installation Wizard - Host and Port for ER/Studio Portal Server

  1. On this page you must specify the following:
  2. Click Next to advance to the Repository Information panel.

NOTE: If the specified port is invalid or in use by another application, you will receive an error message and need to change the Port setting to an unused port number before proceeding.

Install Wizard - Repository

  1. Specify the following details of the target ER/Studio Repository that is the information source for the Reporting Repository. The Reporting Repository is the database ER/Studio Portal uses to store the information it gathers from the ER/Studio Repository.

    Field

    Description

    Repository Server

    Version

    The corresponding version of the ER/Studio Repository, 5.5, 6.0 or 6.5.

    Repo Server Name

    The name of the machine where the ER/Studio Repository is installed.

    Super User Login

    The user name for a user with the Super User role in the ER/Studio Repository.

    Password

    The password for a user with the Super User role in the ER/Studio Repository.

    Repository Database

    DBMS Server Type

    The server type:
    • Oracle
    • IBM DB2 Universal Database
    • Microsoft SQL Server>

    DBMS Host/Port

    The host name of the machine that contains the ER/Studio repository database. This information is supplied by the DB Administrator.

    For SQL Server only: If the ER/Studio Repository runs on a SQL Server database that is a named instance, specify the host name in the format of HostName\NamedInstanceName, such as DEWKBOW01.embarcadero.com\RepositoryServer.

    DataBase Name

    The name of the ER/Studio Repository database.

    Enable Encryption

    This option is available for the Microsoft SQL Server only. Select to enable Secure Sockets Layer (SSL) communication protocol which encrypts messages between the ER/Studio Portal user and the ER/Studio Repository. When SSL is enabled ER/Studio Portal uses ports 80 and 443 for secure communications.

    User Name

    The user name for the ER/Studio Repository database.

    Password

    The password for the ER/Studio Repository database.

    NOTE: The password fields are preserved when navigating back and forth during the installation process.

  2. After you have entered the required information, click Connect to test the JDBC connection.

    The installation cannot continue until this connection has been established and the ER/ Studio Repository login and password have been validated. After all tests are passed and the connection is established, the Next button becomes available.

  3. Click Next to advance to the ER/Studio Portal Repository page.

Install Wizard - ER/Studio Portal Repository

On this page specify the details for the ER/Studio Portal Repository.

  1. Enter the information as indicated below.

    Field

    Description

    DBMS Server Type

    The DBMS server type displayed matches that of the ER/Studio Repository.

    DBMS Service Host: Port

    Enter the host name and port number of the DBMS Service Host. The DB Administrator can provide you with this information.

    For SQL Server only, if the Reporting Repository will run on a SQL Server database that is a named instance, specify the host name in the format of HostName\NamedInstanceName, such as DEWKBOW01.embarcadero.com\ReportingRepository.

    The information requested depends on the server type selected:

    • Database Name (if MSSQL is selected)
    • SID (if Oracles is selected)
    • DBName (if IBM DB2 is selected)
    This information is supplied by the DB Administrator:
    • For IBM DB2 Server only, an additional field appears where you must enter Tablespace information. With DB2, the tablespace must exist in the database and must be usable by this user with the input database name.
    • For Oracle Server only, an additional field appears asking for Tablespace information. With Oracle, the tablespace must exist in the database and it can be used by the input admin user.

    Enable Encryption

    This option is available for the Microsoft SQL Server only. Select to enable Secure Sockets Layer (SSL) communication protocol which encrypts messages between the ER/Studio Portal user and the Reporting Repository.

    Database Admin User

    This information is supplied by the DB Administrator. The Admin User must have the privilege to create reporting database tables, etc.

    Database Admin Password

    This information is supplied by the DB Administrator.

    Same as Admin

    (This is only available for the MSSQL database.) If the Same as Admin is not checked (default setting), you need to enter a User Name and Password for read/write access to the reporting database and click Next.

    If the Same as Admin is checked the User Name/Password fields disappear and the Admin Name and Password are used as User Name and Password.

    Same as Admin

    (This is only available for the MSSQL database.) If the Same as Admin is not checked (default setting), you need to enter a User Name and Password for read/write access to the reporting database and click Next.

    If the Same as Admin is checked the User Name/Password fields disappear and the Admin Name and Password are used as User Name and Password.

    User Name

    (This is only available for the MSSQL database.) Enter the User Name necessary to access ER/Studio Portal’s Repository.

    Password

    (This is only available for the MSSQL database.) Enter the Password necessary to access ER/Studio Portal’s Repository.
  2. Select one of the three options for connecting to the ER/Studio Portal Reporting database and click Connect.

    Option

    Description

    Password

    (This is only available for the MSSQL database.) Enter the Password necessary to access ER/Studio Portal’s Reporting database.

    Initialize an existing, empty database

    This assumes that the ER/Studio Portal Reporting database exists and it is empty with no tables. The “Admin” user must have the privilege to create Reporting Repository schema. The installer will run the SQL to create the Reporting Repository.

    NOTE: The Reporting database must be created by the Database Administrator.

    The ER/Studio Portal installer is now ready to insert the Reporting Repository tables. For an Oracle DB, the SID must exist for the installer to insert the tables with the given user as the Owner.

    Connect to an existing Repository database

    If you choose this option, the Reporting Repository must exist and all Reporting Repository tables must be ready to be accessed by ER/Studio Portal.

    NOTE: If you are upgrading your ER/Studio Portal installation, select this option to retain your connection to the ER/Studio Repository. If you choose this option, after installing you must update the search index via the Admin dashboard.

    Reinitialize current Repository database

    The Reporting database exists. The install will drop all reporting tables and create a new reporting schema. The “Admin” must have the privilege to drop the tables and create the Reporting Repository schema.

    CAUTION: This is a destructive action.

    Once the connection is established the Install button becomes available.

  3. Click Install to advance to the Summary Information page.

Installation Wizard - Summary Information

The Summary Information page summarizes the install information.

  1. Click Finish.

NOTE: If any errors occur during the installation, an Error page opens, which directs you to the log file located in the directory where you were installing the application. For example: C:\Program Files\Embarcadero\ERConnect X.X\..

Starting the ER/Studio Portal Web interface

Once the installation is complete, open a supported Web browser (see Client System Requirements) and browse to http://yourhost:8080/erconnect/, where yourhost and 8080 are the values you specified in the Installation Wizard - Host and Port for the ER/Studio Portal Tomcat Server. The browser will show the ER/Studio Portal Login page.

Enter a valid login and password for the ER/Studio Repository as specified in the ER/Studio Portal installer. If you are using a login name other than Admin (the default user), you will need to provide your domain name as part of your user name in the format of domain name\username. The login must be a user with the Super User role in the ER/Studio Repository to access the Admin functionality in ER/Studio Portal. Users who are not registered as super users in ER/Studio Repository will have access only to the social aspects of ER/Studio Portal. Login succeeds only if there is an available "social" license.

Changing Configuration Parameters

The Configuration Manager allows you to change parameters defined during installation. These parameters include those related to ER/Studio Portal, ER/Studio Repository, LDAP, email, Solution, and Reporting servers. Using the Configuration Manager, you can reconfigure ER/Studio Portal without needing to reinstall the application.

Additional Resources

Embarcadero Technologies Technical Support

If you have a valid maintenance contract with Embarcadero Technologies, our Support team will assist you with any problems you have with our applications. Our maintenance contract also entitles registered users of Embarcadero Technologies products to download free software upgrades during the active contract period.

Evaluators receive free technical support for the term of their evaluation. To download evaluations of Embarcadero Technologies products go to the www.embarcadero.com.

To contact Support, go to Support.