package tools

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: rpc.ConfigureToolRequest, rpc.ListToolsResponse, rpc.ResetToolsResponse, Tool, Tools

• string id = 1

  A slug identifier for this tool used to reference it regardless of the build/environment; E.g. get-order, or get-order-2

• string name = 2

  Sentence case the action name e.g "Get order"

• optional string icon = 3

  Skipped for auto generated tools

• string action_name = 4

  The action in the schema e.g "getOrder"

• repeated string api_names = 5

  The names of the APIs in which this action sits

• string model_name = 6

  The name of the model on which this tool operates on.

• proto.ActionType action_type = 7

• proto.ActionImplementation implementation = 8

• repeated RequestFieldConfig inputs = 9

• repeated ResponseFieldConfig response = 10

• optional StringTemplate title = 11

  Title of the tool. Default value: a template with the first field of the model if it's a text field, otherwise empty.

• optional StringTemplate help_text = 12

  Template language support: markdown

• string entity_single = 13

  The name of the entity associated with this tool, in a singular form (e.g. order, user). The word is lowercased; for generated tools it is the name of the model

• string entity_plural = 14

  The name of the entity associated with this tool, in a plural form (e.g. orders, users). The word is lowercased; for generated tools it is derived from name of the model

• optional Capabilities capabilities = 15

  What features are enabled for this tool

• repeated ToolLink related_actions = 16

  A list of ... list actions, aka views. E.g. For a listOrders action; these would be tabs that show filtered orders by status (Processed, Pending, Completed) For auto-generated configs, this is only populated for: - list actions, with links to other list actions for the same model. - delete actions, with links to all list actions for the same model.

• optional CursorPaginationConfig pagination = 17

  Only for List actions; Support offset and cursor

• repeated ExternalLink external_links = 18

  List of extenal links that will be displayed with this tool; used only for Get actions. Nothing for auto generated

• repeated ToolLink entry_activity_actions = 19

  Things you can do to this entry All update, deletes, creates, read and write on the same model. Only for List & Get; empty for mutations

• optional ToolLink get_entry_action = 21

  The action to use to get an entry on this model. Default to a get action on the same model Used for: - fetching the record for prefilling a mutation - the link for clicking a row in a List - the action to call after a mutation

• optional ToolLink create_entry_action = 22

  The action to use to create a new entry for this model. By default, this action link will be created for LIST and GET actions in the case where a CREATE action exists for the same model. It should be used to add a button on the tool to `Create a new/another record`

• repeated ToolGroup embedded_tools = 23

  Embeded action groups are tools that will be displayed inline (embedded) withing the one that we're defining. These tools will be rendered within this action's configuration, and can have specific config overrides.

• optional DisplayLayoutConfig display_layout = 24

  Configuration for different views that are enabled for this tool. A tool can be configured to be displayable in multiple types of views, for example, as a table, as an email inbox, or a kanban board. Each view will require specific configuration, these are supplied as part of the DisplayLayoutConfig message.

• repeated Section sections = 25

  An optional array of sections. These act as groups of response/request fields depending of the type of the action: * create/update/write actions - sections can be used to split the forms in multiple subforms * list actions - sections can be used to combine multiple fields in one column/grid * get/ read actions - sections can be used to group response fields Fields are added to sections by having their `section_name` field referencing a section's... name.

• repeated ValidationError errors = 26

  Any validation errors for this tool

• bool has_errors = 27

  Any validation errors for this tool or any child elements of this tool (e.g. an action link that has an error)

• optional FilterConfig filter_config = 28

A kanban-like board display for list views. Each item in a list will be displayed as a card within swimlanes generated by a group_by_field

Used in: DisplayLayoutConfig

• optional ToolLink get_tool = 1

  A link to a get action that will be used when the item is expanded

• optional StringTemplate title = 2

  The primary content of the card

• optional StringTemplate description = 3

  The secondary content of the card

• optional StringTemplate context_field = 4

  Content to be displayed in the right hand side of the card

• bool avatar_enabled = 5

  If an avatar/image is to be displayed with every card

• optional StringTemplate avatar_url = 6

  URL for the image.

• optional StringTemplate avatar_fallback = 7

• optional JsonPath group_by_field = 8

  The response field that will be used to group items within swimlanes

• optional ToolLink update_action = 9

  An optional update action that will be used when an item will move between swimlanes

Used in: FormatConfig

• optional string positive_colour = 1

