Several environment variables are created and/or used by A-Shell and ATE, and they are all described in the following sections. Note that:
| • | In nearly every command context where you can specify a filespec, you can embed an environment variable reference by surrounding the environment variable name by %, e.g. "%miame%\doc\ashelp.mdf". |
| • | A-Shell treats environment variable names as case insensitive (i.e. %MIAME% and %miame% are equivalent). This is consistent with Windows, which treats environment variables as case insensitive, but it might be confusing in the Unix environment, where environment variable names are case sensitive (and traditionally upper case.) |
| • | ATE environment variables (e.g. ATE, ATECACHE) are visible only to the ATE client process and any of its children, e.g. APEX, client-side SBX calls, AUXLOC: print file processing, AG_xxx functions, etc. The server can query these variables remotely using the AG_GETENV command. |
Variable |
Platform |
Source |
Description |
|---|---|---|---|
APEX |
Win |
M |
Defines the location where the APEX work files and archived print files (.apf) are kept. If not defined the default is <My Documents>\APEX. If that is not found, it uses %TEMP%\APEX. The directory will be created as needed, provided that the parent directory exists. |
|
|
Optional definition of the client's IP address. |
|
Win |
M |
Activates low level FTP debugging |
|
Unix |
M |
Directory to use for creation of temporary files used during spool processing. |
|
ASQLTRACE |
All |
M |
Set to 1 to activate detailed tracing of SQLxs operations. |
Win P2P |
M |
Defines local directory for automatic image caching. |
|
ATE |
ATE |
Same as %MIAME% but for ATE only |
|
ATE |
ATE, CP |
Temporary cache (cleared on exit) |
|
ATE |
ATE, CP |
Permanent cache (not cleared on exit) |
|
ATE |
ATE |
ATE or A-Shell/Windows executable filespec (Pseudo-environment variable) |
|
ATE Svr |
AS |
Returns a value indicating ATE license method. |
|
ATE |
ATE, CP |
Default Local Directory from the connection properties dialog. |
|
ATEPROFILE |
ATE |
ATE, CP |
ATE defines this variable to match the name of the current connection profile. |
ATE |
ATE |
ATE or A-Shell/Windows version (pseudo-environment variable) |
|
CURRENTDIRECTORY |
All |
A |
Current directory (e.g. c:\vm\miame\dsk0\001004) |
ATE Svr |
M |
Use ATE protocol for some subroutine communications. |
|
FTP2TIMEOUT |
All |
M |
Overrides default timeout for FPT2 of 60 seconds. |
Unix |
U, M |
Standard Unix variable defining the user's home directory. |
|
All |
A |
A-Shell base directory—i.e., the location of miame.ini. |
|
MIAMEFILE |
All |
A |
Complete filespec of miame.ini; is created automatically by A-Shell once it locates miame.ini. |
ATE |
ATE, CP |
Alias for ATEPERMCACHE |
|
Unix |
U, M |
Same as ASHCLIENTIP, but somewhat extended. |
|
SYSTEMDIRECTORY |
Win |
A |
Windows system directory (e.g. c:\Windows\System32) |
Unix |
U, M |
Standard Unix variable defining terminal type |
|
WINDOWSDIRECTORY |
Win |
A |
Windows directory (e.g. c:\Windows) |
ATE Svr |
M |
Disable XTREE data transfer optimization. |
Meaning of codes in "Source" column above:
Code |
Meaning |
Description |
|---|---|---|
M |
Manual |
Defined optionally and manually by user |
ATE |
ATE client |
Defined automatically by ATE client |
CP |
ATE connection profile |
Definition is based on parameter in connection profile |
AS |
A-Shell server |
Defined automatically on server upon connection from ATE client |
A |
A-Shell |
Defined automatically in all A-Shell environments |
U |
Unix |
Typically defined automatically by Unix shell |
Optional definition of the client's IP address. When a connection is made to a A-Shell / Unix, an attempt is made to identify the client's IP address by various means. This is the first step, and is mainly of use with sophisticated front-end connection managers that may prevent the true client IP from being determined by the normal means.
If you define this variable, the FTPDLX file transfer routine (used by ATE implicitly and by A-Shell/Windows when you explicitly call FTPDLX) will output detailed, low-level debugging information to the file %temp%\ftpdebug.log (prior to A-Shell build 1153 of June 2009, the log file was named c:\debug.log). Note that even without this, a somewhat higher-level debug log of the last file transfer can always be found in the file ftpdlx.log (in the current directory.)
Optional definition of directory to use for creation of temporary files used during spool processing. Temporary files are often used to assemble the completed spool request from parts, such as PREFIX and SUFFIX options, or resulting from pre-filtering, before sending to the system spool queue.) If ASHTMP not defined, the MIAME directory is used.
