View Schema

The following table provides the list of view schemas used in Action Orchestrator.

S.NoNameTypeDescription

1

title

String

The title keyword specifies label for the UI field.

2

type

String

The type keyword specifies type for the UI field.

3

Component

String

The component keyword specifies type of UI component for the field.

4

required

Array

The required keyword specifies all the required fields in the form

5

format

String

It is used to parsed the field value based on specified format. For example, date, time, date-time, and so forth.

6

maxlength

Integer

The maxLength keyword specifies maximum number of characters allowed for the field.

7

minlength

Integer

The minLength keyword specifies minimum number of characters allowed for the field.

8

maximum

Integer

The maximum keyword specifies maximum value allowed for the field.

9

minimum

Integer

The minimum keyword specifies minimum value allowed for the field.

10

lhv_clearable

Boolean

The lhv_clearable keyword is used to specify whether the select component is clearable or not.

11

lhv_inline

Boolean

The lhv_inline keyword is used to render title and component in same line.

12

lhv_inlineToNext

Boolean

The lhv_inlineToNext keyword is used to render multiple fields in same line.

13

lhv_inlinehideTitle

Boolean

The lhv_inlinehideTitle keyword specifies to hide the title for the UI field.

14

lhv_placeholder

String

The lhv_placeholder keyword specifies placeholder text for the UI field.

15

lhv_section

String

The lhv_section keyword specifies the section to which UI field belongs to.

16

lhv_width

String

The lhv_width keyword specifies the width of UI field.

17

lhv_mindate

String

The lhv_minDate keyword specifies the minimum Date for Calendar component. The value shoudld be in ISO string format.

18

lhv_maxdate

String

The lhv_maxDate keyword specifies the maximum Date for the Calendar component. The value shoudld be in ISO string format.

19

lhv_position

Integer

The lhv_position keyword specifies the position of UI field in the form.

20

lhv_maxfiles

Integer

The lhv_maxFiles keyword specifies maximum number of files a user can upload using uploadfile component.

21

lhv_maxFileSize

Integer

The lhv_maxFileSize keyword specifies the maximum file size in bytes.

22

lhv_minFileSize

Integer

The lhv_minFileSize keyword specifies the minimum file size in bytes.

23

lhv_options

Array

The lhv_options keyword specifies the list of options for the select component.

24

lhv_editorTypes

Array

The lhv_editorTypes keyword used to specify the types supported by editor component.

25

lhv_optionsDynamicRef

Object

The lhv_optionsDynamicRef keyword specifies the properties and information needed to generate options asynchronously.

26

lhv_filterBy

Object

The lhv_filterBy keyword specifies dynamic filter attributes to filter options.

27

lhv_invisible

String

The lhv_invisible keyword specifies whether to hide the UI field from formOnly or formAndData.

28

lhv_renderAs

String

The lhv_renderAs keyword specifies to render field value as plain text or link or as count in ListWithModal component.

29

lhv_multiSelect

Boolean

The lhv_multiSelect keyword specifies to render dropdown as a multiselect.

30

lhv_subTitle

String

The lhv_subTitle keyword specifies subtitle for the picker component.

31

lhv_subTitlePosition

String

The lhv_subTitlePosition keyword specifies position of subtitle in picker component.

32

lhv_disabled

Boolean

The lhv_disabled keyword used to disabled the field.

33

lhv_variable

String

The lhv_variable keyword specifies that a field is variable referenceable.

34

lhv_varTypeAnyOf

Array

The lhv_varTypeAnyOf keyword specifies types of variable a field can accept.

35

lhv_help

String

The lhv_help keyword specifies additional information related to UI field.

36

lhv_table

Boolean

The lhv_table keyword specifies outout variable is of type table.

37

lhv_accessColumnsFrom

String

The lhv_accessColumnsFrom keyword specifies the field name from which UI field should get the columns from.

38

lhv_margin

String

The lhv_margin keyword specifies the margin for the UI field.

39

