Create a New Database in ZIM

Using ZimAdmin login to a server and right click on the Databases folder.  Select “Create Database” and follow the instructions.

Once the database has been created, ZimAdmin will add the new database details to the zomdb.zim file.

For older systems use ZIMBOOT. ZIMBOOT Initializes a new ZIM-X database.

Syntax

ZIMBOOT <directory_name> <[ZANTHEZIM | encryption_key]> [-UTF-8]

Parameters

directory_nameThe disk directory where the new Object Dictionary is to be initialized. This directory must exist before ZIMBOOT is executed
encryption_keyA key that the software uses later to encrypt the disk files created as objects are created in the Object Dictionary. You must provide ZANTHEZIM if you DO NOT want the database to be encrypted.
encodingWhether the database will be initialized with the ANSI or UTF-8 encoding. If not provided, the default is ANSI.

Comments

If an Object Dictionary already exists in the specified location, ZIMBOOT asks you to confirm that you want to overwrite the existing database.

The newly created ZIM:X database will only contain the basic content for a ZIM:X application to be built. Prior to any work on this database, the developer must start ZIMQTC on this database and then execute

ZOMEnable

to populate the database with the remaining objects needed for the development of the application.

ZimAdmin

Comprehensive Database Management Console

ZimAdmin is a powerful graphical management console designed to simplify the configuration, monitoring, and management of all Zim databases and Zim Server machines within your network. With its intuitive interface, ZimAdmin provides a seamless experience for database administrators.

Key Features

  • Activate Zim Products: Easily view and activate your Zim products.
  • View Server Log: Access the Zim Server log file to monitor server activities.
  • Manage User Connections: See all users connected to Zim Server-managed databases.
  • Zim Server Configuration: View and edit the Zim Server configuration file.
  • View Zim Server Statistics: Get detailed statistics for your Zim Server.
  • View File Statistics: Analyze statistics for each file in your databases.
  • Customize Database Language: Personalize language settings for various database elements.
  • Database Configuration: Display and manage the Zim database configuration file.
  • View Database Objects: Navigate and query database objects with ease.

User Interface

The ZimAdmin interface is designed for efficiency and clarity:

  • Tree View: On the left, Zim Servers, databases, and objects are organized in a hierarchical tree view.
  • Grid Area: On the right, detailed information is displayed in a grid, depending on the selected utility.

Creating a New Database

To create a new Zim database, right click on the Database folder and select “Create Database” option and follow the prompts.

ZimAdmin is your go-to tool for managing complex database environments with ease and precision. Explore the full potential of your Zim network with ZimAdmin today!

Language Customizer

The Zim Database Language Customizer utility displays and enables editing the contents of the zimlang.zim customization file for the selected Zim database.

Click on the cell in the Current Value column along the row corresponding to the language customization item you wish to change

Type in the new value for the language customization item. The updated value will appear in bold. Click on Save to store the new language customization file

The Zim language customization changes for the selected database have been accepted and will take effect as soon as Zim Server restarts.

Activation

Activated Products

The Activation utility displays all currently activated Zim products installed on the same machine as the selected Zim Server.

Each row in the Activated Products grid corresponds to a single Zim product:

The column headers in the Activated Product grid are described in the table below:

ColumnDescription
Product CodeIndicates the activated licensed product (e.g., ZIM PDP, ODBC Driver, JDBC Driver, SAM, ZIM Web, ZIM Backup Server, JDBC SAM)
Serial NumberThe serial number used to activate the product
UsersThe number of licensed users for the product
Zim VersionThe Zim version compatible with the product
OSThe operating system for which the product was licensed
Start DateThe date on which the product license was activated
End DateThe date on which the product license will expire
CompanyThe name of the company for which the activation key was issued

Activating a New Product

New Zim products can be activated by clicking on Activate a New Product and providing the correct information in the dialog:

Note: You will always receive, via e-mail, the required activation information (Serial Number, Activation Key and Registration Name) for any Zim product licensed to you..

Click on Activate to complete the procedure.

User Connections

Viewing User Connections

The User Connection utility lists all users connected to the selected Zim Server and provides an interface for disconnecting users from the server.

The column headers in the User Connections grid are described in the table below:

ColumnDescription
UserA user identifier number, assigned by Zim Server in chronological order
User NameThe name of the User connected to the host machine
TypeZim ODBC Driver, Zim JDBC Driver, Zim TC Agent, or Zim DB Agent
DatabaseThe database name as listed in zimdb.zim
ConnectedThe date and time when the connection was established
Host NameThe machine name where Zim Server is running
IP AddressThe IP address of the host machine
Agent PIDThe process ID of the executing task in the host machine
Client PIDThe process ID of the executing task in the client machine
Read LocksThe number of read locks caused by this user since connected to the server
Write LocksThe number of write locks caused by this user since connected to the server
File LocksThe number of file locks caused by this user since connected to the server
Work PathThe full path to the file in which the user information is maintained

Disconnecting Users

To disconnect a user, right-click on the user number and then click on Yes in the pop-up dialog

The selected user connection will be terminated and the list of connected users will be updated

File Statistics

The File Statistics utility displays statistics for all open files that belong to any of the databases managed by the selected Zim Server.

Each Zim file is displayed in a single row in the File Statistics grid, whose column headers are described in the table below:

ColumnDescription
FileAn identifying number that represents the chronological order in which files have been opened
UseIndicates whether the file is IN USE or NOT IN USE
ReadsThe number of times this file has been read since the selected Zim Server session was initiated
WritesThe number of times this file has been written to since the selected Zim Server session was initiated
Read LocksThe number of times this file has had a read lock since the selected Zim Server session was initiated.
(A read lock happens when a 1kb page within the file is locked for reading)
Write LocksThe number of times this file has had a write lock since the selected Zim Server session was initiated.
(A write lock happens when a 1kb page within the file is locked for writing)
File LocksThe number of times this file has been locked since the selected Zim Server session was initiated.
(A file lock happens when the entire file is locked for reading)
File PathThe full path to the file

