Table of Contents

Search

  1. Preface
  2. Introduction
  3. Installation
  4. Design
  5. Operation

The Options Explained

The Options Explained

This section provides information on the Options.

Project Options

New
Allows you to create a new Project from a
project.sdf
file, from a flat (exported) file or by cloning the currently selected Project. The Console Server then loads the Project definitions into the Rulebase. This new Project will then be added to the list of available Projects.
The parameters are as follows:
Project Name
The name of the new Project. This name must match the name specified in the Project definition file.
Using the same name for the Rulebase and Project is not allowed. (The default Rulebase name is "rule".)
Definition File
The name of the Project definition file which describes the new Project.
Database Directory
The directory into which the database for this Project will be created. The name of the database file will be the same as the Project Name with the file name extension
.db
automatically added to the name. If this field is left blank, then the default DCE working directory, controlled by the
SSAWORKDIR
environment variable, will be used.
Maximum DB Size
Select the maximum database size for this Project. The default is 32 GB. Note that the created database will not allocate the chosen amount of disk space but the size will grow as required.
Cloning a Project is possible if the Project exists in the current Rulebase. You must supply a new Project Name and the Database parameter as when creating a Project from a
.SDF
file.
Importing a Project from a flat file requires that the flat file have been created using the Export option (explained below). You must supply the Input File name, Project Name and Database parameters as when creating a Project from an
.SDF
file. It is also possible to retain the Project name that was used in the exported Project if you check the Match Project Name selection. If a different Project name is used, it is necessary to load the Project to create the clustering file with the new Project name before the new Project can be run. An exported Project may contain run time information from the original Project, if runtime information is not desired during cloning, the option Import As Template should be checked to import only the Project definition information.
Select
You can select a Project from the current Rulebase. The selected Project will be used in any subsequent operations.
The parameters are as follows:
Project Name
The name of the Project to be used.
Edit
Opens the Project Editor that allows editing all Project settings. Refer to the
Editing a Project
section for more details.
Load
Activates a Project that was imported from a flat file. See the
Export
option below.
Reset DB
Replace the current Project database with an empty one. The results of any Clusterings that you may have run so far will be discarded.
Delete
Delete the current Project from the Rulebase.
Status
Displays the status of the current Project and allows the user to change it. The below table describes the meaning of each status selection:
Status
Description
Read
Upd
Del
Run
Build
Under construction - unusable
yes
yes
yes
no
Test
Uncontrolled - any use
yes
yes
yes
yes
Production
Relaxed Production
yes
yes
no
yes
Locked
Frozen production
yes
no
no
yes
Prototype
Secured prototype - read-only use
yes
no
no
no
Export
Export an existing Project and/or SSA-NAME3 v1.8 Service Group to a flat file. This is useful for example if you wish to transfer the Project and/or SSA-NAME3 v1.8 Service Group to another Rulebase. You may also want to use this option to create "templates" for your future Projects.
The parameters are as follows:
Output file
The name of the flat file which will contain the exported Project or SSA-NAME3 v1.8 Service Group.
Service Group
The name of the SSA-NAME3 v1.8 Service Group to be exported.
Run Clustering
Opens a window from which you can choose a Clustering step defined for the currently selected Project to be run.

Rulebase Options

Select
Allows you to select an existing Rulebase.
Rulebase
Edit feature
should be used only if so instructed by Informatica Corporation technical support. Making changes to the Rulebase may render it unusable.
Edit
Invokes the Rulebase Editor to edit the current Rulebase, defined by Rulebase Name and Rulebase Server.
Create
Allows you to create and initialize a new Rulebase.
When creating a new Rulebase, you cannot share the Rulebase and Project names as this will lead to a file naming conflict.

Tools Options

Run Clustering
Runs a selected clustering.
The parameter is, Clustering definition name.
Relate
Runs the Relate client. Refer to the
Batch Search Client - Relate
section for detailed description.
DupFinder
Runs the Duplicate Finder client. Refer to the
Batch Search Client - DupFinder
section for detailed description.
Report Viewer
Runs the Report Viewer client. Refer to the
Report Viewer
section for detailed description.
Run Program
Runs a user-specified program on the server.
The parameters is as follows:
Command Line
The program to run, followed by its parameters.

