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 |
|
- Example: Interface to another system
- Generated JavaScript interfaces
- Create a request for a new project
- The structure of the request
- Request object
- Simple fields
- Check the xs_string() function
- Check expected parameters in invoke() function
- Check the syntax for the Response function
- Use getValue
- Write the invoking JavaScript code
- Determine the structure of the request and response
- PPM request
- PPM response
The structure of the request
The bold $$elementChildren.push section shows that the requestObj Child element is of type Request(). To find the structure of the Request, find the definition of that function in the generated code.
function Request( ) { this.$$nsPrefix = "ns8"; this.$$elementFormDefault = "qualified"; this.$$attributes = new Array(); this.$$xmlNames = new Array(); this.$$objNames = new Array(); this.$$minOccurs = new Array(); this.$$refs = new Array(); this.getName = getName; this.getXmlName = getXmlName; this.setContent = setContent; this.addContent = addContent; this.getContent = getContent; this.isFault = isFault; this.$$elementChildren = new Array(); this.$$name = "Request"; this.$$xmlNames[ "Request" ] = "Request"; this.$$minOccurs[ "id" ] = 0; this.id = new xs_string(); this.$$elementChildren.push( "id" ); this.requestType = new xs_string(); this.$$elementChildren.push( "requestType" ); this.simpleFields = new Array(); // of SimpleField this.simpleFields.$$nsPrefix = "ns8" this.simpleFields_newInstance = function() { var newLen = this.simpleFields.push( new SimpleField() ); return this.simpleFields[ newLen-1 ]; } this.$$elementChildren.push( "simpleFields" ); this.tables = new Array(); // of Table this.tables.$$nsPrefix = "ns8" this.tables_newInstance = function() { var newLen = this.tables.push( new Table() ); return this.tables[ newLen-1 ]; } this.$$elementChildren.push( "tables" ); this.notes = new Array(); // of Note this.notes.$$nsPrefix = "ns8" this.notes_newInstance = function() { var newLen = this.notes.push( new Note() ); return this.notes[ newLen-1 ]; } this.$$elementChildren.push( "notes" ); this.fieldChangeNotes = new Array(); // of FieldChangeNote this.fieldChangeNotes.$$nsPrefix = "ns8" this.fieldChangeNotes_newInstance = function() { var newLen = this.fieldChangeNotes.push( new FieldChangeNote() ); return this.fieldChangeNotes[ newLen-1 ]; } this.$$elementChildren.push( "fieldChangeNotes" ); this.URLReferences = new Array(); // of URLReference this.URLReferences.$$nsPrefix = "ns8" this.URLReferences_newInstance = function() { var newLen = this.URLReferences.push( new URLReference() ); return this.URLReferences[ newLen-1 ]; } this.$$elementChildren.push( "URLReferences" ); this.remoteReferences = new Array(); // of RemoteReference this.remoteReferences.$$nsPrefix = "ns8" this.remoteReferences_newInstance = function() { var newLen = this.remoteReferences.push( new RemoteReference() ); return this.remoteReferences[ newLen-1 ]; } this.$$elementChildren.push( "remoteReferences" ); }