Home | Table of Contents | Graph Parameter Editor | CloverETL 4.6.1
--- | --- | ---
Prev | Parameters | Next

## Graph Parameter Editor

Detailed List of Available Operations
Properties of Graph Parameters
Graph Parameter Type Editor

Graph parameters are managed by Graph parameters editor. Main purpose of this editor is to create, edit and remove internal graph parameters, link and unlink external parameter files and edit particular graph parameters inside parameter files.

Graph parameter editor is available via Outline view. Just double-click on Graph parameters section.

Figure 36.3. Example of a Graph parameters editor

Both internal and external graph parameters are managed by this editor at once. Internal parameters are on top-level of tree and external parameter files are represented by sub-trees (for example workspace.prm in the figure above).

Order of graph parameters defines usage priority. In case of parameters name collision, the parameter above the other has higher priority. The order of graph parameters can be changed using drag and drop or move actions available on left-side toolbar.

In case of some error being detected in graph parameters setting, yellow exclamation mark icon is shown over affected graph parameters and an error message is displayed in tooltip on corrupted graph parameter.

### Detailed List of Available Operations

- ###### Adding a new graph parameter use

  To add a new parameter to the end of the list use in-line editing of Add new parameter cell at the end of each parameter section. To insert a new graph parameter above current position use Plus button on the left side.

- ###### Removing a graph parameter

  Use Minus button or Delete key to remove selected parameters. Multi-selection is supported. If you would like to remove unused graph parameters, use Cleanup Unused Elements.

- ###### Name and value editing

  Edit name and value of graph parameter directly in parameters viewer.

- ###### Changing the order of parameters

  Use left-side toolbar (Move top, Move up, Move down, Move bottom) or Drag&Drop to move selected graph parameter. Order of parameter files can be changed as well. Multi-selection is supported.

- ###### Creating a new parameter file

  Create new parameter file using button New parameter file.

- ###### Linking an existing parameter file

  Link existing parameter file using button Link parameter file

- ###### Filtering parameters

  Parameters filtering is based on substring of parameter name and value.

Dialog supports commonly used operations known from graph editor:

- Copy (Ctrl+C), Cut (Ctrl+X) and Paste (Ctrl+V) operation on selected graph parameters.

- Undo (Ctrl+Z) and Redo (Ctrl+Y) operations.

### Properties of Graph Parameters

- ###### Name

  Identifier of the parameter.

- ###### Value

  Value of the parameter. The Value field can use different editors to edit the value. The editors are set up using property Editor type.

- ###### Secure

  The parameter is considered as a Secure parameter. See Secure Graph Parameters

- ###### Description

  Description is user defined text for a graph parameter or for a graph parameter file. Contrary to the label the description can be several paragraphs long.

- ###### Public

  Public parameters serve for configuration of subgraphs. See Configuring Subgraphs.

- ###### Required

  This field is available in public parameters only. If a parameter of a subgraph is marked as required and the subgraph as is used as a component, the corresponding attribute of the subgraph component is mandatory and user has to set it up.

- ###### Label

  Label is a short description of the field appearing as an attribute name in a subgraph component. This field is available in public parameters only.

- ###### Value Hint

  This value is displayed in the value column in the properties of subgraphs component. The value helps user of subgraph to decide which value should be filled in to the user-defined graph attribute. The field is available in public parameters only.

- ###### Category

  Category of component attributes in which is parameter displayed: Basic or Advanced. Basic is default category. This field is available in public parameters.

- ###### Editor Type

  The public parameters can use type of editor corresponding to the field of the component using the parameter. You can use for example File URL Editor or Transform Editor. This field is available for all parameters.

  The editor type is primarily used for public parameters when setting them in parent graph (when configuring a subgraph).

  See also: Graph Parameter Type Editor

### Graph Parameter Type Editor

Simple type
Component Binding

Graph Parameter Type Editor serves to set up correct editor to particular graph parameters. You can choose between Simple Type or Component binding. The dialog is opened from parameter property Editor type in Graph parameters editor.

Figure 36.4. Graph Parameters Type Editor

#### Simple type

Simple type can be one of:

- Basic

  - String - inline editing or external dialog (Edit Parameter Value or Edit Parameter CTL2 Value)

  - Multiline string - external dialog Multiline String Editor.

  - Integer - inline editor, allows to insert whole numbers only

  - Decimal - inline editor, allows to insert decimal numbers

  - Boolean - inline editor - user selects true, false or empty value

- Advanced

  - File URL - external dialog (File Url Dialog). A configuration of the dialog is described in File URL. See URL File Dialog for details on File URL Dialog.

  - Date/Time - inline editor, allows user to set up date using calendar.

  - Properties - inline editor, serves to set up key-value pairs. See Properties.

- Metadata Related

  - Single Field - external dialog, allows to choose one metadata field. See Single Field.

  - Multiple Fields - external dialog, allows to choose one or more fields. See Multiple Fields.

  - Sort Key - external dialog, lets you define sort key. See Sort Key.

  - Field Mapping - external editor, allows user to set up field mapping. See Field Mapping.

  - Join Key - external editor, allows user to set up fields to be joined. See Join Key