• optional string positive_value = 2

  a string to replace the displayed value when the field is true

• optional string negative_colour = 3

• optional string negative_value = 4

  a string to replace the displayed value when the field is false

Used in: ActionConfig

• bool comments = 1

• bool audit = 2

  Export data TBC more options

Used in: NumberFormatConfig

• NONE = 0

• NORMAL = 1

• INVERTED = 2

• CUSTOM = 3

Used in: ActionConfig

• optional CursorPaginationConfig.FieldConfig start = 1

• optional CursorPaginationConfig.FieldConfig end = 2

• optional CursorPaginationConfig.PageSizeConfig page_size = 3

• optional JsonPath next_page = 4

• optional JsonPath total_count = 5

TBD

Used in: CursorPaginationConfig

• string request_input = 1

• optional JsonPath response_field = 2

Used in: CursorPaginationConfig

• string request_input = 1

• optional JsonPath response_field = 2

• optional int32 default_value = 3

DataMapping maps a response value or a scalar value to inputs. For each input's key we can have one of: - a path to a response field - a dataMapping object (for nested fields) - a scalar value

Used in: ToolLink

• string key = 1

• optional JsonPath path = 2

• repeated DataMapping object = 3

• optional ScalarValue value = 4

Used in: ActionConfig

• DisplayLayoutConfig.Type type = 1

  The type of the view: e.g. Inbox, Board, List, Calendar, Table, Data Grid

• optional InboxViewConfig inbox_config = 2

• optional BoardViewConfig board_config = 3

• optional GridViewConfig grid_config = 4

• optional RecordViewConfig record_config = 5

• optional GalleryViewConfig gallery_config = 8

• repeated ValidationError errors = 6

  Any validation errors for this display layout

• bool has_errors = 7

  Any validation errors for this display layout or any child elements of it (e.g. an action link that has an error)

Used in: DisplayLayoutConfig

• UNKNOWN = 0

• INBOX = 1

• BOARD = 2

• GRID = 3

• RECORD = 4

• GALLERY = 5

Used in: FormatConfig

• repeated EnumFormatConfig.EnumValueFormatConfig values = 1

Used in: EnumFormatConfig

• string value = 1

  the value of the enum: e.g. (for an OrderStatus) Pending/Dispatched

• optional string display_value = 2

• optional string colour = 3

• int32 display_order = 4

Used in: ActionConfig

• optional StringTemplate label = 1

• optional StringTemplate href = 2

• optional string icon = 3

• int32 display_order = 4

• optional string visible_condition = 5

  A CEL expression used to control the visibility of the link. e.g. if expression is not true then the link will be hidden.

Similar to how Tools wrap config for an action, a Field wraps the formatting config for a model or enum field.

Used in: rpc.ConfigureFieldsRequest, rpc.ConfigureFieldsResponse, rpc.ListFieldsResponse

• Field.Type type = 1

• optional FormatConfig format = 2

• optional string enum_name = 3

• optional string model_name = 4

• optional string field_name = 5

• optional string display_name = 6

• optional StringTemplate help_text = 7

• optional bool visible = 8

• optional bool image_preview = 9

Used in: Field

• MODEL = 0

• ENUM = 1

Used in: ActionConfig

• optional JsonPath quick_search_field = 1

  The field to be used a quick search. e.g. $.name.contains

Used in: Tool

• string name = 1

  Sentence case the flow name e.g "Process refund"

• string flow_name = 2

  The flow in the schema e.g "refundOrder"

• optional StringTemplate help_text = 3

  Template language support: markdown

• repeated FlowInputConfig inputs = 4

  Flow inputs, generated from the schema

• optional ToolLink completion_redirect = 5

  A tool link to which the user will be redirected after completing the flow.

• repeated ValidationError errors = 6

  Any validation errors for this tool

• bool has_errors = 7

  Any validation errors for this tool or any child elements of this tool (e.g. an action link that has an error)

• string model_name = 8

  The name of the model on which this flow tool operates on.

• optional string icon = 9

  Skipped for auto generated tools

Used in: FlowConfig

• optional JsonPath field_location = 1

  common fields with request field configs (inputs for actions)

• proto.Type field_type = 2

• bool repeated = 3

• string display_name = 4

• int32 display_order = 5

• optional StringTemplate help_text = 6

• optional ScalarValue default_value = 7

• optional StringTemplate placeholder = 8

• optional string enum_name = 9

  If `type` is set to TYPE_ENUM then this value is the name of the the enum that the type refers to.

• optional string model_name = 10

  If this field is set then this type is referring to a model. In the case of TYPE_ID this type _is_ the model named here. In the case of other types e.g. TYPE_ID this type is referencing a field on the model named here, and the specific field being referenced is indicated by `field_name`.

• optional string field_name = 11

  This field indicates which field on `model_name` this type is referencing. This field should only be set if `model_name` is set.

FormatConfig holds configuration on how a field's value should be formatted when displayed.

Used in: Field, ResponseFieldConfig

• FormatConfig.Type type = 1

• optional EnumFormatConfig enum_config = 2

• optional NumberFormatConfig number_config = 3

• optional StringFormatConfig string_config = 4

• optional BoolFormatConfig bool_config = 5

Used in: FormatConfig

• UNKNOWN = 0

• ENUM = 1

• NUMBER = 2

• STRING = 3

• BOOL = 4

A gallery view for displaying a list of images.

Used in: DisplayLayoutConfig

• optional StringTemplate title = 1

  The primary content

• optional StringTemplate description = 2

  The secondary content

• optional GalleryViewConfig.Image image = 3

  The image to be displayed.

Used in: GalleryViewConfig

• optional JsonPath file_field = 1

  The field that contains the image.

• optional StringTemplate alt = 2

  The alt text of the image.

A data-grid view, similar to a table view but providing rich editing and data manipulation features.

Used in: DisplayLayoutConfig

• optional StringTemplate title = 1

  The primary content

• optional StringTemplate description = 2

  The secondary content

• optional ToolLink update_action = 3

  The action to be used when editing rows inline.

• bool editable = 4

  If the inline editing of rows is enabled.

An email inbox style display for list views. Each item in a list will be displayed as a row with an exapandable view

Used in: DisplayLayoutConfig

• optional ToolLink get_tool = 1

  A link to a get action that will be used when the item is expanded

• optional StringTemplate title = 2

  The primary content of the row

• optional StringTemplate description = 3

  The secondary content of the row

• optional StringTemplate context_field = 4

  Content to be displayed in the right hand side of the row

• bool avatar_enabled = 5

  If an avatar/image is to be displayed with every row

• optional StringTemplate avatar_url = 6

  URL for the image.

• optional StringTemplate avatar_fallback = 7

Used in: BoardViewConfig, CursorPaginationConfig, CursorPaginationConfig.FieldConfig, CursorPaginationConfig.PageSizeConfig, DataMapping, FilterConfig, FlowInputConfig, GalleryViewConfig.Image, ProgressIndicatorConfig, RequestFieldConfig, ResponseFieldConfig, ResponseOverrides

• string path = 1

Used in: FormatConfig

• NumberFormatConfig.Mode mode = 1

• optional string currency_code = 2

  ISO 4217 codes

• optional string unit_code = 3

  Supports compound units e.g meter-per-second

• optional bool sensitive = 4

  hidden by default, hover to show

• optional string locale = 5

  Set a specific locale code. Otherwise we auto detect

• optional string prefix = 6

• optional string suffix = 7

• ConditionalFormatMode colourise = 8

Used in: NumberFormatConfig

• DECIMAL = 0

  Default to decimal

• RAW = 1

• PERCENTAGE = 2

• CURRENCY = 3

• UNIT = 4

ProgressIndicatorConfig specifies configuration for a Stepper like field

Used in: RecordViewConfig

• optional JsonPath stepper_field = 1

  Path to the response field that gives us the stepper status. The field should be an ENUM state; though the stepper could work with any other type

• repeated ProgressIndicatorConfig.Step steps = 2

  Array of steps that should be displayed

• bool enabled = 3

  If this progress indicator should be enabled or not

Used in: ProgressIndicatorConfig

• int32 display_order = 1

  Order of the step

• optional StringTemplate title = 2

  Displayable title; If not set, value will be used

• repeated string value = 3

  The values of the field which give the current state of the stepper. This is a repeated field to allow multiple values to map to the same step: e.g. For an order status * New => New * Awaiting packing || Items Picked || Packed => Processing * Handed to courier || In Transit => Shipped * Received => Completed

A display layouts for viewing db records (i.e. a get tool)

Used in: DisplayLayoutConfig

• optional ProgressIndicatorConfig progress_indicator = 1

Used in: ActionConfig

