Note that this application may not work when executed from a local file system because of security reasons. In such a case, please access it only via HTTP (e.g., from the DELMIA Apriso server).
This Web application enables users to view information about the DELMIA Apriso tables.
The tables are ordered in groups and are accessible from the browser on the left side of the screen. The relations between the tables are presented in diagrams for each table category. Simply use the browser pane on the left to navigate to the objects you are interested in.
The application window contains three sections:
The browser allows for simple navigation between groups, categories, and tables. The browser tree structure is generated dynamically based on the xmlTree.xml file extracted from the database located in the application's XMLs folder. The browser is also used to display search results, which allows for easy navigation between them.
This is the main window of the application. It enables viewing an entity that has its description (hyperlink) selected from the browser. The viewer mainly consists of description fields.
Used to search for a word or phrase within the Browser hierarchy and in the document content. The Browser tree will be filtered based on the results found while content results will be displayed in the Viewer.
The browser mimics a standard tree control, so navigation is very intuitive. It is possible to expand/collapse the tree nodes and display information for the selected branch or leaf of the tree.
button to expand a tree group
button to collapse a tree group
icon (as well as the entire group text) can be clicked to expand/collapse a tree group, but only if the group does not have a description assigned (that is, the group text must be in the normal font)The browser structure is dynamically generated from the XML file exported from the database during the update process. Each DELMIA Apriso table can be assigned to a specific group, category, subcategory (one or many), etc. The groups and assignments are defined in the database. For the user's convenience, groups can be nested within other groups to ensure custom table classification. Tables can only be nested within groups (that is, they cannot appear in the root of the tree).
The three kinds of entities that appear in the browser are:
These are groups with no description assigned. The names are shown in a normal black font, and these names can also be used as triggers for expanding/collapsing the tree nodes.
Just as with tables, after clicking the name of one of these groups, the group description (the image file name specified for the group) will be displayed if available. The application will use this image to illustrate the group (the image presents the relations diagram between the tables included in the group).
These links enable calling the table details into the viewer. The link names represent the table names, and all the links with the same names refer to the same table (though they may exist in different groups).
When viewing an individual database table document in the viewer, the Columns section (specifically the Links column) displays hyperlinks that make it possible to jump quickly to the table that is linked to the specific row of the table being viewed (via a foreign key reference).
Additionally, the viewer displays the prime data for any kind of image that is assigned to the table (if any exists for the table being viewed).
Back to topThe viewer always displays an entity Description section (regardless of whether the entity is a group or a table). This description is replaced with a custom one if it exists for the table being viewed. The Columns section and the Prime Data section (if hosted) are additionally displayed for tables. If attached to an entity, an Image section is also displayed for a group or a table.
The Columns section has the following fields:
The Database Documentation application was developed for customers to be able to easily view the tables in their own database. Therefore, a script (Upgrader) was attached to the application that makes it possible to refresh both the tables and the structure in which they are organized (that is, the browser tree). As opposed to running the application (which can be done on any environment with IE5+ with JavaScript service), updating the application's contents is only possible on a machine with DELMIA Apriso connected to either an Oracle or MSSQL Database and which is appropriately configured (for details, ask your System Administrator).
Documentation will be updated for tables for which a record exists in ERD_TABLE and ERD_TABLE.Documentation is set to 1.
The update script is launched by an EXE file that can be found at this path:
C:\Program Files\Dassault Systemes\DELMIA Apriso 2021\WebSite\Help\en-us\DB\updater\FlexNet.DatabaseDocumentationGenerator.exe.
However, before the first update, it is necessary to manually configure the script configuration by editing the FlexNet.DatabaseDocumentationGenerator.exe.config file (in the same location).
The DELMIA Apriso Database Documentation configuration file consists of three main sections which should be adjusted according to the specific user/update needs:
The DELMIA Apriso language code, which should be changed only by an advanced user or a DELMIA Apriso Administrator.
If this value is set to the default, the system will show the total and processed number of XMLs being generated.
If this value is set to the default, the upgrader will refresh all the tables that are flagged as DocumentationTable in the database. Leave this value intact if you are performing the update for the first time, or change it to "false" if you want the upgrader to refresh only the tables of your choice in the last key.
If this value is set to the default, the system will refresh the xmlTree.XML file containing the browser (tree) structure. It will refresh the group names and update the table group assignments.
If this value is set to the default, the system will refresh the XML files containing information of clickable groups and categories displayed in the main viewer window.
The special tables in the DELMIA Apriso database were created along with the Database Documentation application to gather and hold information about the tables, categories, and descriptions as well as the relations between them. The Upgrader script refreshes local data on the basis of the information contained in these tables, and it is necessary to refresh their content (on the database). The database tables will be refreshed each time a script is executed with the value of this key equal to "true."
If this value is set to the default, the Upgrader will automatically put the generated XMLs into the correct application folder (XMLs). The files displayed are always taken from that folder. If you want to have the files stored somewhere else, change the path (e.g., for future use if you do not want the old files to get overwritten).
This field is commented by default and therefore not taken into account in normal Upgrader operation. If you want specific tables to be refreshed only, uncomment this field and type the tables' names in the "value" parameter. Separate the table names with commas (e.g., "value="RESOURCE_, WIP_OPERATION""). Remember to set the "RegenerateTables" key value to "false"; otherwise, the Upgrader will ignore this key.
The location of the logging configuration file. Setting a default DELMIA Apriso logging configuration file is recommended. If this is done, all the update script logs are saved in the default DELMIA Apriso logging folder.
The location of the DELMIA Apriso Central Configuration file. The database connection strings are taken from the DELMIA Apriso Central Configuration, so this path must always be valid.