Child pages
  • EISCD Setup Procedures
Skip to end of metadata
Go to start of metadata

OVERVIEW

The EISCD procedure generates a standardized set of EIS fiscal year-end reports that are available to registered users online via a secure web site. The set of reports will be in .TXT and .PDF format and can be copied to an appropriate OECN$EIS_CDROM: subdirectory which can be used for later archival to CDRom. Appropriate INDEX.HTML files are also created automatically by the procedures so that the ITC may easily provide web access to the directory structures to give their districts immediate access to their reports via their web browser. Including the standardized reports generated, the ITC may also provide additional custom reports.

SETTING UP EISCD

Logicals and Data Structures

The data structures within each district’s top-level directory must be created prior to defining the logical or using the program. Be sure to give the necessary users WRITE access to the directories. If the ITC is providing web access to the directories, the web-server process will need to be granted READ access to the directories. The procedure will automatically create subdirectories beneath the district level for each fiscal year.

For example:

DEV:\[EISCDROM_ARCHIVE.district1.F2010\]

The OECN$EIS_CDROM logical should be defined for each district as a rooted logical pointing to the top-level directory where the districts’ reports should be placed.

For example:

DEFINE/TRANS=CONCEAL OECN$EIS_CDROM DEV:\[EISCDROM_ARCHIVE.district1.\]

This logical must be defined in order for the procedures to run. If not defined, the user will receive an error directing them to their system manager to find out whether or not they are configured to be able to run this procedure.

Web Usage

In order to provide web access to the district using OSU, the ITC will need to do the following:
1. First, add rules to the www_system:http_paths.conf file (or an included file). The following is an example:

  protect /eiscdrom/district1/\* www_system:eiscdrom_district1.prot
  pass /eiscdrom/district1/\* /eis$cdrom/district1/\*
 

The first rule says "protect URL’s starting with /eiscdrom/district1 using the rules in the file called www_sysman:eiscdrom_district1.prot".
The second rule only applies if authentication is successful and says "URLs starting with /eiscdrom/district1 reside on desk at eis$cdrom:[district1]."

2. The second step to provided web access to the district is to create the EISCDROM_DISTRICT1.PROT file for each district. This is the file the OSU server will read to determine what access limitation to place on the URL path. There are a number of options within the OSU’s authenticator, including hardcoded username and passwords, VMS usernames and passwords, or VMS ACL’s. The following is an example of what a .prot file might look like:

<realm>district1 Fiscal Records
username *

where <realm> indicates the prompt that will be shown when the username/password is prompted for, and "username" can access the records using their VMS password.

3. If the district would like their EISCD website address displayed on the email message sent when the EISCD procedure completes, you need to define the OECN$EIS_CDROM_URL logical to point to their EISCD URL address. The following is an example:

DEFINE OECN$EIS_CDROM_URL "https://eiscdrom/district1/"

Custom Reports

The ITC can provide additional custom reports by placing two procedures called EISCD_CUSTOM_REPORTS.COM and BLD_EISCDINDEX_CUSTOM.COM in the OECN$CUSTOM directory.  The EISCD_CUSTOM_REPORTS.COM procedure must accept the following four parameters and generate the desired reports in .TXT and .PDF format.

P1 = District Name
P2 = Period Start Date in MMDDYYYY format
P3 = Period End Date in MMDDYYYY format
P4 = Output Device and Directory

The BLD_EISCDINDEX_CUSTOM.COM procedure must contain a series of "if" statements checking the global symbol "file" and assigning a global symbol "title" to each .PDF file generated in the EISCD_CUSTOM_REPORTS.COM procedure. For example:

$ if file .eqs. "EIS001.PDF" then title == "EIS Code Listing"
$ exit

See EISCD_CUSTOM_REPORTS.SAMPLE and BLD_EISCDINDEX_CUSTOM.SAMPLE included with the release for samples of these two procedures.

Now vs. Later Option

When using the EISCD option from the menu system, the user will be prompted for whether to run the reports "Now" or "Later". The same definitions are used for "Now" and "Later" as are used by other state software report programs run through the standard screen-formatted interface. These definitions are documented in detail in the VMS Manager’s Handbook. Please see this document for details on how you can configure the batch queue, and priority at which the jobs run.