• string id = 1

• optional JsonPath field_location = 2

  common fields

• proto.Type field_type = 3

• bool repeated = 4

• string display_name = 5

• int32 display_order = 6

• bool visible = 7

• optional StringTemplate help_text = 8

• optional ToolLink lookup_action = 9

  For a relation field - A list action with the fewest required inputs on the target model Used to display a lookup/dropdown to allow selecting a entry for this field

• optional ToolLink get_entry_action = 10

  For a relation field - Used for loading a preview

• bool locked = 11

• optional ScalarValue default_value = 12

• optional StringTemplate placeholder = 13

• optional string enum_name = 14

  If `type` is set to TYPE_ENUM then this value is the name of the the enum that the type refers to.

• optional string model_name = 15

  If this field is set then this type is referring to another model. In the case of TYPE_MODEL this type _is_ the model named here. In the case of other types e.g. TYPE_ID this type is referencing a field on the model named here, and the specific field being referenced is indicated by `field_name`.

• optional string field_name = 16

  This field indicates which field on `model_name` this type is referencing. This field should only be set if `model_name` is set.

• RequestFieldConfig.ScopeType scope = 17

  The scope of the request(input) field. Not to be confused with field_type which gives us the data type, this type tells us if the input controls pagination, filters or it's a generic input field

• optional string section_name = 18

  The section field allows the grouping of inputs into sections for a leaner and better UI/UX. References a Section's name.

• optional string visible_condition = 19

  A CEL expression used to control the visibility of the field. e.g. if expression is not true then the field will be hidden.

• repeated ValidationError errors = 20

  Any validation errors for this field

• bool has_errors = 21

  Any validation errors for this field or any child elements of it (e.g. an action link that has an error)

Used in: RequestFieldConfig

• DEFAULT = 0

  Generic input fields

• PAGINATION = 1

  Fields that control pagination

• FILTERS = 2

  Fields used to filter the results of a list action (e.g. where)

• SORTING = 3

  Inputs used to control sorting of results

Used in: ActionConfig

• string id = 1

• optional JsonPath field_location = 2

• proto.Type field_type = 3

• bool repeated = 4

• string display_name = 5

  default to sentence case

• int32 display_order = 6

• bool visible = 7

• optional StringTemplate help_text = 8

• bool sortable = 9

  Based on @sortable()

• optional ToolLink link = 10

  Set if this field is a FK and link to a get/list action on the target model Or set to an appropriate list action if this field is a to-many field - for example, linking to listSaleItems(sale.id)

• bool image_preview = 11

  for file fields only, display images inline

• optional string enum_name = 12

  If `type` is set to TYPE_ENUM then this value is the name of the the enum that the type refers to.

• optional string model_name = 13

  If this field is set then this type is referring to another model. In the case of TYPE_MODEL this type _is_ the model named here. In the case of other types e.g. TYPE_ID this type is referencing a field on the model named here, and the specific field being referenced is indicated by `field_name`.

• optional string field_name = 14

  This field indicates which field on `model_name` this type is referencing. This field should only be set if `model_name` is set.

• ResponseFieldConfig.ScopeType scope = 15

  The scope of the response field. Not to be confused with field_type which gives us the data type, this type tells us if the response is part of the pagination info or a generic api result field

• optional string section_name = 16

  The section field allows the grouping of responses into sections for a leaner and better UI/UX. References a Section's name.

• optional string visible_condition = 17

  A CEL expression used to control the visibility of the field. e.g. if expression is not true then the field will be hidden.

• repeated ValidationError errors = 18

  Any validation errors for this field

• bool has_errors = 19

  Any validation errors for this field or any child elements of it (e.g. an action link that has an error)

• optional FormatConfig format = 20

  Configuration on how should this field be formatted when displayed

Used in: ResponseFieldConfig

• DEFAULT = 0

  Generic response fields (model fields, message fields)

• PAGINATION = 1

  Fields giving pagination info (e.g. cursor, pageSize, etc)

• FACETS = 2

  Fields with aggregated facet data

Used in: ToolGroup.GroupActionLink

• optional JsonPath field_location = 1

• bool visible = 2

  Controls the visibility of the response field

Used in: DataMapping, FlowInputConfig, RequestFieldConfig

• oneof value

  • string string = 1

  • int32 integer = 2

  • float float = 3

  • bool bool = 4

  • bool null = 5

    This indicates that the value is NULL