lhv_pattern

String

The lhv_pattern keyword specifies the pattern name for the field, against which field value will get validated.

40

lhv_trimWhiteSpaces

String

The lhv_trimWhiteSpaces keyword specifies the position from which white spaces should be trimmed.

title

Type - The value of this keyword is a String.

Description The title keyword specifies label for the UI field.

Possible Values Value should be defined by user.

type

Type - The value of this keyword is a String.

Description The type keyword specifies type for the UI field.

Possible Values string, number, integer, boolean, object, and array.

String Example

If the field type is string then the value generated will be string.

Schema

{ 1 item
   "display_name" : { 1 item
    "type" : string "string"
  }
}

Payload

{ 1 item
 "display_name" : string "New Workflow"
}

Number Example:

If the field type is number then the value generated will be number.

Schema

{ 1 item
   "total" : { 1 item
    "type" : string "number"
  }
}

Payload

{ 1 item
 "total" : float 20.35
}

Integer Example:

If the field type is integer then the value generated will be integer.

Schema

{ 1 item
   "timeout" : { 1 item
    "type" : string "integer"
  }
}

Payload

{ 1 item
 "total" : int 5
}

Boolean Example

If the field type is integer then the value generated will be Boolean.

Schema

{ 1 item
   "isRequired" : { 1 item
    "type" : string "boolean"
  }
}

Payload

{ 1 item
 "isRequired" : bool true
}

Object Example

If the field type is integer then the value generated will be object.

Schema

{ 1 item
   "employee_details" :{ 3 items
    "type" : string"object"
    "title" : string"Employee Details"
      "properties" : { 2 items
         "name" : { 2 items
          "type" : string"string"
          "title" : string"Employee Name"
        }
         "id":{2 items
          "type":string"number"
          "title":string"Employee Id"
        }
     }
  }
}

Payload

{ 1 item
   "employee_details" : { 2 items
    "id" : int 1
    "name" : string "Brown"
  }
}

Array Example

If the field type is array then the value generated will be either array of string or array of objects depending on the schema. Below sample json is for array of objects.

Schema

