ams realtime version 8.2 enterprise client

AMS REALTIME Enterprise AMS REALTIME Enterprise • 1

AMS REALTIME Version 8.2

Enterprise Client

Getting Started Guide

Copyright © 2018, Advanced Management Solutions, Inc. All rights reserved.

Last updated January 2018

Contents

AMS REALTIME Enterprise 3

About ............................................................................................................ 3 Installs and Upgrades .......................................................................... 4

Important Instructions ...................................................................................... 4 New Installation ................................................................................................ 4 Upgrade Installation ......................................................................................... 4 Upgrade from 5.7 Installation Procedure ......................................................... 5 Upgrading older installations............................................................................ 5 Server License file ........................................................................................... 5 Client License................................................................................................... 6

Getting Started 7

Overview ...................................................................................................... 7 Client Connection Options ......................................................................... 7

Creating a Preference File ............................................................................... 7 Shared Preference File .................................................................................... 8 Single Signon ................................................................................................... 9 No Preference File ........................................................................................... 9

Creating a Database .................................................................................... 9 Creating a System Administrator Login .................................................. 10

Creating Access Levels ................................................................................. 10 Assigning Access Levels to Named Users .................................................... 11

Login and License Implementation .......................................................... 13 Logging in....................................................................................................... 13 Authentication, License Validation ................................................................. 13 Switches that play a part in the Login process .............................................. 14 Login As / Proxy Login ................................................................................... 15

Local and Remote Login ........................................................................... 15 Local Standalone Login ................................................................................. 16 Client/Server Remote Login ........................................................................... 16


AMS REALTIME Enterprise

About This Getting Started Guide is primarily for users that are installing and configuring AMS REALTIME Enterprise from scratch for the first time. A thorough understanding of the user and system documentation is required for a fully functioning, tailored software configuration and database. If this task seems overwhelming, AMS offers implementation consulting services to help you get the software installed and configured for your environment.

AMS REALTIME Enterprise Version 8.2 is a powerful project planning, resource management, portfolio management, associated data analysis and time recording solution that gives different users throughout the organization the interactive tools for the information they need in real time.

AMS REALTIME is a client / server application that can be rolled out using multiple platforms, operating systems, and combinations of local client installations and/or web clients.

The management of time and resource commitments combined with evaluating project progress and workflow are key concepts in project management today. AMS REALTIME Enterprise is designed to allow project managers to plan their projects at a practical level of detail, while seeing the impact on resource utilization and budgeted cost. The software is feature rich, providing necessary tools such as risk analysis, change request management, status gathering tools and track changes review capabilities.

Program managers can use the Portfolio tools to see high-level real time project status, with graphic color indicators for a quick dashboard-style view of progress, earned value, and actual plan status.

Resource managers can plan workloads and make detailed employee work assignments based on project and non-project tasks to be accomplished. Color-coded employee availability and dynamic skill filters provide just the information that managers need to get the right person assigned to accomplish the work.

Employees can use Solo, a graphic timesheet reporting tool, to see what they are scheduled to work on across all projects, including deadlines and the planned work effort. By reporting their actual time worked and estimate-to-complete, progress and date changes can keep project plans current, allowing project managers instant access to current project status and earned value data.

AMS REALTIME Enterprise allows role based security implementation through custom definition of system Access levels for different roles in the organization, so that users will see just the information and tools that they require to make successful decisions.

Reporting is powerful and flexible, providing management with slice and dice consolidation of variance and status reports in a variety of formats.

Users can perform quick, real-time data analysis on the tables by sorting, grouping, auto filters and automated summarization of data.

The AMS REALTIME Enterprise database can be synchronized with any standard database,

including Oracle, SQL Server, or other standard ODBC compliant databases. Python, an open-source scripting language, can be used to automatically integrate AMS REALTIME data with external systems, providing multi-directional specialized integration. Python is also used to create custom

wizards and other special behavior. AMS REALTIME has a fully documented set of APIs that can be used to create just the enterprise solution that meets your custom requirements.

Installs and Upgrades

Important Instructions

This Version 8.2 release supercedes all previous releases of 7.3, 7.2, 7.1, 7.0, 6.0 and all earlier versions.

1. Data saved with this version will not be readable using earlier versions.

