Data Dictionary MOD009101

• If system customizing changes are made to data tables or data items (e.g. new data items are created, data item parameters are changed), the NEW Tools Restart PLANTA service menu item must be carried out in order to make the changes visible.
  • Note: If you click on the menu item, all open client connections (sessions) are closed. During restart, new client connections are not possible. This does not apply to changes made to I-texts, e.g. changes to the DI name or adjustment of value ranges (also of the VR type).
  • NEW Before restarting the service, the target directory must be deleted so it can be created anew upon server restart in order to make sure that the POJO classes contained in it, which are responsible for the meta data of the data dictionary, are generated anew.

• If system customizing changes have been made to data tables or data items (e.g. new data items have been created, data item parameters have been changed), the Reload system customizing button must be clicked on, or the Tools Reload system customizing menu item must be carried out in the Data Dictionary or Data Items modules to make the changes visible.
  • This does not apply to changes to I-texts, e.g. changes made to the DI name or adjustment of value ranges (also of the VR type).

• If system customizing changes have been made to data tables or data items (e.g. new data items have been created, data item parameters have been changed), the NEW Reload system customizing button, or the menu item of the same name, must be clicked on in the Data Dictionary or Data Items modules to make the changes visible.
  • This does not apply to changes made to I-texts, e.g. changes made to the DI name or adjustment of value ranges (also of the VR type).

• If system customizing changes have been made to data tables or data items (e.g. new data items have been created, data item parameters have been changed), the NEW Restart server button, or the menu item of the same name, must be clicked on in the Data Dictionary or Data Items modules to make the changes visible.
  • This does not apply to changes made to I-texts, e.g. changes made to the DI name or adjustment of value ranges (also of the VR type).

• If system customizing changes have been made to data tables or data items (e.g. new data items have been created, data item parameters have been changed), the Reload forking server button, or the menu item of the same name, must be clicked on in the Data Dictionary or Data Items modules to make the changes visible.
  • This does not apply to changes made to I-texts, e.g. changes made to the DI name or adjustment of value ranges (also of the VR type).

• Since all changes made to the standard data items will be overwritten in an update, such changes should be documented (individual ICOU) and be made subsequent to the update NEW or be treated with the new PLANTA conflic management procedure.

• The standard DIs deactivated by PLANTA must not be reactivated by customer users since such DIs are very likely to be removed in one of the releases following the deactivation. If a customer user tries to activate such a DI anyway, a warning message is displayed.
• NEW The deactivated data items are displayed grayed out in the Data Dictionary module.

• If individual data items are required for data tables of the Q1B or Q2B system databases, an individual data table with relation to the corresponding system database data table must be created.
• Creating and changing is allowed in the application database data tables (Q4-Q7).

• Open the Data Dictionary module.
• Select the required data table from the listbox.
• Right-click on an existing DI and select Insert Data item.
• Allocate and save the name in the Name field as well as the Column type (in window 2).
  • As a result, the number of the new DI is generated automatically and some own fields, like e.g. DB type, DF type, and PPMS type, and other fields depending on the column type (data type), are filled automatically.
• For real data items (data items with Virtual parameter = ):
  • Allocate a Python ID in the DI Python ID field.
  • Allocate an SQL ID in the SQL ID field (usually the DI addition is put in front of the automatic number, e.g. DI100001)
    • By clicking on the Set column name button (in the header area of the module), SQL IDs can be created automatically for all created DIs at once.
  • Allocate the number ascending to the number of the previous DI in the DB Pos. field. Please make sure that this field does not remain empty.
  • Activate the activated checkbox.
  • If DB length and DF length were not filled when the column type was set, please do so now.
  • Save.
    • As a result, the following message is displayed: Due to your changes to DT412, your database must be adjusted. Please select the appropriate ./xx_*.sql file (depending on the database system) and run the content on your database.
    • Warning: If other DIs are created in the same session, the schema update information is no longer displayed. The text file, however, is extended by the other DIs.
  • NEW Check the text file created by the schema update and run it on the database. For this purpose, see the next chapter Creating a Data Item in the Database.
  • Create the data item in the database by right-clicking on the newly created data item and selecting the Create data item command. Further information

