Agility Database Administration Tool (ADAT)

Agility Database Administration Tool (ADAT)

January 2015

01/15 ii Agility Database Administration Tool (ADAT)

Table of Contents Overview ......................................................................................................................................................... 1 Database Management .................................................................................................................................... 2

Database Backup ............................................................................................................................... 3 Database Restore ............................................................................................................................... 3 Database Refresh............................................................................................................................... 4 User Management ............................................................................................................................. 5 Database Log Viewer ........................................................................................................................ 6

AppServer Management .................................................................................................................................. 7 Other Management Tasks ................................................................................................................................ 8

ADAT Configuration ........................................................................................................................ 8 ADAT Service Management ........................................................................................................... 10 ADAT Task Scheduler .................................................................................................................... 11

01/09 1 Agility Database Administration Tool (ADAT)

Overview In Locally Hosted Windows environments, the Agility Database Administration Tool (ADAT), available on your

database server, allows you to maintain, query and troubleshoot your Progress databases. Using the tool, installed by

DMSi, you can perform the following functions on Progress databases.

Database maintenance (backup, restore, and refresh)

User management

Advanced log file viewing

Progress database administration

Structure of Agility Database Administration Tool

The Agility Database Administration Tool consists of the following folder tabs.

Database Management – Used to start/stop databases

AppServer Management – Used to start/stop AppServers

In addition, the Settings menu bar option, accessed from the main ADAT screen, includes the following functions.

Configuration Settings

ADAT Task Scheduler

Structure of This Document

This document is organized based on the folder tabs on the Agility Database Administration Tool screen along with

the functions from the Settings option. Each section provides details about key elements on each folder tab and the

Settings menu.


Database Management The ADAT application gives you the option to manage your production or test databases. Select the appropriate

environment and database within the environment before proceeding.

The following elements display on the Database Management folder tab.

Element Function

General Tasks Database processing options:

Start – Start the selected database

Stop – Stop the selected database

Status – Query the status of the selected database

Database Status Status indicators:

Red – Database stopped

Yellow – Checking status

Green – Database running

Database Maintenance

Tasks

Database maintenance:

Backup the database

Restore the database from a previous backup

Refresh the database from one environment to another

Database

Administration Tasks

Miscellaneous database administration tasks:

User Management – lists users currently connected to the database

Log File Viewer – tool to view various administrative logs


Refer to the appropriate subheadings for additional details regarding database and administration tasks.

Database Backup

Upon selecting the Database Backup option, the system displays the Agility Database Backup / Restore screen

allowing you to backup the database. The system attempts an online backup first and if it fails, performs an offline

backup.

Database Restore

Upon selecting the Database Restore option, the system displays the Agility Database Backup / Restore screen

allowing you to restore a database from a backup file.

The system restores the database into the existing database structure. If the source database structure is different than

the target database, you must delete the target database and update its structure file manually prior to restoring the

database.

NOTE: Database must be stopped or it will fail with error codes.


Database Refresh

Upon selecting the Database Refresh option, the system displays the Agility Database Refresh screen allowing you

to refresh a database by selecting the source and destination databases.

Following are some of the key fields and commands on the Agility Database Refresh screen. The system processes

Stages 1-4 without user intervention.

Field/Command Function

Stage 1 Backs up the source database (attempts online backup, then offline backup if online fails)

Stage 2, part 1 Fixes structure/extents of destination database


Stage 2, part 2 Deletes the destination database

Stage 3, part 1 Fixes structure/extents/pathing of destination database

Stage 3, part 2 Synchronizes versions

Stage 4 Restores the destination database from the backup file of the source database

Source DB Selection Database used as the source of the refresh (typically the 'production' database)

Destination DB Selection Database being refreshed (typically the 'test' database)

User Management

The Agility Database User Management screen displays the current users in the selected database and allows you to

disconnect a selected user when necessary.

Following are some of the key fields and commands on the Agility Database User Management screen.


User ID Users currently connected to the selected database

Show Current Users Refreshes the list of current users for the selected database

Disconnect Selected User Disconnects the currently selected user from the database

Run Command with

Supplied Credentials

Elevated privileges for "Disconnecting Users" if you do not have sufficient rights. User must

be an administrator of the local box.


Database Log Viewer

The ADAT Log Viewer displays log files for the selected database in reverse format meaning the newest log entries

display first. Options within the viewer allow you to control the data in the log file by doing the following.

Limit displayed lines and file size opened to process files efficiently.

Filter standard error messages that clutter the log files.

Filter based on keywords or text (e.g. can view only certain dates).

Following are some of the key fields and commands on the ADAT Log Viewer screen.


Browse to Open a File Opens the selected log file

Back to Top Returns to the top of the file display which is the newest entry (end of the file)

Display Next Displays the next 400 lines of the file (or specified number of lines)

Refresh Refreshes the text displayed on the screen (applies filtering, etc.)

Reload Reloads the displayed file (gets new changes, processes file size)

Text Filter Filters the displayed text based on keywords or dates entered


AppServer Management The ADAT application gives you the option to manage the AppServer for your production or test databases. Select

the appropriate environment and database within the environment before proceeding.

The following elements display on the AppServer Management folder tab. Only versions of Agility using .NET

menus use the AppServer .NET tasks and statuses.


AppServer General Tasks AppServer options:

Start – Start the selected AppServer

Stop – Stop the selected AppServer

Status – Query the status of the selected AppServer

AppServer Status AppServer status indicators:

Red – AppServer stopped


Green – AppServer running

AppServer .NET General Tasks AppServer .NET options:

Start – Start the selected AppServer .NET

Stop – Stop the selected AppServer .NET