2. AMS recommends Python 2.7.3 version with AMS REALTIME 8.2.

3. To use the Python interface, you need Python 2.x installation on the system. Though this version can work with your existing Python 1.5.2 installation, the XML translation mechanisms need at least Python 2.2.x. since Python 1.5.2 does not support XML. Python 2.x can co-exist with other versions of Python, provided it is installed in a different location on the machine.

4. Idle program location in Python 2.4 and Python 2.5 have changed. This necessitates changes in the startup.py. Contact Technical Support for details.

5. AMS recommends that you make backup copies of all Project Files, Database Files, Preference Files, Map Files, Report Files and Batch files that are present in the existing program directories and subdirectories, before you install or unzip this version over your existing version.

6. This release is supported on Windows 2000, Windows XP, Windows 2003, Windows Vista and Windows7. For Linux version support, contact Technical Supprt.

7. Upgrading from an older 7.x version is automatic. Since a number of database related changes have been made in this version, a review of the database definitions and local testing is necessary before rolling out to production.

8. Upgrading from a 6.x is automatic. Since a number of database related changes have been made in this version, a review of the database definitions and local testing is necessary before rolling out to production.

9. Upgrading from a 5.7 or earlier version requires a manual process for upgrade (this is covered in the next section). Contact technical support for the recommended migration process to migrate the database to version 6.0 before continuing the upgrade to version 7.3.

10. Enterprise Server versions 7x and 8.0 require a license file in addition to the product control (*.ctl) file. Your current support status will determine if the license file is free or if an upgrade fee is required. Contact Technical Support for details specific to your software use license.

New Installation

Insert the install CD and run autorun.exe if the application does not start automatically. Select AMS REALTIME Enterprise for installation. The Python install is also available on the install CD.

Upgrade Installation

Obtain upgrade zips from AMS Support or from the web site, providing details of your current support information. The password to extract the upgrade files will be provided by email. The upgrade zips will


not affect the existing data, such as untitled templates, configuration files, or user data. However, if changes have been made to string files (rtp.str, rtrstrs.str and rtrsstrs.str), they will be overwritten.

1. Data once read by the 8.1 and higher software versions will no longer be readable in earlier versions. Before starting the upgrade, make a complete backup of all data and do not share data between the two versions. This is generally only relevant to major version updates, not service pack releases.

2. Existing MSP Enterprise add-on (Enterprise menu in Microsoft Projects) should be uninstalled completely before installing a new one.

Upgrade from 5.7 Installation Procedure

If you have skipped the version 6.0 release and would like to upgrade from AMS REALTIME 5.7 directly to AMS REALTIME 7.3, please contact technical support before doing the upgrade. There may be database design changes that will have an impact on your specific upgrade process.

Obtain upgrade zips from AMS Support or from the web site. You will require a password for extracting the zips. The password will be provided by AMS Technical Support if your maintenance and support contract is current.

The internal data structures have changed considerably between 5.7 and 7.3 versions. Due to this, it is not possible to re-use a migrated database in version 5.7, once they have been read by 7.3 the data structures will have been automatically migrated. For this reason, adequate backup precautions should be taken while upgrading an existing 5.7 installation.

1. Make a complete backup of the data (project files, databases, map files, ini files, preference files, etc.).

2. The database must be opened using version 6.0 to allow the initial atuo-migration database changes to occur. Depending on your particular database, it may be necessary to add specific fields and/or tables that are required for Project tab functionality.

3. Install 7.3 version in a new location and copy over the necessary files (ini files, data files) to the new location and start the 7.3 version.

4. If you wish to upgrade the existing 5.7 installation location, create a test installation and verify integrity of your data and all functionality before rolling out a production 7.3 installation.

5. AMS REALTIME Resources 5.7 users will be upgraded to AMS REALTIME Enterprise 7.3. This requires a server license file. If you are currently on support, contact your AMS representative for the license file and one will be provided.

Upgrading older installations

Contact your AMS representative for an upgrade path. Versions earlier than 6.x are no longer supported.

Server License file

AMS REALTIME Enterprise Server requires a license file in addition to the authorization key to accept client connections. The license file will be provided to current supported users upgrading to new version, based on support records. To purchase additional licenses, send in your request to [email protected] and we will get in touch with you within two business days and address your request.

