Function Parameters

Parameter Properties

Each parameter has a number of properties you must or may set:

Parameter naming and help

  • Parameter name: The name of the parameter. The name is used by the system to identify this parameter. Names must be unique and may not contain spaces and other special characters. Use names like 'Title', 'StartDate', 'LargeImage' etc.
  • Label: The text that users should see when specifying a value for this parameter. This is the 'human name' for the parameter.
  • Help: Write a short text that tells the user what to do with the parameter.

Parameter type and values

  • Parameter type: The type of this parameter.
  • Default value: You can specify a default value for this parameter. If a parameter has a default value, users are not required to specify it when calling the function.
  • Test value: When previewing you can test with different input parameter values using this field. If this is left blank, the default value will be used for previews.

Parameter presentation

Widget type: You can select which type of input widget (like a textbox) to use when specifying a value for this parameter. Widgets are only available for simple types.

  • Position: The position of the parameter. This controls the order of the parameters.