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

updates #2

Merged
merged 2 commits into from
Jan 16, 2025
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 .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '14'
node-version: '18'
- run: yarn install
- run: yarn build
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '14'
node-version: '18'
- uses: kheiakiyama/install-azcopy-action@v1
with:
version: 'v10'
Expand Down
31 changes: 5 additions & 26 deletions docs/answer_prompts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,11 @@ sidebar_label: 'Answer Prompts'

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

| Field | Required / Optional | Description |
| --- | --- | --- |
| RSJ Path | Required | Defines the path to the directory on the UNIX Machine where the RSJ programs are installed. |
| SYM Number | Required | Defines the Episys "SYM" where the control file resides. The value should be a three-digit number or an OpCon token that resolves to a three-digit number. |
| Episys Job | Required | Defines the name of the job in Episys which contains the prompt(s) requiring answers. The name of the job is used to identify the Control File to update. |
| Update First Match Only  | Optional | Determines if the job will update only the first match for each prompt or if it will update all matches for each prompt. |
| Prompt/Response | Required | Defines the text for a Prompt and Response the Episys job will require. |
* **RSJ Path:** Defines the path to the directory on the UNIX Machine where the RSJ programs are installed.
* **SYM Number:** Defines the Episys "SYM" where the control file resides. The value should be a three-digit number or an OpCon token that resolves to a three-digit number.
* **Episys Job:** Defines the name of the job in Episys which contains the prompt(s) requiring answers. The name of the job is used to identify the Control File to update.
* **Update First Match Only:** Determines if the job will update only the first match for each prompt or if it will update all matches for each prompt.
* **Prompt/Response:** Defines the text for a Prompt and Response the Episys job will require.

:::tip Best Practice

Expand All @@ -31,22 +29,3 @@ and to store the SYM### as a **Schedule Instance**,
* **SYM** = ```000```

:::

### Update_scf Syntax

* ```/ops/bin/update_scf -f/SYM/SYM[[SI.SYM]]/BATCH/JOB.NAME "Prompt1:Answer1" "Prompt2:Answer2"```

| Parameter | Required / Optional | Description |
| --- | --- | --- |
| -f | Required | Specify the path and the file of the batch file to update |
| -s | Optional | Will only update the first matching prompt, otherwise all matching prompts will be updated |
| PromptX:AnswerX | Required | Surrounded in quotes, Defines the text for a Prompt and Response the Episys job will require. |

:::tip Examples

Here are some command line examples:

* ```/ops/bin/update_scf -f/SYM/SYM[[SI.SYM]]/BATCH/CC.LATE/FEE "Effective Date:[[$SCHEDULE DATE MMDDYY]]" "Date:047"```
* ```/ops/bin/update_scf -f/SYM/SYM[[SI.SYM]]/BATCH/DRAFTS "Effective Date:[[$SCHEDULE DATE MMDDYY]]"```

:::
28 changes: 28 additions & 0 deletions docs/answer_prompts_startimage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_label: 'Answer Prompts'
---

# Episys: Answer Prompts

* Calls an RSJ Utility called **update_scf**
* It updates a Batch Control File with answers to one or more prompts
* Prompts can be found by utilizing a utility called **find_prompts**

### Update_scf Syntax

* ```/ops/bin/update_scf -f/SYM/SYM[[SI.SYM]]/BATCH/JOB.NAME "Prompt1:Answer1" "Prompt2:Answer2"```

| Parameter | Required / Optional | Description |
| --- | --- | --- |
| -f | Required | Specify the path and the file of the batch file to update |
| -s | Optional | Will only update the first matching prompt, otherwise all matching prompts will be updated |
| PromptX:AnswerX | Required | Surrounded in quotes, Defines the text for a Prompt and Response the Episys job will require. |

:::tip Examples

Here are some command line examples:

* ```/ops/bin/update_scf -f/SYM/SYM[[SI.SYM]]/BATCH/CC.LATE/FEE "Effective Date:[[$SCHEDULE DATE MMDDYY]]" "Date:047"```
* ```/ops/bin/update_scf -f/SYM/SYM[[SI.SYM]]/BATCH/DRAFTS "Effective Date:[[$SCHEDULE DATE MMDDYY]]"```

:::
8 changes: 3 additions & 5 deletions docs/backup_and_prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@ sidebar_label: 'Backup and Prune'

 ```/ops/bin/backup_and_prune SYM### [# days_to_keep_reports] [# days_to_keep_backup]```