mailto:[email protected]

Client License

AMS REALTIME Enterprise supports both named and concurrent licensing. The licensing mechanisms are implemented on the AMS REALTIME Enterprise Server. A client connection is validated against the number of users licensed for that particular client type.

There are several different levels of licensing: administrators, project / resource managers, web users, status only users, timecard only users, and administrative / reporting only users. The server license file controls database access for these user types.

When using named licensing, connection types should be specified against the named resources in the Employee dataset. Detailed information on the licensing mechanisms is provided in the AMS REALTIME Enterprise Server guide.

AMS REALTIME Enterprise Getting Started • 7

Getting Started

Overview AMS REALTIME Enterprise is most commonly run as a Client/Server program with the Server software and common database located on a network server machine. But it can also be run as a Single-User system with a local database, or a Workgroup system where the local database accepts connection from peers or as a multi-user implementation. The client software application can be loaded on each local workstation, or as a shared application on a common network drive.

In the multi-user mode, the server is accessed through a client program (with full functionality) or through an internet browser program (with full functionality using a plugin). There are also some features that can be accessed from HTML pages (using tags, not the plugin). These are Timecard, Reports, Data Tables, and some administrative functions.

In a single-user (or standalone) system, the client program loads the database directly and performs both the client and server functions. This mode is useful while designing and initializing the database for implementation. Standalone mode provides an easy way for the system administrator to modify / customize the system configuration and design.

Standalone or Client/Server access to an AMS REALTIME Enterprise database mode is determined through preference and/or configuration files.

Workgroup mode is useful for small teams where one user controls the data and requires other team members connect to report time or project plan updates. There is no separate server installation required in this mode. This mode requires special licensing in addition to specific settings in the configuration files.

Once the database has been customized locally, the database can be moved to the AMS REALTIME Enterprise Server and users can be allowed to connect.

Client Connection Options

Creating a Preference File

The preference file contains the location of the AMS REALTIME Enterprise database, the last user that used AMS REALTIME Enterprise, and user-defined views, filters and report layouts. If this is the first time that AMS REALTIME Enterprise has been executed, only the sample.prf file will exist.

To create your own preference file, do the following.

1. Start AMS REALTIME Enterprise. You will see the Connection Info dialog box.

2. Choose the Create button in the top 'Select a Preference File' frame.

3. In the resulting Create Settings dialog, enter a file name and location for the new preference file and click OK.

4. In the middle frame under Select DataSet file or Server Address, choose Local and browse for the database file (*.dst) for Standalone mode, or choose Remote and enter the Domain name or IP address and port (separated with a colon).

5. In the bottom frame, enter your UserName and Password and click OK. The DataSource is only needed for preference files that are used for ODBC access.

A Sample Preference File Creation

This completes the creation of a new preference file. You can make this file the default preference file by modifying the Enterprise Configuration file. Locate or add the SETTINGS= switch and point to your new .prf file by entering its name after the equals sign. If the .prf file is not in the program's executable folder or directory, you must enter the full path, as shown in the example below:

SETTINGS=C:\PM\RESOURCEMNGT\MYPREF.PRF

Alternatively, an environment variable can be used in a shared network configuration file so that each user points to their own preference file stored under their AMS Realtime folder that is created in their Documents and Settings folder:

SETTINGS=%USERPROFILE%\AMS Realtime\toAMSdatabase.prf

Shared Preference File

For network installations, the preference file may be used to set the server address and port information alone. In this case, the user login and password should not be saved to the preference file. If this configuration is required, the configuration switch UPDATEPRFFILE=N can be set in the client configuration file.

It's usually preferable for each user to store their own preference file in their user folder to retain the server location and their login information.


Single Signon

If the client is configured for Single Signon, the user's network login ID is located to determine software access and the login screen is bypassed. SIngle Signon assumes that if the user already logged on to the computer, they are valid for AMS REALTIME. These configuration switches should be set in the client rtr32.ini file for Single Signon (the RTESERVER settings are set with your specific server domain name or IP address and port number).

SINGLESIGNON=Y

RTESERVER=PMDomain:8321