Entity IDs and Batch Mode

When running interactively, the procedure will prompt for whether the user wishes to include or exclude entity ids in those programs that allow this functionality. In batch mode, if you wish to include or exclude specific entity ids, you will need to create a file containing the entity ids. The first line of this file should say either "INCLUDE" or "EXCLUDE". Subsequent lines should list the entity ids you wish to include or exclude. This file can either be called oecn$eiscd_entities.dat and placed in the district’s oecn$eis$dta directory, or the logical OECN$EISCD_ENTITIES can be defined to point to this file. For example, a sample oecn$eiscd_entities.dat file might look like:

EXCLUDE
NOGAAP

Parameters

The EISCD procedure accepts several parameters, as described below.  Some of these parameters can be used to optionally run the procedure in batch mode to generate current reports or to more easily generate fiscal reports from archived fiscal year-end files.

  • P1: Optional parameter. If no parameter passed, the default option of "FISCAL" will be used. The values that might be passed are:
    • FISCAL: Generates the reports for the complete fiscal year and places them in OECN$EIS_CDROM:[.FIS]
    • CURFISCAL: Runs a current set of reports for the current fiscal year and places them in OECN$EIS_CDROM:[.CURRENT_YEAR]
  • P2: Optional Additional Username(s) to send email to. Email is automatically sent to the user running the procedure, but may optionally be sent to additional usernames by using this parameter.
    • NOTE: Email is only sent for the FISCAL option. No email is sent for the CURFISCAL option.
  • P3: Optional parameter. Data directory containing EIS files to run against.
  • P4: Optional parameter. Top level CDROM directory (i.e.,OECN$EIS_CDROM logical would normally point to). This should be in the form:DEV:[directory.district.]
  • P5: Optional paramter. Value of NOBATCH, causes routine to execute temporary file inline (via @) rather than submitting it to the batch queue. Default is BATCH.

Generating Fiscal Reports from Archive Accounts

Parameters P3 and P4 may be used to simplify running the procedure in batch against various accounts. For example, to execute the procedure against a district’s fiscal year-end archived files to generate a set of fiscal reports for that year, you might submit it something like this:

SUBMIT EISCD.COM/PARAM=(FISCAL,"",dev:[fyrdir],dev:[dir.district1])

Where the third parameter points to the directory containing the fiscal year-end archive files to run against, and the fourth parameter points to the district’s top level directory set up to store the resulting reports. In this case, if you were running for fiscal year 2009, the procedure would create the directory dev:[dir.district1.f2009.] and place the resulting reports into this directory for archival purposes.

Generating Current Month or Current Fiscal Reports

Parameters P3 and P4 may also be used along with the CURFISCAL option to generate a set of current fiscal reports on a nightly or other periodic basis. The procedure could be set up to run in batch nightly to provide constantly refreshed reports via web access. For example:

SUBMIT EISCD.COM/PARA=(CURFISCAL,"",dev:[livedir],dev:[dir.district1])

In the example above, the third parameter would contain the device and directory of the district’s live EIS files, and the fourth parameter would be the district’s top level directory set up to store the resulting reports. In this case, the procedure would create the directory
dev:[dir.district1.current_fiscal] and generate a set of reports from the beginning of the fiscal year through the current date and placed in the directory dev:[dir.district1.current_year].  In all cases, the appropriate links will be created on the INDEX.HTML file(s) to allow web access to the newly created directories and reports.

Rebuilding the INDEX.HTML Files

The INDEX.HTML files will normally be kept up-to-date as the procedure runs. However, if necessary, these files can be rebuilt manually using the BUILD_EISCDINDEX_TOP.COM procedure. To do this, you would execute the procedure, passing it the following parameters:

  • P1 = Directory to build the index file in
  • P2 = District Name
  • P3 = ALL (causes it to rebuild the index.html files for all recognized subdirectories)

For example:

@OECN$EIS:BLD_EISCDINDEX_TOP dev:[dir.district1] "Sample District" ALL
  • No labels