Contents

Overview
Editing Report Layouts
Report Layout Names
List of Additional Functions
List of Category Identifiers

Overview

Reports provide two functions within TDOC as follows:

- Creation of documents such as letters and transmittals
- Present information in a structured manner viz a report.

The report layouts are configurable so that the layout of the document or report may be changed to suit the users specifi needs.

The default layout of all Reports includes a Logo for the User's. The Logo must be a Windows Bitmap, and named YourLogo.bmp. It is treated as follows:

- Its aspect ratio of the logo is retained,
- It will be expanded or shrunk to fit the default size, (for faster printing one of its dimensions it should the the same as one of the default dimensions so that it is not resized),
- The default size is 2.760 inches wide, and 0.573 inches high. Please note that this seemingly rather aribitarary size is convenient when represented in "Object Coordinates" in which the report definition is kept.

Two other types of images are available for use, and are stored within the database. A logo for each job, and a signature for each internal person with the appropriate authority, See Administrtaive Registers, Names and Jobs for details.

The default layout for many reports and documents includes the provision of functions (see below) for printing signatures and Job logos. The images are stored within the database, and for use a temporary image is generated and the deleted after use.

The same mechanism (ReportPro) is used in whether creating a document or a report. When a document or report is generated electronically (as opposed to being previewed or hard copy printed) the generated file is created in the Spool Directory, and given a unique name.

Using the EDM functionality built into TDOC, this file may be automatically archived once it has been despatched to a nominated directory.

Back to Contents