Note that if the software is configured to timeout after periods of inactivity, the user will need to re-enter their password to continue their session. External password authentication is typically used in this case.

No Preference File

In some cases, it's is preferable not to have the user store a preference file that stores their login information, even if the password is not stored. In that case, omit the SETTINGS switch and set your specific server location and port number in the RTESERVER switch

RTESERVER= PMDomain:8321

This will prompt the user with a short Login As prompt, automatically connecting to the designated server.

Short Login Dialog

Advantages:

1. There is no need to create preference files for every single user in the system, as preference files cannot be shared simultaneously.

2. The last successful login and connection string information are not stored, so there is less of a security risk (although even if the user elects to store their password, it is encrypted).

Limitations:

1. Without the preference file, the last successful login is not remembered. Users will have to key in both the login and the password.

2. Remembering the password is no longer an option without the preference file.

Creating a Database An Enterprise Database is created using the Connection Info dialog box and a Database Definition File (DBD). This DBD file contains a structure that is read by the program and used to build the database. The DBD file can be edited prior to creating a database using a simple text editor, such as Notepad, or the database can be modified at a later date. AMS provides a default.dbd file that sets up a basic database. To create a new database, perform the following steps:

1. Start AMS REALTIME Enterprise, the Connection Info dialog is displayed.

2. Create or select a preference file using the Create or Browse buttons in the top frame.

3. Once a preference file is selected, move down to the next frame in the dialog, 'Select Database file or Server Address'.

4. Click the Create button and in the resulting dialog, 'Create Dataset', enter a name for the new database. Click OK...

5. Go to the bottom of the Connection Info dialog and enter a username, e.g. ADMIN. Click OK.

6. The next dialog asks for the .DBD file. Choose default.dbd and click OK.

7. The following message will be displayed:

This message informs you that this is a new database and no users have been defined. You will be able to access the entire database with no restrictions until the access definitions and assignments are complete for the system administrator login. Click OK.

8. The system will now prompt for the login name of the system administrator, enter a name (ADMIN) and click OK.

9. Finally, you will be prompted to enter your name. Enter it and click OK to enter your new database.

This completes the process for creating a new database. Database additions and modifications can be made at any time by a System Administrator with access rights.

Creating a System Administrator Login A new database requires the creation of a System Administrator Login with full access to everything in the system. To do this, enter the new database and click on the Access tab.

Define a role for the administrator (e.g. FULL) and set the System to “System Access”.

This table allows access levels to be created, and then applied to individuals entered in the Employee table.

Creating Access Levels

1. In the Roles column, enter a name for the system administrator level, e.g. FULL. The columns are provided with the default access levels.


2. There are four tabs on the left edge of the Access tab, viz., Tables, User Tables, Functions, and Applications. These tabs are views set on the access table to group similar elements together and provide easier access to those elements. Select Tables Tab.

3. Make necessary changes to the columns as desired and switch to User Tables, Functions, and Applications to do similar changes.

4. Click on the Save button or choose Save from the File menu.

5. Now we need to apply the new access level to the employee record that was created for the System Administrator. Click on the Data Tables tab.

6. Click on the Select Dataset list button and choose Employee from the resulting list. Tip: Clicking on the little arrow keys on the left side of this button will step through the list of datasets without having to open the list.

7. Check that the Update Dataset tool is selected.

8. In the ResID column enter an ID for the System Administrator. In the Login Column there should already be the original login name you entered. In the Name column you should already see the name you entered.

9. Click in the cell for that employee record in the Level column. Select the System Administrator access level name you have just defined, e.g. FULL.

10. In the Password column, enter a password for the System Administrator.

11. Additional setup is required to assign access levels to individual users for named licenses. This is documented in the next section.

12. Save the changes and exit the program.

After associating the admin user to the access level:

Note: Failure to associate the correct access level to the administrator will prevent appropriate access permissions from being implemented.

Whenever a change is made to the Access table, a restart of the application may be necessary for changes to take affect. This is not the case with any of the other tables.

If Named Licenses are purchased, additional setup is required.

Assigning Access Levels to Named Users 1. Use the database you have saved and start the AMS REALTIME Enterprise Server. 2. Start the AMS REALTIME Enterprise and connect to the server as administrator. 3. Open Data Tables tab and select Employee dataset. 4. Switch to the dataset definition mode. 5. Add a field to the dataset (e.g., Products) and set the data type to “LicensePick” Set the

