Variable properties
Variable Level Plugin properties
The plugin properties in this section are applied at variable level. Use these to map data points in the source to target variables.
Description
Used to provide a human-readable description of the mapping logic applied to map the source dataset/target datasets. Multi-list element.
Mapping
Used to specify the mapping for the target variable. Using the list of options specified, this is the main source of logic to map the Target Variable back to the Source Variable. If there are multiple Source Datasets then users can specify multiple Mapping elements. If users do specify multiple Source Datasets, ensure to use appropriate Source Dataset Identifiers on each different mapping.
Source Type
Used to classify the type of mapping for the target variable. A dropdown list of all the different possible types of mappings the system is capable of. This is used in conjunction with the plugin properties below to determine the mapping. The list of source type mappings are:
- None
- Source Variable
- String
- Function
- Dataset lookup
- Copy Mapping
- Choice
- ValueList: Value Name
- ValueList: Value Label
- ValueList: Value Origin
- ValueList: Value Data Value
- ValueList: Value Original Unit
- ValueList: Variable
- Sequence No: Sequentially Number Rows
- Sequence No: Sequentially Number Rows per Subject
- Sequence No: Unscheduled Visit
- Populate IDVARVAL
- Comment Data Value
Follow the relevant sections for more detail on the individual Source Types. The only one not covered below is the Source Type “None”. This is used when no mapping value is intended to be returned. This means that the column in the output Dataset is blank.
Source
This is used in many places throughout the mapping plugin and is context-aware. Source is recommended to be specified. In this context, this is used to cover the Source Types of “Source Variable” and “String”. For “Source Variable” it is used to specify the Source variable in a direct one-to-one mapping. For “String” it will output an explicit string.
Do Not Uppercase
Used to determine the casing of the final value. The converter by default outputs everything in uppercase. ‘Yes’ means that the system will not uppercase the final value.
Controlled Terminology Lookup
Used to specify a look up to a Controlled Terminology specified in the define file. If any coded value matches the source value of the mapping it will return the Decode value of the Terminology. The Controlled Terminology Lookup property has the following plugin properties
- Controlled Terminology Identifier - This is a dropdown list of all the Controlled Terminologies specified in the Define File. Users select one from the list as the identifier for this mapping.
- Default Value - Used to specify a fall back value if there is no match on any of the Coded Values specified for terminology specified above.
Function
Used to specify one of the inbuilt functions for the converter tool.
Copy Mapping
Used to copy a mapping from another variable. Users specify which variable they wish to copy from and whatever mapping is specified in that variable is used here also. The copy mapping has the following plugin properties:
Domain - This is a drop down list of all the Domains in the define file. Users specify the Parent Domain of the variable they wish the mapping to be copied from
Variable - This is a drop down list of all the variables in the Domain specified above. Users select the variable they wish the mapping to be copied from.
Source Dataset Identifier - For instances where there are multiple mappings on the selected variable, users specify the Source Dataset Identifier for the individual mapping they are trying to copy.
Choice
The Choice mapping allows you to apply conditional logic to your mappings. This follows the traditional logic of If...Then...Else statements.
When
Choice Mappings are built up by a number of When statements. Users should use the When statement to define different scenarios of when they would want a specified output. If the When conditions are not met then the logic will fall back to the Otherwise element. Users should try and create unique When elements so that they do not have scenarios where multiple When’s could execute.
Condition (if)
When Conditions can be chained together.
Output Value (then)
If the When Condition is satisfied, users can specify the Output Value. This allows for the basic mapping options, including outputting a String value.
Otherwise (else)
If none of the When conditions are met, users are able to specify a fall back value.
Example - In the following example, if the Source Variable SAE has a "Y" value; then the Choice mapping will convert it to a "YES" string value.
If SAE does not have a value of "Y" then the output value is converted to "NO".

Dataset Lookup: Source
Used to specify mapping that can look up a dataset which is not one of the current Source Datasets. Use this mapping type if you want to access a Dataset which will only be used for this particular variable mapping. If a Dataset is used for multiple variables you should consider joining the Dataset to the Source.
Also used when the Dataset comes from a different Source system to the other Source Datasets. For example, if most source Datasets come from an EDC but there is an external LAB dataset to be incorporated, it may be better to use a Dataset Lookup as the EDC and LAB Dataset Structures may differ, making it impossible to use a Dataset Join.
Lookup Dataset Identifier - Used to specify the Source Dataset that you are trying to lookup.
When - Used to specify the Conditions under which the Dataset Lookup should work. Users can specify multiple When conditions.
Calculated Value - Used to specify the returned value based on the Dataset lookup match. This is a traditional Mapping element.
Note: at this level, options are limited to the following Source Types:
- None
- Lookup Variable
- Source Variable
- String
- Function
- Choice
The Lookup Variable Source Type is unique to this level of mapping. It refers to a Variable in the Lookup Dataset.
Calculated Value Modifier - This is a dropdown list containing Maximum and Minimum as options. The Dataset Lookup can only ever return ONE row for the mapping but it is possible that the When specified may return multiple rows in the Lookup Dataset. This will result in multiple Calculated Values, This is why the property forces the user to choose Maximum or Minimum as it needs to select only ONE return from the When specified in.
The Minimum and maximum work as expected if the values returned are numeric i.e. Minimum will return the lowest value and Maximum will return the highest value. If the values are textual then the minimum/maximum will be determined alphabetically.
Result Mapping - As a result of Calculated Value and Calculated Value Modifier, there will be a returned value from the Dataset Lookup. From here users can specify a further mapping for this result. This is a basic mapping element.
Note: Source Types are limited here to:
- None
- Calculated Value
- Lookup Variable
- Source Variable
- String
- Function
- Choice
Calculated Value is a reference to the Value returned as a result of the mapping. Result mapping will often be the Calculated Value but the Result Mapping allows an extra level of logic to be applied to the Calculated Value. The example below is the same as above except the Result Mapping applies a Substring after function to the output to LLT_NAME in the correct format.
Source Dataset Identifier
Used to link the mapping to a particular source dataset. Users can define multiple Mapping elements for variables. This should be used when there are multiple Source Dataset Elements specified. If multiple Source Datasets are specified, you can use multiple mappings for each element based on those Source Datasets. If you do this they MUST populate this property with the Source Dataset that the particular mapping is referring to.
ValueList Source Types
For the ValueList Source Types these correspond to the ValueList Values specified in the define file. These are used when there is a horizontal to vertical pivot operation in place
ValueList: Value Name
This will return the Name of the current Value in the pivot operation.
ValueList: Value Label
This will return the Description of the current Value in the pivot operation.
ValueList: Value Data Value
This will return the mapping result of the current Value in the pivot operation.
ValueList: Value Origin
This will return the origin of the current Value in the pivot operation.
ValueList: Value Original Unit
See ValueList Values Properties; Mapping; Original Unit for more detail.
ValueList: Variable
See ValueList Values Properties; Mapping; Variable for more detail.
Sequence No: Source Types
Sequentially Number Rows
Increments for every row in the target Domain
Sequentially Number Rows per Subject
Requires USUBJID to be present and populated in the target Domain. Increments by one for every row for each unique USUBJID value, starting at one.
This replicates the SDTM - SEQ derivation.
Sequentially Number Rows: Unscheduled Visit
Increments for every row in the target Domain based on the Visit Type. If Visit is Unscheduled then the output will increment with a leading 0.0001.
Example:
To organize Visits and Unscheduled Visits:
- Map all Visits into a single dataset. Scheduled Visits should have a VISITNUM assigned, while unscheduled Visits should have a blank VISITNUM.
- Sort by Visit date to arrange the Visits in chronological order for each subject.
- Apply a Choice Mapping to handle Unscheduled Visits. Use the following logic:
- If VISIT = 'Unscheduled', assign “Sequence No: Unscheduled Visit.”
- Otherwise, use the VISITNUM.
This process fills in the missing VISITNUMs, starting from the preceding VISITNUM. For example:
VISIT | VISITNUM |
|---|---|
VISIT 1 | 1 |
VISIT 2 | 2 |
Unscheduled | |
Unscheduled | |
VISIT 3 | 3 |
After applying the Sequentially Number Rows: Unscheduled Visit mapping, the dataset will look like this:
VISIT | VISITNUM |
|---|---|
VISIT 1 | 1 |
VISIT 2 | 2 |
Unscheduled | 2.0001 |
Unscheduled | 2.0002 |
VISIT 3 | 3 |
Copying Mappings
Allows users to copy whole mappings from one variable to another. The copying mechanism is separate to the Copy Mapping element in the previous section. This functionality allows users to copy mappings within the application to then paste into other mapping elements. It allows for easier re-use of mappings.