Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add: Otto Skills #298

Merged
merged 7 commits into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Files/UI/Solution-Manager/Forgot-Password-Login.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Forgot Password / Reset Password for Solution Manager Login
# Forgot / Reset Password

## Resetting Password

Expand Down
11 changes: 9 additions & 2 deletions docs/Files/UI/Solution-Manager/Otto/Otto-Chatbot.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
---
lang: en-us
title: Managing Studio
title: AI Chatbot Overview
viewport: width=device-width, initial-scale=1.0
---

# Overview

Otto is the name of the AI chatbot that is available in Solution Manager. It is designed to help users answer questions about all things OpCon. Coming soon, Otto will be available in the bottom-right corner of the screen and can be accessed by clicking on the chat icon.
Otto is the name of the AI chatbot that is available in Solution Manager. Otto can understand and respond to natural language questions. It is designed to help users answer questions about all things OpCon and help with executing specific skills. Otto is available at the bottom-right corner of the screen and can be accessed by clicking on the chat icon.

![Chatbot](../../../../Resources/Images/SM/Otto/Chatbot-Overview.png "Chatbot")

## Features

Otto has the following features:

- **Search**: Otto can search the OpCon documentation for answers to your questions.
- **Skills**: Otto can perform certain tasks in OpCon for you.
29 changes: 29 additions & 0 deletions docs/Files/UI/Solution-Manager/Otto/Skills/Skill-Add-Daily-Job.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
lang: en-us
title: Otto Skill - Add Daily Job
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Add Daily Job** skill allows you to add a new daily job to a specified daily schedule for a specified date, with a specified frequency, and status.

## Skill Details

- **Skill Name**: `add-daily-job`

### Parameters

The **Add Daily Job** skill requires the following parameters:

- **Date** _(string)_: The specified schedule's date where the job will be added.
- **Frequency Name** _(string)_: The name of the frequency where the job will be added. If not specified, the default frequency will be used.
- **Job Name** _(string)_: The name of the job to be added.
- **Schedule Name**: _(string)_ The name of the daily schedule where the job will be added.
- **Status** _(string)_: The status in which the job will be added, options: `released`, `onHold`

## Example

`Add daily job on 2021-12-31 for frequency Daily, job name TestJob, schedule name TestSchedule, status released`

`Please add a daily job with a name of "TestJob", a status of "released", and a frequency of "Daily" to the schedule "TestSchedule" for today.`
28 changes: 28 additions & 0 deletions docs/Files/UI/Solution-Manager/Otto/Skills/Skill-Build-Schedule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
lang: en-us
title: Otto Skill - Build Schedule
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Build Schedule** skill allows you to build a schedule for a specified date, and either place it on hold or release it, and optionally overwrite an existing build.

## Skill Details

- **Skill Name**: `build-schedule`

### Parameters

The **Build Schedule** skill requires the following parameters:

- **Date** _(string)_: The specified date when the schedule will be built.
- **Hold** _(boolean)_: Determines whether to place schedule on hold or released. True if hold, false if release, and defaults to true
- **Overwrite** _(boolean)_: Determines whether to overwrite an existing build, defaults to false
- **Schedule Name** _(string)_: The name of the daily schedule to build.

## Example

`Build schedule TestSchedule for today`

`Please build the schedule with name "TestSchedule" for today, and release it. Do not overwrite the existing schedule.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
lang: en-us
title: Otto Skill - Delete Daily Job
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Delete Daily Job** skill allows you to delete a specified job from the specified daily schedule for the specified date.

## Skill Details

- **Skill Name**: `delete-daily-job`

### Parameters

The **Delete Daily Job** skill requires the following parameters:

- **Date** _(string)_: The specified date of the job that will be deleted.
- **Job Name** _(string)_: The name of the job to be deleted.
- **Schedule Name** _(string)_: The name of the daily schedule on which the job name is to be deleted from.

## Example

`Delete job TestJob from schedule TestSchedule for today`

`Please delete the job with the name "TestJob" from the schedule "TestSchedule" for today.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
lang: en-us
title: Otto Skill - Get Failed Jobs
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Get Failed Jobs** skill allows you to retrieve a list of failed jobs for a specified date.

## Skill Details

- **Skill Name**: `get-failed-jobs`

### Parameters

The **Get Failed Jobs** skill requires the following parameters:

- **Date** _(string)_: The date for which the failed jobs will be retrieved.

## Example

`Get failed jobs for today`

`Please retrieve the list of failed jobs for today.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
lang: en-us
title: Otto Skill - Get Failed Schedules
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Get Failed Schedules** skill allows you to retrieve a list of failed schedules for a specified date.

## Skill Details

- **Skill Name**: `update-schedule-status`

### Parameters

The **Get Failed Schedules** skill requires the following parameters:

- **Date** _(string)_: The date for which the failed schedules will be retrieved.

## Example

`Get failed schedules for today`

`Please retrieve the list of failed schedules for today.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
lang: en-us
title: Otto Skill - Perform a Fast Schedule Check
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Perform a Fast Schedule Check** skill allows you to perform a schedule check for the given schedule for the given date.

## Skill Details

- **Skill Name**: `perform-a-fast-schedule-check`

### Parameters

The **Perform a Fast Schedule Check** skill requires the following parameters:

- **Date** _(string)_: The specified date of the schedule to check.
- **Schedule Name** _(string)_: The name of the daily schedule to check.

## Example

`Check schedule TestSchedule for today`

