Right-to-Know Conceptual Design Definition of Terms API Application Program Interface – a message and language format used by an application program to communicate with the operation system or some other program such as the communications protocol or database management system Application – Abbreviation identifying the Daemon program in the High Level Conceptual Design Diagram on page 5. Binary Large Object – a collection of binary data stored as a single entity in a database management system A constantly running program which triggers actions when it receives certain input, for example a printer Daemon spools information to a printer when a user prints a document File Transfer Protocol – a network protocol used to transfer data from one computer to another through a network, such as the internet Service Oriented Architecture – the architectural style of a computer system used for creating and operating business processes Extensible Mark-up Language – a standard for creating mark-up language which describes the structure of data
APP BLOB Daemon
FTP SOA XML
5/22/2008
1
The following diagram depicts three ways that agencies could electronically transmit documents.
Search
Retrieve Contracts
Public Access Portal (Custom Built)
Public Access
Agency
Meta Data and Contracts
Contract Submission Portal
API API- Option 1
Web Server/Application Server
Direct Import – Option 2
Document Management System (Custom built by KORYAK)
Agency
A P P
XML API
SOA (Service Oriented Architecture )
Docs. (Option 2)
File System (Option 1)
APP Agency
FTP
Staging Area
Extract Meta Data (Custom Built Application)
Docubase
Data Loading
Data Processing
Historical Data
Data Loading 1. Authorized representatives from agencies can access the “Agency Log In” page via a link on to the “patreasury.org/contracts” portal, submit summary data associated with the contract manually on the website, and submit the actual contract document, contract amendment, or purchase order associated with an existing contract. Covered Contracts can be supplied in Microsoft Word, Excel, PDF, or tiff format. Treasury will provide each Commonwealth Entity with the User IDs and Passwords needed to log into the system 2. Agencies can develop applications that will work with their current contract management system to automatically upload contracts and the associated summary data using SOA APIs. 3. Agencies may upload contracts and summary data in a flat file format via FTP on to a staging area hosted by patreasury.org/contracts, which will then be automatically imported into the system by a daemon application developed by the Right to Know team. A header file manually completed for each submitted contract by the submitting agency will be used to gather summary data.
5/22/2008
2
Data Collection from Agencies The proposed process for data collection is shown in this diagram. This diagram displays how agency stakeholders will interact with the application program interface to upload contracts. All versions of documentation submitted must be validated and satisfactorily screened before they can enter the documentation management system. Data Collection from Agencies
5/22/2008
3
Agency Login Page This page will be accessed via the “Agency Log In” link on the PA Treasury.org website, and provides a login capability for the external agencies. The page will be a part of the PA Treasury.org website.
After login, the agency will be presented a page on which they will select the required process for this session. This will include contract, amendment, and purchase order upload.
5/22/2008
4
Agency Input Page This page would be accessed only after log on is entered by the agency user, and would provide the ability to upload new contracts, amendments, purchase orders associated with an existing contract, or search for contracts in the database. Agency Input Page
5/22/2008
5
SOA Input The left side of the diagram represents a service-oriented architecture (SOA) API that accepts xml streams and BLOBs that represent summary data and the document files. Each parameter is parsed and validated, if validation fails it returns to the API, if validation passes, and the uploaded document is redacted, it moves on to the next step – a secondary redaction. Again, if secondary redaction fails, it will return to the API. All of this occurs in a live session, and feedback is sent live. SOA Input Header File The section is used to identify the type of document. Valid values are limited to; “contract”, “purchase order”, or “amendment” (note: Contracts can be in the form of things called agreements, covenants, promissory notes, MOU's, stand alone purchase orders, field limited's, or many other forms.) This is a unique number used by the agency to identify the document in their system. The Agency Contract Number associated with the amendment or purchase order. This is the date when the last necessary signature to fully execute the contract is obtained. This is the date on which an obligation first becomes due under the contract. This is the date on which obligations cease. This is the dollar amount of the contract, or amendment, or a purchase order associated with and existing contract. Agency provided description of the contract. A brief narrative description of the services or commodities provided, amount, contracting party(s), and all possible extension terms of the contract. Agency legal name as documented in the Pennsylvania Journal, executive order, statute, or articles of incorporation. Vendors or anyone providing the service or commodity File name of the document such as “IBMContract.pdf”
Type
Agency Contract Number Parent Contract Number Execution Date Begin Date End Date Contract Amount Subject Matter Agency Name Contract Party(s) Document Name
Detailed specifications for this option will be available by June 10, 2008.
5/22/2008
6