FOCUS AREAS

ARM - Application Response Measurement

%ARMINIT


Signifies the initialization of an application

Type: ARM macro

Syntax

%ARMINIT(APPNAME=aname,<options>)

Required Argument

APPNAME=aname
is the required application name that is a SAS character variable or quoted literal value.
Restriction: The application name has a 127 character limit.

Options

APPIDVAR=
is a SAS numeric variable that contains the value of the application ID.
 
APPUSER=
is the application user ID that is a SAS character variable or quoted literal value.
Restriction: The application user ID has a 127 character limit.
 
GETID=NO | YES
is optional and denotes whether to generate a transaction class ID.
Default: NO
Requirement: TXNNAME= is required when you use GETID=YES.
 
LEVEL=
is a variable that specifies the conditional execution level. The value must be a numeric constant or variable.
 
MACONLY=NO | YES
allows the %ARMINIT macro to be issued in open code, outside of a DATA step.
Note:   MACONLY is experimental for Release 8.2.  
Default: NO
 
SCL=NO | YES
allows the %ARMINIT macro to be issued in SCL environment.
Note:   SCL is valid for Release 9.0 and later.  
Default: NO
 
TXNIDVAR=
is a SAS numeric variable that contains the value of a transaction ID.
Restriction: Use the TXNIDVAR= only when you use GETID=YES.
 
TXNDET=
is a transaction detail that is a SAS character variable or quoted literal value.
Restriction: The transaction detail has a 127 character limit.
Requirement: TXNDET= is required only when you use GETID=YES.
 
TXNNAME=aname
is a transaction name that is a SAS character variable or quoted literal value.
Restriction: The transaction name has a 127 character limit.
Requirement: TXNNAME= is required only when you use GETID=YES.

Description

An %ARMINIT macro call names the application and optionally the user of the application. Additionally, it initializes the ARM environment if a previous %ARMINIT has not been issued. It typically is executed when the application initializes.


Input

None


Output

The _ARMAPID variable, which is the application ID, is the output. If GETID=YES, then the _ARMTXID is returned also. Any variables for APPIDVAR= and TXNIDVAR= are also updated.

Examples

Example 1: Basic example, resetting the default user ID to the current ID

data _null_;
   %arminit(appname='General Ledger');
run;

 

Example 2: Supplying the user ID

data _null_;
   aname = 'Order Entry Application';
   %arminit(appname=aname, appuser='sasxyz');
run;

 

Example 3: Saving the application ID

data _null_;
   %arminit(appname-aname, appuser='sasxyz', appidvar=appl);
   put "application id is " appl;
run;