The Blue Prairie Forms Basic API lives, by default, in the BPIFORMS account on your multivalue server. The API lives in the bpi.bp.form directory and should be fully functional, at the time of installation, within the BPIFORMS account.
Exposing the API in your application accounts
If you wish to call the API from another account, the BASIC objects need to be exposed within that account. The recommended method to be used for exposing the API will be determined by your MultiValue platform using the normal methods appropriate for that Multivalue platform.
To expose the API in another account, the following procedure will work. However, remember that on a jBASE system, there are a variety of ways that accounts can be configured. Some installations make use of the SYSTEM to establish environmental configurations. Other jBASE installations prefer to use UNIX initialization scripts to setup the jBASE environment.
The main goal in exposing the Blue Prairie Forms API in JBASE is to ensure that two environment variables hold the path to the Blue Prairie Forms bin and lib directories.
If you use the jBASE SYSTEM file method of environment setup, this procedure will work
For this example, we will assume that the account into which we wish to expose the Blue Prairie Forms API is called EXAMPLE:
Example SYSTEM file entry
The jBASE SYSTEM file is defined on the jBASE website at this URL: https://www.jbase.com/r5/knowledgebase/manuals/3.0/30manpages/man/sup22_SYSTEM.ENTRIES.htm
For convenience, the definitions for attributes 25 and 26 (as highlighted above) are excerpted here:
PATH refers the environment variable $PATH. This is the normal operating system $PATH variable. The operating system $PATH variable will be set to the value defined in this attribute.
JBCOBJECTLIST refers to the environment variable $JBCOBJECTLIST. This environment variable is specific to jBASE and defines the location where subroutine shared objects live.
Some users of jBASE configure their environments using the SYSTEM file but others prefer to control their environment using UNIX scripts. In that case, you will need to look into the the environment setup scipts (usually .profile or .bash_profile). For a full explanation of the jBASE Environment Variables, please refer to the jBASE documentation at: https://jbase.com/r5/knowledgebase/manuals/3.0/30manpages/man/env1.htm
To expose the API in another account, the following procedure will work
- LOGTO your target account
- SET.FILE BPIFORMS bpi.bp.form BPIFORMS.bpi.bp.form
- SSELECT BPIFORMS.bpi.bp.form
- CATALOG BPIFORMS.bpi.bp.form
Simple login to the BPIFORMS account and globally catalog all items in bpi.bp.form.