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

Website and Exercise updates #114

Merged
merged 1 commit into from
Sep 4, 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
19 changes: 12 additions & 7 deletions docs/Access Codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,31 @@
sidebar_label: 'Access Codes'
---

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

* In Solution Manager, **Access Codes** is found in **Library > Security > Access Codes**
* Access Codes can be used to secure individual Job records
* To make use of an Access Code, Privileges must be granted
* A single Access Code can be used to secure as many different Jobs as necessary

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

### Access Code Privileges

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

* To implement Access Codes for securing Jobs, each User must have appropriate Access Code Privileges through one or more Roles to view and update Jobs
* ```<None>``` is the default Access Code for all Jobs
* All Roles automatically have Privileges to update any Jobs with ```<None>``` Access Code
* When additional Access Codes are created, the Administrator must grant Privileges for Access Codes to the appropriate Role Name

* In Solution Manager, **Access Codes** is found in **Library > Security > Access Codes**
### Access Codes in Master Job

### Add Access Code
![](../static/imgbasic/AC_Master.png)

* ```<None>``` is the default Access Code for all Jobs
* An Access Code is assigned to Jobs in Job Details tab of Job Master
* A Job can only be assigned to **one** Access Code

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

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

## Enterprise Manager

Expand Down
2 changes: 2 additions & 0 deletions docs/Action Buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ The table contains the keyboard shortcuts for Solution Manager. If a shortcut ha
| CTRL + S | Save |
| Esc | Cancel/Undo/Exit/No |



## Enterprise Manager

<details>
Expand Down
28 changes: 28 additions & 0 deletions docs/Additional Resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_label: 'Additional Resources'
---

### OpCon Connections

* <a href="https://smatechnologies.com/connections" target="_blank">SMA Connections</a>
* A new series of sessions designed to develop meaningful connections with and among our valued customers. These sessions will provide a space where you can engage not only with our products but also with each other, fostering a collaborative information network..

### SMA Webinars

* <a href="https://smatechnologies.com/resources/webinars" target="_blank">SMA Webinars</a>
* Webinars are educational presentations updating clients on releases and improvements as well as demonstrations of OpCon use cases.

### SMA Lunch & Learns

* <a href="https://smatechnologies.com/lunch-learn" target="_blank">SMA Lunch & Learn</a>
* Web sessions that provide an in-depth look into product setup, and explore the specific features and functionality of our offerings.

### SMA Innovation Lab

* <a href="https://github.com/SMATechnologies" target="_blank">Innovation Lab</a>
* A repository of projects and demonstrations of OpCon use cases and possibilities

### OpCon Wizards

* <a href="https://www.linkedin.com/groups/12274641" target="_blank">OpCon Wizards Group</a>
* A Learning Community hosted as a LinkedIn Group that provides communication and feedback with OpCon experts within SMA and with other users
3 changes: 1 addition & 2 deletions docs/Advanced Failure Criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
sidebar_label: 'Advanced Failure Criteria'
---

![](../static/imgbasic/sm-failure-criteria-job-definition.png)

* Failure Criteria - Advanced tab allows the specification of multiple Exit Codes
* Combining this with Events based on Job Exit Description allows OpCon to behave differently based on Exit Condition
* **Unlike Events based on Job Exit Description**, Advanced Failure Criteria does **NOT** need the full Exit Code

### Basic Failure Criteria

![](../static/imgbasic/sm-failure-criteria-job-definition.png)

## Enterprise Manager

Expand Down
76 changes: 76 additions & 0 deletions docs/Agent Details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
sidebar_label: 'Agent Details'
---

## Machine Definition

* A Representation of an **Agent or LSAM** in OpCon’s database
* LSAM stands for “**Local Schedule Activity Monitor**”
* LSAM/Agent listens for commands from OpCon’s main engine kicking off and monitoring specified tasks
* Machines define where a task will be run

#### Machine Status

* Displays Connection Status of all Machines configured in the OpCon database
* Displayed in Grid format
* Statuses are updatable from this screen

## Agent List Screen

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

## Defining a New Machine

### Agent Details

* Provide a Name
* Add Documentation
* Pick the Machine Type

:::tip Best Practice

