Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
API Reference
The Language Class
This class encapsulates information about the language, such as resource bundle postfix, possible encoding, and so on.
Fields
Name | Description |
---|---|
locale | Java object which represents locale. |
bundlePostfix | Resource bundle postfix. This postfix is used in resource bundle file names to identify the language. For example, the langNetwork_ger.properties bundle includes a ger bundle postfix. |
charsets | Character sets used to encode this language. Each language can have several character sets. For example, the Russian language is commonly encoded with the Cp866 and Windows-1251 encoding. |
wmiCodes | The list of WMI codes used by the Microsoft Windows OS to identify the language. All possible codes are listed at http://msdn.microsoft.com/en-us/library/aa394239(VS.85).aspx (the OSLanguage section). One of the methods for identifying the OS language is to query the WMI class OS for the OSLanguage property. |
codepage | Code page used with a specific language. For example, 866 is used for Russian machines and 437 for English machines. One of the methods for identifying the OS language is to retrieve its default codepage (for example, by the chcp command). |
The executeCommandAndDecode Method
This method is intended to be used by business logic Jython scripts. It encapsulates the decoding operation and returns a decoded command output.
Name | Description |
---|---|
cmd | The actual command to be executed. |
keyword | The keyword to be used for the decoding operation. |
framework | The Framework object passed to every executable Jython script in DFM. |
timeout | The command timeout. |
waitForTimeout | Specifies if client should wait when timeout is exceeded. |
useSudo | Specifies if sudo should be used (relevant only for UNIX machine clients). |
language | Enables specifying the language directly instead of automatically detecting a language. |
The getCharsetName Method
This method returns the name of the most recently used character set.
The useCharset Method
This method sets the character set on the ShellUtils
instance, which uses this character set for initial data decoding.
Name | Description |
---|---|
charsetName | The name of the character set, for example, windows-1251 or UTF-8 . |
See also The getCharsetName Method.
The getLanguageBundle Method
This method should be used to obtain the correct resource bundle. This replaces the following API:
Framework.getEnvironmentInformation().getBundle(...)
Name | Description |
---|---|
baseName | The name of the bundle without the language suffix, for example, langNetwork . |
language | The language object. The ShellUtils.osLanguage should be passed here. |
framework | The Framework, common object which is passed to every executable Jython script in DFM. |
The osLanguage Field
This field contains an object that represents the language.
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to cms-doc@microfocus.com.
Help Topic ID:
Product:
Topic Title:
Feedback: