Required Fields

Modified on: Fri, 31 Mar, 2023 at 2:11 PM

For developers to have their Transforms listed on the Transform hub the following fields are required:

FieldWhat it MeansExample
* NameName of your Transform/sIMDB Transforms
* Seed URLWhere the Seed of your Transforms are locations (e.g. URL). You can optionally ask that this not be visible in the GUI as well. If this is not specified it will not be displayed.
* Description (short)A short description of your Transform/s' function.This Transform queries the Internet Movie Database.
* Description (long)A longer description of your Transform/s.This set of Transforms allows you to pivot from movie, director, and actor.
ModifiedA UNIX timestamp of when this entry was last modified.474336000
* Icon (URL)A 48x48px PNG icon for your Transforms.
* Provider NameYou / your company name.MoviesRUs
* Provider websiteWhere users can read about you and your Transforms.
*Provider emailWhere users can email
Provider phoneWhere users can contact you by phone.555-123-1234
Registration URLIf users need to register for the Transforms, this page should explain the process to them.
Input FieldsIf you want to perform access control on your Transforms (e.g. make it commercial) these are the fields you'll use in your transforms to identify users. Fields have the following properties:
  • Name - Variable name used
  • Display - The display name shown in the GUI
  • Type - The type of this input field, this can be set to one of the following: string (recommended), int, date, url
  • Optional - If this variable is required / optional, default is false
  • Auth - If this is an authentication field and should be *'d in the GUI, default is false
See example below this table.
Pricing infoExplain to users how much your Transforms cost (if at all).$0.01 per Transform run.
Pricing websiteAt this website they'll pay / enter CC info.

Note: * - required fields.

Example XML

Below is an example of Transform hub XML, please note this is CaSe SeNsItIvE.

<Seed Pos="10" Display="Commercial TAS v3">
    <Url Visible="true"></Url> <!--visible is optional, default "false"--> 
    <Description>This is a short description.</Description> 
    <Details>This can be a very very very very very long description. This can be a very very very very very long description.</Details> 
    <Modified>1417531063521</Modified> <!-- unix time --> 
    <Icon><!-- 48x48px png--> 
        <Phone>+27 555 5555</Phone> 
        <Info>$1 per transform or $100 per month unlimited transforms.</Info>
        <!-- Examples... --> 
        <Input Name="api-key" Display="API Key" Type="string" Optional="true" Auth="true"/>
        <Input Name="username" Display="User Name" Type="string" Auth="true"/> <!-- default for Optional and Auth is "false" --> 
        <Input Name="password" Display="Password" Type="string" Auth="true"/> 
        <Input Name="service-url" Display="Main Blah URL" Type="url" Optional="true" DefaultValue=""/> 
        <Input Name="from" Display="Start Date" Type="date" Optional="true" DefaultValue="1999-04-22"/> 
        <Input Name="netblockSize" Display="Netblock Size" Type="string" Optional="false" DefaultValue="10"/> 

600 error messages

If your Transform returns the following XML it will result in the Maltego Client popping up an useful error message prompting the user to fill out the fields marked as 'Auth' (as defined in the Transform hub item).

An example of this can be seen below:

        <exception code="600">Your error message such as API key required</exception>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.