A section represents a grouping of fields.

Used in: ActionConfig

• string name = 1

  A name that's referenced by response/request fields. Acts as an ID.

• optional StringTemplate title = 2

  A title that will be displayed with this section

• optional StringTemplate description = 3

  A description for this section. Can be used to display user help text or any other copy

• int32 display_order = 4

  Ordering of sections within a tool

• optional string visible_condition = 5

  A CEL expression used to control the visibility of the whole section. e.g. if expression != true then the section will be hidden

• bool visible = 6

  If this section should be displayed or not; this superseeds the visibility condition.

Used in: FormatConfig

• optional string prefix = 1

• optional string suffix = 2

• optional bool show_url_preview = 3

• optional bool sensitive = 4

  hidden by default, hover to show

• optional string text_colour = 5

Used in: ActionConfig, BoardViewConfig, ExternalLink, Field, FlowConfig, FlowInputConfig, GalleryViewConfig, GalleryViewConfig.Image, GridViewConfig, InboxViewConfig, ProgressIndicatorConfig.Step, RequestFieldConfig, ResponseFieldConfig, Section, ToolGroup, ToolLink

• string template = 1

  e.g. "{{$.firstName}} {{$.lastName}}" template syntax TBC.

• bool markdown = 2

  If markdown is supported for this template. e.g. Italic text: _{{$.Var}}_

Used in: rpc.ConfigureToolRequest, rpc.ConfigureToolResponse, rpc.DuplicateToolResponse, rpc.ListToolsResponse, rpc.ResetToolsResponse, Tools

• string id = 1

  A slug identifier for this tool used to reference it regardless of the build/environment; E.g. get-order, or get-order-2

• Tool.ToolType type = 2

• optional ActionConfig action_config = 3

• optional FlowConfig flow_config = 4

Used in: Tool

• ACTION = 0

• FLOW = 1

Used in: ActionConfig

• string id = 1

  A reference that persists for this tool group from build to build

• optional StringTemplate title = 2

  Title of the group

• int32 display_order = 3

• repeated ToolGroup.GroupActionLink tools = 4

  A list of decorated ActionLinks which will be embedded within this group

• bool visible = 5

• repeated ValidationError errors = 7

  Any validation errors for this group

• bool has_errors = 8

  Any validation errors for this group or any child elements of it (e.g. an action link that has an error)

When embedding ToolLinks, we need to provide extra-configuration that will override the link's target tool configuration

Used in: ToolGroup

• optional ToolLink action_link = 1

• repeated ResponseOverrides response_overrides = 2

  The config for responses of the target tool for this embedded action can be altered for this embed group

Used in: ActionConfig, BoardViewConfig, FlowConfig, GridViewConfig, InboxViewConfig, RequestFieldConfig, ResponseFieldConfig, ToolGroup.GroupActionLink

• string tool_id = 2

• repeated DataMapping data = 3

  The shape of this data is the input for the target action (i.e. 'where' and not 'values') but with JSON paths for field values. Is a full object tree e.g. { "where": { "id": "$.id" // JSON path on the current action repsonse. Can be recursive } }

• optional StringTemplate title = 4

  Title/label to be displayed as part of the link/button created for this action link.

  Empty by default

• optional StringTemplate description = 5

  An optional string template which is to be displayed as a description/tagline for this link.

  Empty by default

• int32 display_order = 6

  When the link is used within a list of action links, this field will be used to order items.

• optional bool as_dialog = 7

  If this link should be opened up as a dialog/modal.

• optional string visible_condition = 8

  A CEL expression used to control the visibility of the action link. e.g. if expression is not true then the link will be hidden.

• repeated ValidationError errors = 9

  Any validation errors if

• optional bool skip_confirmation = 10

  If true, actions that have no inputs (or all inputs have values from the data mapping) will trigger without confirmation. Only applicable to mutation actions

• optional bool emphasize = 11

  If true, the action link will be displayed with emphasis to make as a primary action

Tools is a wrapper for a collection of action configs/tools

• repeated ActionConfig tools = 1

• repeated Tool configs = 2

Used in: ActionConfig, DisplayLayoutConfig, FlowConfig, RequestFieldConfig, ResponseFieldConfig, ToolGroup, ToolLink

• string error = 1

  A human friendly error message; e.g.: `The target tool does not exist.`

• string field = 2

  The field that is invalid: e.g. `tool_id` for a missing link's target tool.