Overview
Transform settings are a means of allowing additional input when running a Transform. Often these are configured as "popups" where the user is prompted to answer a question. An example of this can be seen when splitting an IP address into a Netblock (the popup asks for the size you require the netblock to be split into):
Implementation
Transform settings can be configured on the iTDS via the Transform Settings section of the web interface, once on the Transform settings list page, click Add Transform Setting which will lead you to the page shown below:
Each field for adding a Transform setting is described below:
- Name: A mandatory field requiring a unique name for the Transform Setting which can be used programmatically in the Transform to fetch the value of the input.
- Display: This text will be displayed as the label to the field in the client.
- Type: The data type of the input in the client. This can either be a string or an integer.
- Popup: Choose Yes or No to set whether you would or would not want the user to be prompted to add/edit the value before running the Transform. The user is also given the option via checkbox in the client to choose to have their input "remembered" to prevent further popups, however, this will not affect the setting in the server.
- Default Value: Mandatory field holding a default value for the Transform setting. This can be modified in the client.
- Optional: True or False, to indicate whether users are able to to either send a value or not.
Once you have added the Transform settings, you can add these settings to different Transforms from the Edit Transform page as shown in the screenshot below:
Changing Transform Settings in the Maltego Desktop Client
If you do mark a Transform setting as 'remember' and it no longer pops up, or if you wish to restore a setting that was originally not marked as a popup, you can enable/disable this within the client. To do this, click Manage Transforms under the Manage tab. From here you need to find the Transform, click on the setting and enable or disable popup as shown below:
For a code example of using Transform Settings with the maltego-trx and the iTDS, have a look at the following articles in the Transform Development Guide: