Managing projects - 6.3

Talend Administration Center User Guide

EnrichVersion
6.3
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend Real-Time Big Data Platform
task
Administration and Monitoring
Deployment
EnrichPlatform
Talend Administration Center

Warning

Only users that have the Administrator role and rights can have read-write access to this page. Other users, depending on their roles, can have either read-only access or no access to this page. For further information on access rights, see User roles/rights in the Administration Center. When a user of the Administration Center opens this page, he/she will have access only to the items for which the user has been granted the appropriate authorization by the Administrator.

From the Projects page, you can add projects, duplicate projects, view/edit the selected project information or delete projects. You can also create different branches for a project.

Accessing the project list

To access the project list stored in the remote repository, click Projects in the Menu tree view.

When you access the Projects page for the first time, no projects show on the list. To allocate resources and define user accesses to projects, you first need to add projects to the list. For more information, see Adding a project.

The list of projects provides the following information per project:

Column

Description

Reference

The icon shows when the corresponding project has been defined as a reference project.

Id

The identifier of the project. This identifier can be useful to execute MetaServlet commands, For more information, see Non-GUI operation in metaServlet.

Label

The name of the project.

Description

The description text typed at project creation.

Creation

The creation date of the project.

Active

Project status (active or inactive).

Project type

Data Integration/ESB, Data Quality and Master Data Management depending on the license you set in Talend Administration Center. For more information, see What domains can you work in depending on your user type and license.

Storage

Storage type of the project: either (no storage), (SVN storage) or (GIT storage).

Url

URL of the subversion project.

Warning

A warning message displays if there are any errors in the project.

The buttons on the toolbar of the Projects page allow you to refresh the display of the project list, add a new project and delete one or more projects.

You can hide/show this panel by clicking on the and the buttons, which is located on the splitter.

To display the details of a project, click the relevant project Name in the project list. From the project details page, select the action you want to carry out for this particular project.

Adding a project

To add a project which is stored in SVN or GIT

  1. In the Menu tree-view, select Projects to open the project list page.

  2. From the toolbar, click Add. Mandatory fields in the Project panel to the right are followed by .

  3. In the Project panel, enter the following information:

    Field

    Description

    Label

    Type in the project name. This name should match the project name you will connect to in Talend Studio.

    Active

    Select/clear this check box to activate/deactivate the current project.

    Reference

    Select/clear this check box to add or remove the selected project as reference.

    Note

    When you select a project in the Projects list that is already used as a project reference, this check box is selected by default.

    For more information on project references, see Managing project references.

    Description

    Fill in a description if needed.

    Author

    The first and last names of the project author. This field is read-only and so cannot be modified.

    Project type

    Select the type of project according to the license you set in Talend Administration Center. For more information, see What domains can you work in depending on your user type and license.

    Note

    If the license set in Talend Administration Center is a Data Integration or ESB license only, this field will not display as there will not be other types available.

    Storage

    Select the storage type SVN or GIT depending on where your project is stored.

    Advanced settings

    Select this check box if you want to use a connection (URL), a commit mode (Commit mode), or a lock mode (Lock mode) which differ from the default connection you have defined on the Configuration page, then fill in the fields that follow according to your needs.

    For more information on the connection used by default, see Setting up SVN or Git parameters.

    Url

    Enter the connection URL to the SVN or GIT repository.

    Note

    When you create a project, note that SVN automatically creates a default structure in your repository (<project name>/ branches|tags|trunk) to store the project metadata.

    For SVN projects:

    Subversion URLs use the following syntax: Repository URL/project name.

    A typical Subversion repository often holds the files (or source code) for several projects. Usually, each project is a subdirectory in the repository's file system tree.

    Subversions' URLs can match any of the following syntaxes:

    svn+ssh://<login>@<hostName>/<repositoryName>/<project name>

    ex: svn+ssh://tisadmin@10.42.0.10/svn/repo/tac_di

    http://10.42.10.99/repo/<project name>.

    Login

    Type in the user login to the repository.

    Password

    Type in the user password to the repository.

    Commit mode

    Different types are possible to submit the latest changes done to Projects or to any item in the Repository in Talend Studio:

    Automatic: Talend Studio automatically commits the changes made on the Project and Repository items. This is the default setting,

    Unlocked items: Talend Studio commits the changes made on certain items when those items are unlocked. An item is unlocked either when you close it or when you manually unlock it, depending on theLock mode selected (see Lock mode in this table). For more information about lock principles, see Talend Studio User Guide.

    Lock mode

    Different SVN lock types are possible:

    Automatic: Items are automatically locked/unlocked when a user wants to edit them in Talend Studio,

    Ask user: The user is prompted to lock/unlock items when needed,

    Manual: The user needs to manually use the Lock/Unlock option in the contextual menu of the items.

    For more information regarding lock management, see Removing locks on projects and Talend Studio User Guide.

    Custom log

    Select this check box if you want the users to be prompted to enter their own commit log for each commit. The auto generated application log will be still appended at the end.

    For more information, see the section on logging information on edited items of Talend Studio User Guide.

  4. Click Check connection to verify your connection status.

  5. Click Save to validate the creation of the new project or click Cancel to cancel it.

    Note

    You can also create a remote project directly from the CommandLine thanks to the createProject command. For more information about the createProject command, display the Help provided in the CommandLine. For more information on the CommandLine, see CommandLine features.

