You are here: Development Standards > OSAS Standards > Installation > Distribution Media File Descriptions and Comments

# Distribution Media File Descriptions and Comments

Pre-Installation Files

In addition to the application programs and data, include an xxAPPL.TXT file on the distribution media (xx stands for the application ID) that describes the application and its installation. Below is a sample of the POAPPL.TXT file:

`[Application Information]`
`ApplId = PO`
`ApplDesc = Purchase Order`
`InstDesc = Purchase Order`
`ApplSDesc = Purchasing`
`ApplVFil = POORx`
`AddApp = AP`
`ApplFlag =`
`ApplVer = 7.60`
`ApplSize = 5544
ApplGl = Y`

`[Dependencies]`
`ApplDep = AP~`

`[Install Files]`
`File001 = POAPPL.TXT`
`File002 = RWdata/PORWDATA.ZIP`
`File003 = data/PODATA.ZIP`
`File004 = gui/PORES.ZIP`
`File005 = progAP/POPROGAP.ZIP`
`File006 = document/POPROD.ZIP`
`File007 = progRM/POPROGRM.ZIP`
`File008 = sample/POSAMPLE.ZIP`
`File009 = sysfil/POSYSFIL.ZIP`
`File010 = document/PODOC.PDF`

`[First Task]`
`cmd001 =`

`[Last Task]`
`cmd001 = CALL STBL("RMPREFIX")+"RMAPPL.PUB","AP","OFF"`

`[Label Information]`
`Label01 = Purchase Order 7.01 Copyright (c)1982 - 2005`
`Label02 = Open Systems Holdings Corp. All Rights Reserved.`

This text file contains a number of sections and tags that describe the application and offer key information about how the application is installed. Section titles are delineated by square brackets ([ ]), while tags are found at the beginning of each line and are followed by an equal sign and then a developer-assigned value.

Section titles and tags must appear exactly as described below.

[Application Information]

This section contains several tags that describe the application.

Tab | Description and Comments
ApplID | The two-character application ID.
ApplDesc | The name of the application as it will appear on the graphical and text OSAS main menus.
InstDesc | The name of the application as it will appear on the installation menu.
ApplSDesc | The short description of the application as it will appear on the application tabs in the MDI menu.
ApplVFil | The filename for verifying that the application is installed. Use a lowercase x in the filename to indicate that the file is company specific.
AddApp | The two-character ID of the application onto which this application adds functionality or on which it is dependent.
ApplFlag | Left blank on OSAS shipping applications, this field can be used for modifications to prevent reinstallation of the original (unmodified) OSAS application.
ApplVer | This is the version of the application to be installed.
ApplSize | The number of kilobytes of disk space consumed by the installed application, not including data files.
ApplGl | Set to Y if this application interfaces to General Ledger; otherwise, set to N.

The system uses the values for the application code, enhancement code, and enhancement ID in a manner illustrated in this table:

Tags in xxAPPL.TXT | ApplID | ApplFlag | AddApp
Application Code | xx | xx | yy
Enhancement Code | blank | xx | xx
Enhancement ID | blank | site ID | blank

[Dependencies]

The Dependencies section lists applications that must be installed before this application, if any. The installation process will ensure that if multiple applications are installed at one time, dependent applications are installed after the applications on which they depend.

Tab | Description and Comments
ApplDep | The two-character application IDs of each application that must be installed before this application. Each application ID must be followed by a tilde (~).

[Install Files]

The Install Files section contains a list of the files that will be copied to the server during the installation process. File names without subdirectory information are copied to the application’s progXX directory. To install files to other directories on the server, include the subdirectory information in the file name.

Tab | Description and Comments
FILEnnn | The name of each file and subdirectory, if necessary, to be copied during the process. nnn must be a unique 3- digit number entered in consecutive ascending order beginning with 001. Enter names in each directory in alphabetical order, beginning with files in the root directory. Enter subdirectories as needed. For example: FILE001 = File1 FILE002 = File2 FILE003 = data/XXDATA/ZIP FILE004 = progXX/XXPROGXX.ZIP File names can refer to zipped files or unzipped files. Capitalization is critical to proper installation. See xxREMOVE.TXT Standards below for more information about capitalization rules.

[First Task]

This section contains BBx commands that must be executed by the installation process before installing the application. A typical use of this capability would be to CALL a program stored on the initial distribution volume that does something out of the ordinary to the installed OSAS as a prerequisite to installation (for example, verifying that a certain version of RM was installed).

Tab | Description and Comments
cmdnnn | Optional preinstallation processing. For example, `cmd001 = CALL INFODEV$+"DO-THIS.1ST"` To prevent losing access to the installation process, do not use a RUN here. Note the use of INFODEV$. It forces access to the installation directory for the program so that it doesn't have to be copied.

[Last Task]

This section contains BBx commands that must be executed by the installation process after installing the application. A typical use of this capability would be to turn off access to another application or to merge files after installation.

Tab | Description and Comments
cmdnnn | Optional postinstallation processing. For example, `cmd001 = CALL STBL(“RMPREFIX”)+"DO-THIS.LAST"` To prevent losing access to the installation process, do not use a RUN here.

[Label Informaton]

This section contains the name, version and copyright information for the application as it will appear on the application information inquiry screen.

Tab | Description and Comments
Label01 | The first line of the copyright information, specifying the name of the application and the version, followed by the right-justified copyright years.
Label02 | The Last line of the copyright information, specifying the copyright holder's name and the right-justified text "All Rights Reserved."

Post-Installation Files

In addition to the Last Task section of the xxAPPL.TXT file, the system uses these files at the end of the installation process.

Name | Type | Description and Comments
xxREMOVE.TXT | TEXT | Noninstallation processing replaces xxFILES.TXT only for removing files. The file contains a list of all the files installed for the application. The system uses it when the user chooses to remove an application.
UPDATE.TXT | TEXT | Update kits only • always on first volume root directory • used for list of applications on media • not copied The file contains a list of application IDs on the media in the order in which the system must install them. Separate each ID by one space. The file should use only one line of text, such as: AP AR BR FA GL JO PA PO RM RW SO

To create an installable update kit, follow these steps:

- Copy the xxAPPL.TXT file for each application to the root directory on the media.
- Copy each application's specific files into their proper subdirectories.
- Create a file on the root directory named UPDATE.TXT, as described before.
- If an application spans more than one volume, the file xxAPPL.TXT must be on the root directory of all additional volumes containing the application.

Application Setup Files

The system uses these files after the installation process, during setup:

Name | Type | Description and Comments
xxDATA.yyy | MKeyed | Data file information file • used to create, rebuild, report on, and remove application data files • copied to application programs directory
xxCNVT.yyy | Program | Data file conversion • prompt user for location of old and new files • copied to application programs directory • optional