Using DataExchange Manager
A Tour of DataExchange Manager Utility
This utility is covered in the following topics:
DataExchange Manager Concepts
DataExchange Manager provides a standard interface to administer your activated databases. You may perform the following functionality with the utility:
To use DataExchange Manager, you must log on to the utility and connect to a database. By default, the logon user name is ADMIN and the password is password. Both are case-sensitive.
DataExchange Manager writes entries to da.log in C:\ProgramData\Actian\Zen\Replication\LogFiles. You may customize logging features as explained in DataExchange Manager Tasks.
Managing Replication Schedules
The replication of data to and from sites can be automated by schedules. You may also initiate replication manually. With DataExchange Manager, you may view, change, add, and delete replication schedules.
A schedule becomes effective immediately if you create one for the First Site machine on which you are running the DataExchange Manager. If you create a schedule for a site not local to machine on which the DataExchange Manager is running, the schedule becomes effective after the next successful replication between those sites. For example, suppose you are running the DataExchange Manager on machine A and you create a schedule for machine B. The schedule takes effect the next time site A replicates with site B.
Caution Typically when using Real-Time Backup, data is replicated from the First Site to the Partner Site. When using Real-Time Backup, do not set schedules from the Partner Site or with the Partner Site selected. Doing so will result in changes from the Partner Site being replicated to other sites in the network and may also cause other schedules to operate incorrectly.
Site Schedule Tab
The site Schedule tab allows you to view, create, delete, or edit replication schedules for a site. You can also schedule periods when replication is not to occur. You access the site Schedule tab by clicking Database > Sites.
Figure 5 Site Schedule Tab
A schedule for the First Site applies to all sites that are subscribed to the First Site. You can create as many schedules as you need for each site.
Managing Site Information
DataExchange Manager allows you to manage information about any site in your replication network from a single site (assuming that you have the correct authorization). By default, a user defined in DataExchange Manager as a system administrator can view all sites, and users other than system administrators can view only their own site.
Managing a remote site is done the same way as managing your own site. However, because any changes you make to a remote site are initially stored in your local copy of the replication system database, the changes do not take effect until your site replicates with the managed site. To manage a remote site, your site must subscribe to that remote site.
Site List
The site list contains a list of all the sites to which you have administrative access in the replication network. You can display the site list by selecting Database > Sites. The first entry in the site list is always All Sites. The other sites are listed under All Sites.
Figure 6 Site List
Site Information Tab
The site Information tab allows you to view or change the information about a site, such as contact information for a person responsible for the site. You access the site Information tab by clicking Database > Sites.
Figure 7 Site Information Tab
Remove Site from Replication Network
The Information tab contains an option Remove Site from Replication Network. This options acts as a toggle to remove a site from a replication network, or to restore a site that has been previously removed. This option does not delete any database files. The option marks the site as no longer belonging to the replication network.
This option is typically used to exclude a database from replication over a long period. See Using the DataExchange Monitoring Tools.
The other sites on your replication network do not know that a site has been removed until you perform a replication. Until you replicate, only the site for which you are logged on to DataExchange Manager knows that a site has been removed. An example helps clarify this.
The DataExchange Manager requires that you connect to a specific database when you log on. Assume that you select MyDataBase when you log on to DataExchange Manager. Once logged on, you remove site Partner_Site_2. At this point, only the replication tables for MyDataBase contain the removal information. The information has not been replicated to the rest of your replication network.
If you were to open the Initiate Replication dialog and select MyDataBase as the source database, Partner_Site_2 would not be included in the list of sites to replicate with. However, if you were to select a different site on the same replication network—for example Partner_Site_1—then Partner_Site_2 would still be listed in the sites to replicate with because you have not yet replicated. After you replicate, then Partner_Site_2 is no longer listed in the sites to replicate with.
Note that the first replication after removing (or restoring) a site from the replication network will fail for that site. After the first replication, this error no longer occurs because all sites on the replication network are aware of the site’s status (removed or restored).
Managing Users
DataExchange Manager is supplied with two groups of users: System Administrators and Everyone. With DataExchange Manager, you may view, change, add, and delete user information and membership groups.
Each group contains certain permissions within DataExchange Manager and within your replication project.
By default, the System Administrator user for DataExchange Manager is named ADMIN. The ADMIN user’s password, by default, is “password.” Both are case-sensitive. When you add a user, he or she is automatically added to the Everyone permission group.
The following table compares the default permissions of System Administrators (abbreviated System Admins) and Everyone.
Permissions Within DataExchange Manager and Replication Network | System Admins | Everyone |
|---|---|---|
Can add DataExchange Manager users |  | |
Can see all users | | |
Can change information for any group or user | | |
Can view, add, change, or delete replication schedules for any site | | |
Can view, add, change, or delete replication schedules only for their own site | | |
Can change only their own user information | | |
Can change any site’s information | | |
Can change only their own site’s information | |
Tabbed Dialogs and User List
Two tabbed dialogs allow you to specify user information and group membership, respectively. You access the tabbed dialogs by clicking Database > Users.
A user list appears to the left of the tabbed dialogs and contains a list of the users who can access DataExchange Manager. By default, nonadministrative users have permission to see only themselves in the list.
Figure 8 Location of User List and User Tabbed Dialogs
By default, new users added to your database project are automatically made members of the Everyone group. To change a user’s membership from the Everyone group, you must change the user’s group membership. See To change a user’s group membership.
User Information Tab
This tab allows you to specify information about a user such as name, address, login name, and password.
Figure 9 User Information Tab
User Membership Tab
This tab controls a user’s membership in the defined permission groups.
Figure 10 User Membership Tab
Your ability to perform many administrative and data access functions is controlled by the permission group to which you belong.
Managing Permissions
With DataExchange Manager, you may only view the permission groups available with DataExchange Manager. The DataExchange permission groups are System Administrators and Everyone. You access the permissions group list by clicking Database > Permission Groups.
Figure 11 Permissions Group List
A user’s permissions are determined based on the permission groups to which they belong. As you add new users, you must decide the appropriate permission group to which that user should belong. By default, new users added to your replication project are automatically made members of a permission group Everyone.
DataExchange Manager GUI Visual Reference
This topic details the objects on the DataExchange Manager graphical user interface.
Main Window
The following screen shot shows the main window of the GUI. The following table describes the parts of the window.
Figure 12 DataExchange Manager Main Window
GUI Object | Description | Related Information |
|---|---|---|
Title Bar | Shows the name of the utility | |
Actions menu | Provides the following commands: •Exit | |
Reconnect command or  icon | Displays the Logon dialog from which you may disconnect from and reconnect to a database as a different user or connect to a different database. | |
Refresh command or  icon | Applies changes made by another running copy of DataExchange Manager so that the changes are visible to your instance of the utility. | |
Exit command | Terminates the execution of DataExchange Manager. | |
Database menu | Provides the following commands: •Permission Groups | |
Sites command or  icon | Switches to site view. A list of sites appears in the List pane and tabbed dialogs appear in the Tabbed Dialog pane. | |
Users command or  icon | Switches to user view. A list of users appears in the List Pane and tabbed dialogs appear in the Tabbed Dialog pane. | |
Permission Groups command or  icon | Switches to permission group view. A list of permission groups appears in the List pane. | |
Options command | Displays the dialog on which you specify logging options for DataExchange Manager. | |
Help menu | Provides the following commands: | |
Help Topics | Lists the documentation topics for DataExchange Manager. | |
About | Displays the name and version of DataExchange Manager and the DataExchange copyright information. | |
List pane | Depending on the selected view, displays a list of the following: •Activated sites within the replication network •DataExchange Manager users •Permission Groups | |
Tabbed Dialog pane | Depending on the selected view, displays the following: •Tabbed dialogs for working with sites •Tabbed dialogs for working with users | |
View indicator | Specifies the current view: •Sites •Users •Permission | |
Logged on Database indicator | Identifies the database to which DataExchange Manager is currently connected. | |
User indicator | Identifies the user currently accessing DataExchange Manager. |
DataExchange Manager Tasks
This topic explains the tasks that you perform with DataExchange Manager:
General Tasks
General tasks apply to the overall use of the tool:
►To start DataExchange Manager from Control Center (ZenCC)
1 Start ZenCC if it is not already running.
2 Select DataExchange > Manager.
►To start DataExchange Manager from a command prompt
1 Open a command prompt, enter da then press Enter.
The DataExchange Manager executable is da.exe. The executable also supports command line options. At a command prompt, enter da /h to display the help text and view the available options.
►To log in to DataExchange Manager
You must log in to DataExchange Manager before you can use the utility. A login dialog appears when you start the utility.
1 From the Database selection list, select the activated database to which you want to connect.
2 For Login Name, enter a valid user’s name. The default login name is ADMIN (all capital letters).
3 For Password, enter a valid password. The default password is password (all lowercase).
4 Click OK.
Note DataExchange Manager exits after three unsuccessful attempts to connect to a database.
►To log on as a different user or to connect to a different database
These steps require that you already be logged on to DataExchange Manager.
1 Click Actions > Reconnect or click .
.Clicking Cancel returns you to DataExchange Manager. However, if an unsuccessful logon attempt has been made, clicking Cancel exits DataExchange Manager.
►To change a logon password
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Users or click .
.2 In the user list, click the user whose password you want to change.
3 Click the Information tab.
4 Click Change Password.
5 Enter a new password in the New Password and Confirm Password entry fields.
Note The password is stripped of leading and trailing blanks.
6 Click OK to return to the Information tab.
7 Click Apply to save your changes.
►To set the log options for DataExchange Manager
1 In the menu bar, click Options.
2 Specify the options you want on the logging options dialog.
The following image shows the Options dialog. Click an item in the dialog to jump to more information in the following table.
Option | Discussion |
|---|---|
Error | Turns on or off the logging of errors to the log file. On by default. Errors are indicated by an E in the first column: E 0142 1109-16:33:26 Login unsuccessful, the username/password combination is invalid |
Information | Turns on or off the logging of information messages to the log file. On by default. Information messages are indicated by an I in the first column: I 019c 1109-14:06:36 Zen Replication Administrator |
Tracing | Turns on or off the logging of trace information to the log file. The information being traced is every function call. Trace information is indicated by a T in the first column: T 0172 1109-16:33:26 0 << MessageEvent (0ms) Caution: Avoid using the Trace option for long periods (over 30 minutes), particularly if you are performing numerous tasks with DataExchange Manager. Trace outputs every function call to the log file. Your log file can grow enormously in a very short period. Generally, use Trace only when requested by a technical support representative. |
Warning | Turns on or off the logging of warnings to the da.log file. On by default. Warnings are indicated by a W in the first column: W 0142 1109-14:07:05 Could not find site 000000 |
Debug | Turns on or off the logging of debug information to the log file. Debug information is indicated by a D in the first column: D 013f 1109-14:06:37 Response received from DRE: 1:SUCCESS:PD2PQQ85001,TrackerPROJ (net) - Tracker PD2PQQ85002,TrackerPROJ (net) – TrackerPrtnr PD2PQQ86001,tracker-project int-tut-network) - IntTut_First_Site PD2PQQ86002,tracker-project int-tut-network) - IntTut_Partner_Site PD2PQQ86003,tracker-project (int-tut-network) - drelogtest |
Verbose Logging | This option applies only to Debug. (The Debug option must also be checked.) Verbose outputs the source program name and the line number within the program. For example, the following example shows that program cmdsend is receiving a response from the replication engine (line 308 of the source code). D 013f 1109-14:06:37 cmdsend 308 Response received from DRE: 1:SUCCESS:PD2PQQ85001,TrackerPROJ (net) – Tracker Note: Some of the programs listed in verbose mode may not exist as a separate file on physical storage. Verbose mode shows the programs that are part of a compiled executable or dynamic link library. |
Maximum Log Size | This value determines when a new history log file is started (lo1, lo2, and so forth). See Maximum Logs to Keep. |
Maximum Logs to Keep | This value sets the number of history log files retained. Default is 5. When a log file reaches its maximum size, the file is reassigned to the next history file name. For example, when a log file, such as da.log reaches its maximum size, da.LO1 gets created. The da.log file is then empty and starts acquiring new entries. When the maximum size is again reached, da.LO1 becomes da.LO2, a new da.LO1 is created from da.log, and da.log is again empty. The Keep setting determines the extent of the history retained: LO1, LO2, LO3, and so forth. |
Name of Log File | Sets log file name and location, defaulting to C:\ProgramData\Actian\Zen\Replication\Logfiles. You can change this path name. |
►To refresh DataExchange Manager view
When you make changes to a database from another running copy of DataExchange Manager, such as adding a user or changing a schedule, the changes may not be immediately visible to your current instance of the Manager.
For example, suppose that you made changes to a specific user in a second instance of the Manager. To see the changes, you would need to switch to the user Information tab in the first Manager and refresh the view.
1 In the menu bar, click Options, or press F5 or click .
.►To display help
1 Click Help, then the type of help you want:
•Help Topics – Lists the documentation topics for DataExchange Manager.
•About – Displays the name and version of DataExchange Manager and the DataExchange copyright information.
You may also press F1 to access the list of help topics.
Schedule Tasks
Schedule tasks apply to automating replication:
►To create a replication schedule
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Sites or click .
.2 In the site list, click the site for which you want to set up a replication schedule.
You cannot set up a schedule for All Sites.
3 Click the Schedule tab.
4 Click Add on the tab.
5 Enter a name for the new schedule.
6 Specify the days of the week, month, or specific dates for which the replication occurs.
7 Specify the hours, in 24-hour format, for which the replication occurs.
The range is 00:00 to 23:59.
8 Specify the action taken by the schedule:
Option | Meaning |
|---|---|
Schedule every [value] minutes | The frequency, in whole minutes, in which the replication schedule runs. A value of zero indicates continuous replication, which means that another replication session begins as soon as the previous session completes. |
Do not replicate | Disables the replication schedule. |
Notify if no replication after [value] minutes | See dxagent for a discussion of the notification agent and how this option applies to the agent. The minutes value for the notify option must be either zero, for continuous replication, or greater than the Replicate every value by at least one minute. |
9 Click Apply to save the changes.
10 Click OK to acknowledge that a replication is required for the changes to take effect.
►To change a replication schedule
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Sites or click .
.2 In the site list, click the site for which you want to set up a replication schedule.
You cannot set up a schedule for All Sites.
3 Click the Schedule tab.
4 In the Name list, click the schedule that you want to change.
►To delete a replication schedule
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Sites or click .
.2 In the site list, click the site that you want to delete.
3 Click the Schedule tab.
4 Click Delete on the tab.
5 Click Yes to confirm the deletion.
Site Information Tasks
Site information tasks apply to contact information about a site or removing a site from a replication network:
►To change site information
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Sites or click .
.2 In the site list, click the site that you want to delete.
3 Click the Information tab.
4 Specify the contact information for the site.
To remove a site from a replication network, or to restore a site that has been previously removed, see the following task.
5 Click Apply to save the changes.
►To remove a site from or restore a site to a replication network
1 Click Database > Sites or click .
.2 In the site list, click the desired site.
3 Click the Information tab.
4 Do one of the following:
•To remove a site, select Remove Site from Replication Network.
•To restore a site already removed, clear Remove Site from Replication Network.
Note The option Remove Site from Replication Network does not require you to apply the action. Selecting or clearing the option is sufficient. For the removal or restoration to take effect, however, you must perform a replication session.
User Tasks
User tasks apply to adding or deleting users and membership groups and changing user information:
►To add a new user
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Users or click .
.2 Click the Information tab.
3 Click Add on the Information tab.
4 Enter the desired user information in the entry fields. The First Name, Last Name, Logon Name, and Password are mandatory.
Note that the Logon name is automatically converted to uppercase and stripped of leading and trailing blanks.
5 Click Set Password.
6 For New Password, enter the desired password. Reenter this same password for Confirm Password.
7 Click OK.
Note that the password is stripped of leading and trailing blanks.
8 Click Apply to save your changes.
►To change user information
Permission Group Requirement: To edit a user’s information (other than your own), you must be a member of the System Administrator Permission Group. All users can change their own information.
1 Click Database > Users or click .
.2 In the user list, click the desired user.
3 Click the Information tab.
4 Change the user information as desired.
See To change a logon password if you want to change a password.
5 Click Apply to save your changes.
►To delete a user
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Users or click .
.2 In the user list, click the desired user.
3 Click the Information tab.
4 Click Delete.
You cannot delete the default administrator user ADMIN.
►To change a user’s group membership
Permission Group Requirement: You must be a member of the System Administrator Permission Group to perform this task.
1 Click Database > Users or click .
.2 In the user list, click the desired user.
3 Click the Membership tab.
4 In the Work Sets pane, click the work set to which the permission group belongs
.
Permission groups for a selected work set are sorted into two lists: Not a Member Of and Member Of. The selected user is a member of all those groups in the Member Of list.
5 Click the desired permission group, then use the arrow buttons between the lists to move the group to the Member Of or Not a Member Of lists.
For example, in the following image, if you wanted to add a user to the System Administrators group, click System Administrators in the Not a Member Of list, then click 
.
.
6 Click Apply to save your changes.