Salesforce

SpecialExcludeServerSideEnv (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

SpecialExcludeServerSideEnv (Magic xpa 4.x)

In a Rich Client application, when this flag is set to Y, the following will not be sent to the client:

  • The EngineDir, WorkingDir, and TempDir logical names.

  • The environment settings, other than [MAGIC_ENV], [MAGIC_LOGICAL_NAMES] and any other user section created by the developer.

  • The project information. Due to this, the ProjectDir function will return an empty value if used in a client handler.

  • Internal requester parameters, such as REMOTE_HOST and REMOTE_ADDR.

This means that the client will not be able to use these settings and any reference to them might not work.

For example: ServerFileToClient('%WorkingDir%xxx') or using %WorkingDir%images\myimage.png in a Wallpaper property might not work properly.

Note: Until V3.2a, only the logical names and the [MAGIC_ENV]StartApplication and [MAGIC_SERVERS]Default Broker environment settings were not sent to the client.

Valid values: Y, N, [SECTION], and [SECTION]KEYWORD

Default value: N

Since version: 2.5c and 3.1a

The two new Valid values [SECTION] and [SECTION]KEYWORD are added to the existing Valid values of this special flag to be able to exclude multiple sections and/or keywords. Since version: 3.3c

The [SECTION] and [SECTION]KEYWORD values are supplementary. This means, all the environment currently excluded will continue to be excluded and in addition, user-defined section(s) and/or specific keyword(s) will also be excluded.

Examples: (in addition to the predefined environment/sections keywords currently excluded)

  • SpecialExcludeServerSideEnv=Y will exclude only the predefined environment/sections keywords currently excluded.

  • SpecialExcludeServerSideEnv=N will not exclude anything (not the predefined environment/sections keywords currently excluded and not user-defined section(s) and/or keyword(s)). In this case, any other value will also be ignored.

  • SpecialExcludeServerSideEnv=[MAGIC_LOGICAL_NAMES] will also exclude all logical names.

  • SpecialExcludeServerSideEnv=[MAGIC_LOGICAL_NAMES]Name1 will also exclude the logical name Name1.

  • SpecialExcludeServerSideEnv=[MAGIC_LOGICAL_NAMES],UsersPath will also exclude all logical names AND [MAGIC_ENV]UsersPath

There will be no need to explicitly set SpecialExcludeServerSideEnv=Y in case any section(s) and/or keyword(s) are requested to be excluded. SpecialExcludeServerSideEnv=Y will always have precedence.

Reference
Attachment 
Attachment