Merge pull request #1 from MoKranda/main

added collateral

docs/answer_prompts.md

@@ -0,0 +1,54 @@
+---
+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**
+
+### Sub-Type
+
+<!--
+![ ](../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. |
+
+:::tip Best Practice
+
+It is best practice to store the path to RSJ in a **Global Property**, 
+
+* **RSJPath** = ```/ops/bin```
+
+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]]"```
+
+:::

docs/backup_and_prune.md

@@ -0,0 +1,27 @@
+---
+sidebar_label: 'Backup and Prune'
+---
+
+# Backup And Prune
+
+* **backup_and_prune** is a program that will tar and compress the ```/SYM/SYM###/opcon_reports``` directory. 
+* It stores the resulting file in ```/SYM/SYMnnn/opcon_backup``` directory. 
+* It also removes old backup files that are located in the ```/SYM/SYMnnn/opcon_reports``` directory.
+
+### backup_and_prune Syntax
+
+ ```/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 |
+
+
+:::tip Best Practice
+
+* To put a version of this job in SMAUtility for every SYM that you run RSJ jobs in. Each instance of the job should be run daily in order to maintain disk space on your host. 
+
+* In the Start Image run:  ```/ops/bin/backup_and_prune SYM000 7 30```
+:::

docs/find_batch_output_seq_num.md

@@ -0,0 +1,64 @@
+---
+sidebar_label: 'Find Batch Report Sequence Nnumber'
+---
+
+# Episys: Find Batch Report Sequence Number
+
+* Recommended to use **Find Report from RSJ Output**
+* Calls an RSJ Utility called **LookForBatchOutputSequence**
+* Scans the lastest Batch Output located in the ```/SYM/SYM###/opcon_reports/<JOB.NAME>``` directory
+* Parses the SEQ# out of the Batch Output for a Batch Job that was ran via RSJ
+* **First instance found ONLY**
+* Submits a **$PROPERTY:ADD** event so the **Property Value** will reflect the **SEQ#** found
+
+### Sub-Type
+
+<!--
+![](../static/imgbasic/BatchOutputSEQNum.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 that ran in Episys through RSJ. |
+| Property Name | Required | Defines the name of the OpCon Property that will have its value set by this job. |
+| MSGIN Directory | Required | Defines the full path to the MSGIN directory on the UNIX machine the job will run on. |
+| OpCon User ID | Required | Defines an OpCon User ID with privileges to "Maintain Global Properties". |
+| External Event Password | Required | Defines the External Event Password for the OpCon User ID specified. |
+| Occurrence to Search for | Optional | Defines a numerical value (maximum value 99) that identifies the occurrence of the Report title to search for. |
+
+:::tip Best Practice
+
+It is recommened that the values for RSJ Path, SYM Number, MSGIN Directory, OpCon User ID, and External Event Password fields reference Global or Schedule Properties with the appropriate values. 
+
+* **PATH_RSJ** = ```/ops/bin```
+* **SI.SYM** = ```000```
+* **PATH_UNIX_MSGIN** = ```/usr/local/lsam/msgin/3100```
+* **USER_OCADM** = ```ocadm```
+* **USER_TOKE** = ```ocadm's token```
+
+:::
+
+### LookForBatchOutputSequence Syntax
+
+```[[RSJPATH]]/LookForBatchOutputSequence SYM### JOB.NAME PROPERTY.NAME UNIX_MSGIN USER "TOKEN” OCCURENCE```
+
+| 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. |
+| JOB.NAME | Required | Defines the name of the job that ran in Episys through RSJ. |
+| PROPERTY.NAME | Required | Defines the name of the OpCon Property that will have its value set by this job. |
+| UNIX_MSGIN | Required | Defines the full path to the MSGIN directory on the UNIX machine the job will run on. |
+| USER | Required | Defines an OpCon User ID with privileges to "Maintain Global Properties". |
+| TOKEN | Required | Defines the External Event Password for the OpCon User ID specified. |
+| OCCURENCE | Optional | Defines a numerical value (maximum value 99) that identifies the occurrence of the Report title to search for. |
+
+:::tip Examples
+
+Here are some command line examples:
+
+* ```/ops/bin/LookForBatchOutputSequence 000 ACH.REPOST.JOB "SEQ.ACH REPORT" [[PATH_UNIX_MSGIN]] [[USER_OCADM]] "[[USER_TOKEN]]”```
+* ```/ops/bin/LookForBatchOutputSequence 000 GN.AFTER.OFFLINE SEQ.GN.AFTER.OFFLINE [[PATH_UNIX_MSGIN]] [[USER_OCADM]] "[[USER_TOKEN]] 5```
+
+:::

docs/find_prompts.md

@@ -0,0 +1,23 @@
+---
+sidebar_label: 'Find Prompts'
+---
+
+# Find Prompts
+
+* A program that will find all possible user prompts in a nested Symitar job. 
+* This program facilitates the conversion of a Symitar job file into OpCon.
+
+### find_prompt Syntax
+
+```/ops/bin/find_prompts SYM### job_file```
+
+| 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. |
+| job_file | Required | Defines the name of the jobfile that is being quered for prompts. |
+
+:::tip Best Practice
+To put a version of this job in SMAUtility  with an OnRequest frequency.
+Manually add it when creating a new Answer Prompts job to get all prompts.
+In the Start Image: ```/ops/bin/find_prompts SYM000 [[JI.JOBNAME]]```
+:::

docs/find_report_from_episys_report.md

@@ -0,0 +1,64 @@
+---
+sidebar_label: 'Find Report From Episys Report'
+---
+
+# Episys: Find Report From Episys Report
+
+* Calls an RSJ Utility called **LookForReportSequenceInReports**
+* Scans the Batch Output located in the ```/SYM/SYM###/REPORT``` directory
+* Parses the SEQ# out of the Batch Output for a Batch Job that were **NOT** ran via RSJ
+* Can specify an occurrence to search for
+* Submits a **$PROPERTY:ADD** event so the **Property Value** will reflect the **SEQ#** found
+
+### Sub-Type
+
+<!--
+![](../static/imgbasic/ReportEpisysReport.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 that ran in Episys through RSJ. |
+| Report Name | Required | Defines the name of the report whose sequence number is of interest. |
+| Property Name | Required | Defines the name of the OpCon Property that will have its value set by this job.  |
+| MSGIN Directory | Required | Defines the full path to the MSGIN directory on the UNIX machine the job will run on. |
+| OpCon User ID | Required | Defines an OpCon User ID with privileges to "Maintain Global Properties". |
+| External Event Password | Required | Defines the External Event Password for the OpCon User ID specified |
+| Occurrence to Search for | Optional | Defines a numerical value (maximum value 99) that identifies the occurrence of the Report title to search for. |
+
+:::tip Best Practice
+
+It is recommened that the values for RSJ Path, SYM Number, MSGIN Directory, OpCon User ID, and External Event Password fields reference Global or Schedule Properties with the appropriate values. 
+
+* **PATH_RSJ** = ```/ops/bin```
+* **SI.SYM** = ```000```
+* **PATH_UNIX_MSGIN** = ```/usr/local/lsam/msgin/3100```
+* **USER_OCADM** = ```ocadm```
+* **USER_TOKE** = ```ocadm's token```
+
+:::
+
+### LookForReportSequenceInReports Syntax
+
+```[[RSJPATH]]/LookForReportSequenceInReports SYM### JOB.NAME PROPERTY.NAME UNIX_MSGIN USER "TOKEN” OCCURENCE```
+
+| Parameter |	Required / Optional | Description |
+| --- | --- | --- |
+| ### | Required | This is the three digit SYM number of where the Batch Job was ran. |
+| JOB.NAME | Required | This is the name of the subdiredctory to search. It will be the same name that is used when the RSJ job ran. |
+| PROPERTY.NAME | Required | This is the name of the Property that will be updated with the SEQ number found for the Report. |
+| UNIX_MSGIN | Required | This is the path to the UNIX MSGIN directory. |
+| USER | Required | This is the user id that is submitted via the event that is submitted when the SEQ number is found. |
+| TOKEN | Required | This is the token for the user id that is specified in the previous parameter. |
+| OCCURENCE | Optional | This is the occurence of the report to search for. If nothing is specified, the first occurence is found. |
+
+:::tip Examples
+
+Here are some command line examples:
+
+* ```/ops/bin/LookForReportSequenceInReports 000 ACH "SEQ.ACH REPORT" [[PATH_UNIX_MSGIN]] [[USER_OCADM]] "[[USER_TOKEN]]”```
+* ```/ops/bin/LookForReportSequenceInReports 000 "Teller Totals by Branch" SEQ.GN.AFTER.OFFLINE [[PATH_UNIX_MSGIN]] [[USER_OCADM]] "[[USER_TOKEN]] 3```
+
+:::

docs/find_report_from_rsj.md

@@ -0,0 +1,66 @@
+---
+sidebar_label: 'Find Report From RSJ'
+---
+
+# Episys: Find Report from RSJ Output
+
+* Calls an RSJ Utility called **LookForReportInRSJ**
+* Scans the Batch Output located in the ```/SYM/SYM###/opcon_reports/<JOB.NAME>``` directory
+* Parses the SEQ number out of the Batch Output for a Batch Job that was ran via RSJ
+* Can specify an occurrence to search for
+* Submits a **$PROPERTY:ADD** event so the **Property Value** will reflect the **SEQ#** found
+
+### Sub-Type
+
+<!--
+![](../static/imgbasic/FromRSJOutput.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 that ran in Episys through RSJ. |
+| Report Name | Required | Defines the name of the report whose sequence number is of interest. |
+| Property Name | Required | Defines the name of the OpCon Property that will have its value set by this job.  |
+| MSGIN Directory | Required | Defines the full path to the MSGIN directory on the UNIX machine the job will run on. |
+| OpCon User ID | Required | Defines an OpCon User ID with privileges to "Maintain Global Properties". |
+| External Event Password | Required | Defines the External Event Password for the OpCon User ID specified. |
+| Occurrence to Search for | Optional | Defines a numerical value (maximum value 99) that identifies the occurrence of the Report title to search for. |
+
+:::tip Best Practice
+
+It is recommened that the values for RSJ Path, SYM Number, MSGIN Directory, OpCon User ID, and External Event Password fields reference Global or Schedule Properties with the appropriate values. 
+
+* **PATH_RSJ** = ```/ops/bin```
+* **SI.SYM** = ```000```
+* **PATH_UNIX_MSGIN** = ```/usr/local/lsam/msgin/3100```
+* **USER_OCADM** = ```ocadm```
+* **USER_TOKE** = ```ocadm's token```
+
+:::
+
+### LookForReportInRSJ Syntax
+
+```[[RSJPATH]]/LookForReportInRSJ SYM### JOB.NAME REPORT.NAME PROPERTY.NAME UNIX_MSGIN USER "TOKEN” OCCURENCE```
+
+| 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. |
+| JOB.NAME | Required | Defines the name of the job that ran in Episys through RSJ. |
+| REPORT.NAME | Required | Defines the name of the report whose sequence number is of interest. |
+| PROPERTY.NAME | Required | Defines the name of the OpCon Property that will have its value set by this job. |
+| UNIX_MSGIN | Required | Defines the full path to the MSGIN directory on the UNIX machine the job will run on. |
+| USER | Required | Defines an OpCon User ID with privileges to "Maintain Global Properties". |
+| TOKEN | Required | Defines the External Event Password for the OpCon User ID specified. |
+| OCCURENCE | Optional | Defines a numerical value (maximum value 99) that identifies the occurrence of the Report title to search for. |
+
+:::tip Examples
+
+Here are some command line examples:
+
+* ```/ops/bin/LookForReportInRSJ 000 ACH.REPOST.JOB ACH "SEQ.ACH REPORT" [[PATH_UNIX_MSGIN]] [[USER_OCADM]] "[[USER_TOKEN]]”```
+* ```/ops/bin/LookForReportInRSJ 000 GN.AFTER.OFFLINE "Teller Totals by Branch" SEQ.EXP_TELLER_TOTALS_AND_CHECKS [[PATH_UNIX_MSGIN]] [[USER_OCADM]] "[[USER_TOKEN]] 5```
+
+:::
+

docs/force_log_off.md

@@ -0,0 +1,27 @@
+---
+sidebar_label: 'Force Logoff'
+---
+
+# ForceLogOff
+
+* **ForceLogOff** will automatically log off any users that are logged into a specific SYM.
+
+### ForceLogOff Syntax
+
+```/ops/bin/ForceLogOff SYM###```
+
+| 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. |
+
+:::tip Best Practice
+
+* To put a version of this job in GOODNIGHT.
+
+* In the Start Image: ```/ops/bin/ForceLogOff 000```
+:::
+
+:::caution
+
+**If user(s) are running any Episys jobs interactively, running this command can lock up the database requiring a reload of the sym.**
+:::