Jargon Building BlocksTM
Installation and Configuration Notes
Version 2.3 - December 2000
Related Documents
Overview
The Jargon Building BlocksTM system is an application development
infrastructure that consists of several elements:
-
The XFiles Database
-
Host Programs
-
HTML Online Help Documents
-
Client Applications
The schema file for the XFiles Database is distributed as both a
"tar" file for Unix systems (jsxdb.tar) and a "zip" file for Windows NT/2000
systems (jsxdb.zip).
The Host Programs are distributed as both a "tar" file for Unix
systems (jsxprog.tar) and a "zip" file for NT systems (jsxprog.zip). These
files also include certain "base" database table contents (".d" files).
The HTML Online Help Documents are distributed as both a "tar"
file for Unix systems (jsxhelp.tar) and a "zip" file for NT systems (jsxhelp.zip).
The Client Applications are distributed as a "zip" file for Windows
95/98/NT/2000 client systems (jsxapp.zip).
Installation
Note: these installation instructions
assume that you have already installed Jargon ReaderX, Jargon Reader, and/or
Jargon Writer on both your client and host systems. If not, you should
complete the installation of one or more of those products before continuing
with these steps.
The XFiles
database.
-
Extract the jsxdb.tar or jsxdb.zip contents into
the host directory where you want to build the database.
-
You can make a new empty Progress database for the
XFiles and attach it to your application database at startup, or you can
add the XFiles schema to your application database schema.
-
For a new database, use the appropriate Progress
utility to create a new "xfiles" database from "empty" (on unix: "$DLC/bin/prodb
xfiles empty).
-
Start a Progress editor session and go into the data
dictionary.
-
Connect the new or existing database in which you
will be loading the Xfiles schema.
-
Load the schema file "xfiles.df".
-
End the Progress editor session.
-
Modify your WebSpeed or AppServer startup parameters
to attach the "xfiles.db" if you have created it as a separate database.
This is often done in a ".pf" file, with other session startup parameters.
HostPrograms.
-
Extract the jsxprog.tar or jsxprog.zip contents into
the host working directory for your application. The programs will be extracted
into two subdirectories: "jrep/include/" and "jsx/".
-
In the "jsi/" subdirectory, edit the "jsi.ini" file
and change the definition of "UseBldBlks" (line 15) to read: &GLOBAL-DEFINE
UseBldBlks TRUE
-
If you want to compile the host programs to object
(".r") programs for performance reasons, start a Progress editor session,
then run "jsx/compall.p".
-
To compile the programs for syntax only (to make
sure everything is okay), you can run "jsx/compchk.p" instead.
-
Create a system reports directory, individual user
report directories, and a Job Processor logs directory. Note these names
for later use when running various system setup programs (see below).
-
Create a subdirectory named "temp" directly beneath
the Web server's HTML root directory, such as "/html/temp" or (for NT)
"C:\Inetpub\wwwroot\temp". This is needed to enable viewing reports in
a Web browser. Make sure it has fully open read/write permissions.
-
Modify the jsx/runbatch.sh script as needed on Unix
systems (for Job Processor startup command). On NT systems, configure a
".bat" file or equivalent in the NT or Progress utility programs.
HTML Documents.
-
Extract the jsxhelp.tar or jsxhelp.zip contents into
the host or client directory where you want to store your online help documents.
The documents will be extracted into a "doc/progress/jsx" subdirectory.
-
If installed on the host (which is the preferred
method, to simplify the process of updating online help documents), extract
this subdirectory under the Web server's "document root" HTML directory
path. For example, if your Web server locates all HTML documents relative
to "/html", you could extract into it, so that the help documents will
be in "/html/doc/progress/jsx".
-
Before you can use online help, you must configure
the "base help directory" in System Control Setup. For this host example,
you would enter: "/html/doc/progress/".
-
If installing help documents on each client system,
they must all be installed in an identical location on each client computer,
which would normally be "<Jargon working directory>\doc\progress\jsx".
Client Applications.
-
For use with Jargon ReaderX, extract the jsxapp.zip
contents on your web server host system into the subdirectory "xml\jsx\"
under your web server document root directory. On NT, this would extract
the client xml files into the directory C:\inetpub\wwwroot\xml\jsx (which
must also be added to the AppRootURL search path in the ReaderX html startup
page's parameters).
-
For use with Jargon Writer or Jargon Reader, extract
the jsxapp.zip contents on each client into the subdirectory "xml\jsx\"
under your Jargon Writer or Jargon Reader working directory.
-
For Jargon Reader:
-
Create a desktop shortcut which starts Jargon Reader
using a "system/jsx.ini" preferences file.
-
In the "system" subdirectory, create a "jsx.ini"
preferences file by copying the "preferences.ini" file as a template.
-
Set the directory search path to "AppRootDir=.\xml;.\xml\util;.\xml\jsx".
-
Set the startup app to "AppName=x00login".
-
Modify other parameters if needed (such as proxy
and browser startup info).
-
Set the "HostURL=" and "Script=" parameters (for
WebSpeed) or the "AppServerURL=" parameter (for AppServer) to the appropriate
values for your installation. Be sure only one set of host parameters is
used, with "#" in front of the other set of parameters to comment them
out.
-
The normal browser startup parameter for Windows
clients is: "BrowserCommand=rundll32 url.dll,FileProtocolHandler"
-
For Jargon Writer,
-
Create a desktop shortcut which starts Jargon Writer
using a "system/jsx.ini" preferences file.
-
In the "system" subdirectory, create a "jsx.ini"
preferences file by copying the "preferences.ini" file as a template.
-
Set the directory search path to "AppRootDir=.\xml;.\xml\util;.\xml\jsx".
-
Modify other parameters if needed (such as proxy
and browser startup info).
-
Set the "HostURL=" and "Script=" parameters (for
WebSpeed) or the "AppServerURL=" parameter (for AppServer) to the appropriate
values for your installation. Be sure only one set of host parameters is
used, with "#" in front of the other set of parameters to comment them
out.
-
The normal browser startup parameter for Windows
clients is: "BrowserCommand=rundll32 url.dll,FileProtocolHandler"
-
Start Jargon Writer, then open and run "xml\jsx\x00login.xml".
Configuration
-
Determine your security strategy. You will need to
have this spelled out in order to configure and set up various tables in
the following steps. See Implementing Security
for details.
-
Make sure that your Web server and WebSpeed
broker or your AppServer brokers and servers are running
correctly. You will need to stop and restart the broker after installing
the database, so that it is connected to the XFiles schema.
-
Start the Building Blocks application by clicking
a web page link (ReaderX) or desktop shortcut (Reader), or by running
xml\jsx\x00login.xml in Writer. A login window should appear.
-
Log in,
leaving the User ID and password fields blank. The system will detect that
this is a "first time" login and will initialize certain database tables,
including:
-
Adding an "sa" User
-
Adding an "Admin" Group
-
Loading database table contents for x_app, x_proc
and x_help from ".d" files in the "jsx/data" host directory.
-
Enter a new passwordfor
"sa" when prompted. Record the password for future use!
-
Click "Starting
Menu" to run the System Administration Menu.
-
Run System Control
Setup and fill in values for your installation. Do NOT enable security
at this point, until other required records have been added.
-
Run System Codes Setup.
Certain required system codes will be automatically added the first time
that this program is run. Add other codes, including Security Period definitions,
as required.
-
Run Printer Setup
and add host printer definition records.
-
Run Group Setup
and add application groups.
-
Run User Setup
and add users for each Group, including their default printer and startup
menu.
-
Run Application Setup
and add the Applications you have decided to use.
-
Run Procedure Setup
and add a record for each procedure in your applications.
-
Run Security Matrix
Setup and create any desired security control records.
-
Run System Control
Setup again and enable any desired security testing. Be sure you
have already given yourself sufficient security permissions in the Security
Matrix, or you could "lock yourself out" for future logins (it's been known
to happen!).
-
Test Online Help
from one or more programs, to be sure
that it is configured correctly.
-
Test a report program to verify that all configured
Output Routing methods (View,
Print, Fax, Email, File) are working, and that background
scheduling is working.
-
Configure startup scripts for the background Job
Processor (for unix, see jsx/runbatch.sh).
-
Run the Job Processor
Control Panel
and start a Job Processor, then test various status
and pause/resume/end commands to make sure the background processing system
is working.
-
Log in under various User ID's with different
security profiles, to make sure that security has been set up correctly.
-
You are now ready to begin adding your specific
applications, menus, procedures and help documents to the system.
Return to Top Help
Topics Help
Index