`Please check the schedule with the name "TestSchedule" for today.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
lang: en-us
title: Otto Skill - Restart Failed Jobs
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Restart Failed Jobs** skill allows you to restart all failed jobs in a specified schedule for a specified date.

## Skill Details

- **Skill Name**: `restart-failed-jobs`

### Parameters

The **Restart Failed Jobs** skill requires the following parameters:

- **Date** _(string)_: The specified date of the jobs to restart.
- **Schedule Name** _(string)_: The name of the schedule on which to restart all jobs.

## Example

`Restart Failed Jobs TestSchedule for today`

`Please restart all failed jobs in the schedule "TestSchedule" for today.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
lang: en-us
title: Otto Skill - Update Job Status
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Update Job Status** skill allows you to perform an action to update the status of a daily job on a specified schedule for a specified date.

## Skill Details

- **Skill Name**: `update-job-status`

### Parameters

The **Update Job Status** skill requires the following parameters:

- **Action** _(string)_: The action to update the job status - must be one of: `release`, `restart`, `forcerestart`
- **Date** _(string)_: The specified date for the job.
- **Job Name** _(string)_: The name of the job to update.
- **Schedule Name** _(string)_: The name of the daily schedule for the updated job.

## Example

`Update job TestJob to status "released" on schedule TestSchedule for today`

`Please update the job with the name "TestJob" to the status "released" on the schedule "TestSchedule" for today.`
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
lang: en-us
title: Otto Skill - Update Machine Status
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Update Machine Status** skill allows you to perform an action to update the status of a machine. The machine status must be one of: `limited`, `up`, `down`.

## Skill Details

- **Skill Name**: `update-machine-status`

### Parameters

The **Update Machine Status** skill requires the following parameters:

- **Action** _(string)_: The action to update machine status - must be one of: `limited`, `up`, `down`.
- **Machine Name** _(string)_: The name of the updated machine.

## Example

`Update machine TestMachine to status "up"`

`Please update the status of machine with the name "TestMachine" to the status "up".`
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
lang: en-us
title: Otto Skill - Update Schedule Status
viewport: width=device-width, initial-scale=1.0
---

# Overview

The **Update Schedule Status** skill allows you to update the status of the specified daily schedule for the specified date. The status can be set to `release`, `hold`, `start`, or `close`.

## Skill Details

- **Skill Name**: `update-schedule-status`

### Parameters

The **Update Schedule Status** skill requires the following parameters:

- **Date** _(string)_: The specified updated schedule's date.
- **Schedule Name**: _(string)_ The name of the daily schedule to be updated.
- **Status** _(string)_: The status to be applied to the schedule, options: `release`, `hold`, `start`, `close`

## Example

`Update schedule TestSchedule to status "release" for today`

`Please update the status of the schedule with the name "TestSchedule" to the status "release" for today.`
15 changes: 15 additions & 0 deletions docs/Files/UI/Solution-Manager/Otto/Skills/Skills-Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
lang: en-us
title: Skills Overview
viewport: width=device-width, initial-scale=1.0
---

# Overview

Skills are a way to perform specific tasks in OpCon directly via the Otto chatbot. Skills are designed to help users execute tasks in OpCon without having to navigate through the OpCon UI. Each skill is mapped to a specific api endpoint in OpCon and can be executed by directly asking Otto to perform the task. Each skill is defined in the OpCon API documentation.

## Accessing Skills

To access and execute a specific skill, ask Otto to perform the task. If the skill is available and enabled, Otto will respond with a confirmation message before executing the task. If the skill is not available/enabled or if the skill failed to execute successfully, Otto will respond with an error message.

![Skills Example](../../../../../Resources/Images/SM/Otto/Skills-Overview-Example.png "Skills Example")
Binary file modified docs/Resources/Images/SM/Login2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 33 additions & 6 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -392,10 +392,11 @@ module.exports = {
label: "Solution Manager",
collapsed: true,
items: [
"Files/UI/Solution-Manager/Getting-Started",
"Files/UI/Solution-Manager/Application-Help",
"Files/UI/Solution-Manager/Logging-In",
"Files/UI/Solution-Manager/Migrating-Data",
'Files/UI/Solution-Manager/Getting-Started',
'Files/UI/Solution-Manager/Application-Help',
'Files/UI/Solution-Manager/Logging-In',
'Files/UI/Solution-Manager/Forgot-Password-Login',
'Files/UI/Solution-Manager/Migrating-Data',
{
type: "category",
label: "Understanding the Layout",
Expand Down Expand Up @@ -792,8 +793,34 @@ module.exports = {
},
],
},
"Files/UI/Solution-Manager/Using-PERT-View",
"Files/UI/Solution-Manager/Managing-Daily-Processes",
{
type: 'category',
label: 'Otto',
collapsed: true,
items: [
"Files/UI/Solution-Manager/Otto/Otto-Chatbot",
{
type: "category",
label: "Skills",
collapsed: true,
items: [
"Files/UI/Solution-Manager/Otto/Skills/Skills-Overview",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Add-Daily-Job",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Build-Schedule",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Delete-Daily-Job",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Get-Failed-Jobs",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Get-Failed-Schedules",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Perform-A-Fast-Schedule-Check",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Restart-Failed-Jobs",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Update-Job-Status",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Update-Machine-Status",
"Files/UI/Solution-Manager/Otto/Skills/Skill-Update-Schedule-Status",
]
}
]
},
'Files/UI/Solution-Manager/Using-PERT-View',
'Files/UI/Solution-Manager/Managing-Daily-Processes',
],
},
],
Expand Down
Loading