diff --git a/docs/answer_prompts.md b/docs/answer_prompts.md new file mode 100644 index 0000000..ffdbbac --- /dev/null +++ b/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 + + + +| 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]]"``` + +::: \ No newline at end of file diff --git a/docs/backup_and_prune.md b/docs/backup_and_prune.md new file mode 100644 index 0000000..2ccb5b1 --- /dev/null +++ b/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``` +::: \ No newline at end of file diff --git a/docs/find_batch_output_seq_num.md b/docs/find_batch_output_seq_num.md new file mode 100644 index 0000000..8ea9ae1 --- /dev/null +++ b/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/``` 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 + + + +| 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``` + +::: \ No newline at end of file diff --git a/docs/find_prompts.md b/docs/find_prompts.md new file mode 100644 index 0000000..d8bf8cb --- /dev/null +++ b/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]]``` +::: diff --git a/docs/find_report_from_episys_report.md b/docs/find_report_from_episys_report.md new file mode 100644 index 0000000..a077fea --- /dev/null +++ b/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 + + + +| 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``` + +::: \ No newline at end of file diff --git a/docs/find_report_from_rsj.md b/docs/find_report_from_rsj.md new file mode 100644 index 0000000..95950ea --- /dev/null +++ b/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/``` 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 + + + +| 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``` + +::: + diff --git a/docs/force_log_off.md b/docs/force_log_off.md new file mode 100644 index 0000000..66aa9a4 --- /dev/null +++ b/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.** +::: \ No newline at end of file diff --git a/docs/ftp_all_reports_in_list.md b/docs/ftp_all_reports_in_list.md new file mode 100644 index 0000000..a260854 --- /dev/null +++ b/docs/ftp_all_reports_in_list.md @@ -0,0 +1,63 @@ +--- +sidebar_label: 'FTP All Reports in List' +--- + +# Episys: FTP all Reports in List + +* Calls an RSJ Utility called **optical_transfer** +* Takes a list of SEQ numbers and transfers the to another server. +* This list is created by a special Symitar repgen that prints just SEQ numbers to an output file. +* FTP must be enabled in order for this utility to work + +### Sub-Type + + + +| 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. | +| Report Name | Required | Defines the name of the report whose sequence number is of interest. | +| FTP User | Required | Defines the name of the user which the files will be "FTPed" as. | +| FTP Password | Required | Defines the FTP User's Password. Some special characters have a special meaning to the UNIX shell and may be converted by the shell into other strings (such as '*'). These characters must be 'escaped' with a backslash. | +| Destination Host Name | Required | Defines the name of the Server the files will be sent to. | +| Port Number | Optional | Defines the FTP Port number to use. | +| Destination Folder | Required | Defines the directory to place the files on the destination Host machine. | +| Extension | Optional | Defines the optional parameter used to give the reports an extension. | + +:::tip Best Practice + +It is recommened that the values for RSJ Path, SYM Number, FTP User, and FTP Password fields reference Global or Schedule Properties with the appropriate values. + +* **PATH_RSJ** = ```/ops/bin/``` +* **SI.SYM** = ```000``` +* **FTP_User** = FTP User Name +* **FTP_Password** = FTP User's Password (can be encrypted) + +::: + +### optical_transfer Syntax + +```/ops/bin/optical_transfer sym# sequence_number ftp_username ftp_password ftp_hostname[:port] ftp_directory_to_place_files [ftp_extension_to_append]``` + +| 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. | +| sequence_number | Required | Defines the name of the report whose sequence number is of interest. | +| ftp_username | Required | Defines the name of the user which the files will be "FTPed" as. | +| ftp_password | Required | Defines the FTP User's Password. Some special characters have a special meaning to the UNIX shell and may be converted by the shell into other strings (such as '*'). These characters must be 'escaped' with a backslash. | +| ftp_hostname | Required | Defines the name of the Server the files will be sent to. | +| port | Optional | Defines the FTP Port number to use. | +| ftp_directory_to_place_files | Required | Defines the directory to place the files on the destination Host machine. | +| ftp_extention_to_append | Optional | Defines the optional parameter used to give the reports an extension. | + +:::tip Examples + +Here are some command line examples: + +* ```/ops/bin/optical_transfer 000 123456 ftp_username ftp_password FileShare[:21] "C:\Temp" .txt``` +* ```/ops/bin/optical_transfer 000 456789 ftp_username ftp_password FileShare[:21] "C:\Temp" .txt``` +::: + diff --git a/docs/index.md b/docs/index.md index 3a0c298..d11588e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,9 @@ --- slug: '/' -sidebar_label: 'RSJ Connector Training' +sidebar_label: 'RSJ Training' --- -# RSJ Connector Training \ No newline at end of file +# RSJ Training + +The Episys Interface is an OpCon environment that allows OpCon to run RSJ through a UNIX LSAM on the Episys server. + diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..c53e8a1 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,15 @@ +--- +sidebar_label: 'Intoduction to RSJ' +--- + +# Introduction to RSJ + +* OpCon with RSJ allow your IT team to streamline Symitar platform administration and redirect their efforts towards strategic and growth initiatives, rather than routine operational tasks. + +* With RSJ you can: + * Automate repetitive tasks to prevent errors and save time + * Send, retrieve, and process daily files to and from The Fed and third-party vendors + * Automate payment processing, loan origination and servicing, and more + * Streamline critical processes within Symitar + * Automate disaster recovery procedures + * Assist in maintaining compliance with regulatory requirements diff --git a/docs/restart_point.md b/docs/restart_point.md new file mode 100644 index 0000000..51e40ae --- /dev/null +++ b/docs/restart_point.md @@ -0,0 +1,56 @@ +--- +sidebar_label: 'Restart Point' +--- + +# Restart Point + +* Allows a user to restart a Batch Job at a specific point +* Primarily used in event of a failure +* Can be utilized in a nested job +* Is specified as a Comment in the Batch Job in the following format ```RESTART_POINT ``` + +### Sub-Type Usage + + + +| Field | Required / Optional | Description | +| --- | --- | --- | +| SYM Number | Required | The SYM# parameter is required. It tells RSJ which SYM to run the job in. The SYM number can be in either of the following formats: 000 or SYM00. | +| Episys Job | Required | The Job Name parameter is required. It tells RSJ the name of the Symitar Batch Job to Run | +| Restart Point | Optional | The restart_point parameter is optional. It tells RSJ the name of the restart point to look for tin a Symitar Batch File | +| Edit File | Optional | The name and path to the file that RSJ will move into EDITFILE. If an Edit File is specified the Multi-Thread check box isn’t available . | +| Multi-Thread Check Box | Optional | Allows RSJ to run multiple jobs at a time. Not available if an Edit File is specified. | +| Delete Edit File Check Box | Optional | Tells RSJ to delete the Edit File if specified after the Batch Job has run. | + +### Restart_Point Syntax + + ```/ops/bin/RSJ [-Eeditfile_name] [-d] [-D] SYM# JobName [restart_point]``` + +| Command Line Parameter | Required / Optional | Description | +| --- | --- | --- | +| -E | Optional | The –E parameter is optional. It specifies the path and name of the file to move into the /SYM/SYMnnn/EDITFILE.DATA There is no space between the –E and the editfile_name. If an EDITFILE is specified, RSJ will automatically run the job in single_thread mode. | +| -D | Optional | It causes RSJ to delete the contents of /SYM/SYMnnn/opcon_reports/job_name_to_run before running the job. If the –D switch is not present on the command line; the directory will not be deleted before running the job. | +| -d | Optional | It causes RSJ to delete the –E. Eeditfile_name upon successful completion of the job. If the –d switch is not present on the command line, the editfile_name file will not be deleted. | +| SYM# | Required | The SYM# parameter is required. It tells RSJ which SYM to run the job in. The SYM number can be in either of the following formats: 000 or SYM000. | +| JobName | Required | The JobName parameter is required. It tells RSJ the name of the Symitar Batch Job to run. | +| restart_point | Optional | The restart_point parameter is optional. It tells RSJ the name of a restart point to look for in a Symitar Batch Jobfile. For more information, refer to RESTART_POINT. | + +:::tip Best Practice +* Locate the Job File that you want to restart from. + + + +* Add a comment to specify the restart point. ```RESTART_POINT [Jobfile Name]``` + + +* Modify the dailly version of the RSJ job to specify the Jobfile Name + +::: \ No newline at end of file diff --git a/docs/rsj_reports.md b/docs/rsj_reports.md new file mode 100644 index 0000000..6ef8c8b --- /dev/null +++ b/docs/rsj_reports.md @@ -0,0 +1,13 @@ +--- +sidebar_label: 'RSJ Reports' +--- + +# RSJ Reports + +* Every job that is ran via RSJ creates an RSJ Report +* These files are stored in the ```opcon_reports``` directoy within the SYM that the job was executed in +* These files are used when searching for SEQ numbers +* The ```opcon_reports``` directory is maintained by the RSJBankup_Prune job in the SMAUtility schedule +* The structure of the ```opcon_reports``` directory is: + * ```/SYM/SYM###/opcon_reports/JOB.NAME``` + * Where JOB.NAME is the name of the Batch File that is executed byt RSJ. \ No newline at end of file diff --git a/docs/sma_defaults.md b/docs/sma_defaults.md new file mode 100644 index 0000000..503445b --- /dev/null +++ b/docs/sma_defaults.md @@ -0,0 +1,92 @@ +--- +sidebar_label: 'SMA_DEFAULTS' +--- + +# SMA_DEFAULTS + +## What is the SMA_DEFAULTS file? + +* Is stored in /SYM/SYM###/BATCH +* Needs to be in every SYM that RSJ runs jobs in +* Holds all of the settings that should be applied to EVERY job ran via RSJ +* Is always printed in the Job Output of EVERY RSJ job +* All of the settings can be placed as a Comment in the Batch File as well + +:::danger + +This file will be read and executed for all job files to be run. Make sure that reasonable/wanted values are set for error processing. To override these defaults for a single job, you will need to place the desired error processing commands at the start of the job file. + +::: + +:::tip Best Practice + +In the ***SMA_DEFAULTS** files, define the following settings for RSJ: +* Create Reports Links +* Error Levels +* Max Exceptions +* Java Home Directive + +::: + +## Popular Settings + +### CREATE_OPCON_REPORTS_LINKS + +* The default value is "true.” +* This will create symbolic links to Batch Outputs in the opcon_reports directory +* If set to false, symbolic links to Batch Outputs in the opcon_reports directory will NOT be created + +#### Syntax + +* ```;CREATE_OPCON_REPORTS_LINKS true|false``` + +### ERROR_LEVELS + +* The codes set will cause the RSJ to stop processing the Batch File (nested or not) +* Can be set as a Comment in the Batch File and will override what is in the SMA_DEFAULT file. + +#### Syntax + +* ```;ERROR_LEVEL ``` + +### MAX_EXCEPTIONS + +* The default is 0 +* Is the maximum number of exceptions pages that are allowed +* If the number of exception pages goes over this limit, the job will be terminated + +#### Syntax + +* ```;MAX_EXCEPTIONS #``` + +### JAVA_HOME + +* Can only be set in the SMA_DEFAULTS file +* Points to where Java lives on the host + +#### Syntax + +* ```;JAVA_HOME ``` + +### MINUTES_TO_WAIT_FOR_EDITFILE + +* The default is 10 minutes +* If the job to be executed requires an EDITFILE but an EDITFILE exists, RSJ will wait +* If the time elapses RSJ will move the file into a temporary location as a form of backup + +#### Syntax + +* ```; MINUTES_TO_WAIT_FOR_EDIT_FILE #``` + + +:::note Example of an SMA_DEFAULTS File + +``` +;CREATE_OPCON_REPORTS_LINKS false +;ERROR_LEVEL 1-4,6,10-13 +;MAX_EXCEPTIONS 999999 +;JAVA_HOME "/usr/java7" +;MINUTES_TO_WAIT_FOR_EDITFILE 15 +``` + +::: diff --git a/docs/subtype_rsj.md b/docs/subtype_rsj.md new file mode 100644 index 0000000..1b0b8e1 --- /dev/null +++ b/docs/subtype_rsj.md @@ -0,0 +1,32 @@ +--- +sidebar_label: 'Run JobFile' +--- + +# Episys: Run JobFile + +* This is the sub-tpye that is used to run Batch Jobs via RSJ. + + + +| Field | Required / Optional | Description | +| --- | --- | --- | +| SYM Number | Required | The SYM# parameter is required. It tells RSJ which SYM to run the job in. The SYM number can be in either of the following formats: 000 or SYM00. | +| Episys Job | Required | The Job Name parameter is required. It tells RSJ the name of the Symitar Batch Job to Run | +| Restart Point | Optional | The restart_point parameter is optional. It tells RSJ the name of the restart point to look for tin a Symitar Batch File | +| Edit File | Optional | The name and path to the file that RSJ will move into EDITFILE. If an Edit File is specified the Multi-Thread check box isn’t available . | +| Multi-Thread Check Box | Optional | Allows RSJ to run multiple jobs at a time. Not available if an Edit File is specified. | +| Delete Edit File Check Box | Optional | Tells RSJ to delete the Edit File if specified after the Batch Job has run. | + +:::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``` + +::: \ No newline at end of file diff --git a/docs/what_is_rsj.md b/docs/what_is_rsj.md new file mode 100644 index 0000000..5da6cc7 --- /dev/null +++ b/docs/what_is_rsj.md @@ -0,0 +1,41 @@ +--- +sidebar_label: 'What is RSJ?' +--- + +# What is RSJ? + +* Stands for ‘Run Symitar Job’ +* Is a connector that is run via a UNIX Agent on a Symitar Host +* Allows CUs and CUSOs to automate running Symitar Batch Files +* Provides the ability to Multi-Thread processes + +## Command Line Syntax + +* In order to use RSJ to execute Symitar Batch Jobs, you have to call RSJ in the command line: + +```/ops/bin/RSJ -E -d -D SYM### JobName restart_point``` + +| Command Line Parameter | Required / Optional | Description | +| --- | --- | --- | +| -E | Optional | The –E parameter is optional. It specifies the path and name of the file to move into the /SYM/SYMnnn/EDITFILE.DATA There is no space between the –E and the editfile_name. If an EDITFILE is specified, RSJ will automatically run the job in single_thread mode. | +| -D | Optional | It causes RSJ to delete the contents of /SYM/SYMnnn/opcon_reports/job_name_to_run before running the job. If the –D switch is not present on the command line; the directory will not be deleted before running the job. | +| -d | Optional | It causes RSJ to delete the –E. Eeditfile_name upon successful completion of the job. If the –d switch is not present on the command line, the editfile_name file will not be deleted. | +| SYM# | Required | The SYM# parameter is required. It tells RSJ which SYM to run the job in. The SYM number can be in either of the following formats: 000 or SYM000. | +| JobName | Required | The JobName parameter is required. It tells RSJ the name of the Symitar Batch Job to run. | +| restart_point | Optional | The restart_point parameter is optional. It tells RSJ the name of a restart point to look for in a Symitar Batch Jobfile. For more information, refer to RESTART_POINT. | + +:::tip Examples + +Here are some command line examples: + +* ```/ops/bin/RSJ 000 GOODNIGHT``` +* ```/ops/bin/RSJ -E/SYM/SYM000/LETTERSPECS/ACH.FILE -d 000 ACH ``` + +::: + +## Single versus Multi-Thread + +* RSJ defaults to single threaded mode, meaning only one job can run at a time. +* RSJ allows users the ability to run multiple Batch Files at one time. +* Multi-Threaded will is not available when and EditFile is specified. +* Multi-Threaded will block the EditFile directory from being used while multiple jobs are executing. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index f859f8b..927205c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,5 +1,34 @@ module.exports = { mySidebar: [ 'index', + 'introduction', + 'what_is_rsj', + 'rsj_reports', + 'sma_defaults', + { + type: 'category', + label: 'RSJ Sub-Types', + collapsed: true, + items: [ + 'subtype_rsj', + 'answer_prompts', + 'find_report_from_rsj', + 'find_batch_output_seq_num', + 'find_report_from_episys_report', + 'ftp_all_reports_in_list', + ], + }, + { + type: 'category', + label: 'RSJ Utilities', + collapsed: true, + items: [ + 'backup_and_prune', + 'find_prompts', + 'force_log_off', + 'restart_point', + ], + }, + ], }; diff --git a/static/imgbasic/AC_Master.png b/static/imgbasic/AC_Master.png new file mode 100644 index 0000000..000f34f Binary files /dev/null and b/static/imgbasic/AC_Master.png differ diff --git a/static/imgbasic/AnswerPrompts.png b/static/imgbasic/AnswerPrompts.png new file mode 100644 index 0000000..87f281d Binary files /dev/null and b/static/imgbasic/AnswerPrompts.png differ diff --git a/static/imgbasic/BatchOutputSEQNum.png b/static/imgbasic/BatchOutputSEQNum.png new file mode 100644 index 0000000..e8e2aef Binary files /dev/null and b/static/imgbasic/BatchOutputSEQNum.png differ diff --git a/static/imgbasic/FromRSJOutput.png b/static/imgbasic/FromRSJOutput.png new file mode 100644 index 0000000..a9ecf5e Binary files /dev/null and b/static/imgbasic/FromRSJOutput.png differ diff --git a/static/imgbasic/ReportEpisysReport.png b/static/imgbasic/ReportEpisysReport.png new file mode 100644 index 0000000..f79663a Binary files /dev/null and b/static/imgbasic/ReportEpisysReport.png differ diff --git a/static/imgbasic/RunJobFile.png b/static/imgbasic/RunJobFile.png new file mode 100644 index 0000000..922669e Binary files /dev/null and b/static/imgbasic/RunJobFile.png differ diff --git a/static/imgbasic/comment.png b/static/imgbasic/comment.png new file mode 100644 index 0000000..c733f09 Binary files /dev/null and b/static/imgbasic/comment.png differ diff --git a/static/imgbasic/ftpallreportsinlist.png b/static/imgbasic/ftpallreportsinlist.png new file mode 100644 index 0000000..218f10f Binary files /dev/null and b/static/imgbasic/ftpallreportsinlist.png differ diff --git a/static/imgbasic/jobfile.png b/static/imgbasic/jobfile.png new file mode 100644 index 0000000..e794fd6 Binary files /dev/null and b/static/imgbasic/jobfile.png differ