To add a project which is not stored in SVN or GIT

If you have already executed your Jobs on a development environment and want to have the exact same Jobs you have previously generated on your production environment, you can create a "no-SVN/GIT" project in which you will import the generated Jobs.

In this case, note that the name of the project must be the same as the name of the development project in which you have previously generated your Jobs.

For more information on how to import a Job that has been previously generated, see Adding an execution task on a pre-generated Job.

  1. From the toolbar of the Projects page, click Add. Mandatory fields in the Project panel to the right are followed by .

  2. In the Project panel, enter the following information:

    Field

    Description

    Label

    Type in the project name. This name should match the project name in which you have previously generated your Jobs.

    Active

    Select/clear this check box to activate/deactivate the current project.

    Reference

    Select/clear this check box to add or remove the selected project as reference.

    Note

    When you select a project in the Projects list that is already used as a project reference, this check box is selected by default.

    For more information on project references, see Managing project references.

    Description

    Fill in a description if needed.

    Author

    The first and last names of the project author. This field is read-only and so cannot be modified.

    Project type

    Select the type of project according to the license you set in Talend Administration Center. For more information, see What domains can you work in depending on your user type and license.

    Note

    If the license set in Talend Administration Center is a Data Integration or ESB license only, this field will not display as there will not be other types available.

    Storage

    Select the storage type None as your project is not stored in Subversion.

  3. Click Save to validate the creation of the new project or click Cancel to cancel it.

Managing sandbox projects

Users of Talend Studio have the possibility to create a working project by themselves directly from the studio. These working or sandbox projects are mainly used for testing purpose, but an Administrator can easily share them with other users and they can be migrated to a production environment.

Sandbox projects display on the project list of the Projects page with a specific naming to easily identify them: Sandbox_username_project.

As other projects, a sandbox project can be duplicated, edited or deleted. For more information on these actions, see the sections below.

The type of a sandbox project is determined by the licence used. For more information about licenses, see Managing licenses.

When a user creates his/her sandbox project, he/she also creates his/her account as a designer user on the Users page of Talend Administration Center. For more information on the Users page, see Managing Users. Thus, a user is consumed from Talend Administration Center's license. If you activated the SMTP option on the Configuration page of Talend Administration Center, the user will receive an email notifying him/her of the creation of his/her account. For more information on notifications, see Setting up an SMTP protocol.

Moreover, the user will automatically be authorized to access his/her sandbox project on the Projects authorizations page. From this page, you will be able to remove the authorization, share the project with other users or give read only and read & write rights to users. For more information on Projects authorizations, see Managing project authorizations.

For more information on how to activate/deactivate sandbox project feature, see the relevant section in the Talend Installation Guide.

For more information on how to create a sandbox project, see Talend Studio User Guide.

Editing the details of a project

Warning