| Parameter | Required / Optional | Description |
| --- | --- | --- |
| ### | Required | Defines the Episys "SYM" where the control file resides. The value should be a three-digit number or an OpCon token that resolves to a three-digit number. |
| # days_to_keep_reports | Required | Defines the number of days to keep files in the opcon_report directory |
| # days_to_keep_backup | Required | Defines the number of backup files to keep |
* **###:** Defines the Episys "SYM" where the control file resides. The value should be a three-digit number or an OpCon token that resolves to a three-digit number.
* **# days_to_keep_reports:** Defines the number of days to keep files in the opcon_report directory
* **# days_to_keep_backup:** Defines the number of backup files to keep


:::tip Best Practice
Expand Down
66 changes: 66 additions & 0 deletions docs/exercise1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
sidebar_label: 'Exercise 1'
---

# RSJ Exercise 1

## Exercise 1: Architecture Set-up

## Objective

To define a new UNIX agent and path to RSJ.

## Summary

Define a new UNIX Agent called Symitar and define a new Global Property with the path to where RSJ would be installed.

## Instructions

#### Adding the Machine

1. In **Library** > **Administration**, select **Agents**.
2. Click the **Add** button.
* In the **Name** field, enter ```SYMITAR```.
* In the **Documentation** field, enter in some documentation.
* _Example: This machine will run all the Symitar jobs._
* In the **Type** drop-down list, select **UNIX**.
3. Click **Save**.

#### Define the General Settings

4. Expand the **General Settings** section.
* In the **IP Address** field, enter in the IP Address assigned to you by the instructor.
* In the **Socket Number** field, enter the port number ```3100```.

#### Define the Communication Settings

5. Expand the **Communication Settings** section.
* In the **JORS Port Number** field, enter ```3110```.

#### Define the File Transfer Settings

6. Expand the **File Transfer Settings** section.
* In the **File Transfer Role** field, select **Both** from the drop down menu.
* In the **File Transfer Port Number (Non-TLS)** field, enter ```3110```.
* In the **Support non-TLS for SMAFT Agent Communications** field, select **True** from the drop down menu.
* In the **Support non-TLS for SMAFT Server Communications** field, select **True** from the drop down menu.
* Click **Save**.
7. Close **Operations**.

:::info

We are **NOT** going to start communication to this agent. This is because we do not have a SYMITAR machine in this environment. All the jobs that we are going to be creating are for educational purposes but will not be ran in this environment.

:::

#### Define RSJ Global Property

8. In the **Library** > **Administration**, select **Global Properties**.
9. Click the **Add** button.
* In the **Name** field, enter ```RSJPATH```.
* In the **Value** field, enter ```/ops/bin```.
* Add this **Documentation** to the Global Property
* _Example: This Global Property stores the path to where RSJ is installed on the SYMITAR Host._
* Click the **Save** button.
10. Close **Library**.

66 changes: 66 additions & 0 deletions docs/exercise2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
sidebar_label: 'Exercise 2'
---

# RSJ Exercise 2

## Exercise 2: Multi-Threaded RSJ Job

## Objective

Create a multi-threaded RSJ job.

## Summary

Create a schedule that will have a single multi-threaded RSJ job in it.

## Instructions

#### Create the Schedule

1. In **Library** > **Administration**, select **Master Schedules**.
2. Click the **Add** button.
3. On the **Master Schedule Definition** screen:
* In the **Schedule Name** field, enter ```Multi-Threaded RSJ Schedule```.
* Add **Documentation** to your Schedule.
* Monday through Sunday are working days
* Use the Master Holiday Calendar.
* **Auto Build** 7 days in advance for 1 days
* **Auto Delete** 7 days ago
* Click the **Save** button.

#### Define the Schedule Instance Property

4. Click the **Lock** icon to enter **Admin Mode**.
5. Expand **Instance Definition**
* Click **Add New Property Set**
* In the **Name** field, enter ```SYM```.
* In the **Value** field, enter ```000```.
* Click the **Green Check Mark**.
6. Click **Save**.
7. Click **Back**.
8. Select **Multi-Threaded RSJ Schedule** in the **Schedule List**,
9. Click **View**.

#### Create the Multi-Threaded RSJ Job