Attribute “ResLicPick” on the same field.

6. Switch to Update mode. 7. When you click in the Products column for the administrator row, a multi-pick will be

shown.

8. Pick the products that you want the administrator to use for connecting to the server. Eventually, this should be done for all users, but for now, just set the product access for the administrator user (select RTE at a minimum to provide access to AMS REALTIME Enterprise).

9. If additional resources are created, associate the license with the user. If the number of users associated with a product exceeds the licensed level, an error is shown.

Note: If no user is associated with a product on the first connection to the server, the server will reject any subsequent connections. This can be reset only by restarting the server.


10. If a user without a license connects to the server, a message is shown on connection.

Named License Product Codes

Product Code Product Description

RTE AMS REALTIME Enterprise Client

RTP AMS REALTIME Projects

MSP Microsoft Project Enterprise Add-in Menu

ODBC Open Database Connectivity

Python Python Scripting Language

VFS Virtual File Server

WEBSOLO Web Timecard (HTML)

SOLO Timecard Only Application

WebPlugin Browser based Access via Plugin

Login and License Implementation User logins are tightly coupled with licensing in AMS REALTIME. Named user licensing and concurrent user licensing are both offered, and various security controls are applied in the software to control licensed use.

Logging in

When the user logs in, the server location (i.e., IP address or domain name and port), user login name and password are entered in the connection dialog. This is the default behavior, but there are configuration switches that can modify the login process.

If the server information is incorrect, an error message is displayed to the user. The connection dialog is displayed again if the user chooses to retry. The user is allowed three login attempts. If the user is still unsuccessful after the third login attempt, the application closes.

Authentication, License Validation

If the server is set to authenticate users from external sources (NT Authentication), then the validation for the user and password is done with the external system. The AMS REALTIME Enterprise Employee dataset still needs to have the external login defined in order to determine the access level, organization hierarchy, etc. of the current user, but the password does not need be stored in AMS REALTIME.

If Concurrent Licenses have been purchased, the server then checks to determine if there is a license available for the new client connection. If all the licenses are currently in use, an error message is displayed to the user and the client application closes. If a license is available, the license counter is updated and user is allowed to connect to the server.

If Named Licenses have been purchased, the server validates that the user is a named user in the database. If the named user is validated, the license count is updated and connection is given. Otherwise, an error message is displayed and user is disconnected, closing the client application.

Switches that play a part in the Login process

These switches are needed only if the preference file is used. In absence of a preference file, the following switches should be commented out or removed from the configuration file.

SETTINGS – This specifies the name and location of the preference file that is initially loaded when a user logs on.

AUTOLOGON – If this is set to Y, the preference file stored in SETTINGS is loaded and the last user is automatically connected. The REMEMBERPASSWORD switch should also be set to Y for automatic logon to fully function. If anything in the stored connection preferences is incorrect, the dialog will be displayed for user update.

REMEMBERPASSWORD – If this is set to Y, the last password entered will be remembered. If the password is invalid, the user will be prompted for a valid password.

SINGLESIGNON – If this is set to Y, the user login prompt will be skipped. The RTESERVER swich must also be set in the local client configuration file to define the network location and port of the AMS REALTIME Enteprirse Server. The user's network Login ID must match with the Login ID defined in the database so that the user's access level can be determined. If SINGLESIGNON is used with automated client timeout options (CLIENTAUTOLOGOUTTIME and CLIENTAUTOLOGOUTWARNTIME) the user will still be prompted for their password if their session times out. Passwords can be validated by the external network by configuring EXTERNAL_AUTHENICATION and EXTERNAL_AUTHENICATION_DATA switches.

Reference the Configuration Guide for full information and examples of configuration switches.

Login Configuration Switches

AUTO LOGON

REMEMBER

PASSWORD

Initial login screen

Server info incorrect

User/Password incorrect

N N Full connection dialog. Password field is blank.

Error Message. On OK, Shows connection dialog again (max – 3 tries)

Error Message, On OK, Shows simple login dialog (max – 3 tries)

N Y Full connection dialog shown. Password displayed with asterisks.