{ 1 item
   "queries" : { 4 items
    "type" : string "array"
    "title" : string "Json Queries"
    "component" : string "list"
      "items" : { 2 items
       "type" : string"object"
         "properties" : { 2 items
            "query_name" : { 2 items
             "type" : string "string"
             "title" : string "Query Name"
           }
            "query_type" : { 2 items
             "type" : string "string"
             "title" : string "Data Type"
           }
       }
    }
}

Payload

{ 1 item
   "queries" : [ 2 items
      0 : { 2 items
        "query_name" : string "Name"
        "query_type" : string "string"
     }
      1 : { 2 items
       "query_name" : string "Id"
       "query_type" : string "integer"
     }
  ]
}

Component

Type - The value of this keyword is a String.

Description The component keyword specifies type of UI component for the field.

Possible Values string, number, integer, boolean, checkbox, radio, textarea, password, picker, switch, objectComponent, list, propertylist, dynamiclist, horizontallist, editor, calendar, uploadfile, and daterange.

String Component Example

If the component is string then input field of type text is rendered.

Schema

{ 1 item
   "display_name" : { 2 items
    "type" : string "string"
    "component" : string "string"
  }
}

Preview


If user want to render a text input then no need to explicitly mention component in schema. Longhorn UI will render text input by default if field type is string.

Number Component Example

If the component is number then input field of type number is rendered.

Schema

{ 1 item
   "total" : { 2 items
    "type" : string "number"
    "component" : string "number"
  }
}

Preview


If user want to render a number input then no need to explicitly mention component in schema. Longhorn UI will render number input by default if field type is number.

Integer Component Example

If the component is integer then input field of type number is rendered.

Schema

{ 1 item
   "timeout" : { 2 items
    "type" : string "integer"
    "component" : string "integer"
  }
}
Preview


If user want to render a integer input then no need to explicitly mention component in schema. Longhorn UI will render integer input by default if field type is integer. Difference between number and integer component is in integer component you cannot enter decimal numbers where as in number component you can.

Boolean Example

If the component is Boolean then a drop down component will be render with TRUE/FALSE option.

Schema

{ 1 item
   "isRequired" : { 2 items
    "type" : string "boolean"
    "component" : string "boolean"
  }
}
Preview

Boolean Component 

Checkbox Example

Checkbox component is used for Boolean type fields.

Schema

{ 1 item
   "is_required" :{ 2 items
    "type" : string"boolean"
    "component" : string"checkbox"
  }
}
Preview

Checkbox Component 

Radio Example

Radio component is used for Boolean type fields.

Schema

{ 1 item
   "is_required" : { 2 items
    "type" : string "boolean"
    "component" : string "radio"
  }
}
Preview

Radio Component

If radio component is configured with lhv_options then Longhorn UI will render it as a radio group else it will be rendered as independent radio component.

TextArea Example

TextArea component is used when the value of the field is paragraph.

Schema

{ 1 item
   "description" : { 2 items
    "type" : string "string"
    "component" : string "textarea"
  }
}
Preview

TextArea Component 

Password Example

Password component is used for secret values like accessKeys or User Password.

Schema

{ 1 item
   "access_key" : { 2 items
    "type" : string "string"
    "component" : string "password"
  }
}
Preview

Password Component

Picker Example

Picker component is used for number type fields. It extends Number component API and provides more features and behavior.

Schema

{ 1 item
   "total" : { 2 items
    "type" : string "string"
    "component" : string "picker"
  }
}
Preview

Picker Component

Switch Example

Switch component is used for Boolean type fields.

Schema

{ 1 item
   "total" : { 2 items
    "type" : string "boolean"
    "component" : string "switch"
  }
}
Preview

Switch Component

Object Example

Object component is used if user wants to render payload in object format.

Schema

{ 1 item
   "employee" : { 3 items
    "type" : string "object"
    "component" : string "objectComponent"
      "properties" : { 2 items
         "name" : { 2 items
          "type" : string "string"
          "lhv_margin" : string "0px 0px 0px 20px"
        }
         "id" : { 2 items
          "type" : string "integer"
          "lhv_margin" : string "0px 0px 0px 20px"
        }
     }
  }
}
Preview

Object Component

List Example

List component is used for array type fields.

Schema

{ 1 item
   "employees" : { 3 items
    "type" : string "array"
    "component" : string "list"
      "items" : { 2 items
       "type" : string "object"
         "properties" : { 2 items
            "name" : { 2 items
             "type" : string "string"
             "title" : string "Name"
           }
            "id" : { 2 items
             "type" : string "integer"
             "title" : string "Id"
           }
       }
    }
  }
}
Preview

List Component

Preview

List Component with add new

Property List Example

Property List component is used for array type fields.

Schema

{ 1 item
   "employees" : { 3 items
    "type" : string "array"
    "component" : string "propertylist"
      "items" : { 2 items
       "type" : string "object"
         "properties" : { 2 items
            "name" : { 1 item
             "type" : string "string"
           }
            "id" : { 2 item
             "type" : string "integer"
           }
        }
     }
   }
}
Preview

Property List Component

Dynamic List Example

Dynamic List component is used for array type fields.

Schema

{ 1 item
   "employees" : { 3 items
    "type" : string "array"
    "component" : string "dynamiclist"
      "items" : { 2 items
       "type" : string "object"
         "properties" : { 2 items
            "name" : { 1 item
             "type" : string "string"
           }
            "id" : { 2 item
             "type" : string "integer"
           }
        }
     }
   }
}

Its another way of representation in UI for array of objects field.

Preview

Dynamic List Component

Horizontal List Example

Horizontal List component is used for array type fields.

Schema

{ 1 item
   "date_list" : { 3 items
    "type" : string "array"
    "component" : string "propertylist"
      "items" : { 2 items
       "type" : string "string"
       "component" : string "calendar"
     }
  }
}

Its another way of representation in UI for array of strings field.

Preview

Horizontal List Component

Editor Example

Editor component is used to render text editor in UI.

Schema

{ 1 item
   "response" : { 4 items
    "type" : string "string"
    "component" : string "editor"
       "lhv_editorTypes" : [ 2 items
        0 : string "XML"
        1 : string "JSON"
     ]
     "title" : string "API Response"
  }
}

By default editor component support JSON, TEXT, XML and HTML editorTypes. If user want to render specific type of editor then set the component value to any of ['json', 'xml', html]. In addition, user can render editor with set of editorTypes by using lhv_editorTypes keyword in schema.

Preview

Editor Component

Calendar Example

Calendar component is used to render DatePicker in UI.

Schema

{ 1 item
   "start_date" : { 4 items
    "type" : string "string"
    "component" : string "calendar"
    "lhv_format" : string "date"
    "title" : string "Start Date"
  }
}

By default calendar component support MM/DD/YYYY dateFormat and it is non-editable. User can set maxDate and minDate using lhv_maxDate and lhv_minDate keywords and its value should be in ISO format. For date fields user must set lhv_format keyword to date in schema.

Preview

Calendar Component

Upload File Example

Upload File component is used to upload the file content. It is commonly used to upload certificate keys.

Schema

{ 1 item
   "key" : { 2 items
    "type" : string "string"
    "component" : string "uploadfile"
  }
}

This component can be configured using following keys: lhv_acceptedType, lhv_isMultiple, lhv_maxFiles, lhv_maxFileSize lhv_minFileSize.

Preview

Upload File Component

Date Range Example

Date Range component is used to specify start date and end date.

Schema

{ 1 item
   "date_range" : { 4 items
    "type" : string "object"
    "title" : string "Date Range"
    "component" : string "daterange"
      "properties" : { 2 items
         "start_date" : { 2 items
          "type" : string "string"
          "component" : string "calendar"
        }
         "end_date" : { 2 items
          "type" : string "string"
          "component" : string "calendar"
        }
     }
  }
}

This component is only supported for object types fields with start-date and end-date properties.

Preview

Date Range Component

required

Type - The value of this keyword is an Array.

Description The required keyword specifies all the required fields in the form.

Possible Values any required field name.

Required Example

In below schema display name is marked as required.

Schema

{ 2 items
   "required" : { 1 item
    0 : string "display_name"
  ]
   "properties" : { 2 items
      "display_name" : { 2 items
       "type" : string "string"
       "maxLength" : int 30
     }
      "description" : { 1 item
       "type" : string "string"
     }
   }
}

UI will throw validation message if form is submitted with empty values for required field.

Preview

Required field

format

Type - The value of this keyword is an String.

Description It is used to parsed the field value based on specified format. Eg: date, time, date-time, and so forth.

Possible Values date, date-time, ipv4, ksuid, lgh-time, time, email, lgh-hostname.

maxlength

Type - The value of this keyword is an Integer.

Description The maxLength keyword specifies maximum number of characters allowed for the field.

Possible Values nonNegative integers.

Maximum Length Example

maxLength is applicable only for string type fields. It is used for Form validation.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "maxLength" : int 30
  }
}

