The documentation from version 39.5.17 of PLANTA project can be found in the new PLANTA Online Help.
TWiki> CurrentEN Web>PLANTALinkDocumentation>PLANTALinkModules>ConfigurationMOD009C35

Configuration MOD009C35 New from S 39.5.4

From DB 39.5.9

Access path

Up to DB 39.5.9

Access path

Information

  • In this module, the most important data and parameters of an interface are created and maintained.
  • Depending on the access rights of the current user, data can be modified.

Create New Interface Configuration

Define configuration manually

From DB 39.5.8

  • Click on the Insert button.
  • The UUID field is filled automatically.
  • Enter a configuration name in the Name field.
  • Fill the mandatory Source module and Target module data fields.
  • Define further configuration parameters or change already preset ones as desired.
    • When defining the log type you have to consider that writing log entries in a log file on the server is substantially more performant than writing in a PLANTA table, then again, the log entries written in PLANTA can be searched more comfortably in the Logging module designed for this purpose.
  • Save.

Up to DB 39.5.8

  • Click on the Insert button.
  • The UUID field is filled automatically.
  • Enter a configuration name in the Name field.
  • Fill the mandatory Source module and Target module data fields.
  • Define further configuration parameters or change already preset ones as desired.
  • Save.

    • Details

    • Each newly created configuration can be marked as a template for the creation of further interface configurations by activating the Template checkbox.

    Copy from template

    • Click on the Copy template button.
      • The Interface Templates module, which contains a list of all interface configurations that can be used as templates, is opened.
        • Click on the link on the name of the required template.
        • A new configuration is created, the name of which is composed as follows: [Source configuration name + Copy String]

    Copy existing configuration

    • Click on the Insert button.
    • Select the required configuration from the listbox.
    • Right-click Select Copy configuration.
    • A new configuration is created, the name of which is composed as follows: [Source configuration name + Copy String]
      • Locked configurations cannot be used as a copy source. If you try to copy such a configuration, the following message is displayed: It is not possible to copy: The configuration is locked.

    Edit Interface Configuration

    Procedure
    • Click on the Insert button.
    • Select the required configuration from the listbox.
    • Make the required changes and save.

    Context menu

    From DB 39.5.7

    • Via the context menu in the configuration header, the following actions can be carried out:
      • NEW Execute: opens the configuration in the Execution module.
      • Edit source module: opens the module stored in the Source module field in the Modules module
      • Edit pool module: opens the module stored in the Pool module field in the Modules module
      • Edit target module: opens the module stored in the Target module field in the Modules module
      • Go to source configuration: If the current configuration is a copy, the corresponding source configuration is opened. Otherwise, the This configuration is a copy message is displayed.
      • Copy configuration

    Up to DB 39.5.7

  • Via the context menu in the configuration header, the following actions can be carried out:
    • Go to transaction: opens the current configuration in the Transaction module
    • Edit source module: opens the module stored in the Source module field in the Modules module
    • Edit pool module: opens the module stored in the Pool module field in the Modules module
    • Edit target module: opens the module stored in the Target module field in the Modules module
    • Go to source configuration: If the current configuration is a copy, the corresponding source configuration is opened. Otherwise, the This configuration is a copy message is displayed.
    • Copy configuration

    • Edit Configuration Parameters

    From DB 39.5.7

    Procedure
    • Click on the Edit parameters button in the header area of the configuration.
    • The Interface Parameters module is opened and displays the parameters available for source, pool, and target modules.
      • Which parameters are available depends on the module subclasses of the source, pool, and target module.
      • For a detailed documentation of the parameters, see the Interface Library topic.
    • Edit the required parameters.
    • Save.

    Up to DB 39.5.7

    Procedure
    • Click on the Edit parameters button in the header area of the configuration.
    • The Interface Parameters module is opened and displays the parameters available for source, pool, and target modules.
      • Which parameters are available depends on the module subclasses of the source, pool, and target module.
      • For a detailed documentation of the parameters, see the Interface Library topic.
    • Edit the required parameters.
    • Save.

    Mappings

    Information
    • A mapping is the centerpiece of any configuration.
    • A mapping specifies which columns in the source correspond to which columns in the target.
    • Additionally, a mapping allows to check, convert, and adapt values before they are sent to the target module.

    Notes

    • A mapping always leads from a source to a target.
    • Between source and target, various mapping functions can be interposed.

    Mapping element types

    • Source: Source column
    • Pool: Pool column
    • Target: Target column

    Mapping functions

    Mapping structure

    MappingAufbauEN.PNG

    Create Mapping

    Procedure
    • In order to generate the mapping automatically, click on the Generate mapping button at the top of the configuration.
      • The Generate Mapping module is opened.
      • Select the required mapping type and click on the Generate button.
      • The mapping elements are inserted automatically on the basis of the objects defined in the source or target module.

    From DB 39.5.7

    Note
    • Alternatively, the mapping elements can be inserted on the same level via right-click or via the Insert button. This may be necessary,e.g., when the mapping function is interposed.
    • NEW By clicking on the Insert child mapping button, individual mapping elements can be created below the respective mapping elements.

    Up to DB 39.5.7

    Note
    • Alternatively, the mapping elements can be inserted on the same level via right-click or via the Insert button. This may be necessary,e.g., when the mapping function is interposed.

    Edit Mapping Parameters

    Procedure

    • Click on the Edit parameters button on the required mapping element.
    • The Mapping Parameters module is opened in which mapping parameters can be compared.
    • For information on the impact of the parameters, please refer to the interface library topic.

    Note

    • Parameters can also use the result of another mapping column as a value. For this purpose, @<target mapping name> must be entered as a value.

    Validate Configuration

    Information

    • The validation of the configuration automatically takes place before every transfer, i.e., at the beginning of the transaction. However, it can be started manually as well.

    Procedure

    From DB 39.5.8

    • Select the configuration to be checked.
    • Click on the Validate configuration button.
      • The validation is carried out and the result is subsequently written in the log of the configuration. You can look at the log records in the Logging module or NEW in the log file, NEW depending on the log type set for the configuration.
      • If mappings were detected to be incorrect, they are marked in the module.

    Up to DB 39.5.8

  • Select the configuration to be checked.
  • Click on the Validate configuration button.
    • The validation is carried out and the result is subsequently written in the log of the configuration. You can look at the log records in the Logging module.
    • If mappings were detected to be incorrect, they are marked in the module.

    • From S 39.5.8

    Validation check
    • The mapping is checked for the following requirements:
      • No source mapping may have a parent mapping.
      • No target mapping must have a child mapping.
      • Each source mapping must lead to at least one pool or target mapping.
      • Each target mapping must stem from a source mapping.
      • Each pool mapping must stem from a source mapping.
      • All mapping functions must be integrated in a chain from source to target.
      • The python IDs of the pool mapping must be available in the pool table.
      • Each python ID must only occur once within the pool and target mappings.
        • This does not apply to mappings that are placed after a validator.
      • The Object field must be set for all mappings except for the source mappings.
      • All relative parameters must refer to an existing target mapping.
      • All mapping functions must be findable.
      • All mapping objects need a valid type.
    • Further validation checks:
      • The pool table must possess the status, transferred_on, and UUID fields.
      • The source module must implement the send method.
      • The source module must implement the receive method.
      • The pool module must implement both methods.
      • No pool mapping without pool module or pool table, or vice versa.
      • NEW All validators with child_when_invalid parameter refer to an invalid submapping.

    From S 39.5.7

    Validation check
    • The mapping is checked for the following requirements:
      • No source mapping may have a parent mapping.
      • No target mapping must have a child mapping.
      • Each source mapping must lead to at least one pool or target mapping.
      • Each target mapping must stem from a source mapping.
      • Each pool mapping must stem from a source mapping.
      • All mapping functions must be incorporated correctly in a chain from source target.
      • The python IDs of the pool mapping must be available in the pool table.
      • Each python ID must only occur once within the pool and target mappings.
        • This does not apply to mappings that are placed after a validator.
      • The Object field must be set for all mappings except for the source mappings.
      • All relative parameters must refer to an existing target mapping.
      • All mapping functions must be findable.
      • All mapping objects need a valid type.
    • Further validation checks:
      • The pool table must possess the status, transferred_on, and UUID fields.
      • The source module must implement the send method.
      • The source module must implement the receive method.
      • The pool module must implement both methods.
      • NEW No pool mapping without pool module or pool data table, or vice versa.

    Up to S 39.5.7

    Validation check
    • The mapping is checked for the following requirements:
      • No source mapping may have a parent mapping.
      • No target mapping must have a child mapping.
      • Each source mapping must lead to at least one pool or target mapping.
      • Each target mapping must stem from a source mapping.
      • Each pool mapping must stem from a source mapping.
      • All mapping functions must be incorporated correctly in a chain from source target.
      • The python IDs of the pool mapping must be available in the pool table.
      • Each python ID must only occur once within the pool and target mappings.
        • This does not apply to mappings that are placed after a validator.
      • The Object field must be set for all mappings except for the source mappings.
      • All relative parameters must refer to an existing target mapping.
      • All mapping functions must be findable.
      • All mapping objects need a valid type.
    • Further validation checks:
      • The pool table must possess the status, transferred_on, and UUID fields.
      • The source module must implement the send method.
      • The source module must implement the receive method.
      • The pool module must implement both methods.

    See also: Here you can find an overview of all PLANTA link contents
    Attachments Attachments
    Topic attachments
    I Attachment History Size Date Comment
    Pngpng MappingAufbau.png r1 6.5 K 2013-12-17 - 15:24  
    Xmlxml MappingAufbau.xml r1 3.9 K 2013-12-17 - 18:22  

             PLANTA project







     
    • Suche in Topic-Namen

    • Suche in Topic-Inhalten
    This site is powered by the TWiki collaboration platform Powered by Perl