10. Select **Add Job** button in the side menu.
11. On the **Master Job Definition** screen,
* In the **Name** field, enter ```RSJ BATCHJOB.1```.
* In the **Job Type** drop down, select **UNIX**.
* In the **Machine** drop down, select **SYMITAR**.
* In the **Job Sub-Type** section, click the blue **Edit** button.
* In the **Job Sub-Type** pop-up window, select **Episys: Run JobFile**
* In the **RSJ Path** field, verify that **[[RSJPATH]]** is showing.
* In the **SYM Number** field, enter ```[[SI.SYM]]```.
* In the **Episys Job** field, enter ```BATCHJOB.1```.
* Check the box for **Multi-thread**.
* Click **Save**
* In the **User ID** drop down, select **0/0**
* Click **Save**.
12. Click the **Lock** icon to enter **Admin Mode**.
13. In the **Documentation** section, add some documentation.
14. In the **Frequency** section, add the **Example Mon-Sun-O** Frequency.
15. Click **Save**.
16. Click **Back**.
17. Close **Studio** and **Library**.
94 changes: 94 additions & 0 deletions docs/exercise3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
sidebar_label: 'Exercise 3'
---

# RSJ Exercise 3

# Exercise 3: Single-Threaded RSJ Job

## Objective

Define a single threaded RSJ job.

## Summary

Create a schedule that will transfer a file to the host and run a single threaded RSJ job to process that file.

## Instructions

#### Create the Schedule

1. In **Library** > **Administration**, select **Master Schedules**.
2. Click the **Add** button.
3. On the **Master Schedule Definition** screen:
* In the **Schedule Name** field, enter ```Single Threaded RSJ Schedule```.
* Add **Documentation** to your Schedule.
* Monday through Sunday are working days
* Use the Master Holiday Calendar.
* **Auto Build** 7 days in advance for 1 days
* **Auto Delete** 7 days ago
* Click the **Save** button.

#### Define the Schedule Instance Property

4. Click the **Lock** icon to enter **Admin Mode**.
5. Expand **Instance Definition**
* Click **Add New Property Set**
* In the **Name** field, enter ```SYM```.
* In the **Value** field, enter ```000```.
* Click the **Green Check Mark**.
6. Click **Save**.
7. Click **Back**.
8. Select **Single Threaded RSJ Schedule** in the **Schedule List**,
9. Click **View**.

#### Create the File Transfer Job

10. Select **Add Job** button in the side menu.
11. On the **Master Job Definition** screen,
* In the **Name** field, enter ```SMAFT FILE2```.
* In the **Job Type** drop down, select **File Transfer**.
* On the **Source** side,
* In the **Machine** drop down, select **SMATraining**.
* In the **User** field, select **SMATRAINING\SMAUSER**.
* In the **File** field, enter ```"C:\RSJ_Training\FILE2.txt"```
* In the **Data Type** field, select **ASCII**.
* On the **Destination** side,
* In the **Machine** drop down, select **SYMITAR**.
* In the **User** field, select **0/0**.
* In the **File** field, enter ```/SYM/SYM[[SI.SYM]]/DATAFILE/FILE2```
* In the **Data Type** field, select **ASCII**.
* Leave the other settings as their default settings.
* Click **Save**.
12. Click the **Lock** icon to enter **Admin Mode**.
13. In the **Documentation** section, add some documentation.
14. In the **Frequency** section, add the **Example Mon-Sun-O** Frequency.
15. Click **Save**.
16. Click **Back**.

#### Create the Multi-Threaded RSJ Job

17. Select **Add Job** button in the side menu.
18. On the **Master Job Definition** screen,
* In the **Name** field, enter ```RSJ BATCHJOB.2```.
* In the **Job Type** drop down, select **UNIX**.
* In the **Machine** drop down, select **SYMITAR**.
* In the **Job Sub-Type** section, click the blue **Edit** button.
* In the **Job Sub-Type** pop-up window, select **Episys: Run JobFile**
* In the **RSJ Path** field, verify that **[[RSJPATH]]** is showing.
* In the **SYM Number** field, enter ```[[SI.SYM]]```.
* In the **Episys Job** field, enter ```BATCHJOB.2```.
* In the **Edit File** field, enter ```/SYM/SYM[[SI.SYM]]/DATAFILE/FILE2```
* Click **Save**
* In the **User ID** drop down, select **0/0**
* Click **Save**.
19. Click the **Lock** icon to enter **Admin Mode**.
20. In the **Documentation** section, add some documentation.
21. In the **Frequency** section, add the **Example Mon-Sun-O** Frequency.
22. In the **Job Dependency** section,
* Click the green **+** button
* In the **Job** field, select **SMAFT FILE2**
* Click **Save**
23. Click **Save**.
24. Click **Back**.
25. Close **Studio** and **Library**.
Loading
Loading