minlength

Type - The value of this keyword is an Integer.

Description The minLength keyword specifies minimum number of characters allowed for the field.

Possible Values - nonNegative integers.

Minimum Length Example

minLength is applicable only for string type fields. It is used for Form validation.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "minLength" : int 2
  }
}

maximum

Type - The value of this keyword is an Integer.

Description The maximum keyword specifies maximum value allowed for the field.

Possible Values - nonNegative integers.

Maximum Example

Maximum is applicable only for integer and number type fields. It is used for Form validation.

Schema

{ 1 item

   "count" : { 2 items
    "type" : string "number"
    "maximum" : int 100
  }
}

minimum

Type - The value of this keyword is an Integer.

Description - The minimum keyword specifies minimum value allowed for the field.

Possible Values - nonNegative integers.

Minimum Example

Minimum is applicable only for integer and number type fields. It is used for Form validation.

Schema

{ 1 item

   "count" : { 2 items
    "type" : string "number"
    "minimum" : int 1
  }
}

lhv_clearable

Type - The value of this keyword is a Boolean.

Description - The lhv_clearable keyword is used to specify whether the select component is clearable or not.

Possible Values TRUE, FALSE.

Clearable Example

If the value is set to true then the selected option can be cleared.

Schema

{ 1 item

   "category" : { 4 items
    "type" : string "string"
    "lhv_clearable" : bool true
    "component" : string "select"
      "options" : { 1 item
         0 : { 2 items
          "label" : string "cisco"
          "value" : string "cisco"
        }
     ]
  }
}

