Documentation Center

Using TriDK XML Setup

TriDK XML Setup uses XML scripts. An XML script has to be an XML file that is valid according to the “TriDKSetup” Schema.

Getting started

A functionally different script is needed depending on the action you want to execute. The following table provides an overview of the different scripts.

Script TypeDescription
Input Script

Contains all customer-specific metadata declaration. It serves as input for the complete action.

Completed ScriptContains the same information as in the input script although it is completed with:
  • Default information required by TriDK XML Setup in case the metadata declaration was not yet available inside the repository.
  • Actual information in case the metadata declaration was already done previously.
Action Script

Contains the same information as the completed script plus action attributes.

The action attributes are used for:

  • Discovering which modification would be made to the data model in the repository when the action script is executed.
  • Informing TriDK XML Setup of the modifications which must be made to the data model inside the repository.
Result Script

Contains the same information as the action script plus returncode attributes. The returncode attribute indicates whether the data model has changed successfully or not.

The process of making a change to the database requires the following steps:
  1. Creating an input script

    Typically this contains only the customer specific elements since you do not know which other elements are necessary for a valid action script. Noted below are different ways to get started on an input script.

  2. Generating a completed script

    Run the TriDK XML Setup tool with the action: complete

    The input script is completed automatically with all elements that are required by the system, that is, all additional metadata that is required for the next steps to produce correct SQL statements. This contains metadata that the user may not be aware but which is required in the next steps.

  3. Generating an action script

    Run the TriDK XML Setup tool with the action: difference

    The completed script is compared with the actual configuration of the database. The result is an action script in which any redundant information has been removed relative to the data model stored inside the repository. Any mandatory elements that are still missing is indicated and all actions are placed in the correct order. Allowable values for the action attribute are:

    • create
    • update
    • delete
    • add
    • remove
  4. Generating a result script

    Run the TriDK XML Setup tool with the action: execute.

    SQL statements are generated based on the specified actions, and executed on the database. The resulting XML file contains information about the success or failure of the execute action.

Diagram

The following drawing shows the logical steps and their input/output files.