Introduction to the Semarchy DI Designer |
Previous
|
|
Next
|
Introduction to Semarchy Convergence for DI |
|
Working with Projects |
Introduction to the Semarchy DI Designer
Opening the Semarchy DI Designer
To open the Semarchy DI Designer:
- In the Semarchy Convergence for DI installation folder, double-click the
SemarchyDI.exe
file.
- The Semarchy DI Designer opens.
Semarchy DI Designer Overview
The Semarchy Convergence for DI Designer appears as follows.
In the DI Designer, the following sections are available:
- The
Project Explorer view provides a hierarchical view of the resources. From here, you can open files for editing or select resources for operations such as exporting.
- The
Editors ' section contains the various objects being edited: mappings, metadata, processes, etc.
- Various other
Views are organized around the edition view and allow navigating, viewing and editor object properties.
- The
Configuration zone allows selecting the active Configuration (development, production, etc.).
- You can use the
Perspectives to customize the layout of the various views in the DI Designer. A default
Semarchy Convergence for DI perspective is created and it is possible to customize your own perspectives.
Design-Time Views
The following section describes the main views used at design-time.
The Project Explorer
The
Project Explorer contains a hierarchical view of the resources in the workspace.
These resources are organized into projects and folders.
The following types of resources appear in the projects:
Resource Type |
File Extension |
Description |
Metadata |
.md |
A metadata resource describes source or target systems and datastores or variables that participate in a mapping or a process. |
Mapping |
.map |
A mapping is used to load data between source and target datastores. |
Process |
.proc |
A process is a sequence of tasks and sub-tasks that will be executed during run-time. Certain processes are
Template Processes, which are used to generate a process from a mapping.
|
Templates Rules |
.tpc |
Templates Rules file describe the conditions upon which template processes can be used. For example, an Oracle integration template can be used when integrating data to a target datastore in an Oracle database, but is not suitable when targeting XML files. |
Configuration Definition |
.cfc |
A configuration makes the metadata variable. For example, configurations can contain the connection information to the data servers and you can use configurations to switch between production and development environments. |
Runtime Definition |
.egc |
Definition of a runtime engine. A runtime engine executes the integration processes created with the Semarchy Convergence for DI Designer. |
From the project explorer toolbar (highlighted in the previous screenshot) you can create the three main types of design-time resources:
Metadata,
Mappings and
Processes.
The Properties View
The
Properties view displays the list of properties of the object currently selected.
The Expression Editor
The
Expression Editor displays code related to the object being edited. For example, the mapping expressions, the code of the actions, etc.
This editor provides two options:
-
Lock: Allows you to lock the expression editor. When this option is not-selected the expression editor changes every time you select an element in the Semarchy DI Designer to display the code of this element. To build expressions in the expression editor using drag-and-drop, you can select the element that you want to edit (for example, a target mapping), select the lock option and then drag and drop columns from the various source datastores of the mapping into the expression editor.
-
Auto-Completion: This option enables auto-completion in the code. While editing, press CTRL+SPACE to have the list of suggestions for your code.
The Outline View
The
Outline view provides a high-level hierarchical or graphical view of the object currently edited.
The Impact View
The
Impact view allows you to analyze the usage of an object in the project and perform impact analysis and cross-referencing.
To use the Impact Monitor:
- Check the
Active Monitoring option in the
Impact editor.
- Select the object that you want to analyze. The
Impact view displays the list of usages for this object.
- Double-click on one of the objects in the list to open it for edition.
Note: Impact Monitoring may be a resource consuming operation on your system. It is recommended to switch it off when you do not use it by un-selecting the
Active Monitoring option in the
Impact editor.
The
Cache Manager tab of the
Impact view allows you to explicitly refresh the cross-references cache for your workspace. In the normal course of operations, the cache is automatically refreshed.
The Run-Time Views
Three views are used to monitor the run-time components and executions of the sessions.
The Runtime View
The
Runtime view allows monitoring of a Runtime Engine.
From this view, you can perform the following operations:
- Click the
Environment button to start and stop a local (pre-configured) runtime engine and demonstration databases.
- Click the
Runtime Editor button to add or modify runtime engine definitions. The procedure to create a runtime engine definition is described below.
- Check that a runtime engine is active by selecting it in the list and clicking
Ping.
- Connect a runtime engine: Select it in the list and then click the
Connect option. When a runtime engine is connected, it is possible to view its sessions and issue commands to it via its command-line console.
- When connected to a runtime engine, you can activate the
Refresh Diagram option. When this option is active, you can monitor on the diagram of a process this process' activity as it runs in the runtime engine.
- When connected to a runtime engine, click the
Runtime Command button to open its command-line console. From the
Console you can issue commands to the runtime engine. Type
help
in the console for a list of valid commands.
To create a new runtime definition:
- In the
Runtime view, click the
Runtime Editor button. The runtime definition (conf.egc) opens.
- Select the root node, right-click and select
New > Engine.
- In the
Properties view, enter the following information:
-
Description: Description of this runtime.
-
Name: User-friendly name for the run-time.
-
Server: Host name of IP address of the machine where the runtime components run.
-
Port: Port on this machine where the runtime runs.
- Press
CTRL + S to save the new runtime definition.
The Sessions View
The
Sessions view displays the list of sessions of the connected runtime engine.
This list includes the following session properties:
-
Start Time: Startup day and time of the session.
-
Name: Name of this session.
-
Status: Status of the session.
-
Elapsed Time: Duration of the session.
-
ID: Unique identifier of the session.
-
Log Name: Name of the log storing this session.
-
Log Type: Type of the log storing this session.
-
Engine: Name of the runtime engine processing the session.
-
Guest Host: Name of the host from which the session was initiated.
-
Launch Mode: Method used to start the session: Semarchy Convergence for DI Designer, Web Service, Scheduler, etc.
-
Execution Mode: Memory or command line.
In this view, you can filter the sessions using parameters such as the session Name or Status, filter a number of sessions, or only the session started by the current user. If the log is shared by several runtime engines, it is also possible to filter only sessions of the current runtime engine.
From this view, you can also purge the log by clicking the
Delete All and
Delete Until buttons.
The Session Detail View
This view displays the details of the session selected in the
Sessions view. The
Errors and
Warning tabs display the list of issues, and the
Variables tab displays the list of session and metadata variables.
Standard session variables include:
-
CORE_BEGIN_DATE: Startup day and time of the session.
-
CORE_DURATION: Duration of the session in milliseconds
-
CORE_END_DATE: Day and time of the session completion.
-
CORE_ENGINE_HOST: Host of the runtime engine processing the session.
-
CORE_ENGINE_PORT: Port of the runtime engine processing the session.
-
CORE_ROOT: Name of the process containing the session.
-
CORE_SESSION_CONFIGURATION: Configuration used for this execution.
-
CORE_SESSION_ID: Unique identifier of the session.
-
CORE_SESSION_NAME: Name of this session.
-
CORE_SESSION_TIMESTAMP: Session startup timestamp.
-
CORE_TEMPORARY_FOLDER: Temporary folder for this session.
The Statistics View
The
Statistics displays the list of statistics aggregated for the sessions.
The following default statistics are available:
-
SQL_NB_ROWS: Number of lines processed.
-
SQL_STAT_INSERT: Number of lines inserted.
-
SQL_STAT_MERGE: Number of merged records.
-
SQL_STAT_UPDATE: Number of lines updated.
-
SQL_STAT_DELETE: Number of lines deleted.
-
SQL_STAT_ERROR: Number of errors detected.
-
OUT_FILE_SIZE: Output file size.
-
OUT_NB_FILES: Number of output files.
-
XML_NB_ELEMENTES: Number of XML elements processed.
-
XML_NB_ATTRIBUTES: Number of XML attributes processed.
This view can be parameterized via the preferences (
Window > Preferences), in the
Semarchy Convergence for DI > Monitor section.
You can select which of the variables need to be aggregated using which aggregate function.
The Step Detail View
This view displays the details of the steps executed in a session.
It displays the code at various stages in three tabs:
-
Source displays the source code before generation. It comes from the process templates.
-
Generated displays the generated code. It may contain dynamic values replaced before execution.
-
Executed displays the executed code with the variables replaced.
The
Detail Of selection box allows you to select one of the iterations of a step that was executed several times.
The Variable View
The
Variable view displays the variables for the selected step. The list of variables depends on the steps. The following standard variables appear for all steps:
-
CORE_BEGIN_DATE: Startup day and time of the step.
-
CORE_DURATION: Duration of the step in milliseconds
-
CORE_END_DATE: Day and time of the step completion.
-
CORE_BEGIN_ACTION: True if this action is a start action.
-
CORE_NB_ENABLED_EXECUTIONS: Maximum number of executions allowed for this step. This variable is used in loops.
-
CORE_NB_EXECUTION: Number of iterations of this step.
-
CORE_RET_CODE: Return code for this step.
Previous
|
Top
|
Next
|
Introduction to Semarchy Convergence for DI |
|
Working with Projects |