Skip to main content

autocomplete

  • Description: Text input with searchable dropdown suggestions. Can use static controlOptions or dynamic options from API via autocompleteParams. Supports workflow variable autocomplete when typing %.
  • Base Type: control
  • Data Type: String (Searchable)
  • Validation Rules:
    • User can type to filter options
    • Can select from filtered results or type custom values (if allowed)
    • Options can be static (controlOptions) or dynamic (autocompleteParams)
  • Example Values: us-east-1, server-prod-01, admin-group, %VariableName%
  • Common Use Cases: Entity selection (devices, users, workflows), Region selection, Dynamic lookups
  • Optional Properties:
    • controlOptions (Array): Static list of options with key and value (used when autocompleteParams is not specified)
    • autocompleteParams (Object): Configuration for dynamic API-based options:
      • entityType (Number): EntityTypes enum value specifying what kind of entities to fetch
      • stringToSearch (String): Optional search string filter
      • extraParams (Any): Optional additional parameters for the API call
    • value (String): Default selected value
    • idFieldName (String): Field name to store the selected item's ID
    • idDefaultValue (String): Default ID value
    • excludeItems (Array): Items to exclude from the autocomplete results
    • required (Boolean): If true, the field must be filled. Default is false
    • disabled (Boolean): If true, the control is read-only

EntityTypes Enum Values (for autocompleteParams.entityType):

ValueNameDescription
0NoneNo entity type
1WorkflowWorkflow selection
2DeviceDevice/server selection
3UserUser selection
4GroupUser group selection
5DutyDuty/shift selection
6TemplatesTemplate selection
7Global_VariablesGlobal variables
8ServicesService selection
9ClassificationsClassification selection
10CommandsCommand/executor selection
11SitesSite selection
12OperationSystemOperating system selection
16TimeFramesTime frame selection
17ConditionCondition selection
18ModulesModule/integration selection
19ErrorHandlingError handling configuration
20ClustersCluster selection
21ActivitiesActivity selection
27IncidentIncident selection
31IncidentDevicesIncident devices selection
32IncidentServicesIncident services selection
35MessageTemplatesMessage template selection
36ModulesFilteredFiltered modules
37FoldersWorkflowsWorkflow folders
38FoldersTemplatesTemplate folders
40ErrorMessagesError message selection
41TimeZoneTime zone selection
42UserByFullNameUser by full name
46NotesNotes selection
54QueuesQueue selection
55ModuleFieldsModule fields
62AwsRegionAWS region selection
63AwsInstanceTypeAWS instance type
64AwsVolumeTypeAWS volume type
67SelfServiceFoldersSelf-service folders
68SelfServiceFormsSelf-service forms
78DeviceWithNoMasterDevice without master
94WebServicesWeb services
131RecipientUserRecipient user
132RecipientGroupRecipient group

JSON Example (Static Options):

{
"key": "serverRegion",
"label": "Server Region",
"baseType": "control",
"controlType": "autocomplete",
"value": "us-east-1",
"disabled": false,
"required": true,
"controlOptions": [
{
"key": "1",
"value": "us-east-1"
},
{
"key": "2",
"value": "us-west-2"
},
{
"key": "3",
"value": "eu-west-1"
}
]
}

JSON Example (Dynamic Options with autocompleteParams):

{
"key": "targetDevice",
"label": "Target Device",
"baseType": "control",
"controlType": "autocomplete",
"value": "",
"idFieldName": "DeviceId",
"idDefaultValue": "0",
"required": true,
"autocompleteParams": {
"entityType": 2
}
}

JSON Example (AWS Region Selection):

{
"key": "awsRegion",
"label": "AWS Region",
"baseType": "control",
"controlType": "autocomplete",
"value": "",
"required": true,
"autocompleteParams": {
"entityType": 62
}
}