localvaluehelp

The localvaluehelp command enables users to access help for possible input sets for SAP inputfields when you perform a right-click on the field in question. This command will function both on GuiXT and native SAP fields. The syntax is as follows:

localvaluehelp("[screen_element]", {"option":value…});

Note: The localvalue help command can be used only on inputfields.

To enable localvalue help, the following entries must be entered in the guixt.sjs configuration file:

historyonrightbutton = true;
domains = "directory"

you can also store your localvaluehelp domain files along with your script files in the SAP Web Repository (SAPWR). When you use SAPWR to store your localvaluehelp files, the 'directory' and 'domains' entries in your guixt.sjs file will appear very similar to the following example.

directory1 = "SAPWR:Z_GUIXT1";
historyonrightbutton = true;
domains = "SAPWR:Z_GUIXT1";

You can specify that only GuiXT-created fields will have the history visible - native SAP fields will not. The guixt.sjs entry to do this action is a s follows:

historyononlyguixt = true;

If the 'historyononlyguixt' entry is not present, both native SAP fields and GuiXT-created fields will have history enabled as long as the 'historyonrightbutton' parameter is present.

The 'historyonrightbutton' parameter enables the domain list box to display when the user right-clicks. The 'domains' parameter specifies what history will be searched. If no domain file is specified for a field, the history will instead show all previously entered values. The directory path can be any of the following formats:

Local directories

To access localvaluehelp from a file from a directory on your local machine, the syntax would be:

C:\\directoryName

Network shares

To access localvaluehelp from a file from a shared directory on the network, use the following syntax:

\\\\network\\directory

Web shares

To access localvaluehelp from a file from a shared directory on the web, use the following syntax:

http://directoryName

SAP Web Repositories

To access localvaluehelp from a file from the SAP Web Repository (SAPWR), use the following syntax:

sapwr:z_directoryName

Note: Use the file command to give the file an alias if it exceeds the 30-character limitation on SAPWR file names.

Options

The localvaluehelp command takes the following option:

domain

Can be used to specify the domain from which the localvaluehelp will be called. This domain is specified in the domains entry in the guixt.sjs file and will be the source from whence the localvaluehelp is obtained.. The syntax is as follows:

{"domain":"domain_name"}

Domain inputsets

For localvaluehelp, you must create files that contains the inputsets that will display when a user triggers the field's localvaluehelp. Fields will only display localvaluehelp if a domain is mapped to it as described in the previous section. The file that contains the inputsets must be named in the following format:

			dom.<languageKey>.<domainName>.txt

If there is no domain mapped to the field, then instead of the ' dom.<languageKey>.<domainName>.txt ' file, a different file will be read. This alternate file is usually named in the following format:

 
			dom.TEXT.<language code>.txt

The inputsets will be stored inside this alternate file. If no domain name is specified, then the domains will be read from this file.