lhv_inline

Type - The value of this keyword is a Boolean.

Description - The lhv_inline keyword is used to render title and component in same line.

lhv_inlineToNext

Type - The value of this keyword is a Boolean.

Description - The lhv_inlineToNext keyword is used to render multiple fields in same line.

Possible Values - TRUE, FALSE.

Inline To Next Example

lhv_inlineToNext is used to render multiple form fields in single line.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "lhv_inlineToNext" : bool true
  }
}

lhv_inlinehideTitle

Type - The value of this keyword is a Boolean.

Description - The lhv_hideTitle keyword specifies to hide the title for the UI field.

Possible Values - TRUE, FALSE.

Hide Title Example

lhv_hideTitle is used to hide title for the respective field in UI.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "lhv_hideTitle" : bool true
  }
}

lhv_placeholder

Type - The value of this keyword is a String.

Description - The lhv_placeholder keyword specifies placeholder text for the UI field.

Placeholder Example

lhv_placeholder specifies a short hint that describes the expected value of an input field.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "lhv_placeholder" : string "Display Name"
  }
}

The placeholder attribute works with the following input types: text, search, url, tel, email, and password.

lhv_section

Type - The value of this keyword is a String.

Description The lhv_section keyword specifies the section to which UI field belongs to.

Section Example

lhv_section is used to group common behavior fields.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "lhv_section" : string "Variable"
  }
}

If lhv_section keyword is not specified in schema then by default Longhorn UI add the field to General section.

lhv_width

Type - The value of this keyword is a String.

Description The lhv_width keyword specifies the width of UI field.

Width Example

lhv_width is used to configure width of the field.

Schema

{ 1 item

   "display_name" : { 2 items
    "type" : string "string"
    "lhv_width" : string "medium"
  }
}

xsmall will be of 32px, small will be of 128px, medium will be of 160px, large will be of 256px and extraLarge will be of 400px.

lhv_mindate

Type - The value of this keyword is a String.

Description The lhv_minDate keyword specifies the minimum Date for Calendar component. The value should be in ISO string format.

Possible Values 2018-08-10T12:00:00.000Z

Minimum Date Example

It is used to configure calendar component.

Schema

{ 1 item

   "start_date" : { 3 items
    "type" : string "string"
    "component" : string "calendar"
    "lhv_minDate" : string "2018-08-10T12:00:00.000Z"
  }
}

Applicable only for calendar component.

lhv_maxdate

Type - The value of this keyword is a String.

Description The lhv_maxDate keyword specifies the maximum Date for the Calendar component. The value shoudld be in ISO string format.

Possible Values - 2019-05-19T12:00:00.000Z

Maximum Date Example

It is used to configure calendar component.

Schema

{ 1 item

   "start_date" : { 3 items
    "type" : string "string"
    "component" : string "calendar"
    "lhv_maxDate" : string "2019-05-19T12:00:00.000Z"
  }
}

Applicable only for calendar component.

lhv_position

Type - The value of this keyword is a Integer.

Description The lhv_position keyword specifies the position of UI field in the form.

Possible Values - nonNegative integers.

lhv_maxfiles

