6.11 Application

Application definitions and definition examples are shown below. For details on Application, see “Application”.

(Table) Application definitions

Label Default value Required* Description
apiVersion: Yes API version
Specify 1.0.
kind: Yes Specify "application".
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 Application 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 List the related YAML files for use in this YAML file.
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 GUI to be displayed.
- kind: Yes Type of YAML file to be loaded
  name: Yes Internal name of the YAML file to be loaded
description: No Detailed description for this YAML file
This can be written using the template function.
link: One of these is required Hyperlink for this application icon
tabs: Tabs for this application
- name: No Name of this tab
  label: Yes Display name of this tab
This can be written using the template function.
  description: No Explanation of this tab
This can be written using the template function.
  ui: One of these is required Name of the UI definition.
UI definitions must be specified in advance with an "includes" label.
The UI definition that can be specified is UI version 1.0 only. It is recommended to use uipath to specify the windows to be displayed in the tab.
  uipath: Name of the Uipath definition
Uipath definitions must be specified in advance with an "includes" label.
  visible: true No Display settings of this tab
  • true: Display
  • false: Not displayed
If false is specified, the items included in this tab are also not displayed.
  items: No Displays application tabs in a drop-down list. items cannot be nested.
  - name: No Name of the item
    label: Yes Display name of the item
    description: No Item description
    uipath: Yes Name of the Uipath definition
Uipath definitions must be specified in advance with an "includes" label.
    visible: Yes Sets whether to display this item
  • true: Display
  • false: Not displayed
icon: true No Icon for this application
Can be specified from the following Material icons.
https://v5.mui.com/material-ui/material-icons/
Example: AccountBalance
order: 9999 No Application order
Specify an integer between 1 and 9999, and the applications are displayed in ascending order.
However, A value of 0 in the first place is used internally by Ops I, so do not specify this value.
*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".

(Table) Value of Application order initially registered in Ops I

Name Value of "order"
Request 150
Task 200
Document 400
System 900
Git 1000
Secret 1100
ITSM 1200
Automation 1300
Site 1400
Manual 9000

<Definition example>

apiVersion: 1.0
kind: application
type: resource
name: ledger_mgt
label: Ledger management
description: Confirmation of the ledger to be managed
icon: LibraryBooks
order: 955

includes:
  - kind: ui
    name: display_lend_vm_info_ui
    
tabs:
  - name: display_lend_vm_info
    label: VM lending ledger
    description: Displays a list of VM lending ledgers.
    ui: display_lend_vm_info_ui