Pay much attention when modifying the URL of a database or the URL of Subversion. Make sure to validate the editing operation first with the relevant administrator.

To edit the details of a project:

  1. In the Menu tree-view, select Projects to open the project list.

  2. Select the project you want to edit from the project list.

  3. In the Project panel, modify the project details as needed.

    The Label, Author and Repository type are read-only fields and thus cannot be modified.

  4. Click Save to validate the modifications or click Cancel to cancel it.

    You can also edit the details of a project via the MetaServlet application, using the updateProject command based on the project ID. For more information on MetaServlet, see Non-GUI operation in metaServlet.

Activating/deactivating a project

To activate/deactivate a project:

  1. Select the project you want to activate/deactivate on the Projects page.

  2. In the Project panel, select/clear the Active check box.

  3. Click Save to validate the operation or click Cancel to cancel it.

Note

If a Job is deactivated, you cannot use its Label to create another project.

Adding/removing a reference project

To add/remove a reference project, complete the following:

  1. Select the project you want to add/remove as reference on the Projects page.

  2. In the Project panel, select/clear the Reference check box.

  3. Click Save to validate the operation or click Cancel to cancel it.

For more information on project references, see Managing project references.

Managing SVN/Git branches and tags for a project

The Talend solutions provides a version control system that enables users to have different versions of the same project in different SVN/Git branches and tags. Talend Administration Center enables you to create/delete branches and tags of the project stored on SVN or Git.

About Git branches: All branches/tags are visible for all projects on the same Git repository. Therefore, if you create some branches/tags for one project, all other projects on the same Git repository will have the same list.

You can also manage SVN/Git branches and tags via the Metaservlet. For more information, see Non-GUI operation in metaServlet.

For more information about best practices on why and how to use SVN/Git branches and tags with the Talend products, see the Talend Software Development Life Cycle Best Practices Guide.

How to manage SVN/Git branches

When a project is stored on SVN or Git, you can create branches for this project from Talend Administration Center:

To create a Git or SVN branch

  1. In the Menu tree view, click Projects to display the Projects page.

  2. Select the project for which you want to create one or more branches.

  3. On the toolbar, click the Branch management button.

    The [Branch management] dialog box opens.

    The SVN/Git tree of project '<ProjectName>' area shows the structure of the project: all existing branches and their names.

    Before creating branches for a project stored on SVN or Git, the SVN/Git tree of project '<ProjectName>' lists only the trunk which is the main development branch. Later, all created branches/tags will be listed in this tree.

  4. From the Source field, select the trunk or the branch from which you want to copy the data.

    When you create a branch for the first time, the only source possible is the trunk as it contains the main development branch. Then the Source list will include all created branches.

  5. In the Target field, type in the name of the branch you want to create.

  6. Click create.

    The created branch is listed under the branches node in the SVN/Git project tree.

    Now, the project has two different branches: the trunk/master and a newly created branch.

    Once branches are created for a project:

    • you can add an execution task to trigger a Job stored in a specific branch of the project. For more information, see Adding an execution task and Adding an execution server;

    • users of Talend Studio can switch from the trunk to a branch or copy an item from a branch to another branch or a tag. For more information, see Talend Studio User Guide.

Talend Administration Center enables you to delete any of the branches of the project stored on SVN or Git.

To delete a Git or SVN Branch

  1. In the Menu tree view, click Projects to display the Projects page.

    From the project list, select the project for which you want to delete an existing branch.

    The [Branch management] dialog box opens.

  2. In the SVN/Git tree of project '<ProjectName>', right-click the branch you want to delete and select Delete this branch from the contextual menu.

    A confirmation message is displayed.

  3. Click OK to confirm the deletion operation and close the message. A warning message will alert you if you try to delete a branch used by the Job Conductor.

    The selected branch is deleted from the SVN/Git tree of project '<ProjectName>' and from the project on SVN or Git.

    Note that you can also delete a branch or a tag via the MetaServlet application, using the deleteBranch command. For more information on MetaServlet, see Non-GUI operation in metaServlet.

    Warning

    The branches must be deleted from Talend Administration Center and not directly from SVN or Git.

