# Kiwiplan - MAP Variables

### Kiwiplan software uses several environmental variables within the Unix structure.<span style="mso-spacerun: yes;"> </span>

Knowing these variables will provide a better understanding of the directory structure during setup of Kiwiplan software.

#### These variable settings are located in the files:

$HOME/.profile <span style="font-family: Wingdings; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'; mso-char-type: symbol; mso-symbol-font-family: Wingdings;"><span style="mso-char-type: symbol; mso-symbol-font-family: Wingdings;">à</span></span> /KIWI/site/bin/profile.?????

/KIWI/site/bin/stdprofile

$DATA/PROFILE or $WORK/PROFILE

<p class="callout info">Environment variables point to individual directories and give a shortcut to the Kiwiplan software.</p>

#### Below is a listing of all directory variables.

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">{DRIVE}<span style="mso-tab-count: 2;"> </span>= any location<span style="mso-tab-count: 2;"> </span>:folder or drive location</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$KIWI<span style="mso-tab-count: 2;"> </span>= /{drive}/kiwi<span style="mso-tab-count: 2;"> </span>:contains the kiwi environment</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$REV<span style="mso-tab-count: 2;"> </span>= /KIWI/revisions</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$COMMSDIR<span style="mso-spacerun: yes;"> </span>= /KIWI/work/cscomm<span style="mso-spacerun: yes;"> </span>:contains comms logs &amp; audit trails</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$PLANTBIN<span style="mso-tab-count: 1;"> </span>= /KIWI/site/00xx/bin<span style="mso-tab-count: 1;"> </span>:contains plant specific menu scripts</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$SITEBIN<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>= /KIWI/site/bin<span style="mso-tab-count: 1;"> </span><span style="mso-spacerun: yes;"> </span>:contains site specific menu scripts</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$PLANTDAT<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>= /KIWI/site/dat<span style="mso-spacerun: yes;"> </span>:contains plant .MNU, .TOG files</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$SITEDAT<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>= /KIWI/site/dat<span style="mso-spacerun: yes;"> </span>:contains .MNU, .TOG files</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$DATA<span style="mso-tab-count: 1;"> </span>ISAM= /KIWI/data\_a <span style="mso-spacerun: yes;"> </span>:contains revision data files &amp; indexes</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$DATA<span style="mso-tab-count: 1;"> </span>SQL<span style="mso-tab-count: 1;"> </span>= /KIWI/site\_sql<span style="mso-spacerun: yes;"> </span>:contains revision data files</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$WORK<span style="mso-tab-count: 2;"> </span>= /KIWI/usr/work<span style="mso-spacerun: yes;"> </span>:contains all user .TM and .LS files</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$SCP<span style="mso-tab-count: 3;"> </span>= /KIWI/kiwi/scp<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>:contains revision specific scripts </span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$PROGS<span style="mso-tab-count: 2;"> </span>= /KIWI/kiwi/progs<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>:contains all program files for revision</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$BIN<span style="mso-tab-count: 1;"> </span><span style="mso-tab-count: 2;"> </span>= /KIWI/kiwi/bin<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>:contains unix specific scripts</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$UFD<span style="mso-tab-count: 1;"> </span><span style="mso-tab-count: 2;"> </span>= /KIWI/kiwi/ufd<span style="mso-spacerun: yes;"> </span><span style="mso-tab-count: 1;"> </span>:contains data file definitions</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$TOOLS<span style="mso-tab-count: 2;"> </span>= /KIWI/site/tools<span style="mso-tab-count: 2;"> </span>:contains admin tools &amp; menus</span>**

**<span style="mso-bidi-font-size: 14.0pt; mso-text-animation: none;">$SCRIPTS<span style="mso-tab-count: 2;"> </span>= /KIWI/site/SCRIPTS<span style="mso-tab-count: 1;"> </span>:contains homemade scripts</span>**

<span style="mso-text-animation: none;"> </span>

**<span style="mso-text-animation: none;">NOTE:<span style="mso-spacerun: yes;"> </span>Some sites use a different base directory for the Kiwiplan software.</span>**

**<span style="mso-text-animation: none;">Examples: $KIWI may be /usr/kiwi or /kiwi/kiwi.</span>**

**<span style="mso-text-animation: none;"> </span>**

Environmental variables are used to set up the user’s environment, meaning which data, menu, etc… they access when logging in.<span style="mso-spacerun: yes;"> </span>Below is a list of basic environment variables.

**<span style="mso-text-animation: none;">EXEC</span>**<span style="mso-text-animation: none;"><span style="mso-tab-count: 1;"> </span><span style="mso-spacerun: yes;"> </span>= executes a program or script, which in turn will call a specific .MNU file.</span>

**<span style="mso-text-animation: none;"><span style="mso-tab-count: 3;"> </span>Example:<span style="mso-spacerun: yes;"> </span>”kiwimenu menu=csc00”</span>**

**<span style="mso-text-animation: none;"> </span>**

**<span style="mso-text-animation: none;">DATA</span>**<span style="mso-text-animation: none;"><span style="mso-tab-count: 2;"> </span>= which data the user will access when logging in.</span>

**<span style="mso-text-animation: none;"><span style="mso-tab-count: 3;"> </span>Example:<span style="mso-spacerun: yes;"> </span>data\_a or site\_sql</span>**

**<span style="mso-text-animation: none;"> </span>**

**<span style="mso-text-animation: none;"> </span>**

**<span style="mso-text-animation: none;">TERM</span>**<span style="mso-text-animation: none;"><span style="mso-tab-count: 2;"> </span>= what terminal type the user will default to when logging in.</span>

**<span style="mso-text-animation: none;"><span style="mso-tab-count: 3;"> </span>Example:<span style="mso-spacerun: yes;"> </span>vt220, vt100, &amp; ansi</span>**

**<span style="mso-text-animation: none;"> </span>**

**<span style="mso-text-animation: none;">KIWISEA</span>**<span style="mso-text-animation: none;"><span style="mso-tab-count: 2;"> </span>= the search path for Kiwiplan environment.</span>

<span style="mso-text-animation: none;"> </span>

**<span style="mso-text-animation: none;">UNIX PATH<span style="mso-tab-count: 1;"> </span>= </span>**<span style="mso-text-animation: none;">the UNIX executing search path.</span>

<span style="font-size: 18.0pt; mso-bidi-font-size: 10.0pt; mso-text-animation: none;"> </span>

<span style="font-size: 18.0pt; mso-bidi-font-size: 10.0pt; mso-text-animation: none;">To view what each variable is set to, use the echo command.<span style="mso-spacerun: yes;"> </span>**Example= echo $TERM** will tell what terminal emulation is being used.**<span style="mso-spacerun: yes;"> </span>**Below is a directory tree layout to better show the variable locations and directory contents.</span>