6.8 Distribution

Distribution definitions and definition examples are shown below. For details on Distribution, see “Storing documents”.

(Table) Distribution definitions

Label Default value Required* Description
apiVersion: Yes API version
Specify 1.0.
kind: Yes Specify "distribution".
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 Distribution 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: No 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.
- 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
rules: Yes Distribution rules
- name: Yes Rule name
  label: Yes Rule display name
  group: Yes Configure settings for the group to be distributed to.
type: Yes Specify rules to determine the group to which the document will be distributed. The types that can be specified are as follows.
  • fixed:
    All documents are saved in a fixed group.
  • customer:
    Documents are saved to the group with the same name as the customer name.
    However, if a non-customer user attaches a file to a workflow, this rule will not apply and another rule will be applied according to priority.
Regardless of the specified type, create the group to which the document will be distributed in advance.
name: No Specify the group name to be stored when "fixed" is specified for the type.
  repository: Yes Configure settings for the repository to be distributed to.
type: Yes Specify rules to determine the repository in which the document will be stored. The types that can be specified are as follows.
  • fixed:
    All documents are saved in a fixed repository.
Regardless of the specified type, create the repository to which the document will be distributed in advance. See "Documents" for how to create a repository.
name: No Specify the repository name to be stored when "fixed" is specified for the type.
  directory: Yes Configure settings for the directory to be distributed to.
type: No The types that can be specified are as follows.
  • fixed:
    All documents are saved in the directory specified by "path".
path: Yes Specify the path of the directory where the documents will be stored.
Characters and character strings that cannot be used in Windows/Linux file and folder names cannot be specified.
  branch: Yes Specify the branch where the documents will be stored. Use the main branch as the branch.
*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.0
kind: distribution

type: resource
name: VM Creation and Deletion
label: VM Creation and Deletion
description: Classify attachments when generating VMs into groups for each customer.

rules:
  - name: VM Creation and Deletion
    label: VM Creation and Deletion
    group:
      type: customer    
    repository:
      type: fixed
      name: Evidence
    directory:
      type: fixed
      path: /vm
    branch: main