Status – Query the status of the selected AppServer .NET

AppServer .NET Status AppServer .NET status indicators:

Red – AppServer .NET stopped


Green – AppServer .NET running


Other Management Tasks The following options are found within the Settings menu bar.

ADAT Configuration

The Configuration Settings allow for the configuration of databases, AppServers, paths, and environment variables

used in the ADAT application. To modify the settings for an environment, select a record and select Edit or Delete

or double-click a record.

Following are some of the key fields and commands on the Configuration Settings screen.


Databases Lists the databases set up in the ADAT program. The name displays

as 'Descriptive Name', 'Proper Name', Path to Database'.

AppServers Lists the AppServers for the selected database (AppServer and

AppServer .NET)

Progress Prod/Test Env Path Path to the Progress Database folder for the environment (where bin is

located)

Agility Prod/Test Env Path Path to the Agility root folder for the environment where all the

databases are stored (where prod_db and test_db are located)

Admin Server Port Port the Progress Admin Server runs on

Start at Windows Logon Sets ADAT.exe to run at startup with the / minimized switch

Send to Systray on Minimize Changes the minimized functionality to minimize the program to the

system tray instead of the taskbar



Auto Build config.xml Settings Attempts to fill in the database/AppServer information for the

checked environments from the connect xml and conmgr.properties

files.

NOTE: Progress Env Path is REQUIRED and the Port # will not be

detected.

When you add or edit a database, the Database Setup screen displays allowing you to specify the details of the

environment you select.

Following are some of the key fields and commands on the Database Setup screen.


DB Description Descriptive name of the database shown in all menus

DB Name Proper name of the database as named in the Progress Explorer tool

DB Full Path Full path to the database. If not supplied, it is assumed the path is

"agility-env path + DB name"

AppServer and

AppServer.NET

Proper names of the AppServers as named in the Progress Explorer

tool

When you select Auto Build config.xml Settings, the ADAT: Automatic Configuration File Builder screen displays.


ADAT Service Management

The ADAT Service Management application allows you to configure the system service, e-mail alerts and SMTP

settings.

Following are some of the key fields and commands on the ADAT Service Management screen.


Service Installation Displays installation status of the service

Service State Displays current running status of the service



Enable Email Alerts Enables sending of email alerts (must enter the SMTP Server Settings

Enabled Email Alerts Allows you to select which alerts you want enabled

SMTP Server Address SMTP Server to send email through

Port Default port is 25 (gmail uses SSL and port 587)

From Address Address you want to send email from (e.g. sender of the message)

To Address Comma separated list of addresses you want to send the alert to

It is recommended that you click the 'Send Test Message' command after entering the SMTP Settings to verify the

settings are correct.

ADAT Task Scheduler

The Task Scheduler allows scheduling of ADAT tasks including silent backups.

The following table lists the switches available you can enter in the Command Line for a database backup.

Switch Function

-backup Switch to perform backup of DB

-env=prod Environment to work in “prod” = Production, “test” = Test (Progress Version)

-db="backup database path" Source database file path to backup

-dest="backup file destination" Destination file path to backup into

email=always “always” sends an e-mail, “fail” only sends an e-mail on backup failures

[email protected] E-mail address to send to and to send from

-smtp=smtp.company.com SMTP server used to send e-mail through

-port=25 If port is not supplied, the default of 25 is used

Examples:


adat.exe -backup -env=prod -db="c:\agility\prod\prod_db\platte"

- dest="c:\agility\prod\prod_db\backups\platte.bkup" -email=always [email protected]

- smtp=smtp.company.com


- dest="c:\agility\prod\prod_db\backups\platte.bkup"


- dest="c:\agility\prod\prod_db\backups\platte.bkup" -email=fail [email protected]

- smtp=smtp.company.com –port=25

NOTE: There is now a separate executable (lhtasks.exe) in the parent folder that takes the place of using adat.exe

with command-line switches. lhtasks.exe functions exactly like adat.exe only command-line driven and silent. All

switches above are accepted. lhtasks.exe is used to schedule backup tasks in the ADAT Task Scheduler functionality

of ADAT.

When you select to add a new task, the Task Selection screen displays.

The user-defined name you enter in the Enter Task Name field displays as the title of subsequent windows.

When you select Create Task, the standard Microsoft ™ Task Scheduler window displays.

mailto:[email protected]

mailto:[email protected]


Verify the correct options display on the Task, Schedule and Settings folder tabs. For additional help regarding the

Task Scheduler, refer to Microsoft Online Help.


Proprietary Notice

This product material is furnished by Distribution Management Systems, Incorporated (DMSi), and is designed to

provide authoritative information in regard to the subject matter covered. This material is for informational use only

and is subject to change without notice. DMSi assumes no responsibility or liability for any errors, omissions, or

inaccuracies that may appear in this material.

This material is subject to copyright laws. Only in accordance with the license agreement may this material be used

or copied. Information contained in this material is disclosed in confidence and may not be reproduced in whole or

in part, stored in a retrieval system, or transmitted in any form or by any means, electronic or mechanical, including

but not limited to photocopying and recording, without the prior written permission of DMSi or except as described

in the license agreement. The information made available in this material may not be disclosed to other persons

where such disclosure would result in unfair competitive advantages.

© 1997 – 2015 Distribution Management Systems, Incorporated, all rights reserved

Trademark Notice

The Agility™, BInformed™, BLOCS®, DMS+™, EntryNET™, PartnerView™ and StockNET™ products are

trademarks of Distribution Management Systems, Inc. All other trademarks appearing in this document are owned

by their respective companies.

Agility Database Administration Tool (ADAT)

Documents

Transcript of Agility Database Administration Tool (ADAT)