Customizing the layout of a business entity - 6.3

Talend MDM Platform Studio User Guide

EnrichVersion
6.3
EnrichProdName
Talend MDM Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

From Talend Studio, you can design, in a graphical format, the layout of the attributes in a certain entity, and display them in column-based canvas. This customization of the layout of master data could be very important to make the business user or data steward comfortable when working with data through Talend MDM Web User Interface. For further information on defining a layout, see How to design a custom layout.

You can also associate the layout to a specific role or roles. Later, when a business user is assigned this role and try to access master data through Talend MDM Web User Interface , the data will display through this column-based canvas. For further information on assigning roles to business users, see the security chapter in the Talend MDM Web User Interface User Guide.

Once the custom layout is created in the MDM Repository tree view, you must deploy it on the MDM server. For further information, see How to update the custom layout on an MDM server.

How to design a custom layout

Talend Studio provides you with a wizard that simplifies the creation of a layout which you will associate to the selected business entity. You can create more than one layout for the same business entity and associate each form to a specific role or roles.

Prerequisite(s): You have already created data models, business entities and attributes in the data model. For further information, see How to create a data model, How to create business entities in the data model and How to add attributes to the business entity.

To design a custom layout for a specific business entity, do the following:

  1. In the MDM Repository tree view, right-click Custom Layout.

  2. Select New to display the [New Custom Layout] wizard. This wizard guides you through the steps necessary to design a layout for a specific business entity.

  3. Enter a name for the custom layout.

  4. Click the three-dot button to open a dialog box.

  5. From the Data Models field, select the data model that holds the entity for which you want to create the layout, and then from the list that displays select the entity on which to create the layout.

    Note

    You can create more than one custom layout on the same entity and associate it/them with the same or different roles.

  6. Click Add to close the dialog box. The path for the selected entity displays in the corresponding field in the [New Custom Layout] wizard.

  7. In the [New Custom Layout] wizard, click Next to proceed to the next step.

  8. Select to display the entity elements or attributes in one, two or three columns, and then click Finish to close the wizard. In this example, the two-columns option is selected.

    Note

    You can add columns to an existing layout by dragging a Column element from the Palette.

    A custom layout appears in the Studio workspace, a Properties panel opens in the lower part of the workspace and a node for the new custom layout displays under Custom Layout in the MDM Repository tree view.

    The custom layout shows two columns as selected in the previous step. The first column lists all the elements (attributes) defined in the selected business entity. Simple-type elements are represented as fields while complex-type elements are represented as panels.

Note

The hierarchy in the custom layout follows the structure of the data model. You can not move a panel out of its parent panel in a complex-type element.

The Properties panel below the form displays the properties of any of the elements you select in the form. If the data model has any foreign keys, they don't show in the custom layout.

After creating the custom layout, you can now proceed to distribute the elements between the columns in the custom layout in order to finalize its design.

  1. Use a drag & drop operation in order to distribute the fields and panels between the columns.

    Note

    If you want to move a panel, make sure to click on its border first to select the panel and then drop it in the desired column.

  2. From the Palette, you can also drag a Filler element into your layout which can either be left blank, to allow you to insert spaces in your layout, or can be used as a placeholder for custom HTML code such as images and horizontal lines.

    To add custom HTML code, select the Filler element and type the code you want to add in the Properties panel.

  3. You can also drag an Element element from the Palette into your layout. A dialog box appears, allowing you to choose the desired element.

    The Data Models list and the Filter field are automatically populated with your selection. The Xpath field varies with the element you are choosing.

    After selecting the desired element, click Add to add the element to the layout.

    Note that not all elements can be added. Specifically:

    • Only the elements which belong to the current entity but are not available in the current layout can be added.

    • After you add a parent element to the current layout, which is displayed as a panel in the layout, only its child element(s) can be added within the panel.

    The elements which can be added are shown in bold while others are grayed out. Sometimes, even if a node is grayed out, you need to expand it to check whether it has some elements to be added.

  4. Save your layout.

    Note

    After you create a layout for a specific business entity in the MDM Repository tree view, you must deploy it to one of the MDM servers defined in your MDM environment. This will enable Talend MDM Web User Interface to render master data in a web page according to the deployed layout. For further information on deploying objects to the MDM server, see Deploying objects to the MDM Server.

How to update the custom layout on an MDM server

You can make changes to the design of an existing custom layout. These may include adding or moving elements around in the layout, adding or removing columns, or adding custom HTML code snippets.

Prerequisite(s): You have already created a custom layout for a specific business entity in a data model. For further information, see How to design a custom layout.

To update the custom layout on the MDM server, do the following:

  1. In the MDM Repository tree view, expand Custom Layout and double-click the custom layout you want to update.

  2. Edit the custom layout according to your needs. For instance, to add a new column to an existing layout, drag a Column element from the Palette to the place in your layout where you want to add a new column.

  3. Save your changes, and then deploy them to the MDM Server.

How to manage the custom layout

Many management options are available on any of the listed layout forms in the MDM Repository tree view.

  1. In the MDM Repository tree view, expand Custom Layout.

  2. Right-click a layout and:

    Select

    to...

    Remove from Repository

    delete the form from the MDM repository.

    Edit properties

    open a dialog box where you can edit the properties of the selected form.

    Copy

    copy the form. You can then right-click in the MDM Repository tree view and paste the copy and modify it to create a new form for example without starting from scratch.

    Duplicate

    create a copy of the form and list it directly under Custom Layout in the MDM Repository tree view.

    Refresh

    refresh the MDM Repository tree view.

    Export items

    export the form in an archive file or to a root directory.

    Deploy to...

    deploy the form on the server of your choice.

    Deploy Another Version To...

    select and deploy another version of the form on the server of your choice.

    Update server

    update the form on the server with the changes you did on the form in the MMD repository. You must update the MDM server with any modifications you do on the form in the MDM Repository tree view. Otherwise, Talend MDM Web User Interface will not be able to reflect the modifications in the form.

    Update Dependencies

    update the dependencies related to this form.