Common Common Functions

The following describes the functionality provided by the four buttons
Server Status
,
Settings
,
View Logs
and
Clear Messages
.
Server Status
This button activates the Server Status dialog, which reports the status of the DCE server programs, the Rulebase and the database associated with the current Project.
Settings
This option will display the dialog containing the current environment of the client. This is the same dialog as the one presented when the Client is first started. You may make any required changes to the environment variables.
View Logs
Use this button to activate the Log Viewer. The Log Viewer allows the various output files produced by DCE to be viewed.
The Log Views displays the files in a tree layout with the file size rounded to the nearest kilobyte. If the file is empty, the file is marked with an icon resembling letter X and no file size appears.
The Log Viewer also gives the user the ability to delete individual logs as well as all the logs associated with the run itself.
See further information about the Log Viewer and its usage below.
Clear Messages
Click this button to clear the main message window.

Launched Jobs

This is a list of all the jobs launched during the current session. You can access more information about a particular job in the list by click the
Open
button or double-clicking the job details in the list.
When reconnecting the client to the console server, the list will display all the currently running jobs for all console clients using the same Rulebase.
The progress messages for each job are not displayed automatically when a Client reconnects. The user must select a running job from the list and click
Open
(or double-click the item). This will open the usual progress window.

Options

Open
Opens a status window for the selected job.
Delete
Remove the selected job from the list. Note: only completed jobs may be removed from the list.
Refresh
Refreshes the list with the currently running jobs for the same Rulebase.

Log Viewer

Every time a procedure such as
Clustering
,
Relate
or a user-defined Job is started, a Run Number is assigned to that run and all relevant information is stored in the Rulebase. This information includes the completion status and details of any output files created during the run. The Run Number is used to uniquely identify the run.
The Log Viewer provides the user with the ability to access the run information for previously run jobs.
There are two classes of Jobs:
Project Jobs
and
Global Jobs
.
  • Project Jobs
    are jobs which are run against a particular Project, such as Relate.
  • Global Jobs
    are jobs which are not run against a particular Project. These jobs either involve more than 1 Project (eg.
    Clone Project
    ) or are responsible for setting up a Project (eg.
    Create Project
    )
Choosing The Run To Be Viewed
Select the type of Job, either
Project Jobs
or
Global Jobs
, using the radio buttons. If
Project Jobs
is selected, select the required Project using the dropdown list of Projects. If
Global Jobs
was selected, then the Project need not be selected. Now choose the job name from the dropdown list of jobs. User-defined jobs are identified by their user-assigned names. Other procedures, such as
Relate
, are identified by the procedure name surrounded by asterisks, eg.
*Import Project*
.
When the job has been selected a list of runs for this job will be listed on the left hand side of the Log Viewer. The runs will be sorted in ascending order, so the most recent run will appear at the bottom of the list. The title for each run consists of the date and time when the job started and the Run Number which was assigned to this run. Select the run in which you are interested.
A list of the output files created by this run will appear below the list of runs. The most recently created output file will be automatically displayed in the right hand pane of the Log Viewer. To view other files in the list simply click on the required file in the tree display.
The Log Viewer will truncate log files larger than 960k for display.
Other Functions Provided By The Log Viewer
The options are as follows:
Option
Description
Delete File
Use this option to physically delete the currently selected file.
Delete Run
Use this option to delete all output files and run information for the currently selected run.
Refresh
Use this option to reread the run information from the Console Server. This option is useful if a job is currently running and you want to check if anymore output has been created.
Close
Use this option to close the Log Viewer and return to the Main Console Window.
Parameters
Project Name
Select a Project from the list of available Projects in the current Rulebase, to view the list of job names belonging to the Project.
Job Name
Select a job name from the list of available jobs in the selected Project, to view the run information.
Project Logs
Check this option to see the Project dependant logs.
Global Logs
Check this option to see the Project independent logs.
Run-Information
The user is presented with a run information list of the selected Project job. The user can at this time make a selection to view the relative step information.
Step Logs
The user is presented with a list of steps belonging to the selected job. The user can now view the run logs, error logs, output files (if any) of each step by selecting the desired option.

0 COMMENTS

We’d like to hear from you!