]project-open[ : @This Wiki
Portrait

Welcome, Unregistered Visitor

Contact ·  Index · Login · Register
 

Contents

Remote Training
Support
SaaS Service

5 registered users
 in last 24 hours

Admin API Doc

The API Doc allows searches o­n all the active running code on the system, and general browsing of active running code, listed by package.  The two primary coding languages present in the API are TCL and PostgreSQL.  Basically this a graphical interface that presents and hyperlinks, and indexes the contents of the "sql/, tcl/, and www/" directories found in each package.  The API Home Page consists of two important components:

 

image:screenshot_api_doc.gif

 

 

  1. A Listing of all currently enabled and installed packages.
  2. A search bar for all the code that is currently enabled and installed.    

 

The entry for each package consists of:

 

image:screenshot_api_doc_4.gif  

 

  • Library Files - all ".tcl" files contained within this package
  • Procedures - a listing of all procedures found within the ".tcl" files
  • SQL Files - a listing of all ".sql" files found within this package
  • Content Pages - a listing of all the code files (.adp, .tcl) that dynamically generate HTML pages basically everything located in the www/ directory of this package

Library Files

A listing of all ".tcl" files contained within this package.  These files contain all the procedures used in code execution, therefore the  majority of the file names are terminated in  "procs.tcl".  This is an alphabetically sorted list view of the files contained within the "tcl" directory of the files found in each package. 

 

image:screenshot_api_doc_1.gif    

 

Clicking on an individual file name links to a page displaying a listing of all the procedures within the file and their names.  If you are interested in the source code of a particular procedure, click on the specific procedure name.  Procedures used internally by this procedure are hyper-linked to their own source.  The source of accompanying Generic/PostgreSQL/Oracle  XQL files is also shown, if available.   

 

image:­screenshot_api_doc_2.gif

image:screenshot_api_doc_3.gif    

 

Procedures

This is a listing of all the procedures contained in the .tcl files of this package, presented alphabetically.  Each procedure name links to a screen showing what specific .tcl file this procedure can be in and belongs to.  Also , the source of the each procedure can be seen, as well as the source of related XQL files, if available.  Note that procedures called within the body of this procedure are hyper-linked, so that you can quickly jump and see their source as well.   

 

SQL Files

A listing of all ".sql" files contained within this package.  These files contain all the create/delete/update routines run on the database.  This is an alphabetically sorted list view of the files contained within the "sql" directory of files found in each package.  Clicking on a particular file name will link to the source of the file.  

 

 

­

Content Pages

A listing of all files responsible for generating HTML webpages that are the interactive screens that end users view and use to interact with ]project-open[.  The majority of files responsible for dynamically generating content are ".tcl" or ".adp" for AOL dynamic pages.   This is an alphabetically sorted list­ view of the files contained within the "www" directory of files found in each package.  Clicking on a particular file name will link to the source of the file.     

 

References


Please take a moment to complete this form to help us improve our service.

Note:
Please only provide feedback in regards to content this page shows. For support inquiries please refer either to the Community Support forum at Sourceforge or check out our 'Professional Support'

Did this page help you to achieve your goal?

 Yes  No  Don't know

Please provide us with comments to improve this page:

How useful is the information?

 1  2  3  4  5
Not
useful
      Extremely
useful
 
  

Explore

Installers
Demo Server
Modules & Functionality
Packages
Business Processes supported
FAQ's

Help

Getting started
User Manuals
Configuration Manuals
Community Support
Professional Support

News

News
Twitter
RSS Community / Sourceforge
Register for Newsletter

Get in touch

Contact
Register



Creative Commons License This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 2.0 Generic License - Privacy Policy