Name the **Machine** the same as the **Server** that **Agent/LSAM** is installed on, as we resolve **communication via DNS**.

:::

![](../static/imgbasic/sm-unix-agent-details.png)

### Machine Information

This area is where you can:
* Define **Machine Instance Properties**
* Allow the **KILL** command, **USE EXTREME CAUTION IF YOU SET THIS TO TRUE** (not available for all Machine Types)

![](../static/imgbasic/sm-unix-agent-machine-information.png)

### Communication Settings

This area is where you can:
* Define the **JORS (Job Output Retreivial Service) Port Number**
* **TLS** Certificate Name and Serial Number

![](../static/imgbasic/sm-unix-agent-communication-settings.png)

### File Transfer Settings

This area is where you set up the machine to be a part of **SMA File Transfer** jobs.

![](../static/imgbasic/sm-unix-agent-file-transfer-settings.png)



## Enterprise Manager

<details>

![Picture208](../static/imgbasic/208.png)

#### Advanced Machine Properties

![Picture209](../static/imgbasic/209.png)

#### File Transfer Settings

![Picture210](../static/imgbasic/210.png)

</details>
35 changes: 0 additions & 35 deletions docs/Agent Settings.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/All Weeks -- On Occurrence -- On Day.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ sidebar_label: 'All Weeks -- On Occurrence -- On Day'
![Picture239](../static/imgbasic/SM_Frequency_OnDay.png)



## Enterprise Manager

<details>
Expand Down
8 changes: 5 additions & 3 deletions docs/Annual Plan Events.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ sidebar_label: 'Annual Plan Events'
* Dates can be added or removed from a Calendar through Events

```
$CALENDAR:ADD,Company Holiday Calendar,05/25/2025; 05/25/2026; 05/25/2027; 05/25/2028; 05/25/2029,ocadm,opconxps
$CALENDAR:ADD,Company Holiday Calendar,05/25/2025; 05/25/2026; 05/25/2027; 05/25/2028; 05/25/2029
```

```
$CALENDAR:DEL,Company Holiday Calendar,05/25/2025; 05/25/2026; 05/25/2027; 05/25/2028; 05/25/2029,ocadm,opconxps
$CALENDAR:DEL,Company Holiday Calendar,05/25/2025; 05/25/2026; 05/25/2027; 05/25/2028; 05/25/2029
```

* Scenarios:
* A Job needs to run 10 working days after the 15th of month
* A Null Job scheduled to run on the 15th could submit:
```
$CALENDAR:ADD,Company Holiday Calendar,[[$SCHEDULE DATE(+10wd)]],ocadm,opconxps
$CALENDAR:ADD,Company Holiday Calendar,[[$SCHEDULE DATE(+10wd)]]
```
* A Job needs to run the working day before a different Job scheduled for the 15th-B
* Date calculation tool – **Chronoman**
Expand All @@ -36,6 +36,8 @@ $CALENDAR:ADD,Company Holiday Calendar,[[$SCHEDULE DATE(+10wd)]],ocadm,opconxps

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



## Enterprise Manager

<details>
Expand Down
27 changes: 24 additions & 3 deletions docs/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,36 @@ sidebar_label: 'Architecture'

### What is OpCon?


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

![Picture3](../static/imgbasic/Picture3.png)
<img src="imgbasic/Picture3.png" width="600"/>

### OpCon Architecture Overview

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

### Solution Manager

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

![Picture5](../static/imgbasic/Picture5.png)
### Heartbeat Indicator

The **Heartbeat indicator** quickly identifies the status of the SAM and/or the Agents. Depending on the current state of the SAM and Agents, this indicator will have one of the following visual aspects:

