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 |
|
Requirements
- Default field configuration is readable and writable with unlimited length.
- Default field configuration for a Single_Value_List or a Multi_Value_List must be explicitly specified.
- Read-only fields must be explicitly specified.
- You must specify the type and read/write explicitly only for a Single_Value_List/Multi_Value_List.
- If a field is not configured, the field is read/write with unlimited length.
-
A list or multi-list field may contain item elements. For each item specify the value and display text in the form
<itg:item value="$value">$display text</itg:item>
. - If the field in WSDL is an Array, it must be mapped to Multi_Value_List.
- If the QC field is User_List, you can only specify String or Single_Value_List for the corresponding SM field.
-
If the field is read-only you must set the attribute
readonly
astrue
. - If the field attribute
required
ismandatory
, the field is mandatory for creation of a new entity. - If the field has a length limitation (attribute
length
), values from other endpoints could be truncated to match this limitation.