Editing Report Layouts
Select Report | The reports are listed in the section below this one. For example, to create a new General Document Form, open an existing one, and save it with the required new name. After editing, it must then be linked to its "Form Type" category: see Setting to Work; Categories.
Edit Report | Reports may be edited and the following actions taken: Adding more information from tables that are already linked to the report, Linking additional tables to the report, and use their information, Utilising functions to retrieve information from a table not linked to the report, Moving information and titles to the required position. For futher information on editing reports, see the ReportPro Help. This is accessed from the menu which replaces the normal menu when a report is opened.
Edit Report |
Edit Help |
Loading Images | The image is retrieved from the database and used to create a temporary file which is then used within the report. After use the image is then automatically deleted. There are several steps to loading an image as follows: Set the SpoolPath Report Variable using the GetSpoolPath() function as the expression, set at Report Level Create Logo file For Jobs: CreateSig('J', Docjb.Jobno) = 'Ok' For Names: CreateSig('J', Docjb.Jobno) = 'Ok' View the picture using the following expression: cSpoolPath + 'Logo_' + CheckPrintFileName(Alltrim(Docjb.Jobno)) + '.JPG' Logo's can print when: IsSigFile('J', Docjb.Jobno)
Back to Contents
Layout Names
Name | Type | Job | Description
DOCAC.rpt | Wk Pkg | Yes | List of Budget Transactions and Summary
DOCAC_F.rpt | Wk Pkg | Yes | Cashflow actual and projected by Period
DOCAD.rpt | System |  | List of Groups
DOCALD.rpt | System |  | List of Documents allocated to Groups
DOCALG.rpt | System |  | List of Groups with allocated Documents
DOCCA.rpt | Wk Pkg | Yes | Meeting Action List
DOCCA_Sht.rpt | Wk Pkg | Yes | Meeting Action Sheet
DOCCP.rpt | General | Yes | General Document Actions
DOCCU.rpt | Wk Pkg |  | List of Contacts
DOCCU_Sht.rpt | Wk Pkg | Yes | Contact Sheet
DOCDC.rpt | Wk Pkg |  | List of Keywords
DOCDD.rpt | Wk Pkg | Yes | Diary Report
DOCGD.rpt | General | Yes | List of General Documents
DOCGD_AsLogged.rpt | General | Yes | Prescribed Form - For "as logged" document
DOCGD_Letter.rpt | General | Yes | Typical Correspondence Item with signature and verification code.
DOCGD_RFI.rpt | General | Yes | Prescribed Form - For RFI Raised or Forwarded
DOCGD_RFIReply.rpt | General | Yes | Prescribed Form - For Response to RFI
DOCGD_CHG.rpt | General | Yes | Future Prescribed Form - For Change Request
DOCGD_CHGReply.rpt | General | Yes | Future Prescribed Form - For Response to Change Request
DOCGD_ClientInst.rpt | General | Yes | Future Prescribed Form - For Instructions from client
DOCGD_WorkInst.rpt | General | Yes | Future Prescribed Form - For Instructions to subcontractors
DOCGJ.rpt | System |  | List of Subjects
DOCGR.rpt | General | Yes | List of RFI's
DOCIN.rpt | Tech |  | List of Others Documents - Browse
DOCIS_A.rpt | Tech | Yes | List of Acknowledgements
DOCIS_C.rpt | Tech | Yes | List of Comment Sheets
DOCIS_XD.rpt | Tech | Yes | Issues by Document
DOCIS_XR.rpt | Tech | Yes | Issues by Recipient
DOCIT.rpt | Tech |  | Revisions Transformation List"
DOCIV_D.rpt | Tech | Yes | List of an Others Document - Doc / Revs / Movements [Browse, Drill]
DOCIV_IC.rpt | Tech |  | List of Incoming Documents and IC No
DOCIV_XD.rpt | Tech | Yes | List of Others Documents
DOCIV_XR.rpt | Tech | Yes | List of an Others Document to be Returned
DOCJB.rpt | System |  | List of Jobs and associated information
DOCKW_X.rpt | Wk Pkg | Yes | Keyword Search List
DOCLK.rpt | Tech | Yes | List of Documents and Attachments
DOCMJ_H.rpt | Wk Pkg | Yes | Meeting with History
DOCMJ_M.rpt | Wk Pkg | Yes | Minute of Meeting / Agenda
DOCNM.rpt | System |  | List of Names and associated information
DOCNM_MailShot.rpt | Wk Pkg | Yes | Contacts Mail Shot
DOCOW.rpt | Tech |  | List of Own Documents - Browse
DOCPJ.rpt | System |  | List of Projects
DOCPM.rpt | System |  | List of Items for a Category
DOCRQ.rpt | Tech | Yes | List of Requirements
DOCRQ_A.rpt | Tech | Yes | Earned Value Analysis
DOCRQ_N.rpt | Tech | Yes | Requirement Note
DOCRQ_X.rpt | Tech | Yes | Requirement Event Analysis
DOCRV_D.rpt | Tech | Yes | List of an Own Document - Doc / Revs / Movements [Browse, Drill]
DOCRV_X.rpt | Tech | Yes | List of Own Documents
DOCSL.rpt | Wk Pkg |  | List of Inspections
DOCSL_Sht.rpt | Wk Pkg | Yes | Inspection Sheet(s)
DOCTD.rpt | Wk Pkg |  | TimeSheet for Job or Person
DOCTE.rpt | Wk Pkg |  | Expenses for Person
DOCTS_X.rpt | Tech | Yes | Job Issues Matrix for selected Recipients and Documents
DOCTX.rpt | Wk Pkg | Yes | Chargeable Job Expenses
DOCUL.rpt | Misc |  | User Log
DOCWE.rpt | Wk Pkg |  | Event List
OTHACKN.rpt | Tech | Yes | Others Transmittal - Acknowledgement Note
OTHCNOTE.rpt | Tech | Yes | Others Transmittal - User Note (Spare)
OTHCOMM.rpt | Tech | Yes | Others Transmittal - Comment Sheet
OTHCOPY.rpt | Tech | Yes | Others Transmittal - Copied To Sheet
OTHFILE.rpt | Tech | Yes | Others Transmittal - File Copy
OTHPORD.rpt | Tech | Yes | Others Transmittal - Print Order
OTHTNOTE.rpt | Tech | Yes | Others Transmittal - Transmittal Note
OWNACKN.rpt | Tech | Yes | Own Transmittal - Acknowledgement Note
OWNCNOTE.rpt | Tech | Yes | Own Transmittal - User Note (Spare)
OWNCOMM.rpt | Tech | Yes | Own Transmittal - Comment Sheet
OWNCOPY.rpt | Tech | Yes | Own Transmittal - Copied To Sheet
OWNFILE.rpt | Tech | Yes | Own Transmittal - File Copy
OWNPORD.rpt | Tech | Yes | Own Transmittal - Print Order
OWNTNOTE.rpt | Tech | Yes | Own Transmittal - Transmittal Note
STRREP.rpt | Misc |  | Used for miscellaneous printing information (Portrait)
STRREPL.rpt | Misc |  | Used for miscellaneous printing information (Landscape)
TNOTELBL.rpt | Tech |  | Used for printing Labels for Transmittal Documents
YOURLOGO.bmp | All |  | A bitmap on all reports - Aspect Ratio: 4.75, Max Size (Inches) Width: 2.760, Height: 0.573
Back to Contents
List of Additional Functions
All Reports | PageCounter() | Increments the PageNo for multiple documents
| CreateSig() | Creates a Signature. [cType, cRef] cType: N(ame) or J(ob)
| GetSpoolPath() | Returns the Spool Path
| CheckPrint FileName() | Fixes PrintFile Names [cFileName]
| IsSigFile() | Checks that a Signature or Job Logo was created. [cType, cRef] cType: N(ame) or J(ob)
| HaspDongleName() | Returns the Name of the Licencee
| LoggedInUser() | Returns the NameRef of the Logged in User
| RPPrintRisk() | Returns the Risk for the level requested. [Code]
| LookupCategory() | Returns the Description of a Category Item. [Identifier, Code]
| LookupCatMsg() | Returns the Associated Message for a Category Item. [Identifier, Code]
| LookupNameX() | Returns the Organisation Name. [NameRef]
| LookupNameC() | Returns the Contact Name. [NameRef]
| LookupJob() | Returns the Job Title. [JobRef]
| LookupGroup() | Returns the Group Title. [GroupRef]
| LookupProject() | Returns the Project Title. [ProjectRef]
| LookupSubjectX() | Returns the Subject Title. [SubjectRef]
| LookupKeyWord() | Returns the Keyword description. [KeyWordRef]
Technical Documents | CheckIfDocAllocated() | Checks if Doc is Allocated [cJobno, cDocSrc, cMaker, cClientdrg]
| CheckIfDocInGroup() | Checks if Doc is in Group [cJobno,cDocsrc,cGroup,cMaker,cClientdrg]
| LookupIfReturn() | Checks if issues reason is a return [cCode]
| LookupIfHandOverDoc() | Checks if is a Handover Group Type [cCode]
| ShowRev() [Withdrawn] | Shows a revision. [cRevno, cDocSrc, cDrgno, cJobNo, cMaker]
| ShowRev2() [Withdrawn] | Shows a revision. [cDocSrc, cJobNo, cMaker, cRevno]
| ShowRevN() | Shown an Others Technical Document Revision [cJobNo, cMaker, cRevno]
| ShowRevW() | Shows an Own Technical Document Revision [cRevno]
SDRS Reports | CheckRequirementExists() | Validation
| RPEvents() | Create Event Data
| RPGetEvent() | Get Event Information
| RPAnalysis() | Create Event Analysis Data
| RPGetAnalysis() | Get Document / Event Analysis Data
| RPGroupAns() | Get Group Information
| RPGetGpAnalysis() | Get Group Summary Analysis Data
General Documents | LookupIfGenReturn() | Checks if Action requires a response
| CheckIfAnsReqd() | Checks if an Answer is Required
| CheckIfAnsSent() | Checks if an Answer was sent
| CheckIfRFIAnsSent() | Checks if an Incoming RFI has been fully actioned
Work Package | TSExps() | For Timesheet Report calculations
| TSHours() | For Timesheet Report calculations
Back to Contents
List of Category Identifiers
System Codes
Names | Position | D
| Org Type | P
Jobs | Type | J
Group | Type | B
Subject | Type | F
Technical Documents
Documents | Own Stage | G
| Type | Y
| Size | Z
Issues | Reason | S
| Material Type | M
| Return Status | T
General Documents
Documents | Form Type | C
| Action To Do | H
| Action Done | W
Work Packages
Contacts | Status | A
| Mode | L
| Reason | R
Diary | Type | I
Events | Type | E
Inspection | Task | N
Time Sheet | Activity Type | V
| Expense Type | X
Risks | Type | K [Future use]
Back to Contents