Type - The value of this keyword is an Integer.

Description The lhv_maxFiles keyword specifies maximum number of files a user can upload using uploadfile component.

Possible Values - nonNegative integers.

Maximum Files Example

It is used to configure uploadfile component.

Schema

{ 1 item

   "key" : { 3 items
    "type" : string "string"
    "component" : string "uploadfile"
    "lhv_maxfiles" : string "int 1"
  }
}

Applicable only for uploadfile component.

lhv_maxFileSize

Type - The value of this keyword is an Integer.

Description The lhv_maxFileSize keyword specifies the maximum file size in bytes.

Possible Values - nonNegative integers.

Maximum File Size Example

It is used to configure uploadfile component.

Schema

{ 1 item

   "key" : { 3 items
    "type" : string "string"
    "component" : string "uploadfile"
    "lhv_maxFileSize" : int 10000
  }
}

Applicable only for uploadfile component.

lhv_minFileSize

Type - The value of this keyword is an Integer.

Description The lhv_minFileSize keyword specifies the minimum file size in bytes.

Possible Values - nonNegative integers.

Minimum File Size Example

It is used to configure uploadfile component.

Schema

{ 1 item

   "key" : { 3 items
    "type" : string "string"
    "component" : string "uploadfile"
    "lhv_minFileSize" : int 10000
  }
}

Applicable only for uploadfile component.

lhv_options

Type - The value of this keyword is an Array.

Description The lhv_options keyword specifies the list of options for the select component.

Possible Values - array of objects with label value attributes.

Options Example

It is used to configure select component.

Schema

{ 1 item

   "Category" : { 3 items
    "type" : string "string"
    "component" : string "select"
      "lhv_options" : [ 2 items
         0 : { 2 items
          "label" : string "Cisco"
          "value" : string "cisco"
        }
         1 : { 2 items
          "label" : string "Amazon"
          "value" : string "amazon"
        }
    ]
  }
}

Payload

{ 1 item

   "category" : string "cisco"
}

Applicable only for select component.

lhv_editorTypes

Type - The value of this keyword is an Array.

Description The lhv_editorTypes keyword used to specify the types supported by editor component.

Possible Values - json, xml, and html.

Editor Types Example

It is used to configure editor component.

Schema

{ 1 item

   "Category" : { 3 items
    "type" : string "string"
    "component" : string "editor"
      "lhv_editorTypes" : [ 2 items
         0 : string "json"
         1 : string "xml"
     ]
  }
}

Payload

{ 1 item

   "response" : { 1 item
    "description : string "hello Longhorn user"
  }
}

Applicable only for editor component.

lhv_optionsDynamicRef

Type - The value of this keyword is an Object.

Description The lhv_optionsDynamicRef keyword specifies the properties and information needed to generate options asynchronously.

Options Dynamic Reference Example

It is used to configure select component asynchronously.

Schema

{ 1 item

   "swager_url" : { 3 items
    "type" : string "string"
    "component" : string "select"
      "lhv_optionsDynamicRef" : { 4 items
       "endpoint" : string "invoke_adapter"
       "valuekey" : string "id"
       "labelkey" : string "name"
         "payload" : { 1 item
            "properties" : { 1 item
             "api_method" : string "web-service.swagger_verify_request"
           }
        }
     }
  }
}

Payload

{ 1 item

   "swager_url" : { 0 items
  }
}

Applicable only for select component.

lhv_filterBy

Type - The value of this keyword is an Object.

Description The lhv_filterBy keyword specifies dynamic filter attributes to filter options.

Possible Values - Its an object type with filterkey and filterValue

FilterBy with static filterValue Example

It is used to configure select component.

Schema

{ 1 item

   "target_id" : { 4 items
    "type" : string "string"
    "component" : string "select"
      "lhv_optionsDynamicRef" : { 1 item
       "endpoint" : string "targets"
     }
      "lhv_filterBy" : { 2 items
       "filterkey" : string "type"
       "filterValue" : string "target.meraki"
     }
  }
}

