Executive

While Executive is not truly a component, it acts like one in that it processes several generic parameters.

Cookies

Executive drops the cookies listed in the following table. The cookie name is always preceded by the script name used to access the NXT 4 server. For example, if the URL http://LocalHost/NXT/gateway.dll is used, the vid cookie will have the name NXT/Gateway.dll/vid.

Table 1. List of executive cookies

Name	Duration	Purpose
`Uid`	Persistent	User ID for the user. Unique identifier for the current user.
`Vi`d	Persistent	View ID for the user. This determines what view the user is currently using and must correspond to a view ID in the site definition file. If there is no vid cookie set then the default view is used.
`Sid`	Session	Session ID for the user. Unique identifier for the current session.

Template Parameters

The four parameters listed below should not be confused with the functions for the File component. While they belong to Executive, they are not preceded with the EXECUTIVE prefix as are the others.

Table 2. Template parameters

Name	Purpose
`TEMPLATES:<Filename>`	Creates a URL that points to the specified file in the templates directory.
`IMAGES:<Filename>`	Creates a URL that points to the specified file in the images directory.
`OBJECTS:<Filename>`	Creates a URL that points to the specified file in the objects directory.
`STYLESHEETS:<Filename>`	Creates a URL that points to the specified file in the stylesheets directory. Commonly used in a <LINK> tag between the <HEAD> tags of a document.

URL Parameters

Table 3 describes possible URL parameters.

Table 3. URL Parameters

Name	Possible Values	Purpose
`Global`	Alphabetic string	This parameter specifies the prefix that identifies global parameters. A global parameter is stored in the session context property bag so that any component can reference it, and also is automatically returned by a PARAM replacement tag request. For example if you wanted to specify the contents template so that all templates could use it, you would do two things. First you would specify a URL such as: `/NXT/gateway.dll?global=g_&g_content=contents.htm` for the first URL that the system encounters. Next in any template that you wanted to use the global parameter you would use the PARAM replacement tag such as: `<!--#EXECUTIVE:PARAM:g_content -->` The parameters are case sensitive.

Replacement Variables

Table 4 includes a list of replacement variables.

Table 4. Replacement Variables

Name	Purpose
`EXECUTIVE:DOCUMENT_ID`	The ID of the current document
`EXECUTIVE:HOME_ID`	The ID of the document collection containing the current document. This must be put in a source document; it will not work from a template.
`EXECUTIVE:PROPERTY:`	Any site definition file property. Because this replacement variable inserts the actual value for the property, it is strongly suggested that only properties with string values (as opposed to binary values) be used. Using binary properties will cause the binary number (not the string representation) to be inserted into the template.
`EXECUTIVE:INCLUDE:`[?]	Inserts the contents of the specified Filename. As with all replacement variables, you may have a query string associated with the replacement variable. In this case, it is especially useful because this string will be passed to every component that has a replacement variable in the specified file.
`EXECUTIVE:ERROR_VALUE`	The current error `hResult` set by a component. This is used in the `hitlist-failed.htm` file.
`EXECUTIVE:ERROR_CONTEXT`	The current textual error string set by a component This is used in the `error-details.htm` file.
`EXECUTIVE:HOME_PATH`	The root document collection name path for the current document. This must be put in a source document; it will not work from a template.
`EXECUTIVE:SCRIPT_NAME`	The script name in the current URL.
`EXECUTIVE:PATH_INFO`	The path information in the current URL.
`EXECUTIVE:QUERY_STRING`	The query information in the current URL.
`EXECUTIVE:PARAM:`	Replaces any named query info parameter with its value. The parameter will be percent encoded. EXECUTIVE first checks the current URL to see if the parameter is specified there. If the parameter is not specified then it checks the session context property bag.
`EXECUTIVE:PARAM_NOENCODE:`	Replaces any named query info parameter with its value. EXECUTIVE first checks the current URL to see if the parameter is specified there. If the parameter is not specified, then it checks the session context property bag.

Executive Parameters

The Executive.ini file is the settings file that defines parameters for the Executive.dll library. The default path to the Executive.ini file is C:\ProgramData\Rocket\NXT 4 Online Server\Settings\. The file includes three sections:

[APPLICATION]: List of parameters for the application.
[COMPONENTS]: List of function names of all functions that are supported by a system. A value is set to the component .dll file that implements this function. Multiple functions can be associated with the .dll file of a single component.
[SERVICES]: List of service names for all services that are supported by the system. The value is set to the service .dll file that implements this service. This name is used with the events that this service generates.

Table 5. List of parameters for the APPLICATION section

Field Name	Description	Default Value
`Password`	A password that is used to perform executive functions.	`n/a`
`Report Http Error`	A flag that toggles a display of HTTP errors. This parameter returns HTTP errors when invalid links are encountered instead of displaying NXT 4 error messages. By default, NXT 4 does not normally return an HTTP error when it encounters a broken link. This default setting is set because some browsers do not display the error text if you return an HTTP error. However, a site validation tool uses HTTP errors to determine whether the site has problems. Moreover, third-party link verification programs use HTTP errors to report problems with links. In these cases, you need to set this option to `1`.	`0`
`Lock Report File`	This parameter is internal. Do not change it.	`n/a`
`Error Page`	A name of a file that is returned when a system cannot properly handle errors. A path to the file must be specified as an absolute path.	`n/a`
`Session Timeout`	A time interval that a session can remain idle before a server terminates it automatically. The default value is 900000 milliseconds or 15 minutes. The maximum value is 172800000 milliseconds or 2880 minutes. This parameter is required.	`900000`
`ProductName`	A name of a product. A value is set during installation.	`n/a`
`Access Control Module`	A name of an access control module that applies access restrictions for a server. You can use two modules: `DefaultACM.dll` and `ACM.dll`.	`DefaultACM.dll`
`NonBrowser Components`	A semicolon delimited list of component functions that are not called from a browser. Require a returned HTTP error value if an error occurs.	`n/a`
`Install Path`	An installation path of an application.	`n/a`
`Index Path`	A default path for new index files. This item is only used for compatibility with earlier versions.	`n/a`
`Content Path`	A default path for infobases.	`n/a`
`Error Level`	A level of an error that you want to log. This field can accept the following parameters: `0`: Logs errors. `1`: Logs warnings and errors. `2`: Logs user level messages, warnings, and errors.	`0`
`UsePersistentCookies`	A flag that controls persistent cookies. Specifies whether the system is allowed to drop persistent cookies. If set to `1`, the UID and VID cookies expire after one year. If set to `0`, the VID is assigned according to a session and the UID is set to `Anonymous`.	`1`
`SessionCookieTimeout`	A time interval in minutes after which a session cookie expires. Every time a browser requests a page, the session cookie is refreshed. This parameter is valid, if `UsePersistentCookies` is `1`.	`0`
`Platform Version`	A version of an application.	`n/a`
`Platform Addon`	This parameter is internal. Do not change it.	`n/a`
`SecureServiceList`	A list of secure services that are necessary for an application work. The list is formed during installation.	`n/a`
`MaxConcurrentUserSessions`	A maximum number of concurrent user sessions. This value is secured and assigned during installation of an application.	`n/a`
`Serial Number`	A serial number of a product. This parameter is required.	`n/a`
`Proxy-Server`	A proxy server that you want to use for outgoing HTTP requests such as the content network requests. For example, `proxy.rocketsoftware.com:8080`.	`n/a`