Documente Academic
Documente Profesional
Documente Cultură
Ellipse Administration
Contents
Administration .........................................................................................................8
Batch Administration ............................................................................................. 9
Start or Stop the Batch Subsystem ..................................................................... 10
Add User Queues ........................................................................................... 11
Review Default Queues ................................................................................... 12
Override Scheduled Cyclic Request Time ............................................................. 13
View Batch Log File ....................................................................................... 14
View Batch File............................................................................................. 15
Create Custom Batch File ................................................................................ 16
Upload Custom Batch File ................................................................................ 17
Delete Custom Batch File ................................................................................ 18
Reporting Administration (E9.0) ............................................................................. 19
Group Report Requests ................................................................................... 21
Create Program or Report Configuration .............................................................. 24
Modify Program or Report Configuration .............................................................. 25
Delete Program or Report Configuration .............................................................. 26
Upload Report .............................................................................................. 27
Delete Report Upload File................................................................................ 28
Request Cyclic Reports ................................................................................... 29
Request Ad Hoc Reports .................................................................................. 31
Initiate Program or Report Requests using the Search and Detail Screen ....................... 33
Defer Report Request using the Search Screen ....................................................... 34
Modify Report Requests................................................................................... 35
Delete Program or Report Requests .................................................................... 36
View Program or Report Request Log .................................................................. 37
Review Cyclical Request .................................................................................. 38
Modify Cyclical Details .................................................................................... 39
Delete Cyclical Request .................................................................................. 40
Review Reports Online .................................................................................... 41
Send Report to an Employee ............................................................................. 42
Delete an Online Report Record ........................................................................ 43
Display Reports with Logs Files .......................................................................... 44
Reporting - Reports ........................................................................................ 45
Month-End Procedures ......................................................................................... 48
External Systems Interface to Ellipse ....................................................................... 49
General Housekeeping ......................................................................................... 54
Convert Request Banners - MSH080A ................................................................... 55
Convert Standard Text (Compression) - MSH096A ................................................... 56
Convert Standard Text (Relational) - MSH095A ...................................................... 57
Rebuild MSFX99 records for Work Orders - MSHX9AA ................................................ 58
Update MSFX99 record with Project No. - MSHX99A................................................. 59
Audit Rules, Restrictions and Overrides .................................................................... 60
Create Audit Rule .......................................................................................... 62
Review Audit Rule ......................................................................................... 63
Update Audit Rule ......................................................................................... 64
Delete Audit Rule .......................................................................................... 65
Review Audit Data ......................................................................................... 66
Update Audit Rule Reason Code or Comment ........................................................ 67
Create Audit Restriction Override ...................................................................... 68
Review Audit Restriction Override ...................................................................... 69
Update Audit Restriction Override ..................................................................... 70
Delete Audit Restriction Override ...................................................................... 71
5
Contents
6
Contents
7
Ellipse Administration
Administration
There are a number of activities that are essential to the effective administration of the Ellipse EAM
system. These activities are normally managed by a system administrator and included in their daily
routine administrative tasks.
Some of the activities include:
Batch Administration - Contains information on the batch subsystem. This includes activities on
adding user queues, starting/stopping the batch subsystem, creating custom batch files and so
on.
Month-end Procedures - Modules within Ellipse EAM that generate financial transactions for an
accounting period are subject to the month-end process. Information relating to month end
procedures can be found in this process.
Audit Procedures - Auditing provides the functionality to track file modifications within Ellipse
EAM. Audit reports are provided so that copies of these changes can be made and stored for
future reference.
General Housekeeping - Contains information relating to housekeeping programs.
8
Ellipse Administration
Batch Administration
The Batch Administration process is used only by the system administrator or a high level user.
MSEBAT - Batch Admin is used to administer the Batch Subsystem. The batch subsystem is the key
function to run batch programs, which are Ellipse EAM applications that run in the background.
The batch subsystem queues batch requests and the batch programs process the requests on the
batch application servers (the batch subsystem runs on one or more application servers, providing
the opportunity to increase the volume of requests processed in a given time).
There are three applications that support administration:
MSEBAT - Batch Admin
This application can do the following:
Define batch queues as an addition to the default queues provided.
Provide a cyclic request schedule time that overrides the time in Batch.xml.
View the batch job structure defined in batch.xml.
Tasks are part of the job structure (task = batchjob and job = list of tasks)
Streams are a collection of jobs.
Open a custom_batch.xml template.
Upload a custom_batch.xml file.
Create streams, tasklists, and batchjobs through custom_batch.xml that extend the batch
structure.
MSE081 - Program/Report Configuration
This application can do the following:
Create a program/report.
Define or update the parameters that are used for execution of a batch job.
MSE016 - Devices
This application can do the following:
Configure printers by defining where a printer is found in the network and where it can be used.
Store printer configuration information (MSFPRT and MSFPRD).
The System Administrator supports the user by defining, configuring or managing the batch
subsystem.
The System Administrator can:
Set up customer queues and override the cyclic request schedule time.
Add batch structure defining the jobs, tasks, and streams.
Configure printers and assign districts to which they will be accessible, see Maintaining Devices
for more information.
Refer to the Batch Processing Configuration and Administration Guide for more detailed
information on Batch Administration.
9
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Click Stop.
3. Select Refresh.
4. Select the Files tab.
5. Click the batch.log file.
The File Download dialog box displays.
6. Select Open.
The batch.log file displays.
Check that the batch subsystem has stopped, for example, BatchController - BEC stopped.
7. Click Start to restart the Batch Controller.
8. Select Refresh.
To check that the Batch Controller has restarted:
1. Select the Files tab.
2. Click the batch.log file.
The File Download dialog box displays.
3. Select Open.
Check that the batch subsystem has restarted, for example, BatchController - BEC started.
10
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Select the Queues tab.
3. Click the Add icon to add a new row to the queue grid.
4. Enter data in the following fields:
Queue Name
Pattern
Maximum Concurrent Jobs
Do Not Retail
Trim Trailing Spaces
5. Repeat steps 3 and 4 to add additional queue entries.
6. Select Submit.
The queue entries are saved.
11
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Select the Default Queues (Internal) tab.
3. Review data as required.
12
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Modify data in the following field:
Cyclic Request Schedule Time
3. Select Submit.
The default time for scheduling cyclic requests is overwritten by the time entered.
13
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
2. The MSEBAT - Update Batch Admin screen displays.
3. Select the Files tab.
4. Click the batch.log file.
The File Download dialog box displays.
5. Select Open.
6. Review the batch log file as required.
14
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Select the Files tab.
3. Click the batch.xml file.
The File Download dialog box displays.
4. Select Open.
The batch.xml file opens in your browser.
5. Review the batch.xml file as required.
15
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Select the Files tab.
3. Click the Custom Batch.xml template icon below the Custom Batch File field.
The File Download dialog box displays.
4. Save the custom batch file.
5. Open the saved custom batch file.
Use an editor to add job structure details.
6. Save the custom_batch.xml into designated directory used for custom_batch.xml.
7. Access MSEBAT again
8. Select the Files tab.
9. Click the folder icon next to the Custom Batch File field to browse for the created custom
batch.xml file.
10. Select Submit.
The created custom batch file is uploaded.
16
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Select the Files tab.
3. Click the folder icon next to the Custom Batch File field to browse for an existing file to
upload.
Once a file has been selected, the Custom Batch File field is populated and a file type icon
displays below the field.
4. Select Submit.
The uploaded batch file is loaded into the batch subsystem.
17
Ellipse Administration
Activity Steps
1. Access MSEBAT - Batch Admin.
The MSEBAT - Update Batch Admin screen displays.
2. Select the Files tab.
3. Click the Delete icon next to the Custom Batch File field.
The file and icon are removed.
4. Click Submit to save the changes.
18
Ellipse Administration
Report Requests
The request mechanisms can be tailored to vary the database commits during the running of a job
by changing the number of maximum reads and/or updates of the database for the request. Default
values can be set up on MU - Timeslot Details for Batch Programs Table File, specifying start and
end times and optionally specifying a day of the week to which they apply.
Overall default values can be set on the Systems Control file. These are used if neither report
request maximum values nor table type MU maximum values are set up.
19
Ellipse Administration
If the maximum values are entered against the report request then the Table File MU values and
Systems Control file values are overridden for the duration of the run. These values are rechecked
every time the program commits.
If a customer version of a report cannot be selected by the user because the request is embedded in
Ellipse EAM software, the customer-specific report should be entered in the SR -Substitute Request
table file as an associated value of the delivered program.
Business Rules
The following business rules govern this process:
Users with low level of access to MSE083 - Program/Report Request and MSE086 -
Program/Report Review will only be able to modify their own requests and review their own
online report output.
Programs will not perform database commits if the maximum values (identified earlier) are set
to zero.
Programs can be submitted to execute on a cyclic basis, as follows: Daily, Weekly, Fortnightly,
Monthly, Quarterly, Half-Yearly, Yearly, and Periodically (every xx days).
Customers define the length of time that reports that produce online output will be retained,
before being deleted.
When you request a report, Ellipse EAM uses your default printer. You can change this when
submitting the request, and if the printer you nominate is not found, Ellipse EAM will use the
default printer for the district you are using at the time of request submission. If no district default
exists, Ellipse EAM will send the output to the default global printer.
20
Ellipse Administration
Limitations
Grouping report requests is not a scheduling tool.
Additional information
The following procedures need to be considered when you use the Group Report Request facility:
Group labels are set up using Table File LABL. Using a standard set of abbreviations within an
organisation ensures consistency in the table file.
You can create group names using MSE081 - Program/Report Configuration, in the same manner
as program names.
Request parameters for the group require a group label to be entered for each field
(Mandatory). Request parameters for individual programs can have a group label entered
against any field (Optional). The group label allows a relationship to be created between the
group request parameter and the individual program request parameter. The net effect of this
relationship is that, at request time, the values entered for the group are overlaid into the
program where the group labels match.
Reports are added to a group using the MSO088 - Group Report Requests program. You can
also maintain and review available groups with this program.
Groups are submitted for execution using the MSO080 - Report Request program. The process is
similar to that of submitting a request for a program. The request method can be either
Immediate, Deferred, or Cyclical.
If existing defaults are not already available, Report Request Selection details for the group are
overlaid into each program within the group.
Where the group labels match, the request parameters supplied through the MSM080C - Report
Parameters screen for the group will overlay the request parameters for the individual
programs.
Example - setting up and requesting a Group Request
Using MSE081, create a group called EQUIPQ. This group has two request parameters.
Enter Equipment Number From : 'GROUP LABEL = EQUIPFR'
Enter Equipment Number To : 'GROUP LABEL = EQUIPTO'
Set up the group labels using MSE081.
Two programs (MSR600 - Master Register of Equipment and MSR615 - Actual/Effective Statistics
Equipment Profile) are identified to be added as members to the group EQUIPQ. These programs
both use Equipment From/To values as input parameters. Their parameter definitions are adjusted
using MSE081 to also contain reference to the group labels EQUIPFR and EQUIPTO.
21
Ellipse Administration
Note: It is important to create the group label relationship before the programs are physically
added to the group using MSO088.
The programs are then added to EQUIPQ using MSO088. Request parameters are required for fields
other than the ones with a group label relationship. These are entered when the programs are
added to the group.
Program MSR600 requires a mandatory (D/S) entry for the Report Type field. The Equipment No or
Plant No range From and To fields are protected. You can enter the other fields for MSR600, as no
relationship exists with the group on these.
Program MSR615 requires a mandatory (A/E) for the Profile field. The Equipment Reference
range: From and To fields are protected.
You request the group EQUIPQ using MSO080 and the Equipment No.: From and To fields are
mandatory.
A request is created on file MSF080 for MSB084. A review of request parameters will show which
group the request is for and the parameters entered.
When MSB084 is executed, requests are written for both MSR600 and MSR615 on MSF080. The
Equipment From and To values supplied EQUIPQ have now been overlaid into the parameter
definitions for both of the programs.
22
Ellipse Administration
Group Reports
Use this activity to group a number of reports so that only one request is required to run all the
reports in the group.
Activity Steps
1. Add a name for the group of reports to table file LABL.
For information on maintaining Table Files, refer to Create a Table Code in Maintaining Table
Files.
2. Access MSO088 - Maintain Group Report Requests.
The MSM088A - Maintain Group Requests screen displays.
3. Select A - Add from the Actions list.
4. Select Submit.
The MSM088B - Add Requests To A Group screen displays.
5. Enter data in the following fields for each report request to be added to the group:
Program - This field should contain the Report or Batch ID.
Report Id
Request By
Distribution Code
Notify When Complete
Medium
Printer
Copies
6. Select Submit.
The requests are saved to the group and the MSM088A - Maintain Group Requests screen
displays.
The group of reports can be requested by entering the group name rather than a Report ID when
requesting an ad-hoc report, or requesting a cyclic report.
23
Ellipse Administration
Activity Steps
1. Access MSE081 - Program/Report Configuration.
The MSE081 - Search Program/Report Configuration screen displays.
2. Select New.
The MSE081 - Program/Report Configuration detail screen displays.
3. Enter data in the following fields:
Program Name
Request Type
Program ID
Request number
Title
4. Enter data in fields in the Details tab as required:
5. Select the Parameters tab.
6. Click Add to add a new row for parameter value entry.
7. Enter data in the following fields:
Display Row
Description
Mandatory
8. Enter data in the remaining fields on this tab as required
9. Repeat step 6 to 8 for each additional parameter required.
10. To upload an existing file, refer to Upload Report.
11. Select Submit.
The new program/report is saved.
24
Ellipse Administration
Activity Steps
1. Access MSE081 - Program/Report Configuration.
The MSE081 - Search Program/Report Configuration screen displays.
2. Enter data in the following field:
Program Name
3. Select Search.
The program/report matching the criteria entered displays in the results grid.
4. Select the program/report entry.
The MSE081 - Program/Report Configuration detail screen displays.
5. Modify data as required.
6. Select Submit.
The modified details are saved.
25
Ellipse Administration
Activity Steps
1. Access MSE081 - Program/Report Configuration.
The MSE081 - Search Program/Report Configuration screen displays.
2. Enter data in the following field:
Program Name
3. Select Search.
The MSE081 - Program/Report Configuration detail screen displays with the program/report
details.
4. Select Delete.
A message displays prompting you to confirm the deletion.
5. Select Confirm.
The program/report is deleted.
6. Click New to create a new program/report or click New Search to return to the MSE081 -
Program/Report Configuration Search screen.
26
Ellipse Administration
Upload Report
Use this activity to upload an existing file, such as an .rdl, .grvy or .jasper file.
Activity Steps
1. Access MSE081 - Program/Report Configuration.
The MSE081 - Search Program/Report Configuration screen displays.
2. Enter data in the following field:
Program Name
3. Select Search.
The MSE081 - Program/Report Configuration detail screen displays with the program/report
details.
4. Select the Upload File tab.
5. Select the folder icon next to the File field to browse for an existing file.
Once a file is selected, the File field is populated and a file type icon displays below the field.
6. Select the icon to view the file.
7. Select Submit.
The file upload is saved to the program/report.
27
Ellipse Administration
Activity Steps
1. Access MSE081 - Program/Report Configuration.
The MSE081 - Search Program/Report Configuration screen displays.
2. Enter data in the following field:
Program Name
3. Select Search.
The MSE081 - Program/Report Configuration detail screen displays with the program/report
details.
4. Select the Upload File tab.
The name of the file displays in the File field.
5. Click Delete next to the File field.
The file and icon are removed from the program/report.
6. Click Submit to save the changes.
28
Ellipse Administration
Activity Steps
1. Access MSO080 - Request Reports.
The MSM080A - Available Reports screen displays.
2. Select the check box next to the required item.
OR
3. Enter data in the following fields:
Search ID
4. Enter data in the following fields to restrict the reports which display:
Search Program Type
Search Name
Method
5. Select Submit.
The MSM080B - Report Request Selection screen displays.
6. Enter data in the following fields:
Request by (defaults to current user)
Distribution Code
Medium
Enter Printer
and Number of Copies
Enter Y for Additional Printers
Note: If Y is entered, the printers will be selected on the subsequent screen.
Notify when complete
Enter Defer Date
and Defer Time
Batch Submission: Enter Y to Submit Program for Batch Processing
Cyclical Request: Enter Cycle Days
Cycle Type
7. Select Submit.
If you entered Y in the Additional Printers field, the MSM084A - Select Printers screen displays.
Otherwise:
If report parameters are required for this report, the MSM080C - Report Parameters screen
displays.
If report parameters are not required, the MSM080B - Report Request Selection screen
displays.
8. Perform one of the following steps:
a. If you entered Y in the Additional Printers field:
1. Enter data in the Copies field next to each printer on which the report is to be printed.
29
Ellipse Administration
2. Select Submit.
Depending on whether report parameters are required for this report:
The MSM080B - Report Request Selection screen displays.
Note: If you entered Y in the Notify when complete field in MSM080B, advice is displayed when
the report has been successfully executed.
Or
The MSM080C - Report Parameters screen displays.
Note: Some reports run without the need to enter parameters. When this occurs, the Report
Parameters screen is bypassed.
3. Go to step 7.
30
Ellipse Administration
Activity Steps
1. Access MSO080 - Request Reports.
The MSM080A - Available Reports screen displays.
All the reports and batch processes that you can request display. This list is security checked
before it displays.
2. Enter data in the following field:
Search ID
You can enter a program, report ID, partial program or partial report ID.
Reports/programs matching the characters entered in the Search ID field display.
3. Double-click the required item.
The MSM080B - Report Request Selection screen displays.
4. Enter data in the following fields:
Request by
Distribution Code
Medium
Enter Printer
and Number of Copies
Enter Y for Additional Printers - If you enter Y in this field, you will select the printers on the
subsequent screen.
Notify when complete
Enter Defer Date
and Defer Time
Batch Submission: Enter Y to Submit Program for Batch Processing
5. Select Submit.
If:
You entered Y in the Additional Printers field, the MSM084A - Select Printers screen
displays. Go to step 7a.
Otherwise:
If report parameters are required for this report, the MSM080C - Report Parameters screen
displays.
The MSM080B - Report Request Selection screen displays. If report parameters are not
required for this report the message Request was successfully written displays. This is the
end of the activity.
6. Perform one of the following steps:
a. If you entered Y in the Additional Printers field:
1. Enter data in the Copies field beside each printer on which the report is to be printed.
2. Select Submit.
Depending on whether report parameters are required for this report:
31
Ellipse Administration
32
Ellipse Administration
Activity Steps
1. Access MSE083 - Program/Report Requests.
The MSE083 - Search Program/Report Requests screen displays.
2. Perform one of the following steps:
a. To initiate program/report requests using the search screen:
1. Enter the relevant search criteria and select Search.
Program/Report entries matching the search criteria entered display in the results grid.
2. Select the required check boxes next to the program/report.
b. To initiate program/report requests using the detail screen:
1. Select the required entry.
The MSE083 - Program/Report Request detail screen displays.
3. Select Initiate.
Processing of the program/report begins immediately.
4. Select Cancel to stop the initiation process.
Note: Only program/report requests with a process status of Initiating, Executing and Queued
can be cancelled.
33
Ellipse Administration
Activity Steps
1. Access MSE083 - Program/Report Requests.
The MSE083 - Search Program/Report Requests screen displays.
2. Enter the relevant search criteria and select Search.
Program/Report entries matching the search criteria entered display in the results grid.
3. Select the required check boxes next to the program/report.
4. Click Defer.
The Dialog Box - Defer displays.
5. Enter data in the following fields:
Defer Date
Defer Time
6. Select OK.
The selected program/reports are deferred to the date and time entered.
34
Ellipse Administration
Activity Steps
1. Access MSE083 - Program/Report Requests.
The MSE083 - Search Program/Report Requests screen displays.
2. Enter the relevant search criteria and select Search.
Program/Report entries matching the search criteria entered display in the results grid.
3. Select the required Program/Report entry.
4. Modify data in the following fields:
Medium
Notify when Completed - This field identifies whether or not the originator wants to be notified
on completion of task execution.
To add a printer (if the medium type is Print):
1. Select the Printers tab.
2. Select Add.
A new row is added to the grid.
3. Enter data in the following fields:
Printer
No.Copies
4. Select Submit.
To add an email address (if the medium type is Email):
1. Select the Email Destination tab.
2. Select plus.
A new row is added to the grid.
3. Enter data in the following fields:
Report Destination Type
Report Destination Code
Email Address (if not the default address)
4. Select Submit.
35
Ellipse Administration
Activity Steps
1. Access MSE083 - Program/Report Requests.
The MSE083 - Search Program/Report Requests screen displays.
2. Enter the relevant search criteria and select Search.
Program/Report entries matching the search criteria entered display in the results grid.
3. Select the required check boxes beside the program/report.
4. Select Delete.
A confirm deletion message displays.
5. Select Yes.
The selected program/reports are deleted.
36
Ellipse Administration
Activity Steps
1. Access MSE083 - Program/Report Requests.
The MSE083 - Search Program/Report Requests screen displays.
2. Enter the relevant search criteria and select Search.
Program/Report entries matching the search criteria entered display in the results grid.
3. Select the Show Logs check box.
4. Click the document icon beside the program/report request.
The File Download dialog box displays where you can Open or Save the log file.
37
Ellipse Administration
Activity Steps
1. Access MSE082 - Report Cyclical Request.
The MSE082 - Search Report Cyclical Request screen displays.
2. Enter the relevant search criteria and select Search.
Report entries matching the search criteria entered display in the results grid.
3. Select the required cyclical report request.
The MSE082 - Report Cyclical Request detail screen displays.
4. Review data as required.
38
Ellipse Administration
Activity Steps
1. Access MSE082 - Report Cyclical Request.
The MSE082 - Search Report Cyclical Request screen displays.
2. Enter the relevant search criteria and select Search.
Report entries matching the search criteria entered display in the results grid.
3. Select the required cyclical report request.
The MSE083 - Program/Report Request detail screen displays.
4. Modify data in one of the following fields:
Cycle Days
Cycle Type
Note: Only one of Cycle Days or Cycle Type can be used to indicate the length of the cycle.
5. Modify data in the following fields, if required:
Requested By
District Code
Medium
The Banner to be Displayed on Reports
Notify when Complete
Depending on the medium type modify details in either the Printers tab or Email Destinations
tab.
6. Select Submit to save details.
39
Ellipse Administration
Activity Steps
1. Access MSE082 - Report Cyclical Request.
The MSE082 - Search Report Cyclical Request screen displays.
2. Perform one of the following steps:
a. To delete single or multiple cyclical requests using the search screen:
1. Enter the relevant search criteria and select Search.
Cyclical entries matching the search criteria entered display in the results grid.
2. Select the required check box or boxes next to the program/report.
b. To delete a specific cyclical request using the detail screen:
1. Select the required entry in the results grid.
The MSE082 - Report Cyclical Request detail screen displays.
3. Select Delete.
A confirm delete message displays.
4. Select Confirm.
The cyclical request is deleted.
40
Ellipse Administration
Activity Steps
1. Access MSE086 - Program/Report Review.
The MSE086 - Search Program/Report Review screen displays.
2. Enter the relevant search criteria and select Search.
Report entries matching the search criteria entered display in the results grid.
3. Select the icon in the File column to download the report. If there are multiple files, select the
Folder icon to display the files, and then select the required file for download.
Note: If the File column beside the request is blank, no report is available.
41
Ellipse Administration
Activity Steps
1. Access MSE086 - Program/Report Review.
The MSE086 - Search Program/Report Review screen displays.
2. Enter the relevant search criteria and select Search.
Report entries matching the search criteria entered display in the results grid.
3. Select the relevant check boxes.
4. Click Send To.
The Dialog Box - Send To displays.
5. Enter data in the following field:
User ID
6. Select OK.
The selected report is sent to the specified employee email inbox.
42
Ellipse Administration
Activity Steps
1. Access MSE086 - Program/Report Review.
The MSE086 - Search Program/Report Review screen displays.
2. Enter the relevant search criteria and select Search.
Report entries matching the search criteria entered display in the results grid.
3. Select the check box next to the required report.
4. Select Delete.
A confirm deletion message displays.
5. Select OK.
The report is removed from the results grid.
43
Ellipse Administration
Activity Steps
1. Access MSE086 - Program/Report Review.
The MSE086 - Search Program/Report Review screen displays.
2. Perform one of the following steps:
To view a log for a specific program name, user ID or district:
1. Enter data in one or more of the following fields:
Program Name
User ID
District Code
2. Select the Show Logs check box.
3. Select Search.
Report entries matching search criteria entered display in the results grid.
4. Click the icon in the File column to open the log file.
To view logs for all reports:
1. Select the Show Logs check box.
2. Select Search.
All reports containing log files display in the results grid.
3. Click the icon in the File column to open the log file.
44
Ellipse Administration
Reporting - Reports
Reports
MSB081 - Batch Request Housekeeping Program .................................................. 46
MSB085 - Batch Report Monitoring Housekeeping ................................................. 47
45
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Report (Y-Detailed, N- Enter Y for a detailed report or N for a summary. A summary is the
Summary) default.
This field is mandatory.
Retention Day/s Enter the retention days that determines the calculated retention date.
For example, the number of retention days is added to the date the
program is executed, to provide the calculated retention date.
Program Name Enter the program name. When the program name is entered requests
with the same name are processed, otherwise if left blank the records are
deleted.
If the batch request file does not have a restart values the defer date is
older than the calculated retention date, it is deleted.
District Code Enter the district code to process the batch request records for that
district. If left blank all requests for all districts that the user has a
profile are processed.
46
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Retention Days Enter the number of retention days. This date calculates the retention
date as today's date.
This field is mandatory.
47
Ellipse Administration
Month-End Procedures
Modules within Ellipse EAM that generate financial transactions for an accounting period are subject
to the month-end process. This is either an online process using MSM005A - Close Accounting Period
or batch process using MSB005A - Month End Roll, and no month-end report is produced in general.
This process closes off an accounting period for a subsystem and opens up the next accounting
period so that financial transactions are created with this new accounting period.
Note: When month end is closed using MSM005A - Close Accounting Period, you must reset your log
on session for the new period to take effect.
It is possible to reopen a period in a financially closed year. Entry of transactions from the journal
entry screens can then be posted to these non current periods, subject to user security. Adjustment
of opening balances is automatic.
It is not necessary to close an accounting period for all subsystems at the same time. For example,
the Supply subsystem may be closed for 04/2020 and open for 05/2010 while the Fluid Management
module may still be open for 04/2020. A subsystem can be any number of periods ahead of another
subsystem.
However, if these modules are installed, the Journals and General Ledger modules must be closed
last. This means that the Journals module cannot be closed if another subsystem is still open for an
accounting period. Similarly, the General Ledger module cannot be closed if the Journals module is
still open for a period.
The month-end close will not be successful if any financial transactions are generated while the
MSB005 - Month End Roll-Over batch program is run.
Fixed Asset Month End is processed by running batch job MSB685 – Fixed Asset Month End. MSB685
calculates the depreciation and generates the related transactions (if depreciation has been
enabled) and rolls the period over to the next period.
48
Ellipse Administration
Documents
Messages from Ellipse EAM are sent to the out packet queue using the subroutine MSS035, and are
made available for any external system using the subroutine MSS036.
Messages to Ellipse EAM are placed on the in packet queue using the subroutine MSS038, and are
processed by Ellipse EAM when ready, using the subroutine MSS037.
Limitations
There can be some limitations on the speed of the external system. While Ellipse EAM may place the
information on the out packet queue, the external system may not request the information for some
time.
Additional information
Ellipse EAM places a message on the out packet queue using the subroutine MSS035. The external
system retrieves the message from the queue using the subroutine MSS036. All messages are
periodically inspected by the batch program MSB035. Those that have been completely processed
(deleted) are removed from the system. Batch program MSB035 also checks the integrity of the
message files. It can also be used to mark as deleted, messages that are received and are known to
49
Ellipse Administration
have been processed, but were not marked as deleted. Until the message is deleted from the out
packet queue by the batch program MSB035, any message or group of messages can be reported
upon.
The message data is transferred at a fixed number of characters per line. There may be up to 9.4
megabytes (95,700,000 characters) of information per message.
The external system places inbound messages on the in packet queue using the subroutine MSS037.
Ellipse EAM extracts these messages using the subroutine MSS038.
All inbound messages are periodically inspected by the batch program MSB037. Processed or
completed inbound messages (by Ellipse EAM) can be flagged for deletion from the message files. All
messages can be reported on until they are deleted.
The message undergoes status changes after each access. While it is being created, its status is
Incomplete. After the message has been created, its status changes to Complete and can be read
by any external system. When the external system starts reading the message, its status changes to
Accessing. When the external system has completed reading the message, its status changes to
Received. The external system can then set the status of the message to Deleted after the message
has been processed. If a message is created and left in an illegal status, its status is set to Errored
and subsequently to Deleted and it is removed from the out packet queue.
The External System Interface
The external system obtains messages from the out packet queue by calls to subroutine MSS036. It
is the responsibility of the external system to request the messages in a timely manner.
Ellipse EAM receives messages from the in packet queue by calls to subroutine MSS038.
There are two interfaces: MSS036 and MSS038. They are described below.
The MSS036 interface
Parameter Type Length Values/ Meaning
Character 1
OPTION 1 - RESERVED
2 - find a transmission, if available
3 - read a transmission
4 - complete receipt of a transmission
5 - abort the current read
Character 8
FACILITY-CODE free format
Character 2
FACILITY-ID free format
50
Ellipse Administration
FACILITY-ID is used to specify a particular sub-facility within the general facility specified by the
FACILITY-CODE. For example, an external system may be 'ACCNTNG', but there may be many actions
performed by this external system. In this case, FACILITY-ID is used to specify what action to
perform. This field is defined on a facility by facility basis.
A typical message for 'External' would be obtained using the following calls.
1. OPTION = 2, FACILITY-CODE = 'EXTERNAL', FACILITY-ID = spaces, gives a RETURN-STATUS of S
(assuming that a message was found) and MESSAGE with the first line of the message.
2. OPTION = 3 and all other linkage fields left as they are, gives a RETURN-STATUS of S (assuming
that there were more messages) and MESSAGE with the next line of the message.
Continue calling with this option until RETURN-STATUS is = U.
3. OPTION = 4 and all other linkage fields left as they are, stops the reading of the message and
removes it from the output packet queue.
To obtain another message, start again at OPTION = 2.
Note: It is very important that after OPTION = 2 is used successfully, only the OPTION parameter is
changed as the linkage area stores extra information between calls.
After a call to subroutine MSS036, the following parameters are available for interrogation:
When the RETURN-STATUS is S or M the operation was successful. When it is M there are more
message lines available. When the RETURN-STATUS is U the operation was unsuccessful. When the
RETURN-STATUS is P the operation has returned only part of a message in MESSAGE, where the total
length of the message (MESSAGE-LENGTH) is greater than can be passed in MESSAGE in one go. The
rest (or further instalments) of the message will be returned in successive calls.
The MSS038 interface
The following parameters are available:
51
Ellipse Administration
52
Ellipse Administration
FACILITY-ID
PRIORITY
XMITTER-ID
MESSAGE-LENGTH
The following parameters can optionally be set up:
REV-DEF-DATE
REV-DEF-TIME
REQUEST-TYPE
MESSAGE
HEADER-TYPE
With OPTION 2, only the OPTION and MESSAGE fields should be changed. If a line is successfully
added, the RETURN-STATUS is set to S (SUCCESSFUL), otherwise the RETURN-STATUS is set to U
(UNSUCCESSFUL).
With OPTION 3, the MESSAGE field is added as a line to the message. Only OPTION and MESSAGE
should be changed.
With OPTION 4, only the OPTION should be changed. The current message is discarded and is not
sent.
PRIORITY only assures an order for messages, not that messages will be expedited in any manner.
REV-DEF-DATE is calculated as 99999999 - CCYYMMDD (where CC is century, YY is year, MM is
month and DD is date of day). If this field is set, the message is not delivered before this date.
REV-DEF-TIME is calculated as 999999 - HHMMSS (where HH is hour, MM is minutes, SS is seconds). If
this field is set, the message is not delivered before this time.
The following parameters are available for interrogation after a call to subroutine MSS038:
53
Ellipse Administration
General Housekeeping
This section describes the housekeeping programs. These are:
Update MSFX99 record with Project No. - MSHX99A
Rebuild MSFX99 records for Work Orders - MSHX9AA
Convert Request Banners - MSH080A
Bulk Request Creation - MSH083A
Convert Help Text - MSH091A
Convert Standard Text (Relational) - MSH095A
Convert Standard Text (Compression) - MSH096A
54
Ellipse Administration
55
Ellipse Administration
56
Ellipse Administration
57
Ellipse Administration
58
Ellipse Administration
59
Ellipse Administration
60
Ellipse Administration
Note: Audit restrictions can be removed from files that customers have added to the system, by
opening the audit restriction application and selecting Delete. Deleting an audit restriction for non
HR/Payroll files allows all users to access audit data for that file. If an audit restriction override is
deleted for a HR/Payroll file (for example MSF810), the override that was set will be deleted, but
the system defined No Access rule will not be deleted.
61
Ellipse Administration
Activity Steps
1. Access MSEADR - Audit Rules.
The MSEADR - Search Audit Rules screen displays.
2. Select New.
The MSEADR - Audit Rules detail screen displays.
3. Enter data in the following fields
Table Name
Description
If no column conditions are specified in the Column Conditions tab, all operations are
audited.
If no columns are specified in the Column Inclusions tab, all operations are audited.
4. Select Submit.
The audit rule is saved.
62
Ellipse Administration
Activity Steps
1. Access MSEADR - Audit Rules.
The MSEADR - Search Audit Rules screen displays.
2. Enter the relevant search criteria.
Select Search.
3. Double-click the required item.
The MSEADR - Audit Rules detail screen displays.
4. Review data as required
63
Ellipse Administration
Activity Steps
1. Access MSEADR - Audit Rules.
The MSEADR - Search Audit Rules screen displays.
2. Enter the relevant search criteria.
Select Search.
3. Double-click the required item.
The MSEADR - Audit Rules detail screen displays.
4. Modify data as required
If no column conditions are specified in the Column Conditions tab, all operations are
audited.
If no columns are specified in the Column Inclusions tab, all operations are audited.
5. Select Submit.
64
Ellipse Administration
Activity Steps
1. Access MSEADR - Audit Rules.
The MSEADR - Search Audit Rules screen displays.
2. Enter the relevant search criteria.
Select Search.
3. Double-click the required item.
The MSEADR - Audit Rules detail screen displays.
4. Select Delete.
The Confirm Delete dialog box displays.
5. Select OK.
The audit rule is deleted.
65
Ellipse Administration
Activity Steps
1. Access MSEAUD - Audit.
The MSEAUD Search Audit screen displays.
2. Enter the relevant search criteria.
3. Select Search.
The results of the search display in the grid.
4. Review data as required.
66
Ellipse Administration
Activity Steps
1. Access MSEAUD - Audit.
The MSEAUD Search Audit screen displays.
2. Enter the relevant search criteria.
3. Select Search.
The results of the search display in the grid.
4. Select the rows to be updated.
5. Click Update Reason/Comments.
The Update Reason / Comments Dialog box displays.
6. Enter a reason code and / or comments.
7. Select OK.
The information displays in the results grid.
8. Review data as required
67
Ellipse Administration
Activity Steps
1. Access MSEAUR - Audit Restriction Override.
2. The MSEAUR - Search Audit Restriction Override screen displays.
3. Select New.
4. The MSEAUR - Create Audit Restriction Override screen displays.
5. Enter data in the following fields
Table Name
Override Level
6. Select Submit.
The audit restriction override is created.
68
Ellipse Administration
Activity Steps
1. Access MSEAUR - Audit Restriction Override.
The MSEAUR - Search Audit Restriction Override screen displays.
2. Enter the relevant search criteria.
3. Select Search.
Results matching the search criteria display in the grid.
4. Double-click the required item.
5. The MSEAUR - Create Audit Restriction Override screen displays.
6. Review data as required
69
Ellipse Administration
Activity Steps
1. Access MSEAUR - Audit Restriction Override.
The MSEAUR - Search Audit Restriction Override screen displays.
2. Enter the relevant search criteria.
3. Select Search.
Results matching the search criteria display in the grid.
4. Double-click the required item.
5. The MSEAUR - Create Audit Restriction Override screen displays.
6. Modify data as required
7. Select Submit.
The updated details are saved.
70
Ellipse Administration
Activity Steps
1. Access MSEAUR - Audit Restriction Override.
The MSEAUR - Search Audit Restriction Override screen displays.
2. Enter the relevant search criteria.
3. Select Search.
Results matching the search criteria display in the grid.
4. Double-click the required item.
5. The MSEAUR - Create Audit Restriction Override screen displays.
6. Select Delete.
The Confirm Delete dialog box displays.
7. Select OK.
The audit restriction override is deleted.
71
Ellipse Administration
72
Ellipse Administration
Additional Information
The content of data stored on the work file is transaction dependent.
Data records are created and re-used according to transaction logic.
73
Ellipse Administration
Administration - Reports
74
Ellipse Administration
Reports
MSB042 - Notification & Diary Deletion ............................................................. 77
MSB043 - Notification & Diary Reminder ............................................................ 78
MSB044 - Notification & Diary Escalation ........................................................... 79
MSB04A - Diary and Notification Report ............................................................ 80
MSB070 - Bulk Changes ................................................................................. 81
MSB07A - Transfer Selection .......................................................................... 84
MSB07B - Process Transfer ............................................................................ 85
MSB07C - Reduce Dues-In District/Warehouse ..................................................... 87
MSB07D - Close a District .............................................................................. 88
MSB07E - Check for Closure ........................................................................... 89
MSB07F - Bulk Requisition Cancel .................................................................... 92
MSB07G - Delete a Transfer List ...................................................................... 93
MSB07H - Close Warehouse ............................................................................ 94
MSR07Z - Transfer Errors .............................................................................. 95
MSB17V - Valuation Accounting Report ............................................................. 96
MSB19H - Delete Bin Locations ....................................................................... 97
MSBTNE - Maximum Transfer Number Exceeded .................................................. 98
MSB877 - Archive Authorisations ..................................................................... 99
MSB907 - Archive/Roll Back Transactions .......................................................... 100
MSR038 - Errored/Junked Incoming Messages Report ............................................ 101
MSR040 - Diary Report ................................................................................. 102
MSR041 - Diary Follow-Up Report .................................................................... 104
MSR042 - Employee Diary Report..................................................................... 105
MSR079 - Check for District/Warehouse Closure, Goods Holding .............................. 106
MSR07A - Check for District/Warehouse Closure - Orders Report .............................. 107
MSR07B - Check for District/Warehouse Closure - Warehouse Requisitions Report ......... 108
MSR07C - Check for District Closure - Holdings Report ........................................... 109
MSR07D - Check for District Closure - Accounts Payable Invoices Report..................... 110
MSR07E - Check for District Closure - Accounts Receivable Invoices Report ................. 111
MSR07F - Check for District Closure - Work Orders Report ...................................... 112
MSR07G - Check for District Closure - Equipment Report ....................................... 113
MSR07H - Check District/Warehouse Closure - Waybills Report ................................ 114
MSR07I - Check for District Closure - Batch Requests Report ................................... 115
MSR07J - Check for District Closure - Scheduled Tasks Report ................................. 116
MSR07K - Check for District Closure - Goods in Transit Report ................................. 117
MSR07L - Check for District/Warehouse Closure - Purchase Requisitions Report ........... 118
MSR07M - Check for District Closure - Open Incidents Report .................................. 119
MSR07N - Check for District Closure - Logsheets .................................................. 120
MSR07O - Check for District Closure - Projects Report ........................................... 121
MSR07P - Check for District Closure - Accounts Report .......................................... 122
MSR07Q - Check for District Closure - Employees Report ........................................ 123
MSR07R - Check for District Closure - Labour Costing Report ................................... 124
MSR07S - Check for District Closure - Unposted Transactions Report ......................... 125
MSR07T - Check for Supply Customer Closure - Holdings Report ............................... 126
MSR07U - Check for Supply Customer Closure Requisitions Report ............................ 127
MSR07V - Check for Supply Customer Closure - In Transit ....................................... 128
MSR07W - Check for District Closure - Cyclic Requests Report ................................. 129
MSR07X - Check for District Closure - Repair Requests Report ................................. 130
MSR07Y - Check for Warehouse Closure - Holdings Report ...................................... 131
MSR081 - Batch Request Parameters Report ....................................................... 132
MSR083 - Cyclical Request Report ................................................................... 133
MSR09A - Work File Listing ............................................................................ 134
MSBXPO - Purchase Order Print XML ................................................................. 135
MSBXRQ - Request for Quotation ..................................................................... 148
MSRXDRA - Discrepancy Report Letter .............................................................. 154
MSIXPO - Build PO and PS Interface ................................................................. 160
MSIXRQ - TTT ............................................................................................ 171
MSIXRA - TTT ............................................................................................. 179
75
Ellipse Administration
76
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Delete After No of Enter the number of days since creation after which notification messages
Days or diary entries will be deleted.
Exclude Event Names Select one or more types of notification event to be excluded from
processing. Up to 10 event names may be nominated.
Exclude Diary Types Select one or more types of diary message to be excluded from
processing. Up to 10 diary types may be nominated.
77
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Remind After No of Enter the number of days since creation of the original notification
Days message or diary entry after which a reminder will be sent.
Include Event Names Select one or more types of notification event to be included in
processing. Up to 10 event names may be nominated.
Include Diary Types Select one or more types of diary message to be included in processing.
Up to 10 diary types may be nominated.
78
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Diary Type Select a diary type to be processed. If a diary type is selected, an event
name cannot be specified.
Recipient Type Enter the recipient type for the escalation message. This must be
consistent with the type of message, for example, a diary message cannot
be escalated to a team.
Recipient Enter the recipient id for the escalation message. This can be an
employee number, position id or team identifier. It must be consistent
with the selected Recipient Type.
Escalate After No of Enter the number of days since creation of the original diary entry or
Days notification message after which an escalation message will be sent.
79
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Diary Type The diary entry type associated with the message. Entry is validated
against the Table File XD - Diary Entry Control Record.
Event name The event that triggered the notification. Entry is validated against the
Table File EVNT - Ellipse EAM Event.
Assign Status The assignment status for the diary entry (Assigned or Unassigned).
From Date The first diary message/notification creation date in the range.
Include Text (Y/N) Enter Y to include the text associated with the notification message.
80
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
81
Ellipse Administration
Selection Your selections should not conflict with each other or present an
ambiguous choice for the batch process to interpret.
You can enter either an = or a number representing one of the data items
displayed. Enter = to select all records on the Supply Catalogue file.
82
Ellipse Administration
Value of The value must be valid for the choice made as determined by the
items to validation rules for original entry. Enter = to select all records on the
select Supply Catalogue file MSF100.
The following validation applies to the selection parameters:
Product Services Category
This entry field must exist on the Product Services Category file
(MSF1EI).
Stock Class
This entry field must exist on Table File CL.
Stock Type
This entry field must exist on Table File ST.
UN Transport Code
This entry field must exist on Table File TN.
Hazardous Material Code
This entry field must exist on Table File HZ.
Template ID
This entry field must exist on the Template ID file.
Mnemonic
This entry field must exist on the Part Number/ Stock Code Cross
reference file (MSF110C).
Colloquial
This entry field must exist on the Colloquial Name Reference file
(MSF120).
APL Number
This entry field must exist on the APL Header file (MSF130). You can
enter a partial APL Number.
Table File C0 - C9
This entry field must exist on the relevant table file (C0 - C9).
Cat. Reference Codes
This entry field is validated against the special edit field type defined
for the Reference Code Number. This field can contain spaces for the
second and third selections.
Repairable Item
Valid values for this entry field are Y and N. This field is only available
if the Repairable Item Management module is installed.
Reference Enter the reference code number to be used in conjunction with the Cat.
No. Reference Codes selection. This field is mandatory for the Select by
Reference Codes option. You must enter a valid reference code number
for the CAT entity. Entry is not required for other selection options.
If you enter a ?, control passes to the Review Reference Code Parameters
screen. You can then select the appropriate reference code number.
83
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
District Enter the district code. Entry is mandatory if closing a district and in
either an active or suspended state.
84
Ellipse Administration
85
Ellipse Administration
86
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Type Enter the transfer type to match the level of dues out for the district
being suspended.
District Code Enter the district code. This is validated against the VALIDATE macro with
the DSTRCT-CODE, ACTIVE, and AuthoriseD options to ensure the district
is active. The user must be authorised to access the district information.
87
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for this
report:
District Enter the district code. Entry is mandatory if closing a district and in either an
active or suspended state.
88
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Type Enter the type indicator for the district closure report.
District Enter the district code. This field is mandatory if closing a district in an
active or suspended state.
Note: The reports selected are only those relevant to the type of closure
being processed. The following reports are generated:
Orders - (MSR07A) Enter Y to request this closure report. MSR07A report is generated.
Stock Holdings - Enter Y to request this closure report. MSR07C report is generated.
(MSR07C)
Accounts Pay, Enter Y to request this closure report. MSR07D report is generated.
Invoices - (MSR07D)
Accounts Recv, Enter Y to request this closure report. MSR07E report is generated.
Invoices - (MSR07E)
Work Orders - Enter Y to request this closure report. MSR07F report is generated.
(MSR07F)
Equipment - (MSR07G) Enter Y to request this closure report. MSR07G report is generated.
Waybills - (MSR07H) Enter Y to request this closure report. MSR07H report is generated.
Batch Requests - Enter Y to request this closure report. MSR07I report is generated.
(MSR07I)
Scheduled Tasks - Enter Y to request this closure report. MSR07J report is generated.
(MSR07J)
89
Ellipse Administration
Goods in Transit - Enter Y to request this closure report. MSR07K report is generated.
(MSR07K)
Purchase Requisitions Enter Y to request this closure report. MSR07L report is generated.
- (MSR07L)
Open Incidents - Enter Y to request this closure report. MSR07M report is generated.
(MSR07M)
Logsheets - (MSR07N) Enter Y to request this closure report. MSR07N report is generated.
Projects - (MSR07O) Enter Y to request this closure report. MSR07O report is generated.
Control Accounts - Enter Y to request this closure report. MSR07P report is generated.
(MSR07P)
Employees - (MSR07Q) Enter Y to request this closure report. MSR07Q report is generated.
Labour Costing - Enter Y to request this closure report. MSR07R report is generated.
(MSR07R)
Unposted Transactions Enter Y to request this closure report. MSR07S report is generated.
- (MSR07S)
Cyclic Requests - Enter Y to request this closure report. MSR07W report is generated.
(MSR07W)
Repair Requests - Enter Y to request this closure report. MSR07X report is generated.
(MSR07X)
Good Holdings - Enter Y to request this closure report. MSR079 report is generated.
(MSR079)
Parameters Enter the following information in the Report Request Selection screen for
this report:
Type Enter the type indicator for the warehouse closure report.
District Enter the district code. This field is mandatory if closing a district and in
either an active or suspended state.
Note: The reports selected are only those relevant to the type of closure
being processed. The following reports are generated:
Orders - (MSR07A) Enter Y to request this closure report. MSR07A report is generated.
Waybills - (MSR07H) Enter Y to request this closure report. MSR07H report is generated.
Goods in Transit - Enter Y to request this closure report. MSR07K report is generated.
(MSR07K)
90
Ellipse Administration
Purchase Requisitions Enter Y to request this closure report. MSR07L report is generated.
- (MSR07L)
Stock Holdings - Enter Y to request this closure report. MSR07Y report is generated.
(MSR07Y)
Goods Holdings - Enter Y to request this closure report. MSR079 report is generated.
(MSR079)
Parameters Enter the following information in the Report Request Selection screen for
this report:
Type Enter the type indicator for the supply customer account closure report.
Supply Customer Id Enter the supply customer ID for the requested closure report.
Note: The reports that can be selected are only those relevant to the
type of closure being processed. The following reports are generated:
Stock Holdings - Enter Y to request this closure report. MSR07I report is generated.
(MSR07I)
Stock in Transit - Enter Y to request this closure report. MSR07V report is generated.
(MSR07V)
91
Ellipse Administration
92
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for this
report:
93
Ellipse Administration
94
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen
for this report:
95
Ellipse Administration
Report Mode Enter the mode type. The report is generated in the selected
(D - Detailed, mode.
S - Summary)
96
Ellipse Administration
97
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
98
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Archive Records Enter the cut-off date for archiving authorisations. All authorisations
Authorised before before the nominated date are archived.
99
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for this
report:
Maximum You can limit the duration of the run duration by specifying the number of
duration of run in minutes of elapsed time for which the batch run is allowed to run. If the
minutes request is not complete by then, it remains active and continues when it is
next allowed to run.
Earliest Period Specify the earliest Accounting Period for which transaction records should be
for Transx on located on file MSF900. The program either adds records or moves them to
MSF900 other files to achieve this aim. The period specified must be before the
Current Period in the district.
If the period is not specified it is assumed that all transactions should be
relocated on file MSF900.
Earliest Period Specify the earliest Accounting Period for which transaction records should be
for Transx on located on file MSF901. The program either adds records or moves them to
MSF901 other files to achieve this aim. Any period specified must be before the period
entered for file MSF900.
If a period is not specified, it is assumed that all transactions not included
above should be relocated on file MSF901. This period is not applicable if no
period was entered for file MSF900.
Earliest Period Specify the earliest Accounting Period for which transaction records should be
for Transx on located on file MSF902. The program either adds records or moves them to
MSF902 other files to achieve this aim. Any period specified must be before the
earliest periods entered for files MSF900 and MSF901.
If a period is not specified, it is assumed that all transactions not included
above should be relocated on file MSF902. This period is not applicable if no
periods were entered for files MSF900 and MSF901.
Any transactions not covered above are relocated on file MSF078.
Do Consistency Enter Y to check consistency on all fields, to reset all necessary control
Test (Y/N) information required to run this process. This essentially requires a pass
through all the Transaction Master files and is generally only required when a
previous run of this process has not produced the expected redistribution
results.
100
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for this
report:
101
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Diary Type Enter up to 10 specific diary types to include in the report. Alternatively,
leave this field blank to include all diary types.
Entry is validated against the Table File XD - Diary Type.
Responsibility Code Enter a valid responsibility code. Entry is validated against the Employee
(Optional) Core Record file (MSF810). If this field is left blank, all responsibility
codes are included.
Age in Days (Optional) Age in days can be used to limit report to diary notes that are over this
many days old. Enter a valid number.
Action Date From Enter the date defining the start of the period to be reported. If this field
is left blank the report shows all diary entries earlier than the To date.
Action Date To Enter the date defining the end of the period. If this field is left blank all
diary entries with an action date after than the From date are included in
the report.
Diary Status Enter O for outstanding diary entries. Enter C for completed diary entries.
If this field is completed, only diary entries with a status matching that
entered are reported on. If this field is left blank, all diary entries within
the specified parameters are included on the report.
102
Ellipse Administration
Order Enter T to sort and page break by Diary Type. Enter R to sort and page
break by Responsibility Code. Enter D to sort by Action Date/Time. If this
field is left blank the report is sorted by Diary Type.
Include Extended Text Enter Y to include extended text recorded for the diary entry in the
in Report report. If this field is left blank N is entered, no extended text is
included.
103
Ellipse Administration
104
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Responsible Code Enter a valid responsibility code. Entry is validated against the Employee
(Mandatory) Core Record file (MSF810).
Date From Enter the date defining the start of the period to be reported on.
(Mandatory)
Date To (Mandatory) Enter the month defining the end of the period to be reported on.
Status Enter O for outstanding diary entries. Enter C for completed diary entries.
If this field is completed, only diary entries with a status matching that
entered are reported on the details report (MSR042B). If this field is left
blank, all diary entries within the specified parameters are included on
the details report (MSR042B).
Print Report Enter A to print the summary report (MSR042A) only. Enter B to print the
detail report (MSR042B) only. Leave this field blank to print both reports.
105
Ellipse Administration
106
Ellipse Administration
107
Ellipse Administration
108
Ellipse Administration
109
Ellipse Administration
110
Ellipse Administration
111
Ellipse Administration
112
Ellipse Administration
113
Ellipse Administration
114
Ellipse Administration
115
Ellipse Administration
116
Ellipse Administration
117
Ellipse Administration
118
Ellipse Administration
119
Ellipse Administration
120
Ellipse Administration
121
Ellipse Administration
122
Ellipse Administration
123
Ellipse Administration
124
Ellipse Administration
125
Ellipse Administration
126
Ellipse Administration
127
Ellipse Administration
128
Ellipse Administration
129
Ellipse Administration
130
Ellipse Administration
131
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for this
report:
Program Name Enter a range of program names to restrict the selection of program/reports
Range: From/To returned. Leave From blank to report from the first program. Leave To range
blank to report to the last program.
132
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Program Name Range: Enter a range of program names to restrict the selection. Leave 'From'
From/To blank to report from the first program. Leave 'To' range blank to report to
the last program.
Defer Date Range: Enter a range of defer dates to restrict the selection. Leave the 'From'
From/To blank to report from the first request. Leave the 'To' blank to report to
the last request.
133
Ellipse Administration
Parameters Enter the following information in the Report Request Selection screen for
this report:
Detail Required Enter Y to select the Detail mode. The data contents of each record on
file are printed.
Report COMMAREA Enter the COMMAREA level threshold. This number represents the level
Usage Threshold above which statistics will be gathered for COMMAREA shuffling.
134
Ellipse Administration
File Dependency
Main File Lookup File Auxiliary File
MSF096 MSF39K
MSF100 MSF39L
MSF200 MSFX05
MSF220 MSS110
MSF231
MSFX05
Frequency
As required.
Report Information
Each purchase order starts on a new page.
135
Ellipse Administration
XML Tags
The following XML tags and related data are available to the Word template, and fields with an '*'
are currently used by the Word template.
<MSF220_PO_TYPE>
<MSF220_SUPPLIER_NO>
<MSF220_PURCH_OFFICER>
<MSF220_STATUS_220>
<MSF220_SUPPLY_CUST_ID>
<MSF220_REVSD_ORDER_DATE>
<MSF220_REVSD_CRT_DATE>
<MSF220_PO_XMIT_VERSION>
<MSF220_FREIGHT_CODE>
<MSF220_DELIV_LOCATION>
<MSF220_LIVE_CONF_IND>
<MSF220_PO_MEDIUM_IND>
<MSF220_LAST_PRT_RUNNO>
<MSF220_CURRENCY_TYPE>
<MSF220_CHANGE_COUNT>
<MSF220_NO_OF_ITEMS>
<MSF220_COMPLETE_ITEMS>
<MSF220_OWNED_STK_IND>
136
Ellipse Administration
<MSF220_CON_STOCK_IND>
<MSF220_SERV_ITEM_IND>
<MSF220_PREQ_ITEM_IND>
<MSF220_FREL_ITEM_IND>
<MSF220_EDI_ACK_RCVD>
<MSF220_EDI_ACK_DATE>
<MSF220_AUTHSD_BY>
<MSF220_AUTHSD_POSITION>
<MSF220_AUTHSD_DATE>
<MSF220_AUTHSD_TIME>
<MSF220_AUTHSD_STATUS>
<MSF220_RESTRICT_POS>
<MSF220_RESTRICT_RULE>
<MSF220_CREATION_DATE>
<MSF220_CREATION_TIME>
<MSF220_CREATION_USER>
<MSF220_LAST_RCPT_NO>
<MSF220_ORIGIN_CODE>
<MSF220_COMPLETED_DATE>
<MSF220_AUTHSD_TOT_AMT>
<MSF220_AUTHSD_ITM_AMT>
<MSF220_FMS_REQ_IND>
<MSF220_NPV_INDEX_CODE>
<MSF220_NPV_PAY_DATE>
<MSF220_NPV_PAY_DAYS>
<MSF220_ORDER_ORIG>
<MSF220_GLOBAL_PO_IND>
<MSF220_MULTI_DST_RCPT_FLG>
<MSF200_SUP_STATUS>
137
Ellipse Administration
<MSF200_ORDER_ADDR_1> *
<MSF200_ORDER_ADDR_2> *
<MSF200_ORDER_ADDR_3> *
<MSF200_ORDER_ZIP>
<MSF200_ORDER_PCODE> *
<MSF200_ORDER_PHONE>
<MSF200_ORDER_CONTACT>
<MSF200_ORDER_STATE> *
<MSF200_ORDER_FAX_NO>
<MSF200_ORDER_TLX_NAME>
<MSF200_ORDER_TLX_NO>
<MSF200_PAYMENT_NAME>
<MSF200_PAYMENT_ADDR_1>
<MSF200_PAYMENT_ADDR_2>
<MSF200_PAYMENT_ADDR_3>
<MSF200_PAYMENT_ZIP>
<MSF200_PAYMENT_PCODE>
<MSF200_PAYMENT_PHONE>
<MSF200_PAYMENT_CTACT>
<MSF200_PAYMENT_STATE>
<MSF200_PAY_FAX_NO>
<MSF200_PAY_TLX_NAME>
<MSF200_PAY_TLX_NO>
<MSF200_PAYMENT_LINK>
<MSF200_RETURNS_NAME>
<MSF200_RETURNS_ADDR_1>
138
Ellipse Administration
<MSF200_RETURNS_ADDR_2>
<MSF200_RETURNS_ADDR_3>
<MSF200_RETURNS_ZIP>
<MSF200_RETURNS_PCODE>
<MSF200_RETURNS_PHONE>
<MSF200_RETURNS_CTACT>
<MSF200_RETURNS_STATE>
<MSF200_RETURNS_FAX_NO>
<MSF200_RETS_TLX_NAME>
<MSF200_RETS_TLX_NO>
<MSF200_CLOSE_XMAS>
<MSF200_NO_ITEM_ORDER>
<MSF200_FRT_IN_DISC>
<MSF200_SEP_CHEQUE>
<MSF200_LINKED_SUPP_NO>
<MSF200_LINKED_CUST_NO>
<MSF200_COUNTRY_CODE>
<MSF200_SUP_TYPE1>
<MSF200_SUP_TYPE2>
<MSF200_SUP_TYPE3>
<MSF200_SUP_TYPE4>
<MSF200_SUP_TYPE5>
<MSF200_SUP_TYPE6>
<MSF200_PAY_CONTRA>
<MSF200_CURRENCY_TYPE>
<MSF200_LAST_MOD_DATE>
<MSF200_LAST_MOD_TIME>
<MSF200_LAST_MOD_USER>
<MSF200_CREATION_DATE>
139
Ellipse Administration
<MSF200_COMMODITY_TY1>
<MSF200_COMMODITY_TY2>
<MSF200_COMMODITY_TY3>
<MSF200_COMMODITY_TY4>
<MSF200_COMMODITY_TY5>
<MSF200_COMMODITY_TY6>
<MSF200_EMAIL_ADDRESS>
<MSF000_DSTRCT_ADDR_1>
<MSF000_DSTRCT_ADDR_2>
<MSF000_DSTRCT_ADDR_3>
<MSF000_DSTRCT_ZIP_CODE>
<MSF000_DSTRCT_PCODE>
<MSF000_DSTRCT_PHONE> *
<MSF000_DSTRCT_STATE>
<MSF000_DSTRCT_FAX_NO> *
<MSF000_DSTRCT_TLX_NAME>
<MSF000_DSTRCT_TLX_NO>
<MSF000_DSTRCT_ACN_NO> *
<MSF002_DISTRICT_NAME> *
<MSF810_SURNAME>
<MSF810_BARCODE>
<MSF810_FIRST_NAME>
140
Ellipse Administration
<MSF810_FIRST_INITIAL>
<MSF810_PREF_NAME>
<MSF810_NAME_TITLE>
<MSF810_SECOND_NAME>
<MSF810_SECOND_INITIAL>
<MSF810_RES_ADDRESS_1>
<MSF810_RES_ADDRESS_2>
<MSF810_RES_ADDRESS_3>
<MSF810_RES_STATE>
<MSF810_RES_ZIPCODE>
<MSF810_RES_POSTCODE>
<MSF810_POST_ADDRESS_1>
<MSF810_POST_ADDRESS_2>
<MSF810_POST_ADDRESS_3>
<MSF810_POST_STATE>
<MSF810_POST_ZIPCODE>
<MSF810_POST_POSTCODE>
<MSF810_WORK_EXT>
<MSF810_FAX_NO>
<MSF810_MOBILE_NO>
<MSF810_EMAIL_ADDRESS>
<MSF810_PRINTER_ID_5>
141
Ellipse Administration
<group type= "global_supp_comments_1"> * Group data for first Global Supplier Comments
if it exists.
142
Ellipse Administration
<MSF221_CURR_QTY_P> * Quantity
<MSF221_STOCK_CODE>
<ITEM_NAME>
<ITEM_DESC_LINE_1>
<ITEM_DESC_LINE_2>
<ITEM_DESC_LINE_3>
<ITEM_DESC_LINE_4>
<ITEM_EXTENDED_DESC>
<MSF221_UNIT_OF_PURCH> * UOM
<group type= "po_item_extra_part_no"> * Group of data for extra Supplier and Part
Numbers.
143
Ellipse Administration
<FPA_ID> *
<group type= "po_item_repair_data"> * Group of data for all the Repairs required by a
PO Item. Consists of Repair Task
Description/Quantity/Amount and Repair Sub-
Task Description/Quantity/Amount.
<group type= "global_sc_comments_1"> * Group data for first Global Stock Code
Comments if it exists.
<group type= "global_sc_comments_2"> * Group data for second Global Stock Code
Comments if it exists.
<group type= "global_sc_comments_3"> * Group data for third Global Stock Code
Comments if it exists.
144
Ellipse Administration
<group type= "global_sc_comments_4"> * Group data for fourth Global Stock Code
Comments if it exists.
<group type= "global_sc_comments_5"> * Group data for fifth Global Stock Code
Comments if it exists.
<group type= "district_sc_comments_1"> * Group data for first District Stock Code
Comments if it exists.
<group type= "district_sc_comments_2"> * Group data for second District Stock Code
Comments if it exists.
<group type= "district_sc_comments_3"> * Group data for third District Stock Code
Comments if it exists.
<group type= "district_sc_comments_4"> * Group data for forth District Stock Code
Comments if it exists.
<group type= "district_sc_comments_5"> * Group data for fifth District Stock Code
Comments if it exists.
<group type= "global_sc_supp_comments_1"> * Group data for first Global Stock Code Supplier
Comments if it exists.
<group type= "global_sc_supp_comments_2"> * Group data for second Global Stock Code
Supplier Comments if it exists.
<group type= "global_sc_supp_comments_3"> * Group data for third Global Stock Code
Supplier Comments if it exists.
<group type= "global_sc_supp_comments_4"> * Group data for forth Global Stock Code
Supplier Comments if it exists.
145
Ellipse Administration
<group type= "global_sc_supp_comments_5"> * Group data for fifth Global Stock Code Supplier
Comments if it exists.
<group type= "district_sc_supp_comments_1"> * Group data for first District Stock Code
Supplier Comments if it exists.
<group type= "district_sc_supp_comments_2"> * Group data for second District Stock Code
Supplier Comments if it exists.
<group type= "district_sc_supp_comments_3"> * Group data for third District Stock Code
Supplier Comments if it exists.
<group type= "district_sc_supp_comments_4"> * Group data for forth District Stock Code
Supplier Comments if it exists.
<group type= "district_sc_supp_comments_5"> * Group data for fifth District Stock Code
Supplier Comments if it exists.
<PO_ITEM_CLAUSE_2>
<PO_ITEM_CLAUSE_3>
<PO_ITEM_CLAUSE_4>
<PO_ITEM_CLAUSE_5>
<PO_ITEM_CLAUSE_6>
<PO_ITEM_CLAUSE_7>
<PO_ITEM_CLAUSE_8>
<PO_ITEM_CLAUSE_9>
<PO_ITEM_CLAUSE_10>
<PO_ITEM_CLAUSE_11>
<PO_ITEM_CLAUSE_12>
<PO_ITEM_CLAUSE_13>
146
Ellipse Administration
<PO_ITEM_CLAUSE_14>
<PO_ITEM_CLAUSE_15>
<PO_ITEM_CLAUSE_16>
<PO_ITEM_CLAUSE_17>
<PO_ITEM_CLAUSE_18>
<PO_ITEM_CLAUSE_19>
<PO_ITEM_CLAUSE_20>
147
Ellipse Administration
File Dependency
Main File Lookup File Auxiliary File
MSF250 MSF253
MSF251 MSF231
MSF096 MSF096
MSF010 MSF110
MSF100 MSF39A
MSFX05 MSF39B
Frequency
As required.
XML Tags
The following XML tags and related data are available to the Word template, and fields with a '*' are
currently used by the Word template:
148
Ellipse Administration
<group type="header_clause"> * Group of data for each FPA Header clause found, up
to 20 occurrences.
149
Ellipse Administration
150
Ellipse Administration
151
Ellipse Administration
<REQD_DSTRCT_1> *
<REQD_DSTRCT_2> *
<REQD_DSTRCT_3> *
<REQD_DSTRCT_4> *
<REQD_DSTRCT_5> *
<ITEM_CLAUSE_NO_2>
<ITEM_CLAUSE_NO_3>
152
Ellipse Administration
<ITEM_CLAUSE_NO_4>
<ITEM_CLAUSE_NO_5>
<ITEM_CLAUSE_NO_6>
<ITEM_CLAUSE_NO_7>
<ITEM_CLAUSE_NO_8>
<ITEM_CLAUSE_NO_9>
<ITEM_CLAUSE_NO_10>
<ITEM_CLAUSE_NO_11>
<ITEM_CLAUSE_NO_12>
<ITEM_CLAUSE_NO_13>
<ITEM_CLAUSE_NO_14>
<ITEM_CLAUSE_NO_15>
<ITEM_CLAUSE_NO_16>
<ITEM_CLAUSE_NO_17>
<ITEM_CLAUSE_NO_18>
<ITEM_CLAUSE_NO_19>
<ITEM_CLAUSE_NO_20>
153
Ellipse Administration
File Dependency
Main File Lookup File Auxiliary File
MSF010
MSF096
MSF110
MSF150
MSF151
MSF200
MSF221
MSF231
MSF245
MSFX05
Frequency
As Required.
Report Information
Each discrepancy report is printed on a new page.
The following XML tags and related data are available to the Word template, and fields with a '*' are
currently used by the Word template:
154
Ellipse Administration
<MSF061_DSTRCT_CODE_3P>
<MSF061_PRINT_RUN_NO_3P>
<MSF061_MEDIUM_3P> The medium for the report. Valid values are 'P'
(Printer).
<MSF150_RECEIPT_IND>
<MSF245_FORWARD_DSTRCT>
<MSF245_FORWARD_WH>
155
Ellipse Administration
<MSF245_SUPPLIER_NO>
<MSF245_RAISED_BY>
<MSF245_RAISED_DATE>
<MSF246_DISCREP_TYPE_1>
<MSF246_DISCREP_TYPE_2>
<MSF246_DISCREP_TYPE_3>
<MSF246_DISCREP_TYPE_4>
<MSF246_DISCREP_TYPE_5>
<MSF246_DISCREP_TYPE_6>
<ITEM_HEADING_1> * 'Item'
<ITEM_HEADING_3> * 'Item'
<ITEM_HEADING_5> * 'Quantity'
<ITEM_HEADING_6> * ''
156
Ellipse Administration
<ITEM_HEADING_7> * ''
<ITEM_HEADING_8> * 'Mnemonic'
<ITEM_HEADING_1> * 'Item'
<ITEM_HEADING_2> * 'Waybill'
<ITEM_HEADING_3> * 'Item'
<ITEM_HEADING_4> * 'Description'
<ITEM_HEADING_5> * 'Quantity'
<ITEM_HEADING_6> * 'Type'
<ITEM_HEADING_7> * 'Document'
<group type="discr_item"> * Group of data for each item in the Discrepancy Item
table.
157
Ellipse Administration
<ITEM_DETAIL_9> * Ninth (and final) item for discrepancy table Stock Code
Item Name
<group type="discr_type_3_4"> * Group data to indicate that third and forth discrepancy
types exist.
<group type="discr_type_5_6"> * Group data to indicate that fifth and sixth discrepancy
types exist.
158
Ellipse Administration
159
Ellipse Administration
MSIXPO-KEY-012
160
Ellipse Administration
MSIXPO-DATA-AREA.
MSIXPO-HEADER-RECORD.
161
Ellipse Administration
MSIXPO-HEADER-2-RECORD REDEFINES
162
Ellipse Administration
MSIXPO-ADDR-2-STATE-CODE
MSIXPO-ADDRESS-3.
163
Ellipse Administration
MSIXPO-ITEM-1-RECORD REDEFINES
164
Ellipse Administration
165
Ellipse Administration
MSIXPO-ITEM-2-RECORD REDEFINES
166
Ellipse Administration
167
Ellipse Administration
MSIXPO-SUPPLIER-RECORD REDEFINES
168
Ellipse Administration
MSIXPO-ITEM-REPAIR-RECORD REDEFINES
MSIXPO-ITEM-SUB-REPAIR-RECORD REDEFINES
MSIXPO-TEXT-RECORD REDEFINES
MSIXPO-STD-CLAUSE-RECORD REDEFINES
169
Ellipse Administration
MSIXPO-PO-ITEM-TRACKING-RECORD REDEFINES
170
Ellipse Administration
MSIXRQ - TTT
Field Name Field Length/Type
MSIXRQ-KEY-012.
171
Ellipse Administration
MSIXRQ-DATA-AREA.
MSIXRQ-HEADER-RECORD
172
Ellipse Administration
MSIXRQ-HEADER-2-RECORD REDEFINES
MSIXRQ-ADDRESS-2.
MSIXRQ-ADDRESS-3.
173
Ellipse Administration
MSIXRQ-ITEM-1-RECORD REDEFINES
174
Ellipse Administration
175
Ellipse Administration
MSIXRQ-ITEM-2-RECORD REDEFINES
176
Ellipse Administration
MSIXRQ-LEAD-TIME.
MSIXRQ-ITEM-3-RECORD REDEFINES
MSIXRQ-SUPPLIER-RECORD REDEFINES
177
Ellipse Administration
MSIXRQ-TEXT-RECORD REDEFINES
MSIXRQ-STD-CLAUSE-RECORD REDEFINES
178
Ellipse Administration
MSIXRA - TTT
Field Name Field Length/Type
MSIXOS-KEY-012.
179
Ellipse Administration
MSIXOS-DATA-AREA.
MSIXOS-HEADER-RECORD.
180
Ellipse Administration
MSIXOS-SUPPLIER-RECORD REDEFINES
MSIXOS-ITEM-1-RECORD REDEFINES
181
Ellipse Administration
182
Ellipse Administration
183
Ellipse Administration
MSIXSS - TTT
Field Name Field Type/Length
MSIXSS-KEY-012.
184
Ellipse Administration
MSIXSS-DATA-AREA.
MSIXSS-HEADER-RECORD.
185
Ellipse Administration
MSIXSS-ORDER-SUPPLIER-RECORD REDEFINES
MSIXSS-PAY-SUPPLIER-RECORD REDEFINES
186
Ellipse Administration
MSIXSS-INVOICE-HEADER-RECORD REDEFINES
187
Ellipse Administration
MSIXSS-INVOICE-ITEM-RECORD REDEFINES
188
Ellipse Administration
MSIXSS-TEXT-RECORD REDEFINES
189
Ellipse Administration
190
Ellipse Administration
Device Name
The name of the device as defined on your printer network. This name identifies the device.
All Districts
Select this check box to search and display devices for all districts.
191
Ellipse Administration
Device Type
The device type. Options are:
Printer
Fax
Email
This field is mandatory in create mode.
Device Name
The name of the device as defined on your printer network. This name identifies the device.
This field is mandatory in create mode.
Description
A full description of the device. This can be information such as where the device is located and the
type of device, for example if the device is a printer, a description of Duplex can be entered.
This can be taken from the location as defined on your printer network.
This field is mandatory in create mode.
Device URL
The URL of the device.
For Example:
ipp://ServerGrpA.Company.com:631/printers/PRTABC1S.
Use port 631 to print remotely to any IPP enabled printer through the internet.
Note: For printers that are IPP enabled the printer URL can be set up for direct printing rather than
the requirement to go through the server.
This field is mandatory when in create mode.
System Wide Default
Indicates the specified printer is the system wide default printer.
A printer can be the system wide default when it is not available to any district.
A printer that has a district selected as a default is used as the default printer. Priority is district
default before system wide default.
In the case of a printer being selected as the system-wide default, Ellipse EAM will clear the current
system wide default printer.
192
Ellipse Administration
All Scopes
If selected, indicates all scopes are accessible.
District
The district code. When creating a new device association, by entering a district code in this field,
the device will be valid for the district entered only.
If All Districts is selected, the results grid displays a list of all the districts at the time the printer
was configured.
District Desc
The district code description.
Default
Indicates that the district uses the printer as its default.
Functions and Actions
Function and Actions allow you to perform a command or task in an application. For more
information, refer to Ellipse EAM Application Toolbar.
Print Test Page - Prints a test page to the specified printer.
Note: This button does not display when in create mode.
193
Ellipse Administration
194
Ellipse Administration
195
Ellipse Administration
Initiation of Batch Jobs allowed from online - Allows the request to be submitted from
MSO080 as well as cyclic requests being created.
Run Batch Job overnight only - Stops batch requests from running outside of the overnight
cycle.
Note: For users with System Administrator privileges, the system overrides the Run Batch Job
Overnight Only selection.
No. of Requests
The number of requests required for the report.
Options are:
Option Description
Only One Request is Valid For Only one request containing this program is allowed in
This Report MSF080. If a second request is submitted through MSO080 -
Request Reports or MSB082 - Cyclic Request Submission,
this will result in an error (while the request exists in
MSF080).
Single Request Allowed per Only one request containing this program is allowed in
District MSF080 (per district). If a second request is submitted
through MSO080 - Request Reports or MSB082 - Cyclic
Request Submission, this will result in an error (while the
request exists in MSF080).
Note: If it is for a different district that has no request, it is
successfully written to MSF080.
District Code
If selected, this check box indicates that the program/report can be run at global level.
If clear, district code is mandatory and cannot be changed from the user's login district.
Reverse Option
If selected, this check box indicates that the requests are processed 'last in first out'.
If clear, requests are processed 'first in first out'.
For example if selected, if users enter multiple requests for the same program the last request is
processed first.
Parameter Program
The parameter program. This is the name of the online program that will accept and validate the
request parameters for this report.
This program writes its own request records to the Batch Request file (MSF080). This facility is only
used if the standard request parameter validation is insufficient.
Inhibit Medium/Printer
If selected, removes the the medium/printer related options from the MSM080B - Maintain Report
Request screen.
196
Ellipse Administration
Request Record
If selected, request records are written.
If clear, an error displays when a request (cyclic or non-cyclic) is submitted.
Request Allowed
The type of request allowed. This identifies how the program/report can be run.
Valid options are:
Batch only - This report can only be submitted as a cyclic request.
Always - If there are no restrictions on the submission of the report, the report can be
requested using MSO080 - Request Reports from the reports menu of applications, or within
another Ellipse application.
Never - This report cannot be submitted from within an Ellipse application.
No Process SPL
The number of requests to be processed each time the report is initiated. Entry must be in the
range 1 to 999. The default is 1. This field is only for RDL type reports. For example, if this field is
set to 5, on a single execution of a report for example, MSB141 Picking Slips, the report internally
iterates and processes 5 requests before terminating.
No of Requests to Proc in an Execution
(Number of Requests to Process in an Execution)
Enter the required number of requests. This field together with the No Process SPL field are
applicable to installations that can process multiple requests and hold them for spooling. For
example, spool off after every five requests are processed.
Parameters tab
Display Row
The number of the row to display the parameter. The row is relative to the first parameter row, for
example, row 1 is line 9 on the screen.
Description
The description of the parameter. This parameter description displays in MSM080C - Report
Parameters once the request is submitted from MSM080B - Maintain Report Request.
Mandatory
Indicates the report parameter is mandatory.
Repeat Counter
The number of times the parameter is to be repeated on the screen.
Offset
The offset is the character position within that record relative to the start of the parameters field.
Length
The length of the parameter.
Field Type
The code to identify the type of parameter. Entry is validated against the Table File FT - Field
Type.
Field Type Description
The field type code description. For example if Field Type AN has been selected, the description is
Alpha Numeric.
197
Ellipse Administration
Parameter Type
The parameter type. Valid options are:
Constant - The value of this parameter is not shown on the screen, but is moved onto the
request record.
Default - The value is displayed on the screen as a default value.
Note: You must enter a value in the Parameter Value field, if this field is populated.
Parameter Value
The parameter type value where applicable.
Range Test
The range test for numeric parameters. This test is inclusive of the low values.
Range High
The range test for numeric parameters. This test is inclusive of the high values.
Special Editing
The code to specify additional validation requirements.
Entry is validated against the Table File SE - Special Edit.
Special Editing Desc
The special editing code description.
Group Label
A group label to form a relationship between a group and a program. Entry is validated against the
Table File LABL - Group Label Variables.
Table Test
This indicates whether the parameter is to be validated against a Table File.
Table Type
If the Table Test check box has been selected, enter the table type the field is to be validated
against.
Table Type Desc
The title of the table type.
Error
The error number to be used if the validation fails.
Error Desc
The error number description.
Upload File tab
File
Enter or browse and select the file to upload.
198
Ellipse Administration
Exact Match Displays the exact audit restrictions based on the entry made in the
Table Name field.
Starts With Displays audit restrictions that start with the specified characters
entered in the Table Name field.
Starts From Displays all audit restrictions starting from the specified characters
that match the entered search criteria.
Table Name
Enter a table name on which to search.
199
Ellipse Administration
Table Name
The name of the table.
Override Level
Select the required override level from No Access to Full Access.
Note: The default for tor the ABB defined Audit_Restriction file is no access. Users can update the
setting and it will override the ABB defined level of no access. If the user subsequently deletes the
user defined setting, the ABB default of no access will be reapplied.
200
Ellipse Administration
201
Ellipse Administration
Sequence No
The order in which batch subsystem checks the user queues against the request. This is to assess a
match with the queue pattern.
The default queues with First in the Applied field (Default Queues Internal tab) are always
checked before any of the user queues
The default queues with Last in the Applied field are always checked last.
The batch subsystem may find a match with the first user queue it compares or with default queues
with an Applied of first, therefore the batch subsystem stops when a match is found.
Notes:
• When a row is added to the grid, it is allocated a sequence number. To change the sequence of a
queue, select the row and move it up or down.
• Sequence numbers are maintained by Ellipse EAM.
• The relative value of the sequence number ensures the rows are maintained in the correct order.
• Add a new queue at the end and the number continues the series, for example 100, 200, 300 and
so on.
• Add a new queue between the rows and the number continues in sequence, for example 100, 200,
250, 300 and so on.
• Move a row up or down in the queue and the number assigned to the moved row adjusts to
continue the sequence, for example 100,200, 225, 250 and so on.
Queue Name
The name given to the queue. This field is mandatory.
Pattern
The pattern that defines the queue.
Maximum Concurrent Jobs
The maximum number of jobs. This is used to allocate resources and ensure that they are only
available to the specified queue.
When a queue does not have any requests to process it will not consume any resources. When it
does have requests, it continues to add threads until it reaches its maximum or until it does not
have any more resources available.
For example:
If seven is entered for the Picking Slips queue, up to seven picking slip requests would be processed
at any one time.
Note: A number of one or greater must be entered. The higher the number the greater the volume
of job requests can be handled for that queue.
Do Not Retain
Indicates the batch requests belonging to that queue are not retained.
This means, that the request is not moved from MSF080 to MSF085 and is deleted upon completion.
The review information is not written to MSF086, therefore the details cannot be viewed in MSE086
- Program/Report Review.
Trim Trailing Spaces
Indicates the trailing spaces are removed from the output created using this queue.
Default Queues (Internal) Tab
Applied
The order in which the batch subsystem checks the default queues against the request to assess if
there is a match with the queue pattern.
202
Ellipse Administration
First indicates that the default queues are checked before any user queues.
Last indicates that the default queues are checked after the default first and any user queues.
Queue Name
The name given to the queue.
Note: These are the default queues defined by Mincom. These queues cannot be modified.
Pattern
The pattern that defines the queue.
Maximum Concurrent Jobs
The maximum number of jobs. This is used to allocate resources and ensure that they are only
available to that queue.
The default queues are able to have the maximum concurrent jobs field blank. For example, the
queue default has been configured so that one thread is always available and only one job request
can run at a time.
Do Not Retain
Indicates the batch requests belonging to that queue are not retained.
This means, that the request is not moved from MSF080 to MSF085 and is deleted upon completion.
The review information is not written to MSF086, therefore the details cannot be viewed in MSE086
- Program/Report Review.
Note: This field is review only and cannot be modified.
LOGS
Batch Log File
Ellipse EAM generates a batch.log file every day. To separate the current date from past days, the
system provides a date extension in the format of YYYY-MM-DD, for example batch.log.2012-06-22.
The number of past days is dependent on the housekeeping that is in place.
The batch.log file contains entries on the batch subsystem. Each entry starts with the date and
time, and then contains a description of how the batch subsystem has been impacted.
Note: This file contains the errors associated with batch subsystem NOT the batch requests. Batch
request log information can be viewed in MSE086 - Program/Report Review.
CONFIGURATION FILES
This section contains access to the .xml files used by the batch subsystem at start up, which
includes any time MSEBAT makes changes.
Note: Each time the MSFPRF or MSFTFS files are updated through MSEBAT, the batch subsystem
does a stop then start, which ensures it is up-to-date.
203
Ellipse Administration
Batch File
The batch.xml file provides a structure that contains the streams, task lists and batch jobs that are
loaded into the batch subsystem at start up from the MSFTFS file.
Batch.xml is not editable. Entries in custom_batch.xml are used to provide the same functionality.
Custom Batch File
Create or browse and upload a custom batch file.
The custom batch file allows you to create your own batch structure containing batch jobs, task list,
and stream.
If you create an entry with a batch name that is the same name as that contained in batch.xml, it
will override the entry when loaded into the batch subsystem.
A custom batch file can be created from a template and must be saved and uploaded before it is
used. The newly created batch file is stored in the MSFTFS file.
Functions and Actions
Function and Actions allow you to perform a command or task in an application. For more
information, refer to Ellipse EAM Application Toolbar.
Start - Starts the batch subsystem process.
If the batch status is Stopped, the Start button displays.
Stop - Performs a controlled shutdown of the batch jobs where jobs are allowed to finish.
If the batch status is Started, the Stop button displays.
Force Stop - Cancels all running batch jobs.
Release All SyncKeys - Releases all memory synchronized keys. This is useful if a batch freezes
on a specific sync key.
Flip Batch Trace Flag - Turns batch server tracing on or off.
204
Ellipse Administration
Close
(Close Period Indicator)
Enter Y to close the current period and move to the next sub-system. Accounting period records
must exist in the System Control file for the closing period and the new current accounting period.
Journal Holding Sub-system closure. For example, Y is only permitted if the new current accounting
period will not be later than that of any of the other sub-systems displayed excluding the General
Ledger.
General Ledger Sub-system closure. For example, Y is only permitted if the new current accounting
period will not be later than that of any of the other sub-systems displayed excluding the General
Ledger.
Confirmation is required for any entry if its corresponding new current accounting period will be
two periods or more later, than that of any of the modules displayed.
205