Skip to content

Commit

Permalink
corrected spelling and grammer
Browse files Browse the repository at this point in the history
  • Loading branch information
MoKranda committed Jan 16, 2024
1 parent 784500c commit b3a9d22
Show file tree
Hide file tree
Showing 69 changed files with 716 additions and 591 deletions.
3 changes: 0 additions & 3 deletions docs/Access Codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,10 @@ sidebar_label: 'Access Codes'

### Add Access Code


![Access Codes Main Screen](../static/imgbasic/access-codes-main.png)


![Access Codes Add](../static/imgbasic/sm-access-codes-add.png)


## Enterprise Manager

<details>
Expand Down
15 changes: 7 additions & 8 deletions docs/Action Buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,17 @@ sidebar_label: 'Action Buttons'

The table contains the keyboard shortcuts for Solution Manager. If a shortcut has been implemented for a button, then the shortcut will be specified in the button tooltip.


| Shortcut | Function |
| --- | --- |
| Ctrl+Alt+A | Admin Mode |
| Ctrl+Alt+H | Help |
| Ctrl+Alt+R | Refresh |
| Ctrl+Enter | Valid for form without Save button |
| Ctrl+B | Back |
| Ctrl+S | Save |
| CTRL + ALT + A | Admin Mode |
| CTRL + Space | Property Selector |
| CTRL + ALT + H | Help |
| CTRL + ALT + R | Refresh |
| CTRL + Enter | Valid for screens without a Save button |
| CTRL + B | Back |
| CTRL + S | Save |
| Esc | Cancel/Undo/Exit/No |


## Enterprise Manager

<details>
Expand Down
2 changes: 1 addition & 1 deletion docs/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: 'Architecture'
### What is OpCon?


* A Platform independent Job Scheduling and Automation Solution that SMA provides to manage an entire Datacenter
* A Platform independent Job Scheduling and Automation Solution that SMA provides to manage an entire data center