- Enumerations

  - Enumeration - inline or external editor, allows user to choose one option from a list; user may be allowed to define its own value. See Enumeration.

  - Character set - external dialog, for choosing character set. See Character Set.

  - Time Zone - external dialog, for choosing time zone. See Time Zone.

  - Field Type - inline editor, for choosing field data type. See Field Type.

  - Locale - external dialog, for choosing locale. See Locale.

| Note
To store password use secure graph parameters. See Secure Graph Parameters

Figure 36.5. Select Editor Type Dialog

#### Component Binding

Component binding serves to bind the parameter to an attribute of existing component of subgraph. You can for example set up parameter Transform in Reformat component using public graph parameters.

Content of lists of components available in Component binding depends on components available in subgraph.

#### Edit Parameter Value

Edit Parameter Value serves to set up parameter value. The value of the parameter can be converted to the CTL2 code using Convert to dynamic button.

Figure 36.6. Edit Parameter Value

If the Convert to dynamic button is used, the editor is changed.

See also: Edit Parameter CTL2 Value

#### Edit Parameter CTL2 Value

The Edit Parameter CTL2 Value dialog serves to place a CTL2 code as a parameter value.

Figure 36.7. Edit Parameter Value

The value can be converted to string using Convert to static button. If the button Convert to static is used, editor is changed.

See also: Edit Parameter Value

#### Multiline String Editor

Multiline string parameter type lets you use a multiline string as a parameter value. If the parameter value is in xml or json format, its syntax can be checked.

Use Validation configuration property to switch on xml or json syntax validation.

Figure 36.8. Multiline string parameter - configuration

Figure 36.9. Multiline string parameter - validating XML

| Note
To enable support for JSON highlighting, please install 'JavaScript Development Tools' plugin. Help -> Install New Software... -> choose 'Luna' in the drop-down list and search for 'JavaScript Development Tools'

#### File URL

File URL parameter type lets you configure File URL Dialog.

File Extension makes File URL dialog to display files having particular suffix. It can be utilize to display files matching some pattern too. This way you can display file having .txt suffix (`*.txt`) or .xml files whose name starts with "a" (`a*.xml`).

Selection Mode displays files or directories or files or directories.

Allow Multiple Selection checkbox lets you deny multiple file selection. If you uncheck the checkbox, user cannot select multiple files.

Figure 36.10. File URL Dialog - Configuration

In the Select Types dialog, tick the file extensions to be available in File URL Dialog.

If a suffix is not available in the list, use Other extensions field below. The suffix you define should start with asterisk. If more extensions are defined, separate them with comma.

Figure 36.11. Select Types Dialog - Choosing file extension(s)

See also URL File Dialog.

#### Properties

Properties type lets you use key-value pairs.

Properties can be parsed with function parseProperties.

Figure 36.12. Properties - Usage

#### Single Field

Single Field type allows to choose one metadata field from the list.

Configuration of Single Field specifies subset of fields of one existing metadata; user chooses one field of the set. The metadata can be either static or referenced from a particular edge of subgraph. Available metadata fields can be filtered depending on metadata field type or container type.

Figure 36.13. Single Field - Configuration

If you use the parameter, you can choose one field using the following dialog.

Figure 36.14. Single Field - Choosing the Field

#### Multiple Fields

Multiple Fields parameter type serves to choose one or more metadata fields from the set.

Available fields are subset of fields of existing metadata. The fields can be of static metadata or metadata of an edge. Available metadata fields can be filtered depending on metadata field type or container type.

Figure 36.15. Multiple Fields - Configuration

Use arrows to add fields to the list or add field(s) using drag and drop.

Figure 36.16. Multiple Fields - Choosing the Field

#### Field Mapping

Field Mapping type requires metadata of both sides of mapping. You specify fields of which metadata could be mapped using the parameter.

Figure 36.17. Field Mapping - Configuration

In Field Mapping dialog user defines mapping for transformation.

Figure 36.18. Field Mapping - Choosing the Field

See also Mapping Functions.

#### Join Key

When you define Join Key parameter type, choose which metadata take part in joining:

Figure 36.19. Join Key - Configuration

Join Key parameter value specifies joining fields.

Figure 36.20. Join Key - Configuration

See also Mapping Functions.

#### Enumeration

Dialog below serves to set up available values in selection list of enumeration. Values available in the list are defined in Values. Pipe character is displayed escaped, semicolon is surrounded by `"` character.

User-defined values are allowed using Allow Custom Value checkbox.

User chooses the value using inline editor. If there are more than 10 (ten) values defined, user chooses the value using external dialog.

Figure 36.21. Enumeration - Configuration

#### Character Set

Character set parameter type lets user choose one of available character sets.

Figure 36.22. Character set

#### Time Zone

Time Zone lets user choose time zone from list. You can use either Java time zones or Joda time zones

Figure 36.23. Time Zone - Configuration

Figure 36.24. Time Zone - Usage

#### Field Type

Field Type lets you choose field type from a list.

Figure 36.25. Field Type

#### Locale

Locale lets you set locale.

Figure 36.26. Locale

Prev | Up | Next
XML Schema of External Parameters | Home | Table of Contents | Secure Graph Parameters