- ![Heatbeat Indicator 1](../static/imgbasic/HeartbeatIndicator1.png "Heatbeat Indicator 1") - This indicates that the communication between Solution Manager and OpCon Rest API is broken.
- ![Heatbeat Indicator 2](../static/imgbasic/HeartbeatIndicator2.png "Heatbeat Indicator 2") - This indicates that the SAM is DOWN.
- ![Heatbeat Indicator 7](../static/imgbasic/HeartbeatIndicator7.png "Heatbeat Indicator 7")- This indicates that the SAM is DOWN and at least one Agent is waiting on communication.
- ![Heatbeat Indicator 3](../static/imgbasic/HeartbeatIndicator3.png "Heatbeat Indicator 3") - This indicates that the SAM is UP and all started Agents are communicating (whether limited or not).
- ![Heatbeat Indicator 4](../static/imgbasic/HeartbeatIndicator4.png "Heatbeat Indicator 4") - This indicates that the SAM is UP, but at least one Agent is waiting on communication (and none is in error).
- ![Heatbeat Indicator 5](../static/imgbasic/HeartbeatIndicator5.png "Heatbeat Indicator 5") - This indicates that the SAM is UP, but at least one started Agent does not respond (and at least one is started or waiting).
- ![Heatbeat Indicator 6](../static/imgbasic/HeartbeatIndicator6.png "Heatbeat Indicator 6") - This indicates that the SAM is UP, but all started Agents do not respond (in error).



## Enterprise Manager

<details>

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

</details>
18 changes: 12 additions & 6 deletions docs/Audit Management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,26 @@
sidebar_label: 'Audit Management'
---

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

* Used to view history of User updates to the OpCon database
* Click View Audit button or export data to .CSV file

#### Location

* Resides under **Management** > **Reporting**

<img src="imgbasic/AuditHistory.png" width="600"/>

#### Filtering

* The Audit Management (view) screen displays drop list for user, audit category selection, and options for date range to view preferred Audit information
* Select **Master Job** in Audit Categories drop-down list
* Click View Audit button or export data to .CSV file

![AuditHistory](../static/imgbasic/AuditHistory.png)
<img src="imgbasic/Columns.png" width="500"/>

![AuditHistory2](../static/imgbasic/AuditHistory2.png)
<img src="imgbasic/Categories.png" width="500"/>

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

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

## Enterprise Manager

Expand Down
1 change: 0 additions & 1 deletion docs/Batch Jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ sidebar_label: 'Batch Jobs'
* Batch Jobs are designed to run without direct user interaction
* With OpCon, **Enterprise Manager** and **Solution Manager** are the User Interfaces for creating and maintaining Batch Jobs


##### What can be executed from a Windows Batch Job?

* Anything executed from CMD Window
Expand Down
2 changes: 2 additions & 0 deletions docs/Batch Users.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ SQL Agent also requires an added valid Batch User Privilege

![](../static/imgbasic/sm-batch-user-privileges.png)



## Enterprise Manager

<details>
Expand Down
29 changes: 14 additions & 15 deletions docs/Calendars.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@
sidebar_label: 'Calendars'
---

### Holiday Calendars
* In Solution Manager, **Calendars** is found in **Library > Administration > Calendars**

* OpCon supports several types of Calendars to help provide flexible scheduling around holidays and any other non-working days
### Calendar Main Screen

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

## Calendar Types

* OpCon supports several types of Calendars to help provide flexible scheduling around holidays and any other non-working days
* **Master Holiday Calendar**
* Installed with OpCon database
* Stores non-working days for multiple Schedules
Expand All @@ -21,19 +26,6 @@ sidebar_label: 'Calendars'
* Stores non-working days for a single Schedule
* Administrators must set additional days as non-working days when required

### Workdays Per Week

* Workdays Per Week combined with Schedule Holiday Calendars specify which dates are considered working days
* Workdays Per Week can be overwritten by Frequencies

## Solution Manager

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

### Calendar Select/Add/Edit Main Screen

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

### Calendar Add/Edit Selections

![](../static/imgbasic/sm-calendar-add-edit.png)
Expand All @@ -42,6 +34,13 @@ sidebar_label: 'Calendars'

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

### Workdays Per Week

* Workdays Per Week combined with Schedule Holiday Calendars specify which dates are considered working days
* Workdays Per Week can be overwritten by Frequencies



## Enterprise Manager

<details>
Expand Down
1 change: 0 additions & 1 deletion docs/Common Role Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ sidebar_label: 'Common Role Configurations'
![](../static/imgbasic/316.png)
![](../static/imgbasic/317.png)


#### Operators

* These individuals will monitor Jobs and Schedules on daily basis
Expand Down
Loading
Loading