Applicable only for asynchronous select component.

FilterBy with dynamic filterValue Example

It is used to configure select component.

Schema

{ 1 item

   "target_id" : { 4 items
    "type" : string "string"
    "component" : string "select"
      "lhv_optionsDynamicRef" : { 1 item
       "endpoint" : string "targets"
     }
      "lhv_filterBy" : { 2 items
       "filterkey" : string "type"
       "filterValue" : string "$schema.access_meta.targets[].type$"
     }
  }
}

filterValue can be a defined dynamically to get the value from same schema properties or accessMeta info. In Below sample schema, filterValue instructs the UI component to filter the target list based on current schema accessMeta targets type.

lhv_invisible

Type - The value of this keyword is a String.

Description The lhv_invisible keyword specifies whether to hide the UI field from formOnly or formAndData.

Possible Values - formAndData, formOnly.

formAndData Example

It will hide the field from form and data.

Schema

{ 1 item

   "properties" : { 1 item
      "no_runtime_user" : { 4 items
       "type" : string "boolean"
       "component" : string "checkbox"
       "default" : bool true
       "lhv_invisible" : string "formAndData"
     }
  }
}

Payload

{ 1 item

   "properties" : { 0 items
  }
}

formOnly Example

It will hide the field from form only, but keeps its value in payload.

Schema

{ 1 item
   "properties" : { 1 item
      "no_runtime_user" : { 4 items
       "type" : string "boolean"
       "component" : string "checkbox"
       "default" : bool true
       "lhv_invisible" : string "formAndData"
     }
  }
}

Payload

{ 1 item

   "properties" : { 1 item
   "no_runtime_user" : bool true
  }
}

lhv_renderAs

Type - The value of this keyword is a String.

Description -The lhv_renderAs keyword specifies to render field value as plain text or link or as count in ListWithModal component.

Possible Values - data, link, and count.

RenderAs Example

It is used to configure cell values in ListWithModal component. Each cell value can be render as normal data(text) or as a link to edit the row or as a count.

Schema

{ 1 item
   "properties" : { 1 item
      "queries" : { 4 items
       "type" : string "array"
       "title" : string "Json Queries"
       "component" : string "listwithmodal"
         "items" : { 2 items
          "type" : string "object"
            "properties" : { 3 items
               "query_name" : { 3 items
               "type" : string "string"
               "title" : string "Query Name"
               "lhv_renderAs" : string "link"
              }
               "query_type" : { 3 items
                "type" : string "string"
                "title" : string "Data Type"
                "lhv_renderAs" : string "data"
              }
               "options" : { 4 items
                "type" : string "array"
                "component" : string "dynamiclist"
                "lhv_renderAs" : string "count"
                  "items" : { 2 items
                   "type" : string "object"
                     "properties" : { 2 items
                        "key" : { 1 item
                         "type" : string "string"
                       }
                        "value" : { 1 item
                        "type" : string"string"
                       }
                    }
                 }
              }
           }
        }
      }
   }
}

Applicable only for listwithmodal component

lhv_multiSelect

Type - The value of this keyword is a Boolean.

Description -The lhv_multiSelect keyword specifies to render drop down as a multiselect.

Possible Values - TRUE, FALSE.

Multi Select Example

It is use to configure select dropdown to enable multiple selection.

Schema

{ 1 item
   "categories" : { 4 items
    "type" : string "array"
    "component" : string "select"
    "lhv_multiSelect" : booltrue
      "lhv_options" : [ 2 items
         0 : { 2 items
          "label" : string "Cisco" 
          "value" : string "cisco"
        }
         1 : { 2 items
          "label" : string "Amazon"
          "value" : string "amazon"
        }
     ]
  }
}

Applicable only for select component.

lhv_subTitle

Type - The value of this keyword is an String.

Description -The lhv_subTitle keyword specifies subtitle for the picker component.

Sub Title Example

lhv_subTitle keyword is used to configure number or picker components.

