Overview
Synonyms are alternative names used for specific Structure elements, like Properties or Values.
/*<![CDATA[*/ div.rbtoc1770892091104 {padding: 0px;} div.rbtoc1770892091104 ul {list-style: disc;margin-left: 0px;} div.rbtoc1770892091104 li {margin-left: 0px;padding-left: 0px;} /*]]>*/ Overview General Information Details Page Create Change Text Delete Import Copy
General Information
The workspace area for the management of Synonyms can be accessed via menu Synonym. Information on the graphical user interface and basic functionalities can be found on page Graphical User Interface and Basic Functions. This workspace offers users different functionalities described in brief in the following table as well as in more detail in the next chapters.
Toolbar in Browse View
|
Button Icon |
Button Name |
Description |
|---|---|---|
|
|
Search |
Triggers a search in the available content, considering the search options set in the advanced search. |
|
|
Create |
Allows the creation of new Synonyms. |
|
|
Change text |
Allows editing the attributes of a selected Synonym. |
|
|
Delete |
Allows deletion of a selected Synonym. |
|
|
Import |
Allows import of Synonyms and their relations. |
|
|
Copy |
Allows copying of a selected Synonym. |
Details Page
In order to view more details related to a Synonym, users may open the Synonym in view mode by clicking on it from the list view.
The view mode of a Synonym is subdivided into different tabs. The visibility and order of the displayed tabs is configurable by users with configuration rights. Furthermore, custom tabs can be created. The custom tabs allow customers to organize the standard and extended attributes as required by their business use cases.
Tabs which do not contain any information are grayed out.
The following table gives an overview of the tabs available for a Synonym:
|
Tab Name |
Description |
|---|---|
|
General |
Tab General displays the standard and extended Attributes of a Synonym. The visibility and order of the attributes displayed in tab General is configurable by users with configuration rights via the Validation Framework. |
|
Attribute |
Tab Attribute displays extended attributes of the selected Synonym. |
|
Change request |
Tab Change request displays the change requests in connection with the selected Synonym. |
|
History |
Tab History displays historical information on the selected Structure element. |
|
Release |
Tab Release displays the release(s) the selected Synonym is part of. |
|
Reference |
Tab Reference displays all the structure elements to which respective Synonym is assigned. |
|
Document |
Tab Document displays in a tabular view information related to the documents connected to the selected Synonym. Note: Tab Document is only available if the Document Manager is licensed and the user has Document Manager Viewer or Editor rights. |
|
Log |
Tab Log contains logging information related to the selected Synonym and is visible only for users with administrator rights. |
Create
This functionality allows the user to create new Synonyms.
Synonyms are language-specific.
Mandatory attributes are marked with an asterisk. Non-editable attributes are displayed as read-only.
When the work is finished, the user may save the new Synonym as Change Request (using button Save) or directly as structure element (using button Save and Release).
Change Requests usually undergo an approval process before they are released and become effective.
Change Text
This functionality allows users to edit the textual attributes of a Synonym. Mandatory attributes are marked with an asterisk.
When the work is finished, the user may save the changes made to the Synonym as Change Request (using button Save) or directly as structure element (using button Save and Release).
Change Requests usually undergo an approval process before they are released and become effective.
Delete
This functionality allows users to delete existing Synonyms.
Note: on deletion, the Synonym will be marked as deprecated, meaning that it is withdrawn from further usage. Deprecated elements are displayed grayed out in the system and they cannot be worked on or used anymore.
On pressing the Delete button, the system displays the details page of the Synonym selected for deletion. User may check the attributes/relations of the Synonym before proceeding with the deletion.
The user may confirm the deletion by pressing button Save or Save and Release.
On Save, a Change Request for the deletion of the Synonym will be created. Change Requests usually undergo an approval process before they are released and become effective.
On Save and Release, the Change Request for the deletion of the Synonym will be automatically executed (released). As a result, the Synonym is immediately withdrawn from further usage and is displayed as inactive within a given release (grayed out).
Import
This functionality allows users to import Synonyms as structure elements, using an XLSX file.
Import functionality can be used for the following:
-
import new Synonyms as structure elements
-
update existing Synonyms (i.e. already available as structure elements within the system)
-
import relations between Synonyms and Properties.
Following selections need to be made: desired Release and Supplier to which Synonyms shall belong and option if Update should be allowed or not.
After entering e-mail address to which import report will be sent and browsing the xlsx Import file, user may press the Import button.
User will be notified via entered e-mail in connection to the import result.
Copy
This functionality allows users to create assignments of Synonyms to other elements by means of copy and paste.
The user may select a Synonym in the tabular view and press button Copy. In the tabular view or tree view of Property, the user may select a Property to which copied Synonym should be assigned.
On pressing the Paste button, the system will lead to the Assign Synonym page where user may confirm the assignment by pressing button Save or Save and Release.
On Save, a Change Request for the assignment of the copied Synonym to the selected Property will be created. Change Requests usually undergo an approval process before they are released and become effective.
On Save and Release, the Change Request for the assignment of the copied Synonym to the selected Property will be automatically executed (released). As a result, the Synonym is immediately connected to the Property.