• Only PLANTA can create and change data items in system database data tables (Q1-Q3).
• If individual data items are required for system database data tables, an individual data table with relation to the corresponding system database data table must be created.
• Creating and changing is allowed in the application database data tables (Q4-Q7).

• Open the Data Dictionary module.
• Select the required data table from the listbox.
• Right-click on an existing DI and select Insert Data item.
• Allocate the name in the Name field as well as the column type (in window 2) and save. As a result, the number of the new DI is generated automatically.
• For real data items:
  • Allocate the number ascending to the number of the previous DI in the DB Pos. field. Please make sure that this field does not remain empty.
  • Allocate an SQL ID in the SQL ID field.
    • This is automatically done by clicking on the Set column name button.
  • Allocate a Python ID in the DI Python ID field.
• Define further Data item parameters where appropriate.
• Create the data item in the database by right-clicking on the newly created data item and selecting the Create data item command. Further Information
• Save.

Create New Column(s) from the Database in PLANTA project

• With this function, columns which only exist in the database but not as a DI in PLANTA project can be created.

Procedure

• Open the Data Dictionary module.
• Select the required data table from the listbox.
• Click on the Create new column(s) as DI(s) button.
• The Create Data Items module is opened. Here, all columns of the current data table which are available in the database but not in PLANTA project are displayed.
• Activate the Copy checkbox for the columns which are to be created as DIs.
• Click on the Copy marked data items button. As a result, the required columns are created in the PLANTA data table.

Note

• If there are no columns on the DB which do not exist as DIs in PLANTA, the No new data items available on the database message is displayed.

• NEW The new Schema Update function replaces the Create data item (in the database) function from the context menu. That is why this context menu command has been removed.

• By right-clicking on Create data item, the corresponding data item can be created in the database.
• Therefore, the following values must be entered:
  • Name
  • SQL ID
  • DB pos.
  • Column type
    • As a result, the following fields are set automatically: SQL ID, PPMS type, DB type, and DF type
  • DB length, DF length

Note

• If the relevant values are entered incompletely, a message is displayed suggesting that you complete the missing value.

• Open the Data Dictionary module.
• Right-click on the required source data item and select the Define incarnation/fetch exit command.
• The Define Incarnation/Fetch Exit module is opened.
  • Fill the data fields as follows:
    • DT for exit of the CO DIs of the incarnation / Fetch DT: data table from which a data item value is to be fetched.
    • DT for exit of the CO DIs of the incarnation / Fetch DI: data item the value of which is to be fetched to the target data item.
  • When opening the module, the following fields are automatically filled with the data table and the DI from which the context menu command was made.
    • DT of the incarnation / Source DT: data table in which the source DI is located.
    • ID DI of the incarnation / Source DI: data item of the source data table via which the fetch data table is referenced to fetch the required value.
• Click on the Create fetch exit button.
  • The fetch-data item with the exit is automatically created in the target data table (which is the source data table at the same time).

• Open the Data Dictionary module.
• Right-click on the required data item (ID data item) and select the Define incarnation/fetch exit command.
• The Define Incarnation/Fetch Exit module is opened.
• Fill the data fields as follows:
  • DT for exit of the CO DIs of the incarnation / Fetch DT: Data table from which the name for a CO data item of the incarnation is fetched via exit.
  • DT for exit of the CO DIs of the incarnation / Fetch DI: Data item from which the name for a CO data item of the incarnation is fetched via exit.
• When opening the module, the following fields are automatically filled with the data table and the DI from which the context menu command was made.
  • DT of the incarnation / Source DT: Data table in which the incarnation is created.
  • ID DI of the incarnation / Source DI: ID data item of the incarnation
• Click on the Create incarnation button.
  • The CO data item with the corresponding exit and
    • the incarnation data item are
    • created automatically.
• Save.