Error Message, On OK, Shows simple login dialog (max – 3 tries) Password displayed with asterisks


Y N Simple login and password only

Error Message. On OK, Shows

Error Message, On OK, Shows simple


dialog is shown connection dialog again (max – 3 tries

login dialog (max – 3 tries)

Y Y No login dialog displayed



If the SETTINGS switch is not set, the full connection dialog will come up with blank connection information fields.

Login As / Proxy Login

While connected to the server, the session can be reinitialized with another login with the Login As menu option. This follows the same rules as the normal login process when the software is first started.

A proxy login is another user login that is allowed to login as a different user without having to enter a password. For example, if a manager will be away and needs their administrative assistant to approve timecards, he can set the admin assistant’s login as his proxy. After the admin assistant logs in using their own login and password, and they can then use the Login As option with the manager’s login ID, but no password will be required. The proxy login will then inherit all the manager’s access rights for the session.

This functionality requires that the ResProxy attribute be in the Employee table, and that access be given to allow certain users to define or remove a proxy. The ResProxy attribute needs to be used with the Login field. If external authentication is set, the proxy login will also bypass the external password check.

Local and Remote Login The Connection Info dialog accepts information regarding how a connection to the database will be made. Connections can be made directly to the .dst file on a disk drive (used for initial definition and setup), or over a network to the Enterprise Server (used for multi-user access).

Local access means the dataset will be opened directly in the client, with no access possible to other clients. The ‘Standalone’ option is generally used by an AMS consultant or system administrator when first designing and customizing the dataset for implementation. This is a similar principle to opening any file in any other software application. Once opened, the database cannot be accessed by another user.

Local Database Access

Remote access indicates that the dataset will be accessed over the network via the Enterprise Server. The Enterprise Server opens the dataset at startup. It then accepts logins from authorized user on the network and gives concurrent access to the dataset. This allows data access to an entire community of users.

Remote Access Via Enterprise Server

Local Standalone Login

To make a local (Standalone) connection:

1. Start the Enterprise client program.

2. In the Connection Info dialog, use the Browse button to select a preference (.prf) file.

3. In the ‘Select Dataset File or Server Address’ section of the dialog, click the Browse button to select the dataset (.dst) file to open.

4. Enter a valid User Name and Password for the dataset. The sample datasets provided by AMS always have a user login called ADMIN with no password.

5. Click OK to open the dataset.

Client/Server Remote Login

To make a Remote login to the dataset, the client connects to the Enterprise Server.


1. Start the Enterprise client program.

2. In the Connection Info dialog, select or create a preference file using the Browse button in the top section.

3. In the ‘Select Dataset File or Server Address’ section of the dialog, click on the Remote radio button in the Connection frame.

4. Enter the IP address or server name of the machine on which the Enterprise Server resides. The server address should be followed by a colon and then the port number.

5. Enter a User Name and Password.

6. Click OK to login to the Enterprise Server.

Examples:

A valid TCP/IP address might be:

ServerMachineName:8000 - Where ServerMachineName is the DNS name of the computer where the Enterprise Server resides.

Or..

192.168.0.156:8000 - Where 192.168.0.156 is the IP address of the machine where the Enterprise Server resides.

Or..

http:// ServerMachineName:8001 - Where 192.168.0.156 is the IP address of the machine where the Enterprise Server resides and 8001 is the port on which the AMS REALTIME Enterprise Server listens for HTTP requests.

The port number is set in the Enterprise Server configuration file along with the IP address. This is an arbitrary number decided by the system administrator or your IT network management. It is used to identify the port on which the Server is listening for data packets. This number should be between 5000 and 65535 to avoid clashes with reserved port numbers. AMS recommends using numbers in the 8000 – 8999 range for minimum conflict.

The server can be configured to allow client connections on the application’s native port and on a HTTP port. The client can choose to connect to the server either on the native port or the HTTP port.

Note:

1. HTTP connections are slower.

2. Regardless of the port type used, the data communication between client and server is in a native packetized format and not in clear text.

For more secure access, AMS recommend using SSL (secure socket layer) encryption. This can be used with web plugin connections for HTTPS access and with SSL client connections. Refer to AMS REALTIME Enterprise Server guide for additional details.