GNM_RCS_Contributor_Reporting_TS

.

• 1. .Introduction

     1. Purpose

The document GNM_RCS_Contributor_Management_FS.docx is the functional specification that describes what business functions RCS supports in relation to Contributors.

This document is one of a set of technical specifications that provide details of how those functions are implemented in RCS.

• 1. Scope

This document focusses on the contributor reporting requirements. There are 3 reports, or lists, of contributor data that users can request:

• • Photographer list

  • Staff list

  • Contributor list

This document is intended as a high-level technical document outlining how the relevant business functions are implemented in terms of software modules.

Importantly, this document does not aim to provide the level of detail that would be required in a programming specification in areas such as program structure, detailed business rules, data integrity, validation, locking considerations, data security, and calls to/from other software modules, performance considerations, and so forth.

For details of program logic and coding, the reader should refer to the program files themselves.

• 1. .Technical design

     1. Photographer list

        1. Layout

The report is a comma separated value (csv) file which is intended to be loaded into MS Excel.

The first row of data is a header record as follows (please ignore any wrapping):

Name,Surname,Forename,Company name,Street address,Town,County,Postcode,Country, Telephone,Mobile,email,Staff?,Started,Ended,Casual?,Part-time?

The rows of data that follow the header represent the Photographers, listed in alphabetic order.

• 1. Requesting a report

Users request this report via a Report request screen accessed from the main RCS menu as follows:

Contributors → Photographers List

This screen is an Oracle Form named rcs_reports_100_pc.fmb

On pressing “Finish” a request for this report is saved to the REPORT_REQUESTS table, and this is processed later asynchronously by a database job.

• 1. Execution

This report output file is produced by a database job that processes new report requests. The database job executes this package procedure:

reports.process_outstanding_requests

The above packaged procedure executes another package procedure to produce the report:

rcs_cpro_020.run_report

In turn this packaged procedure writes two files to the fip folders (Fingerpost), one being the csv output for the report itself, and the other containing meta data for an email. Fingerpost tools (asynchronously again) find these files and generate an email to the requestor attaching the report.

• 1. Staff list

     1. Layout

The report is a comma separated value (csv) file which is intended to be loaded into MS Excel.

The first row of data is a header record as follows (please ignore any wrapping):

Surname,Forename,Casual?,Part-time?,Started,Ended,Payroll no.,Payroll?,Supplier ID

The rows of data that follow the header represent the relevant Staff, listed in alphabetic order.

• 1. Requesting a report

Users request this report via a Report request screen accessed from the main RCS menu as follows:

Contributors → Staff List

The layout of the Report request screen is as follows:

This screen is an Oracle Form named rcs_reports_110_pc.fmb

On pressing “Finish” a request for this report is saved to the REPORT_REQUESTS table, and this is processed later asynchronously by a database job.

• 1. Execution

This report output file is produced by a database job that processes new report requests. The database job executes this package procedure:

reports.process_outstanding_requests

The above packaged procedure executes another package procedure to produce the report:

rcs_cpro_010.run_report

In turn this packaged procedure writes two files to the fip folders (Fingerpost), one being the csv output for the report itself, and the other containing meta data for an email. Fingerpost tools (asynchronously again) find these files and generate an email to the requestor attaching the report.

• 1. Contributor list

     1. Layout

The report is a comma separated value (csv) file which is intended to be loaded into MS Excel.

The first row of data is a header record as follows (please ignore any wrapping):

Surname,Forename,Company,Telephone,Mobile,email,Street address 1,Street address 2,Street address 3,Street address 4,Town,County,Postcode,Country,Died on

The rows of data that follow the header represent the non-staff contributors, in alphabetic order.

• 1. Requesting a report

Users request this report via a Report request screen accessed from the main RCS menu as follows:

Contributors → Contributor List

The layout of the Report request screen is as follows:

This screen is an Oracle Form named rcs_reports_120_pc.fmb

On pressing “Finish” a request for this report is saved to the REPORT_REQUESTS table, and this is processed later asynchronously by a database job.

• 1. Execution

This report output file is produced by a database job that processes new report requests. The database job executes this package procedure:

reports.process_outstanding_requests

The above packaged procedure executes another package procedure to produce the report:

rcs_cpro_030.run_report

In turn this packaged procedure writes two files to the fip folders (Fingerpost), one being the csv output for the report itself, and the other containing meta data for an email. Fingerpost tools (asynchronously again) find these files and generate an email to the requestor attaching the report.

End of Document