6.2.3 Uipath

Uipath definitions and example definitions are shown below. For more information on Uipath, see “Defining window URL (Uipath)”.

(Table) Uipath definitions (UI version 1.1)

Label Default value Required* Description
apiVersion: Yes API version
Specify 1.1.
kind: Yes Specify "uipath".
type: No Specify "resource".
It indicates a new definition to be added to the operational function of Ops I.
name: Yes Internal name of the Uipath definition.
"name" should follow the conventions shown below:
  • Specify the directory name of this YAML file.
  • The following characters can be entered:
    • Single-byte alphanumeric characters:
      a–z A–Z 0–9
    • Single-byte special characters:
      _ . ( ) -
  • The first character must be a single-byte alphanumeric character or an underscore (_).
  • For other precautions, see "Notes on creating YAML files" 2–4.
label: Yes Display name of the operational function to be written in the YAML file
includes: No Describe the related YAML files for use in this YAML file in an array format.
TipsTips
  • Before this YAML file is registered, the YAML file to be written to must be registered in Ops I.
  • By specifying the "includes" label, you can import information defined in another YAML file. For example, this can be used to import the YAML file for the UI that defines the UI to be displayed by the URL specified by Uipath.
- kind: Yes Type of YAML file to be loaded
  name: Yes Internal name of YAML file to be loaded
description: No Detailed description of this YAML file.
pathType: Yes Specify the type of path segment from the following.
  • static: Static path segment
  • dynamic: Dynamic path segment
path: No If pathType is set as "static", specify the value of the path segment. Cannot be left empty.
navigateTo: No Specify the components to be displayed in the uipath of this YAML file or the type and internal name of the uipath of the navigation destination.
  kind: Yes Type of YAML file for the navigation destination
"ui" or "uipath" can be specified.
  nameType: static No Navigation destination type
  • static: Display the name of the UI specified with "name" or the name of the YAML file for Uipath.
  name: Yes Specify the name of the YAML file for the UI that is to be displayed or the name of the YAML file of the Uipath for the navigation destination.
children: No Describe the child components for placement within components.
If a uipath manifest for which pathType is set as "dynamic" is specified for "children", the number of elements in the array must be one.
Example:
  • Case 1 (specifiable)
    • Uipath YAML file (pathType: static)
    • Uipath YAML file (pathType: static)
  • Case 2 (cannot be specified because "type" is mixed)
    • Uipath YAML file (pathType: static)
    • Uipath YAML file (pathType: dynamic)
  • Case 3 (cannot be specified because of multiple "type:dynamic")
    • Uipath YAML file (pathType: dynamic)
    • Uipath YAML file (pathType: dynamic)
  • Case 4 (specifiable)
    • Uipath YAML file (pathType: dynamic)
- kind: Yes Type of YAML file for use with "Include"
  name: Yes Internal name of YAML file for use with "Include"
*If a label that is not nested has its "Required" field set to "No", the definition is not required. For nested labels, the "Required" setting of a lower-level label applies only when the "Required" setting of its upper-level label is set to "Yes".

<Definition example>

---
apiVersion: 1.1
kind: uipath

## Meta data
type: resource
name: service_detail_by_id
label: "{{.Values.label}}"
description: "{{.Values.description}}"

## Dependencies
includes:
  - kind: ui
    name: service_detail_ui

pathType: dynamic
navigateTo:
  kind: ui
  nameType: static
  name: service_detail_ui