![Picture3](../static/imgbasic/Picture3.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/Calendars.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ sidebar_label: 'Calendars'

<details>

In Enterprise Manager, **Calendars** is found in **Adminstration > Calendars**
In Enterprise Manager, **Calendars** is found in **Administration > Calendars**

### Calendar Screen Descriptions

Expand Down
2 changes: 1 addition & 1 deletion docs/Defining A Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_label: 'Defining A Request'
---

The Service Definition is composed of serveral fields, many of which are optional:
The Service Definition is composed of several fields, many of which are optional:

![](../static/imgbasic/SelfServiceRequestDetails.png)

Expand Down
38 changes: 19 additions & 19 deletions docs/EM_Walkthroughs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,52 +8,52 @@ hide_title: true
### Enterprise Manager


|Schedules and Jobs || | |
|------------------ | ---------------| ------------- | ------------- |
|Schedules and Jobs | | | |
| --- | --- | --- | --- |
| [Create a Schedule](../static/videobasic/U1E1.mp4) | [Create a Windows Job](../static/videobasic/U1E3.mp4) |[Schedule and Job Statuses](../static/videobasic/U1E7.mp4) | [Edit a Daily Job](../static/videobasic/U1E8.mp4) |
| [Build a Schedule](../static/videobasic/U1E6.mp4) | [Null Jobs](../static/videobasic/U2E2.mp4) | [Workflow Designer](../static/videobasic/U1E10.mp4) |

| Dependencies and Tags | |
| --------------------- | -------------- |
| --- | --- |
| [Create Job Dependencies](../static/videobasic/U1E4.mp4) | [Create Tags/Tag Manager](../static/videobasic/U1E5.mp4) |

| Using Properties | | |
| ---------------- | ------ | --------- |
| --- | --- | --- |
| [Define a Global Property](../static/videobasic/U2E1.mp4) | [Define a System Property](../static/videobasic/U3E10.mp4) | [Define an Instance Property](../static/videobasic/U3E11.mp4) |

| Machine Definition and Communication | | |
| ------------------------------------ | ------------------- | ------------------ |
| --- | --- | --- |
| [Define a Machine (UNIX)](../static/videobasic/U2E3.mp4) | [Create a UNIX Job](../static/videobasic/U2E6.mp4) | [Correct a Communication Error](../static/videobasic/U2E4and5.mp4) |

| Frequencies and Calendars ||
| ----------- | -------------|
| [Create a Frequency (All Weeks, On Occurence, On Day) ](../static/videobasic/U2E8.mp4) | [Create a Frequency (OnRequest, Beginning, Middle, End of Period)](../static/videobasic/U2E9.mp4) |
| [Create a Frequency (On Interval, Annual Plan)](../static/videobasic/U2E10.mp4) | [Multiple and Negative Frequencies](../static/videobasic/U2E11.mp4) |
| --- | --- |
| [Create All Weeks, On Occurrence, and On Day Frequencies](../static/videobasic/U2E8.mp4) | [Create OnRequest, Beginning, Middle, and End of Period Frequencies](../static/videobasic/U2E9.mp4) |
| [Create On Interval and Annual Plan Frequencies](../static/videobasic/U2E10.mp4) | [Create Multiple or Negative Frequencies](../static/videobasic/U2E11.mp4) |
| [Create and Update Calendars](../static/videobasic/U2E7.mp4) | |

| User and Account Management | | | |
| --------------------------- | --------------- | --------------- | ------------------ |
| User/Account Management | | | |
| --- | --- | --- | --- |
| [Create a Role and User Account](../static/videobasic/U3E1.mp4) | [Manage Machine Privileges](../static/videobasic/U3E2.mp4) | [Manage Batch Users](../static/videobasic/U3E3.mp4) | [Manage Departmental Privileges](../static/videobasic/U3E4.mp4) |
| [Manage Schedule Privileges](../static/videobasic/U3E5.mp4) | [Manage Function Privileges](../static/videobasic/U3E6.mp4) | [Manage Access Codes](../static/videobasic/U3E7.mp4) |

| Notifications and Escalations | |
| ----------------------------- | ------------------- |
| --- | --- |
| [Notification Manager](../static/videobasic/U3E8.mp4) | [Email Escalation](../static/videobasic/U3E9.mp4) |

|Events, Resources, Thresholds | | |
|----------|-------| ---------- |
| Events, Resources, Thresholds | | |
| --- | --- | --- |
|[Events](../static/videobasic/U3E13.mp4) | [Events (Failure Criteria)](../static/videobasic/U3E14.mp4) | [Resources](../static/videobasic/U4E1.mp4) |
| [Thresholds](../static/videobasic/U4E2.mp4) | [Thresholds (External Events)](../static/videobasic/U4E3.mp4)|

|Scripts||
|------|------|
| Scripts | |
| --- | --- |
| [Embedded Scripts](../static/videobasic/U4E4.mp4) | [Importing Scripts](../static/videobasic/U4E5.mp4)|

|SubsSchedules |||
|------------- |-------|-------|
| SubSchedules | | |
| --- | --- | --- |
|[SubSchedules (Mulitiple Runs)](../static/videobasic/U4E6.mp4) | [SubSchedules (Concurrent Processes)](../static/videobasic/U4E7.mp4)| [SubSchedules (Daily and Monthly Processes)](../static/videobasic/U4E8.mp4)| |

|File Transfer ||
|------------- |---------|
| File Transfer | |
| --- | --- |
|[SMA File Transfer (SMAFT)](../static/videobasic/U4E9.mp4)|[Windows File Movement (Job SubTypes)](../static/videobasic/U4E10.mp4)|
|[Windows File Arrival](../static/videobasic/U4E11.mp4)|[Windows File Arrival (Multiple Files)](../static/videobasic/U4E12.mp4)|
67 changes: 67 additions & 0 deletions docs/EM_Walkthroughs_Alt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
sidebar_label: 'EM Walkthroughs'
hide_title: true
---

## Concept Walkthroughs

### Unit 1
| Topic | EM Video Link |
| --- | --- |
| Schedule Master | [Create a Schedule](../static/videobasic/U1E1.mp4) |
| Batch Job | [Unit 1 Exercise 2](../static/videobasic/U1E2.mp4) |
| Master Job| [Unit 1 Exercise 3](../static/videobasic/U1E3.mp4) |
| Dependencies | [Unit 1 Exercise 4](../static/videobasic/U1E4.mp4) |
| Tags and Tag Manager | [Unit 1 Exercise 5](../static/videobasic/U1E5.mp4) |
| Schedule Builds | [Unit 1 Exercise 6](../static/videobasic/U1E6.mp4) |
| Schedule and Job Statuses | [Unit 1 Exercise 7](../static/videobasic/U1E7.mp4) |
| Daily Jobs | [Unit 1 Exercise 8](../static/videobasic/U1E8.mp4) |
| Workflow Designer | [Unit 1 Exercise 10](../static/videobasic/U1E10.mp4) |

### Unit 2
| Topic | EM Video Link |
| --- | --- |
| Properties | [Unit 2 Exercise 1](../static/videobasic/U2E1.mp4) |
| Null Jobs | [Unit 2 Exercise 2](../static/videobasic/U2E2.mp4) |
| Define a Machine |[Unit 2 Exercise 3](../static/videobasic/U2E3.mp4) |
| Troubleshoot Communication Error |[Unit 2 Exercises 4 and 5 ](../static/videobasic/U2E4and5.mp4) |
| UNIX Job |[Unit 2 Exercise 6](../static/videobasic/U2E6.mp4) |
| Calendars (create and Update) |[Unit 2 Exercise 7](../static/videobasic/U2E7.mp4) |
| Frequencies:<ul><li>All Weeks</li><li>On Occurrence</li><li>On Day</li></ul> |[Unit 2 Exercise 8](../static/videobasic/U2E8.mp4) |
| Frequencies:<ul><li>On Request</li><li>Beginning of Period</li><li>Middle of Period</li><li>End of Period</li></ul> |[Unit 2 Exercise 9](../static/videobasic/U2E9.mp4) |
| Frequencies:<ul><li>On Interval</li><li>Annual Plan</li></ul> |[Unit 2 Exercise 10](../static/videobasic/U2E10.mp4) |
| Frequencies:<ul><li>Multiple</li><li>Negative</li></ul> |[Unit 2 Exercise 11](../static/videobasic/U2E11.mp4) |

### Unit 3
| Topic | EM Video Link |
| --- | --- |
| Users and Roles Management | [Unit 3 Exercise 1](../static/videobasic/U3E1.mp4) |
| Machine Privileges | [Unit 3 Exercise 2](../static/videobasic/U3E2.mp4) |
| Batch User Privileges | [Unit 3 Exercise 3](../static/videobasic/U3E3.mp4) |
| Departmental Function Privileges | [Unit 3 Exercise 4](../static/videobasic/U3E4.mp4) |
| Schedule Privileges | [Unit 3 Exercise 5](../static/videobasic/U3E5.mp4) |
| Function Privileges | [Unit 3 Exercise 6](../static/videobasic/U3E6.mp4) |
| Access Codes | [Unit 3 Exercise 7](../static/videobasic/U3E7.mp4) |
| Notification Manager | [Unit 3 Exercise 8](../static/videobasic/U3E8.mp4) |
| Escalation Manager | [Unit 3 Exercise 9](../static/videobasic/U3E9.mp4) |
| System Properties | [Unit 3 Exercise 10](../static/videobasic/U3E10.mp4) |
| Instance Properties | [Unit 3 Exercise 11](../static/videobasic/U3E11.mp4) |
| Events | [Unit 3 Exercise 12](../static/videobasic/U3E12.mp4) |
| Events Triggers | [Unit 3 Exercise 13](../static/videobasic/U3E13.mp4) |
| Events and Advance Failure Criterial | [Unit 3 Exercise 14](../static/videobasic/U3E14.mp4) |

### Unit 4
| Topic | EM Video Link |
| --- | --- |
| Resources | [Unit 4 Exercise 1](../static/videobasic/U4E1.mp4) |
| Thresholds | [Unit 4 Exercise 2](../static/videobasic/U4E2.mp4) |
| Thresholds via Events | [Unit 4 Exercise 3](../static/videobasic/U4E3.mp4)|
| Embedded Scripts (Existing) | [Unit 4 Exercise 4](../static/videobasic/U4E4.mp4) |
| Embedded Scripts (Importing New) | [Unit 4 Exercise 5](../static/videobasic/U4E5.mp4) |
| SubSchedule (Multiple Runs) | [Unit 4 Exercise 6](../static/videobasic/U4E6.mp4) |
| SubSchedule (Concurrent Processes) | [Unit 4 Exercise 7](../static/videobasic/U4E7.mp4)|
| SubSchedule (Daily/Monthly Processing) | [Unit 4 Exercise 8](../static/videobasic/U4E8.mp4)|
| SMA File Transfer (SMAFT) | [Unit 4 Exercise 9](../static/videobasic/U4E9.mp4) |
| Job Sub-Types |[Unit 4 Exercise 10](../static/videobasic/U4E10.mp4)|
| File Arrival (Single File) | [Unit 4 Exercise 11](../static/videobasic/U4E11.mp4)|
| File Arrival (Multiple Files) | [Unit 4 Exercise 12](../static/videobasic/U4E12.mp4)|
108 changes: 49 additions & 59 deletions docs/Embedded Scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,114 +2,104 @@
sidebar_label: 'Embedded Scripts'
---

* OpCon has ability to push Scripts from OpCon database to Windows and UNIX Machines (LSAMs) to run
* Database has centralized Repository that is replicated with database
* Version Control
* OpCon has ability to push Scripts from the OpCon database to Windows and UNIX environments
* The OpCon Database acts as a centralized Repository that is replicated with database
* The Repository allows for Version Control

* Four places used in OpCon to setup and use Embedded Scripts:
* Script Types
* Script Runners
* Script Repository
* Job Master
![](../static/imgbasic/sm-scripts.png)

### Embedded Scripts - Script Types
#### Four part make up Embedded Scripts

* Configure type of Scripts which can be stored by OpCon
* Script Types
* Script Runners
* Script Repository
* Job Master

### Script Types

* Configure type of Scripts which can be stored by OpCon
* There are 5 **predefined** Script types, but more can be added
* Command Shell (.cmd)
* Perl (.ps)
* PowerShell (.ps1)
* Python (.py)
* VBScript (.vbs)
* Command Shell (.cmd)
* Perl (.ps)
* PowerShell (.ps1)
* Python (.py)
* VBScript (.vbs)

### Embedded Scripts - Script Runners
![](../static/imgbasic/sm-script-types.png)

* Script Runners define Command Line created to run Script
### Script Runners

Example:
* Script Runners define Command Line created to run Script
* Allows more than one Script runner per Script Type

* Powershell includes ```“–ExecutionPolicy Bypass and –File”``` before command
![](../static/imgbasic/sm-script-runners.png)

* Allows more than one Script runner per Script Type
:::tip Example
* Powershell would include ```“–ExecutionPolicy Bypass and –File”``` before command, so the Script Runner would look like: ```powershell.exe -ExecutionPolicy Bypass -File $FILE $ARGUMENTS```.
:::

### Script Repository

* Where Scripts are created and stored
* Previous versions are accessible

![](../static/imgbasic/sm-add-script.png)

#### Required Fields

* **Name** – Defines Name of Script (No spaces allowed in Name)
* **Description** – Documents purpose of Script
* **Open File** - Allows loading of Script from network
* **Blank Text Field** – Create Script
* **Type** – Specifies Script Type
* **Initial Comments** – Documents differences between Script versions

### Assign a Role to a New Script
#### Assign a Role to a New Script

* A Role must be assigned when a Script is created or imported to the Script Repository

### Embedded Scripts - Job Master

* **Job Action** – Change from Run Program to Embedded Scripts
* **Script** – Specifies which script to call
* **Script Type** – Specifies Script Type for Selected Script
* **Runner** – Script Runner for Selected Script
* **Run Command Template** – Contents of Script Runner
* **Version** – Specifies Script Version selected
* **Arguments** – Enter the parameter(s) passed to Script (if needed)
* **Working Dir.** – Working Directory (starting directory) for Script

## Solution Manager

* In Solution Manager, **Scripts** is found in **Library > Administration > Scripts**

### Scripts Menu

![](../static/imgbasic/sm-scripts.png)

### Script Types

![](../static/imgbasic/sm-script-types.png)

### Script Runners
![](../static/imgbasic/sm-assign-role-script.png)

![](../static/imgbasic/sm-script-runners.png)
#### Edit a Script

### Copy Script to Edit Version
* In the Repository, a **Copy** of the script must be made before you can **Edit** it.

![](../static/imgbasic/sm-copy-script-edit.png)

![](../static/imgbasic/sm-edit-script-version.png)

### Add Script
#### Deploy Script

![](../static/imgbasic/sm-add-script.png)

### Assign a Role to a New Script

![](../static/imgbasic/sm-assign-role-script.png)

### Deploy Script
* Multiple jobs can run differnt versions of the same Embedded script.
* To have all jobs run the same version, one needs to **Deploy** that version to the jobs.

![](../static/imgbasic/sm-deploy-script-button.png)

![](../static/imgbasic/sm-script-deploy.png)

### Script Cross References
#### Script Cross References

* Cross Reference in the Repository allows one to see all the jobs that are running the same script.

![](../static/imgbasic/sm-script-cross-references.png)

:::warning

A Script with Cross References cannot be deleted

:::

### Script in Job Properties
### Embedded Script Job

![](../static/imgbasic/sm-script-in-job-properties.png)

* **Job Action** – Change from Run Program to Embedded Scripts
* **Script** – Specifies which script to call
* **Script Type** – Specifies Script Type for Selected Script
* **Runner** – Script Runner for Selected Script
* **Run Command Template** – Contents of Script Runner
* **Version** – Specifies Script Version selected
* **Arguments** – Enter the parameter(s) passed to Script (if needed)
* **Working Dir.** – Working Directory (starting directory) for Script

## Enterprise Manager

* In Enterprise Manager, **Scripts** is found in **Scripts**
Expand Down
Loading

0 comments on commit b3a9d22

Please sign in to comment.