Projects
General - Projects
DataChain projects are available to users who have the role(s) of Project Manager or Project Member.
Projects group together a set of DataChain elements (Business Entities, DataBlocks, etc.) and allow rights to be managed for all project members (user groups or users) within each project.
Two types of projects allow you to define a different level of confidentiality on the elements they contain:
* Public: project elements are visible and consumable from other projects, public or private, and therefore by members of other projects *
Private: project elements are visible and consumable only within the project itself and therefore only by project members
Overall operation
- General
-
-
The number of projects is not limited
-
A project must have at least one administrator
-
A project has a start and end date (by default the interval is 100 years)
-
A project can be private or public
-
- Main Features
-
-
Duplication in the same instance
-
Export for future import
-
Creation from a blank project or an import
-
- Users
-
-
The number of members (users or groups) per project is not limited
-
To use DataChain features and create items, a user must belong to a project or a group that belongs to a project
-
- Project Roles
-
-
Manager: this role allows users to administer the project and manage its members
-
Member: this role allows users to be added to projects and create items based on their global permissions
-
Roles are defined for each user or user group by a user with the "DataChain Administrator" role.
- Elements
-
-
Each element of DataChain belongs to one and only one project
-
An element of a project A Public can be used in a project B Public, but if project A or the element of project A is deleted it is deleted for all
-
An element can be transferred or duplicated from one project to another under certain conditions, in this case, it belongs to the project where it was transferred or duplicated
-
- Access
-
Projects can be accessed from GenericsData
and HandleData
from the menu left
Projects.
The user only sees the projects of which he is a member, or the projects of which the groups to which he belongs are members
Access the list of projects
Search for a project
Create a new project (project manager role)
Delete project (with confirmation)
-
This icon is only visible to project administrators
-
Deleting a project also deletes all the elements it contains
Change project settings (project manager role)
Access the project (click on the map).
Opens the homepage of the project and displays the project statistics related to the module
Bookmark the project
-
-
Multiple projects can be added as favorites
-
Favorite projects appear at the top of the list
-
Pin project
-
-
Only one project can be pinned
-
When connecting, the user is automatically sent to the home page of the pinned project
-
Access an existing Project
Each project is presented in the list in the form of a map.
Project title
Indic if the project is private
or public
Icon associated with the project
Tags associated with the project
Number of contexts associated with the project
Total number of project members
Information about the last member who accessed the project
Click to pin project
Click to add project to favorites
Specifies the approximate expiration date
Project Description
Delete and edit project icons (only visible to Project Managers)
To access a project, click on its map. The homepage of the project is displayed with the statistics of the module concerned.
Create a new Project
To create a project, you must have the "Project Manager" role (See the Rights page to learn more about DataChain roles).
It is possible to create a blank project or from the import of a file containing a previously exported DataChain project.
To create a project, select the icon from the left menu, then click on the "New" button at the top left of the list of projects.
Create a blank project
Screen Layout
After clicking on "New" from the list of projects, select "Blank project".
Metadata
-
-
Entering a label is mandatory
-
Optional input fields such as description, license information and tags allow you to refine information related to a project.
-
Choice of Private or Public project
-
-
Public: project elements can be consumed by members of other projects
-
Private: project elements are consumable only by project members
-
Steps for creating a new project
Project start date.
Before this date, the project is accessible only for administrators.
Project end date: after this date, the project is revoked.
A revoked project can no longer be deleted
Step 1 | Sharing - Template
The Template DataChain allows to manage the rights at the level of each element created within a project and this, for each action (Read, Modify, Delete, Data, Export). The detail of each of these actions is visible from the Rights page.
Additional parameters are available when editing a project (see the chapter Editing a Project)
Enable or disable the whole column for an action and user type
-
-
Creator: person who created the item
-
User: person consuming the item, whether inside or outside the project
-
Set of rights applied to GenericsData elements
Set of rights applied to HandleData elements
Enables or disables an action for a user type *and for a single item type
To go to the next step, click on or on
.
Step 2 | Members
Dynamic search for a DataChain user
Lists of users matching the current search
-
-
Click to select or press ENTER from the keyboard
-
To go to the next step, click on or on
.
Step 3 | Members and Statutes
To validate the creation of the project, at least one member must be a Manager.
Status Manager: the member can access the project settings
To be able to be Manager of a project, a DataChain user must have the role of Manager (see user role management )
Status Member: member cannot access project settings
To go to the next step, click on or on
.
Import Project
If you import a Project from a version of DataChain Core older than that of the import instance, it is possible that this will generate inconsistencies in item rights +. To avoid this problem, we recommend checking the ‘Use default template’ option and, if necessary, modifying the template after import. |
It is possible to create a project from the file of a previously exported project, if it comes from a DataChain instance in a compatible version.
In this case, the project will be automatically created as a private project (editable later).
When importing into an instance different from that of the export, some data is added to the instance and is therefore visible and accessible for all projects
-
tags (from metadata of imported items)
-
collations (if DataBlocks that use collations in formulas have been exported)
After clicking on "New" from the list of projects, select "Import a project".
Step 1 | File selection
Drag and drop or select the file (.dca format) to import. If the format is valid and the file has not been damaged or corrupted, DataChain starts the decompression and a progress bar is displayed.
Step 2 | Configuring the new project
Depending on the content of the source project, different options are visible.
Example with an imported project with context and members
Label: Editable.
By default, the label is the same as the source project
By default, the project is private and the description is identical to that of the source project. This information can be edited after the creation of the project
Effective date and Expiry date: Editable.
By default, this is the date and time of day for the effective date, plus 6 months for the expiration date.
Context: The assignment of at least one context is mandatory for the execution of the various processing operations related to the import
Image template
If the source project template has not been exported: ** the option will not be offered and the project will be created with a basic template, which can then be modified from the project management page
- If the template was exported
-
-
but not the members: it is possible to choose to use the exported template or the basic template. In any case, the template will be used to create the matrix of rights on each element created, for each user or group added to the project
-
as well as the members: the template will be added to the project but will not be applied when creating the elements to create the rights matrix. The rights will be transposed from a user A to a user B from the user association that will have been defined (user or group)
-
Element Types: Element types that have no elements are not selectable.
Some elements are automatically selected or deselected depending on the choice of other types of elements in order to guarantee the proper functioning of the data processing chain.
Warning: no data can be processed if connectors and repositories are not selected.
This can be useful for connecting new sources to a data processing model.
-
Data: Extracting repositories and local data are only available if the repositories are selected.
Exposure DataBlocks: only available if exposures have been exported.
Each selected access point must be unique.
Common suffix: if all or part of the exposed DataBlocks are selected, it is possible to add a common suffix to the initial access point.
Members and Groups
By default, the user who creates the project is automatically added as a member of the project as Manager. Not editable at creation.
-
If the members have been exported: each profile must be associated. For each exported user or group profile, DataChain checks if the user or group is present in the instance. If so, it is automatically associated with the profile of the source user or group (but remains editable). Otherwise, the association must be performed manually. It is possible to associate users to groups and vice versa. It is recommended to associate profiles with identical roles between source project and new project.
If a profile with the role of project member is associated with a profile that does not have this role, the rights matrix applied to the elements for this member will not be effective for that user and they will not be able to access the item.
-
If no members were exported, members (users and groups) must be added manually.
Example of members added to a project
-
In all cases, the project must contain at least one user (or group) with a Member role and a user designated as Manager
Step 3 | Creation of the project
Once the project has been correctly configured, click on "Create the project". The creation process may take some time, depending on the size of the source project and the options selected. Once the project has been created, it is possible to modify its configuration from the project page.
Edit the configuration of an existing Project
At any time, it is possible to modify a project (rights, expiry date, metadata, private/public status, contexts, shares, members). Only project administrators can edit a project.
From the list of projects, click on the icon located at the top right of the map of the project to modify.
Add new member to project
Inactivate a member’s access to the project (the member is still part of the project and can be reactivated)
List of project member names and roles
Permanently remove a project member
Enable or disable admin role for member
Make the changes then click on
Rights template
Additional parameters can be accessed when modifying a project in the Template tab
-
DC Export
-
Persistence/Cache
-
Features
-
Export traceability
-
Extraction
-
Link
Note on the modification of the entitlement template
If the template is modified, this does not modify the existing rights matrix on the project elements for current users. This action will only impact new users added after the modification of the template, for all the elements present. For each element created after the template has been modified, the new template will be applied to create the rights matrix associated with each member of the project (group or single user). |
Advanced parameters
When a Project is created, a root code is automatically generated.
This code is used to access shared resources such as API Show Publications.
When you modify this code, all the URLs of shared elements (APIs) will be updated when the API publication is updated. |
Template mail
When actions are taken on published dashboards, mails are sent to users.
Actions concerned
-
Expiry date modified
-
Dashboard published or updated
You can customise the title and body of the message for each of these actions using the following variables
-
Link to publication: $publicationLink
-
Publication date: $publicationDate
-
Expiry date: $publicationExpirationDate
-
Publication title: $publicationTitle
-
Dashboard title: $dashboardTitle
Export project
Project export allows you to extract (in .dca format) a set of information relating to a project.
Each Project export generates a trace, accessible from the left menu of GenericsData "Traceability exports", "Project" tab.
For each export, and depending on the rights of the connected user, it is possible to download the exported Project file.
Warning, the user who exports the project is solely responsible for the security of the data it contains.
Under no circumstances can Adobis Group be held responsible for the loss, alteration or use that may be made of it.
The project can be private or public but it is not possible to export a project which contains elements which consume external elements to the project to be exported (for example a DataBlock which uses data linked to a Business Entity of a different public project). If this is the case, a message will be displayed during the project analysis stage to inform the user of the problem encountered.
Some elements are not affected by the export * dashboard publications * the referencing of elements in the DataCatalogue
Other DataChain elements are automatically added during export, depending on the exported content * Classifications: if they are used in DataBlock formulas and if DataBlocks are exported * Tags: if added to metadata of exported items
It is possible to export a project from the project configuration screen: click on the menu on the right then on "Export".
Step 1 - Analysis of the project to export
A preliminary step is performed automatically by DataChain to verify that the project can be exported.
It is not possible to export a project that contains elements that consume elements external to the project.
Step 2 - Export settings
Information area on data to export
Choice of the name of the file in which the exported project will be compressed
Specifies whether the template defined in the project should be copied or not.
The template is used when importing the project only in the case where the references of the members of the project have not been exported in order to create the matrix of rights on the elements
Specifies whether references of project members (users and groups) are added to the export
If members are added to the export and the project is imported into an instance that does not have the same members, each profile will need to be manually associated with an existing profile in the import instance
Specifies the element types and related data added to the export Those that contain no element are not selectable.
Some elements are automatically selected or deselected depending on the choice of other types of elements in order to guarantee the operation of the data processing chain.
Extracting repositories and local data are only available if repositories are selected.
If the DataBlocks are selected and they are exposed, it is possible to select all or part of the exposures
User consent is mandatory for data accountability.
His profile will be associated with the export in order to guarantee the traceability of the data
Step 3 - Exporting the project
Once the export of the project has been correctly configured, click on "Export the project"
Note that all elements created, modified or deleted once the procedure begins are not taken into account.
The export process may take some time, depending on the size of the source project and the options selected.
If the export is successful, an email containing the link to download the file is sent to the user who launched the export of the project as soon as the file is ready (the file may be in Spam).
Otherwise, if an error is encountered during the process, an informative email is sent to him.
Duplicate a project
It is possible to duplicate a project (ie all the DataChain elements it contains and its parameters) in the same DataChain instance.
The project can be private or public and it can contain elements that consume elements external to the project to be duplicated. Elements external to the project are not duplicated, but the referencing is preserved.
Some elements are not affected by the duplication * project members * publication of dashboards * referencing to the DataCatalogue
From the configuration screen of the project to be duplicated, click on the menu on the right then on "Duplicate".
Step 1 - Analysis of the existing project
A preliminary step is performed automatically by DataChain to verify that the project can be duplicated.
It is not possible to duplicate a project that contains elements that consume elements external to the project.
Step 2 - Configuring the new project
Depending on the content of the source project, different options are visible.
Label: editable.
By default, the label is the same as the source project
By default, the project is private and the description is identical to that of the source project. This information can be edited after the creation of the project
Expiry date: editable.
By default, this is the current date and time + 6 months
Template by right: the chosen template can in any case be modified after the duplication and before adding a member to the project
Context: context attribution is mandatory to be able to duplicate data
Element Types: Element types that have no elements are not selectable.
Certain elements are automatically selected or deselected depending on the choice of other types of elements in order to guarantee the operation of the data processing chain
Common suffix: if all or part of the exposed DataBlocks are selected, it is possible to add a common suffix to the initial access point.
if the DataBlocks are selected and they are exposed, it is possible to select all or part of the exposures.
For each selected exhibition a unique access point must be defined.
Step 3 - Creation of the new project
Once the project has been correctly configured, click on "Duplicate the project". The creation process may take some time, depending on the size of the source project and the options selected. Once the project has been created, it is possible to modify its configuration from the project page.
Delete an existing Project
Only Project Managers can delete it.
Public Projects whose items are consumed by other Projects cannot be deleted.
An internet connection is required to validate the action of deleting a Project.
Deleting a Project deletes all the elements of the Project * Publications * Dashboards * All Visualizations (Media, Tables, Graphs, TimeLine, Map) * Sources of Visualizations * Datablocks and Datablocks API Exposes (EndPoint and Cache) * Business Entities * Deposits and Extractions * Connectors * Files contained in Local Repositories * All persistances of Business Entities and Datablocks * Leaderboards created in the deleted Project
Step 1
From the Projects list, click on at the top left.
If the Project contains elements, a window opens to indicate all the elements contained in the project.
Click on Next to go to the next step.
2nd step
A message explains all the ins and outs of the deletion of the Project.
To go to the next step, enter the requested sentence and check the box.
The deletion is irreversible, all the elements that are in the project are deleted with it.
It is recommended to export the Project before deleting it.
Click on Next to go to the next step.
Step 3
An email containing a validation token has been sent to the email address of the user performing the deletion.
Enter the code to Permanently delete theProject.