Note: You can sort the grid by clicking on its corresponding header tab. The first click sorts the table in ascending order and the second in descending order.

 

Adding or Removing Servers

Adding a Zim Server

Add a Zim Server to the network tree by right-clicking on the Zim Servers node and then clicking on Add Server…

Alternatively, a Zim Server node can also be added to the network tree by selecting Tools and then clicking on Add Server…

 

Next, enter the Zim Server‘s IP address in the field provided (default: localhost), the port number (default: 6002) and press OK

A new node containing the Zim Server‘s IP address will appear in the network tree. If Zim Server is running on the same machine as Zim Explore, the new node will be labeled localhost

Connecting to a Zim Server

To connect to the newly added Zim Server, right-click on the server node and click on Login

To complete the login procedure, enter the user name (default: ZIM), the password (default: “”) and click on OK

 

Once the connection to the server has been established, a + sign will appear beside the server node

The server node can be expanded by clicking on the + sign or by double-clicking on the server node itself

Removing a Zim Server

To remove a Zim Server node from the network tree, right-click on the server node and click on Remove

 

Statistics

Zim Server Statistics

The Statistics utility displays relevant information pertaining to the configuration and state of the selected Zim Server.

The column headers in the Zim Server Statistics grid are described in the table below:

Connections
Maximum ConnectionThe maximum number of users that can be connected simultaneously to the selected Zim Server
Current ConnectionsThe number of users currently connected to the selected Zim Server
File Handling
Maximum FilesThe maximum number of files, across all databases, that can be handled by the selected Zim Server
Number of Files in UseThe number of files, across all databases, connected to the selected Zim Server
Links
Available Scatter Links to DatablocksThe number of available scatter Links to datablocks
Available Scatter Entries to ClientsThe number of available scatter entries to clients
Lock Handling
Maximum LocksThe maximum number of locks for the selected Zim Server
Read Locks in UseThe number of read locks currently maintained by the selected Zim Server
Write Locks in UseThe number of write locks currently maintained by the selected Zim Server
Quick LocksThe number of available quick locks for the selected Zim Server
Total Quick Locks in UseThe number of quick locks currently maintained by the selected Zim Server
Shared Memory
Shared Memory AllocatedThe total amount of memory (in bytes) allocated to Zim Server by the Operating System
Shared Memory UsedThe total amount of memory (in bytes) currently used by Zim Server
Shared Memory AvailableThe total amount of memory (in bytes) available for Zim Server

.

ZimServer Configuration

Browsing the Zim Server Configuration

The Zim Server Configuration utility displays and enables editing the contents of the zimconfig.srv configuration file for the selected Zim Server.

The column headers in the Zim Server Configuration grid are described in the table below:

ColumnDescription
Option NameThe Zim Server configuration option
Current ValueThe value assigned in the configuration file
Default ValueThe default value for this option if no other value is assigned
MinimumThe minimum allowed value for this option
MaximumThe maximum allowed value for this option

All the available Zim Server configuration options are listed in the table below. Click on any option to view more detailed information.

Zim Server Configuration Options
audit pathbackup pathbackup port numberbackup server name
buffers per usercheckpoint bufferscheckpoint transactionsdatablock timeout
files per transactionjava optionsmaximum data blocksmaximum file locks
maximum locksmaximum log sizemaximum record groupsmaximum tables
object sleepobject timeoutpending sleeppending timeout
quick locksrecord group sizescatter table entriesscatter table links
secondary lock group sizesecondary lock groupsserver port numberweb port number

Editing the Zim Server Configuration

To change the value of a configuration option, click on the cell in the Current Value column along the row corresponding to the selected configuration option

Type in or select the new value for the configuration option and click on Save to store the new configuration file

The Zim Server configuration changes have been accepted and will take effect as soon as Zim Server restarts. Click OK to dismiss the confirmation message

Database Object Browser

Browsing Objects by Type

The Object Browser provides a concise representation for database objects that belong to the selected database.

In the treeview, each database node has a child node labelled Objects, which in turn contains one child node for each object category.

Clicking on a particular category node will result in the Object Grid displaying only the database objects of the that category.

Each object occupies a single row and each of the object’s properties will be represented in a single column.

Object Categories

The table below lists all object categories that can be viewed in the Object Browser.

Also listed are the equivalent Zim:X commands that can be issued from a Zim:X client to retrieve the same objects.

To view more information about a specific object category, click on the category name in the left column.

Object CategoryExecuted ZOM Command
Entity Setslist all entitysets or list all ents
Documentslist all documents or list all docs
Constantslist all constants or list all consts
Variableslist all variables or list all vars
Formslist all forms
Windowslist all windows or list all wins
Displayslist all displays or list all disps
Menuslist all menus
Roleslist all roles
Relationshipslist all relationships or list all rels
Setslist all sets
Directorieslist all directories or list all dirs

Querying Databases

The Database Object Browser also provides an interface for issuing Zim commands to query the database.

For example, to list all the form fields belonging to the form fExample_Zim9, in the database, type the following Zim command in the entry field:

list all ffs where FormName = "fExample_Zim9"

… and press Go.

The form fields will be listed in the Database Explorer grid, where each form field will be represented in a single row and each of its attributes in a single column:

Note: List commands do not generate sets when issued from Zim Explore. If you wish to interact and manipulate objects, use ZXCLIENT or ZXCOMMAND.

pt_BRPortuguese