To create a Git or SVN Branch whitelist

Talend Administration Center allows you to filter the project on the defined SVN/Git branches or tags in order to reduce the use of disk resources and improve performances.

Prerequisites:

  1. Open the whitelist configuration file to edit it (active_svn_branches.csv for SVN projects or active_git_branches.csv for Git projects). You can see the list of all branches of your projects.

  2. Remove the lines corresponding to the branches on which you do not work in order to keep only the necessary ones and save your changes. The project is now filtered on the branches you have chosen to keep.

    Note

    This configuration does not filter the branches that are available for this project in Talend Studio. All branches will still be shown in Talend Studio.

How to manage SVN/Git tags

When a project is stored on SVN or Git, you can create tags for this project by copying the content of a branch or the trunk.

To create a Git or SVN tag

  1. In the Menu tree view, click Projects to display the Projects page.

  2. Select the project for which you want to create one or more tags.

  3. On the toolbar, click the Branch management button.

    The [Branch management] dialog box opens.

    The SVN/Git tree of project '<ProjectName>' area shows the structure of the project: all existing branches/tags and their names.

    Note

    Before creating tags for a project stored on SVN or Git, the SVN tree of project '<ProjectName>' lists only the trunk/master which is the main development branch. Later, all created branches/tags will be listed in this tree.

  4. From the Source field, select the trunk or the branch from which you want to copy the data.

  5. In the Target field, type in the name of the tag you want to create.

  6. Click create.

    The created tag is displayed in the SVN/Git tree of project '<ProjectName>'.

    Once tags are created for a project, you can add an execution task to trigger a Job stored in a specific tag of the project.

To delete a Git or SVN tag

  1. In the Menu tree view, click Projects to display the Projects page.

    From the project list, select the project for which you want to delete an existing tag.

    The [Branch management] dialog box opens.

  2. In the SVN/Git tree of project '<ProjectName>', right-click the tag you want to delete and select Delete this tag from the contextual menu.

    A confirmation message is displayed.

  3. Click OK to confirm the deletion operation and close the message. A warning message will alert you if you try to delete a tag used by the Job Conductor.

    The selected tag is deleted from the SVN/Git tree of project '<ProjectName>' and from the project on SVN or Git.

    Note that you can also delete a branch or a tag via the MetaServlet application, using the deleteBranch command. For more information on MetaServlet, see Non-GUI operation in metaServlet.

    Warning

    The tags must be deleted from Talend Administration Center and not directly from SVN or Git.

Duplicating a project

To avoid creating a new project from scratch, you can duplicate an existing one and work around its metadata to have a new project in the list.

To duplicate a project from the project list, complete the following:

  1. On the Projects page, select the project you want to duplicate.

  2. On the toolbar, click Duplicate. The Project view displays with a copy of the selected project that you can modify as needed.

  3. Click Save to validate the operation or click Cancel to cancel it.

Deleting a project

To delete a project from the project list, complete the following:

  1. On the Projects page, select the project you want to delete.

  2. On the toolbar, click Delete. A confirmation dialog box appears.

  3. Click OK to remove the project from the project list.

    If the project you want to delete is being used as a reference for another project, you need to remove the reference first. For more information about project references, see Managing project references.

Warning

If your projects are stored in SVN mode, they must be deleted from Talend Administration Center first and not directly from SVN. Note that the deleted project remains stored in your SVN server and may need to get purged by an SVN administrator.

Customizing the display of the project list

You can customize the project list view to restrict the number of displayed projects according to different criteria. You can also show/hide one or more columns in the project list.

  1. On the project list, put the pointer on a column name and click the drop-down arrow.

  2. In the drop-down list, select:

    Item

    To...

    Sort Ascending

    arrange the list in an ascending order

    Sort Descending

    arrange the list in an descending order

    Columns

    display a drop-down list where you can select/clear the check box next to the column(s) you want to show/hide

    The figure below shows the list view options in the drop-down list.

    You can also apply filters on all project columns by typing in key words or by selecting check boxes in the Filters fields of these columns. To remove the filters and reset the page, you have to click the cog icon on the right of the top toolbar.