CAPITAL DATA CORP

CCAQS Data Submittals Technical Document

Monday, January 07, 2002

[Revision Number 1.0]

Document Information

Filename:CCAQS Data Submittals Technical Document

Created:Monday, January 07, 2002

Last Modified:Wednesday, January 11, 2002

Rev # / Date / By / Description
1.0 / 01/11/2002 / Seshu Kavuri / Initial release.

Purpose

Assists the people in understand the implementation details of the Catalog application.

Help in making changes, enhancements to the existing application and debugging any errors in the course of maintaining the same.

This document will not contain any information on design of the application. This document is rather aimed in describing the implementation details of the application.

Description

The main functionality of the “data Submittal” module is to

  1. List all the data files that have been processed by QA process.
  2. Provide a way to request all the data in a single submittals file that is processed and accepted by the QA process.
  3. List all the data files that have been processed by QA process on a particular data source.

Files Used

Description

The following files are used in the Data Submittal Module.

  1. SubmittalReport.Asp – Page that displays all the submittal files that are submitted to QA process.
  2. CatalogDisplayTable.Inc – Include File that calculates the next page number, when the results are displayed in more than one page.
  3. getSubmittalData.Asp – Page that displays information about the file that is going to be generated and collects the email address information of the user.
  4. qrySubmittalProcess.Asp – Page that displays request received acknowledgement and makes the component call that process the request.

Configuration

The Query Component is configured in COM+ on the application server.

QryConnection.inc file is to store global variables

A virtual Directory called “Datamaintenance” in the IIS Default Website

A virtual FTP directory called “CCAQSDataFiles” in the IIS Default FTP Site

Dependencies

Query.dll – This is the com object that will build the sql query, execute the query, creates the file from the results of the query, updates the catalog and send request status information to the user.

The implementation details of the COM object are described in COM object part of the document.

Database - This application needs some database object in the database. The database section of the document describes the use of those database objects.

Top

SubmittalReport.Asp

Description

This is the homepage for Data Submittal application. This page has the code that query Submittal_log table and lists all the files information that is processed by QA application. By default this page will display all the files. User can select a particular data source name from the interface to view specific data source provider files information.

This page will display names of the submittal files that are accepted and rejected by the QA application. The files that are processed and accepted by the QA application have links. A click on the file name will take user to the next page (getSubmittalData.asp) of the process.

Include Files

qryLib.Asp

This file is included to access the following global variables.

gCONNSTR

This file is included to access the following client functions.

exitForm()

catalogDisplayTable.Inc

Specific Server Functions

Name / Purpose / Parameters / Return
GetFromattedTableDataPageWise() / This function generates a HTML table structure displaying limited number of records per page. The table will have all the columns specified in the SQL query. / StrSQL: The sql query string. This query is executed to build the table rows.
IntCurrentPage: The current page number to be displayed. / HTML table structure. And page number when the data is displayed in more than one page.

Specific Client Functions

Name / Purpose / Parameters / Return
CallSelect() / This function makes the item that is send to it as a selected item in the Data source selection box. / DCcode: Data source code that is selected
SubmitForm() / This function submits the form to it self.

Top

getSubmittalData.Asp

Description

This page displays the name of the file that user selected and displays the column names that he is going receive in his data file. User has to enter the email address to which the data request process status information has to be sent.

This page gets the submittal log id number form ‘submittalreport.asp’ file in the form of a query string.

To display the file name this page got the script that query the database and finds the filename associated with the submittal ID.

To make the selected available to the next page this cerates a hidden field that holds the submittal log id number.

Include Files

qryLib.Asp

This file is included to access the following global variables.

gCONNSTR

This file is included to access the following client functions.

exitForm()

openHelp()

isEmail()

Specific Client Functions

Name / Purpose / Parameters / Return
SubmitForm() / This function enforces the email address entry in the email address text box and submits the form.
doNothing() / This function will do nothing. This will return false. This is written to fix the problem of submitting to it self when the “enter” button is pressed after entering the email address in the email field. / false

Top

qrySubmittalProcess.Asp

Description

This page displays the “request received” message to the user.

Gets the submittal_Log_ID from the previous asp page “getSubmittalData.asp” and formulate the SQL query C

Calls the “executeQuery” method of the query component.

Include Files

qryLib.Asp

This file is included to access the following global variables.

GCONNSTR

UrlRef

EmailSubject

EmailMessage

EmailSender

opFilePath

This file is included to access the following client functions.

exitForm()

Top

CatalogDisplayTable.Inc

Description

This page has asp code that calculates the page number by calling the getFormattedTableDataPageWise() function in the qryCatalog.asp page, when the data is displayed in more than one page.

This page also has got code that will display two bottom links to navigate to the next and previous pages when the data is displayed in multiple pages.

Database

Description

The database should have the following Tables for the execution of catalog application

Tables

  1. Submittal_Log Table: This table contains information of the data files that are processed by the QA application.

This table is part of the CCAQS database.

Top