Schema

{ 1 item
   "interval_hours" : { 3 items
    "type" : string "integer"
    "component" : string "picker"
    "lhv_subTitle" : string "HRS"
  }
}

Applicable only for number/integer and picker component.

lhv_subTitlePosition

Type - The value of this keyword is a String.

Description -The lhv_subTitlePosition keyword specifies position of subtitle in picker component.

Possible Values - right and left.

Sub Title Position Example

lhv_subTitlePosition keyword is used to configure number or picker components.

Schema

{ 1 item
   "interval_hours" : { 4 items
    "type" : string "integer"
    "component" : string "picker"
    "lhv_subTitle" : string "HRS"
    "lhv_subTitlePosition" : string "right"
  }
}

Applicable only for number/integer and picker component.

lhv_disabled

Type - The value of this keyword is a Boolean.

Description -The lhv_disabled keyword used to disabled the field.

Possible Values TRUE and FALSE.

Disabled Example

lhv_disabled keyword is used to disabled UI field.

Schema

{ 1 item
   "display_name" : { 2 items
    "type" : string "string"
    "lhv_disabled" : bool true
  }
}

Applicable to all UI fields.

lhv_variable

Type - The value of this keyword is a String.

Description -The lhv_variable keyword specifies that a field is variable reference-able.

Possible Values onlyVariable, onlyVariables, and variableAndInput.

Only Variable Example

If a field has lhv_variable set to onlyVariable then Longhorn UI will allow user to refer only single variable and restrict the user from inputting any plain text.

Schema

{ 1 item
   "subject" : { 2 items
    "type" : string "string"
    "lhv_variable" : string "onlyVariable"
  }
}

Applicable only for primitive type fields.

Only Variables Example

If a field has lhv_variable set to onlyVariable then Longhorn UI will allow user to refer multiple variable and restrict the user from inputting any plain text.

Schema

{ 1 item
   "subject" : { 2 items
    "type" : string "string"
    "lhv_variable" : string "onlyVariables"
  }
}

Applicable only for primitive type fields.

Variable and Input Example

If a field has lhv_variable set to variableAndInput then Longhorn UI will allow user to refer variables and input any plain text.

Schema

{ 1 item
   "subject" : { 2 items
    "type" : string "string"
    "lhv_variable" : string "variableAndInput"
  }
}

Applicable only for primitive type fields.

lhv_varTypeAnyOf

Type - The value of this keyword is an Array.

Description -The lhv_varTypeAnyOf keyword specifies types of variable a field can accept.

Possible Values string, number, integer, boolean, secure_string, array, and table.

Variable Type Any Of Example

In below schema subject field can refer string, number, integer, secure_string type variables.

Schema

{ 1 item
   "subject" : { 3 items
    "type" : string "string"
    "lhv_variable" : string "VariableAndInput"
      "lhv_varTypeAnyOf" : [ 5 items
       0 : string "string"
       1 : string "number"
       2 : string "boolean"
       3 : string "integer"
       4 : string "secure_string"
    ]
  }
}

Appliable only for primitive type fields.

lhv_help

Type - The value of this keyword is a String.

Description -The lhv_help keyword specifies additional information related to UI field.

lhv_table

Type - The value of this keyword is a Boolean.

Description -The lhv_table keyword specifies outout variable is of type table.

lhv_accessColumnsFrom

Type - The value of this keyword is a String.

Description -The lhv_accessColumnsFrom keyword specifies the field name from which UI field should get the columns from.

lhv_margin

Type - The value of this keyword is a String.

Description -The lhv_margin keyword specifies the margin for the UI field.

lhv_pattern

Type - The value of this keyword is a String.

Description -The lhv_pattern keyword specifies the pattern name for the field, against which field value will get validated.

lhv_trimWhiteSpaces

Type - The value of this keyword is a String.

Description -The lhv_trimWhiteSpaces keyword specifies the position from which white spaces should be trimmed.

integer



  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved