Introduction to the Semarchy Workbench

Logging In to the Semarchy Workbench

To access Semarchy Workbench, you need a URL, a user name and password that have been provided by your Semarchy Convergence for MDM administrator.

To log in to the Semarchy Workbench:

  1. Open your web browser and connect to the following URL that provided by your administrator. The Login Form is displayed.
  2. Enter you user name and password.
  3. Click Log In

The Semarchy Workbench opens. The Overview perspective is displayed.

Logging Out of the Semarchy Workbench

To log out of the Semarchy Workbench:

  1. In the Semarchy Workbench menu, select File > Log Out.

Opening a Model Edition

A model edition is a version of a model. This edition can be in a closed or open status. Only open editions can be edited.
Opening a model edition connects the workbench to this edition.

Note: Before opening a model edition, you have to create this model and its first edition. To create a new model and manage model editions, refer to the Models Management chapter.

To open a model edition:

  1. In the Semarchy Workbench menu, select File > Open Model Edition
  2. In the Open a Model Edition dialog, expand the node for your model and then select a branch in the branch tree. The list of Editions for this branch is refreshed with the editions in this branch.
  3. Select an edition in this list and then click Finish.
  4. The Semarchy Workbench changes to the Model Edition perspective and displays the selected model edition.

Working with the Semarchy Workbench

The Semarchy Workbench is the graphical interface used by all Semarchy Convergence for MDM users. This user interface exposes information in panels called Views and Editors .
A given layout of views and editors is called a Perspective .

The Semarchy Workbench

Working with Perspectives

There are several perspectives in Semarchy Workbench:

Working with Tree Views

When a perspective opens, a tree view showing the objects you can work with in this view appears.
This view appears on the left hand-side of the screen.
In this tree view you can:

Working with the Outline

Certain perspectives includes an Outline view. This view shows in tree view form the object – and all its child objects – in the editor currently opened.
This view appears on the left hand-side of the screen.
You can use the same expand, double-click, right-click actions in the outline as in the tree view.

Working with Editors

An object currently being viewed or edited appears in an editor in the central part of the screen.
You can have multiple editors opened at the same time, each editor appearing with a different tab.

Editor Organization

Editors are organized as follows:

Saving an Editor

When the object in an editor is modified, the editor tab is displayed with a star in the tab name. For example, Contact* indicates that the content of the Contact editor has been modified and need to be saved.
To save an editor, either:

You can also use the File > Save All menu option or Save All toolbar button to save all modified editors.

Closing an Editor

To close an editor, either:

You can also use the File > Close All menu option or the Close All option the editor’s context menu (right-click on the editor’s tab) to close all the editors .

Accelerating Edition with CamelCase

In the editors and dialogs in Semarchy Workbench, the Auto Fill checkbox accelerates object creation and edition.
When this option is checked and the object name is entered using the CamelCase, the object Label as well as the Physical Name is automatically generated.
For example, when creating an entity, if you type ProductPart in the name, the label is automatically filled in with Product Part and the physical name is set to PRODUCT_PART.

Working with Diagrams

Diagrams are used to design models and workflows.

The Model Diagram

The Model Diagram Editor shows a graphical representation of a portion of the model or the entire model.
Using this diagram, you can create entities and references in a graphical manner, and organize them as graphical shapes.

The diagram is organized in the following way:

Info: After choosing a tool in the palette, the cursor changes. Click the Diagram to use the tool. Note that after using an Add... tool, the tool selection reverts to Select.

For more information about the model diagrams, see the Diagrams section in the Logical Modeling chapter.

The Human Workflow Diagram

The human workflow diagram shows a graphical representation of the human workflows.
Using this diagram, you can design tasks and transitions for a workflow.

The diagram is organized in the following way:

In this diagram, you can drag the transition arrows to change the source and target tasks of a transition.

For more information about the human workflow diagrams, see the Creating Human Workflows in the Working with Applications chapter.

Working with Other Views

Other views (for example: Progress, Validation Report) appear in certain perspectives. These views are perspective-dependent.

Workbench Preferences

User preferences are available to configure the workbench behavior. These preferences are stored in the repository and are specific to each user connecting to the workbench. The preferences are applied regardless of the client computer or browser used by the user to access the workbench.

Setting Preferences

Use the Window > Preferences dialog pages to set how you want the workbench to operate.

You can browse the Preferences dialog pages by looking through all the titles in the left pane or search a smaller set of titles by using the filter field at the top of the left pane. The results returned by the filter will match both Preference page titles and keywords such as “general” and “stewardship”.

The arrow controls in the upper-right of the right pane enable you to navigate through previously viewed pages. To return to a page after viewing several pages, click the drop-down arrow to display a list of your recently viewed preference pages.

The following preferences are available in the Preferences dialog:

Under the Data Stewardship preferences node, preference pages are listed for the data locations accessed by the user and for the entities under these data locations. These preference pages display no preferences and are used to reset the Filters, Sort and Columns selected by the user for the given entities, as well as the layout of the editors for these entities (the collapsed sections, for example). To reset the preferences on a preferences page, click the Restore Defaults button in this page.

Exporting and Importing User Preferences

Sharing preferences between users is performed using preferences import/export.

To export user preferences:

  1. Select File > Export. The Export wizard opens.
  2. Select Export Preferences in the Export Destination and then click Next.
  3. Click the Download Preferences File link to download the preferences to your file system.
  4. Click Finish to close the wizard.

To import user preferences:

  1. Select File > Import. The Import wizard opens.
  2. Select Import Preferences in the Import Source and then click Next.
  3. Click the Open button to select an export file.
  4. Click OK in the Import Preferences Dialog.
  5. Click Finish to close the wizard.
Importing preferences replaces all the current user’s preferences by those stored in the preferences file.

Working with SemQL

Tip: This section provides a quick introduction to the SemQL language. For a detailed description of this language with examples, refer to the "Semarchy Convergence for MDM SemQL Reference Guide".

SemQL is a language to express declarative rules in Semarchy Workbench. It is used in Enrichers, Matchers, Validations, Filters and Consolidators.

SemQL Language Characteristics

The SemQL Language has the following characteristics:

Qualified Attribute Names

A Qualified Attribute Name is the path to an attribute from the current entity being processed.
This path not only allows accessing the attributes of the entity, but also allows access to the attributes of the entities related to the current entity.

Examples:

SemQL Syntax

The SemQL Syntax is close to the Oracle Database SQL language for creating expressions , conditions and order by clauses.

In expressions, conditions and order by clauses, it is possible to use the SemQL functions. The list of SemQL functions is provided in the SemQL Editor

Info: SemQL is not a query language: SELECT, UPDATE or INSERT queries are not supported, as well as joins, sub-queries, aggregates, in-line views, set operators.

SemQL Examples

Enricher Expressions

In these examples, InitCap, Upper and Replace are SemQL functions. The concatenate operator || is also a SemQL operator.

Validation Conditions

InputAddress.Address is not null and 
( InputAddress.PostalCode is not null or InputAddress.City is not null)

In this example, the IS NOT NULL, AND and OR SemQL operators are used to build the condition.

Matcher

InputAddress.Country || InputAddress.PostalCode
SEM_EDIT_DISTANCE_SIMILARITY( Record1.CustomerName, Record2.CustomerName ) > 65 
and SEM_EDIT_DISTANCE_SIMILARITY( Record1.InputAddress.Address, Record2.InputAddress.Address ) > 65 
and SEM_EDIT_DISTANCE_SIMILARITY( Record1.InputAddress.City, Record2.InputAddress.City ) > 65

In this last example, SEM_EDIT_DISTANCE_SIMILARITY is a SemQL function. Record1 and Record2 are predefined names for qualifying the two record to match.

The SemQL Editor

The SemQL editor can be called from the workbench when a SemQL expression, condition or clause needs to be built.

The SemQL Editor

This editor is organized as follows:

Working with Plug-ins

Plug-ins allow extending the capabilities of the Semarchy Convergence for MDM using Java code and external APIs.
Plug-ins are used to implement enrichers or validations not feasible in SemQL.

The plug-ins have the following characteristics:

Examples of plug-ins:

More information: