Contents
1. Outline
1.1 Ops I outline
1.2 Ops I features
1.3 Outline of usage
1.4 Use precautions and temporary restrictions
1.4.1 Use precautions
1.4.1 (1) Notes on logging in to and out of Ops I
1.4.1 (2) Notes on language settings
1.4.1 (3) Notes on user management
1.4.1 (4) Notes on secret management
1.4.1 (5) Notes on document management
1.4.1 (6) Notes on characters that can be entered
1.4.1 (7) Notes on e-mail notifications from Ops I
1.4.1 (8) Notes on operations using Git
1.4.1 (9) Notes on task management
1.4.1 (10) Names of download files
1.4.1 (11) Notes on distribution rules
1.4.1 (12) Notes on backup
1.4.1 (13) Precautions regarding linkage with external systems
1.4.2 Temporary restrictions
1.4.2 (1) Unsupported functions
2. Implementation & Configuration
2.1 Prerequisite knowledge
2.1.1 User implementing & configuring
2.1.2 Association between users and each function
2.1.3 User management functions
2.2 Preparation
2.2.1 Connecting & logging in to Ops I
2.2.2 Setting one-time code
2.3 Creating users
2.3.1 Creating users for using Ops I
2.3.2 Setting roles for created users
2.4 Configuring organization
2.5 Setting a relay server
2.5 (1) Components of relay server function “outpost”
2.5 (2) Flow of configuring outpost
2.5 (3) Deleting nodes
2.5 (4) Upgrade outpost agent
2.5.1 RPM package
2.5.1 (1) Prerequisites for installing RPM package
2.5.1 (2) Contents of RPM package
2.5.1 (3) Command scripts for RPM package
2.5.1 (4) Signature file for RPM package
2.6 Setting a repository
2.7 Setting up external IdP linkage
2.7 (1) Configurations of external IdP linkage
2.7 (2) Log in/log out
2.7 (3) Association between Ops I users and external IdP users
2.7 (4) Deleting users linked with external IdPs
2.7 (5) Changing/deleting/re-setting Ops I passwords of users linked with external IdPs
2.7.1 Setting up OIDC connection
2.7.2 Setting up SAML connection
2.7.2.1 Updating SAML certification
2.7.3 Mapping attributes/groups/roles
2.7.3 (1) Where to obtain and set attribute information
2.7.3 (2) Synchronization mode
2.7.3 (3) Automatic mapping
2.7.3 (4) Value conversion
2.7.4 Log in/log out
2.7.4 (1) Logging in
2.7.4 (2) Logging out
2.8 Private network connection to on-premise environment
2.8 (1) Outline
2.8 (2) Prerequisites
2.8 (3) Connection flow
3. Functions
3.1 Basic window structure
3.1.1 Account management
3.2 Tasks and Requests
3.2.1 Service catalog
3.2.2 Workflow
3.2.2 (1) Workflow list
3.2.2 (2) Workflow operation window
3.2.2 (3) Workflow operation window (when using Stepper)
3.2.3 Tickets
3.2.3 (1) Ticket browser window
3.2.3 (2) Ticket zoom window
3.2.3 (3) Add new ticket window
3.2.3 (4) Other functions
3.2.3.1 incident tickets
3.2.3.2 request tickets
3.2.3.3 task tickets
3.2.3.4 problem tickets
3.2.3.5 rfc tickets
3.2.3.6 release tickets
3.2.3.7 case tickets
3.2.3.8 unclassified tickets
3.2.4 Schedule
3.2.4.1 Calendar management functions
3.2.4.1 (1) Create calendar
3.2.4.1 (2) Copy calendar
3.2.4.1 (3) Delete calendar
3.2.4.1 (4) Displaying and editing the calendar description window
3.2.4.2 Work item management functions
3.2.4.2 (1) Structure of [Work item management function] window
3.2.4.2 (2) Adding work items
3.2.4.2 (3) Displaying and editing work items in the work item [Details] window
3.2.4.2 (4) Copying work items
3.2.4.2 (5) Deleting work items
3.2.4.3 Resource-specific scheduling functions
3.2.4.3 (1) Configuring the “Resource-specific scheduling function” window
3.2.4.3 (2) Adding schedules from the “Resource-specific scheduling function” window
3.2.4.3 (3) Adding schedules using the “Work item management function”
3.2.4.3 (4) Schedules added on the workflow tab
3.2.4.3 (5) Configuring management relationships between groups
3.2.5 Resources
3.2.5 (1) Resource list
3.2.5 (2) Apply skill
3.2.5 (3) Revoke skill
3.3 Documents
3.3.1 Container
3.3.1 (1) Upload window
3.3.2 Distribution
3.4 System
3.4 (1) System configuration tab
3.4 (2) GitOps log tab
3.4.1 User management
3.4.1.1 Users
3.4.1.1 (1) Adding users
3.4.1.1 (2) Viewing user details
3.4.1.1 (3) Deleting users
3.4.1.1 (4) Editing users
3.4.1.1 (5) Inheriting the OTOBO information of deleted users
3.4.1.2 Groups
3.4.1.2 (1) Adding groups
3.4.1.2 (2) Viewing group details
3.4.1.2 (3) Deleting groups
3.4.1.2 (4) Editing groups
3.4.1.3 Roles
3.4.1.3 (1) Adding roles
3.4.1.3 (2) Viewing role details
3.4.1.3 (3) Deleting roles
3.4.1.3 (4) Editing roles
3.4.2 Identity provider
3.4.2 (1) Identity provider outline
3.4.2 (2) Adding OIDC
3.4.2 (3) Adding SAML
3.4.2 (4) Connection setting detail window
3.4.2 (5) Mapping tab
3.4.2.1 Common settings
3.4.2.1 (1) User data reuse policy
3.4.2.1 (2) Default identity provider
3.4.3 Organization management
3.4.3 (1) Outline
3.4.3 (2) Adding organizations
3.4.3 (3) Editing organizations
3.4.3 (4) Assigning roles within organizations
3.4.4 Outpost management
3.4.4 (1) Control plane management
3.4.4 (2) Node management
3.4.4 (3) Node group management
3.4.4 (4) IP block management
3.4.5 Repository management
3.5 IT service management (ITSM)
3.6 Secret management
3.6.1 Register a secret
3.6.1 (1) Creating a secrets engine
3.6.1 (2) Creating a secret
3.6.1 (3) Obtaining authentication information for accessing the Secret from Automation
3.6.2 Change a secret
3.6.2 (1) Changing a secret by incrementing the version
3.6.2 (2) Deleting and recreating a secret
3.6.3 Register user credential information
3.6.3 (1) Creating a secrets engine
3.6.3 (2) Creating a secret
3.7 Git
3.7.1 Register YAML files with GitLab (GUI)
3.7.2 Register YAML files with GitLab (CUI)
3.7.3 Obtaining GitLab access tokens
3.7.4 Checking differences in YAML files
3.7.5 Checking registration status of YAML files
3.8 Automation
3.8.1 Registering authentication information
3.8.1 (1) Authentication information for accessing the secret and GitLab
3.8.1 (2) Authentication information using PAT
3.8.2 Setting projects
3.8.3 Registering inventory
3.8.4 Registering templates
3.8.5 Checking job execution results
4. Designing and Building Your Operation
4.1 Prerequisite knowledge
4.1.1 Associations between functions & required knowledge
4.1.2 Precautions when defining YAML files
4.1.2 (1) Reflecting updates to YAML files to workflows
4.1.2 (2) Restrictions on updates to YAML files
4.2 Organizing tasks
4.2.1 Identifying routine/as-needed tasks
4.2.2 User management
4.2.3 Skills required for operation
4.2.4 Organizing handled documents
4.3 Task design
4.3.1 Designing a data model
4.3.1 (1) Service catalog
4.3.1 (2) Data models
4.3.2 Designing a workflow
4.3.2 (1) Setting a user with skills required for operation
4.3.2 (2) Performing parallel processing
4.3.2 (3) Customizing standard action buttons
4.3.3 Designing notifications
4.3.3 (1) Flow of notification
4.3.3 (2) Notification with schedule/work item set as starting point
4.3.3 (3) Notification with workflow set as starting point
4.3.3.1 Example of notification of schedule and work item origin
4.3.4 Storing documents
4.3.5 Users and ACL
4.3.6 Skill management
4.3.7 Automation
4.3.8 Ticket management
4.3.8 (1) Outline
4.3.8 (2) Ticket management basics
4.3.8 (3) Relationships between tickets
4.3.8 (4) Other functions
4.3.8.1 Ticket notification function
4.3.8.1 (1) Ticket notification settings
4.3.8.1 (2) Ticket watcher settings
4.3.8.2 SLA management function
4.3.8.2 (1) SLA metrics
4.3.8.2 (2) How to create SLA
4.3.8.2 (3) Assigning SLA to each ticket
4.3.8.2 (4) Checking SLA compliance for each ticket
4.3.8.3 Ticket approval function
4.3.8.3 (1) Enabling and disabling the approval function
4.3.8.3 (2) Setting approvers
4.3.8.3 (3) Approving or declining of a ticket by the approver
4.3.9 Schedule management
4.3.9 (1) Outline
4.3.9 (2) Schedule management basics
4.3.9 (3) Associating schedules with workflows
4.3.9 (4) Calendar templates
4.3.9 (5) Repeating schedule execution
4.3.10 Site management
4.3.10 (1) Outline
4.3.10 (2) Display and operation permissions based on roles
4.3.10 (3) Site-based access control
4.3.10 (4) Use cases
4.3.10.1 Prerequisite knowledge
4.3.10.1 (1) Creating and deleting users
4.3.10.1 (2) Windows and items displayed for each role
4.3.10.1 (3) Main sites/template sites
4.3.10.1 (4) Plugins
4.3.10.2 Ops I Menu
4.3.10.3 Embedding the Ops I window in a site
4.3.10.4 Import/export sites
4.3.10.5 Installing themes
4.3.10.6 Multilingual support for sites
4.3.10.7 Notifications
4.3.10.8 Log out from Ops I
4.3.10.9 Changing Ops I password
4.4 UI design
4.4.1 UI version
4.4.1 (1) Specifying a UI version
4.4.1 (2) Differences between YAML definition methods
4.4.1 (3) Enhanced and added functions
4.4.2 Defining window URL (Uipath)
4.4.2 (1) Function overview
4.4.2 (2) Defining URLs
4.4.3 Saving a table display
4.4.4 Displaying hint messages
4.5 Other operational design tips
4.5.1 Library
4.5.2 Application
4.5.3 Customizing the ticket window
4.5.3.1 Ticket fields
4.5.3.1 (1) Adding fields
4.5.3.1 (2) Deleting fields
4.5.3.1 (3) Reflecting to filters
4.5.3.1 (4) Changing field names
4.5.3.2 Ticket statuses
4.5.3.2 (1) Changing status names
4.5.3.2 (2) Changing the initial status and transition order of statuses
4.5.3.2 (3) Adding and deleting statuses
4.5.3.3 Ticket types
4.5.3.3 (1) Changing ticket type names
4.5.3.3 (2) Adding and deleting types displayed on the ticket tab
4.5.4 Customizing the default YAML files
4.5.5 Checking registration status of YAML files (GUI)
4.6 Registering YAML files with GitLab
4.6.1 Process from YAML file code development to actual operation
4.6.2 Uploading YAML files
4.7 Setting up automatic job execution
4.7 (1) Adding workflows
4.7 (2) Updating service catalogs
4.7 (3) Creating a job template
4.7 (4) Starting catalog items
4.8 Using a relay server
4.9 Linking with other products
4.9.1 JP1/AJS3
4.9.1 (1) Prerequisites
4.9.1 (2) Settings for executing JP1/AJS3 linkage templates
4.9.1 (3) Obtaining and registering linkage templates
4.9.1 (4) Executing linkage templates and checking results
4.9.1 (5) Input fields on workflow details window
4.9.2 JP1/IM
4.9.2.1 Monitoring deterrence
4.9.2.1 (1) Prerequisites
4.9.2.1 (2) Settings for executing JP1/IM linkage templates
4.9.2.1 (3) Obtaining and registering linkage templates
4.9.2.1 (4) Location of common exclusion conditions extension definition file
4.9.2.1 (5) Proxy settings for relay server
4.9.2.1 (6) Executing linkage templates and checking results
4.9.2.1 (7) Updating common exclusion conditions extension definition file
4.9.2.1 (8) Input fields on workflow details window
4.9.2.2 Registering incidents
4.9.2.2 (1) Prerequisites
4.9.2.2 (2) Flow of registering incidents
4.9.2.2 (3) Settings for registering incidents
4.9.2.2 (4) Reflecting to tickets
4.10 Extending the environment for automatic execution
4.10 (1) Developing custom execution environments
4.10 (2) Managing custom execution environments
4.10 (3) Registering custom execution environments with AWX
4.10 (4) Executing automation
5. Operation
5.1 Checking license usage
5.1 (1) Checking the number of users
5.1 (2) Checking the number of executions of operational scenarios
5.2 Migrating data from verification environment to actual environment
5.2.1 Approach to data migration
5.2.2 Data migration of files in Git repository
5.3 Actions required when upgrading Ops I version
5.3.1 Preserving the customized ticket function
5.3.2 Updating the AWX execution environment
5.3.2 (1) Checking the version of the AWX execution environment
5.3.2 (2) Upgrading the version of the custom execution environment
5.3.2 (3) Actions when upgrading the version of the AWX execution environment
6. YAML Definition
6.1 Workflow
6.1.1 Provided Ops I components
6.2 UI
6.2.1 UI (UI Version 1.0)
6.2.2 UI (UI Version 1.1)
6.2.3 Uipath
6.3 Datamodel
6.4 Catalog
6.5 Script
6.5.1 Action scripts (UI Version 1.0)
6.5.2 Action scripts (UI Version 1.1)
6.6 Library
6.7 Attachment
6.8 Distribution
6.9 ACL, Statement
6.10 Notification, Notifier
6.11 Application
6.12 Skill, Skillset
6.13 Calendar
7. Troubleshooting
7.1 Message list
7.2 How to deal with errors
7.2.1 How to deal with messages
7.2.2 How to deal with YAML syntax errors
8. OPS I Roles
8.1 Correspondence between roles and support functions in Ops I
8.2 Correspondence between API and Ops I roles
9. Appendix
9.1 OSS version/edition and reference manuals
9.2 Version changes