This section describes the fields of General Interface tools.
Color Picker Tool
The Color Picker allows you to select colors to copy and paste into General Interface Builder.
To open the Color Picker, choose Tools > Color Picker.
To navigate in the Color Picker, use the arrow keys to move the slider, scroll through hex values in the Hex field, and move between radio buttons.
| Field |
Description |
| Color palette |
Click in the color palette to select a color. |
| Color slider |
Use the slider to change color spectrum in the Color palette. |
| Preview color box |
The box at the lower right displays the currently selected color. Click in this box to copy the hexadecimal (hex) color value to the clipboard. |
| H (Hue) |
Specifies the color hue or gradation. |
| S (Saturation) |
Specifies the color saturation, which is the intensity or purity of a specific hue. |
| B (Brightness) |
Specifies the color brightness or strength. |
| R (Red) |
Specifies the red portion of the RGB value. After specifying a value, press the Enter key to view the updated hex equivalent. |
| G (Green) |
Specifies the green portion of the RGB value. After specifying a value, press the Enter key to view the updated hex equivalent. |
| B (Blue) |
Specifies the blue portion of the RGB value. After specifying a value, press the Enter key to view the updated hex equivalent. |
| Hex |
The hex value for the selected color. |
Deployment Utility
Use the Deployment Utility to create a launch page for your application, a launch link, or an inline div element. For more information, see Deploying Applications.
To open the Deployment Utility, choose Project > Deployment Utility.
The Deployment Utility has three panels:
HTML Page Panel
Select the HTML Page tab to create an HTML or XHTML page that launches the deployed application as a standalone application.
| Command |
Description |
| XHTML |
If checked, XHTML markup is generated for the launch page. XHTML launch pages are used for applications that run in XHTML pages, such as portlet applications. |
| Create |
Creates the HTML or XHTML page for launching the deployed application. |
Launch Link Panel
Select the Launch Link tab to generate a hyperlink that launches the application in a new browser window.
Copy and paste the link into your HTML page and modify as desired. This hyperlink requires the file GI_HOME \ shell.html to be deployed also.
| Button |
Description |
 |
Copies the contents of the textbox to the clipboard which you can then paste into your HTML page. |
Inline Div Panel
Select the Inline Dive tab to generate an inline DIV for your HTML page. Use this option when running multiple applications in the same browser window.
Copy and paste the inline DIV into your HTML page and modify as desired.
| Button |
Description |
| |
Copies the contents of the textbox to the clipboard which you can then paste into your HTML page. |
Find and Replace Tool
To open Find and Replace, choose Tools > Find and Replace.
| Field |
Description |
| Find |
Enter the text string to search for in the active open text file in the project. |
| Case Sensitive |
If checked, finds only exact case matches to the string entered in the Find field. |
| Regular Expression |
If checked, JavaScript regexp syntax is supported in the Find field. For more information, see Help > Internet Resources > Regular Expressions Guide (Mozilla). |
| Replace |
Enter a replacement text string for the found text in the active open text file in the project. |
| Replace |
Replaces the found text string with the replacement string. |
| Replace All |
Replaces all occurrences of the text string with the replacement string. |
| Find |
Finds the next occurrence of the text string. |
| Cancel |
Closes the dialog. |
XML Mapping Utility
The XML Mapping Utility provides a visual environment for configuring and testing data services.
For more information, see the following topics:
To open the XML Mapping Utility, choose Tools > XML Mapping Utility or File > New > Mapping Rule.
The XML Mapping Utility has several panels:
When you open the XML Mapping Utility from the Tools menu, the first panel allows you to select the file(s) to open.
| Field / Button |
Description |
| WSDL |
Select this radio button if you are using a WSDL as the source document for generating the mapping rules. |
| XML/XHTML/Schema |
Select this radio button if you are using a XML, XHTML, or Schema as the source document(s) for generating the mapping rules. |
| URL |
If WSDL is selected, choose the URL for the WSDL to be used for generating the mapping rules. If XML/XHTML/Schema is selected, enter the URLs for the outbound and inbound document(s). Documents that are created are "outbound," while documents that are processed are "inbound." |
| Parse Document |
Parses the selected document(s). |
For more information, see Choosing the File for the Rules File Starting Point.
Rules Tree Panel
The Rules Tree panel of the XML Mapping Utility contains the structures defined in the rules file displayed in an hierarchical format. It provides a visual interface for creating bindings and for testing data services. Right-click a rule to see what's available on the context menu.
For more information, see the following topics:
Rule Profile Panel
The Rule Profile panel has two views: one for viewing the WSDL source and one for editing the rule profile.
For more information, see Working in the Rule Profile Panel.
| Radio Button |
Description |
| Original Schema Source |
Displays the original Schema or XML node used to generate the selected rule. |
| Rule Node Profile |
Displays name-value pairs for the selected rule. Many of the fields in the Rule Profile panel are editable. Typically, you would modify the node name and the target namespace. |
| Button |
Description |
| Display WSDL Source |
When the Original Schema Source radio button is selected in the Rule Profile panel and the WSDL node  is selected in the Rules Tree panel, this button is available in the Rule Profile panel. Depending on the size of the WSDL, displaying the WSDL might take some time. |
Rule Node Profile
The Rule Node Profile includes these fields:
| Field |
Description |
| Abstract |
If the value is 1, this rule is abstract and only exists in the rules tree, not in the final XML message. An abstract rule can be used to reorganize the rules tree without affecting the structure of the XML message. |
| Data Type |
For encoded messages, the data type to encode, such as string, boolean, decimal, and so on. |
| Data Type NS |
For encoded messages, the namespace for the data type. |
| Input Source |
URL to the input source file used to generate these rules. The input source file could be a WSDL, XML, XHTML, or Schema file. |
| Node Name |
The name of the node as it appears in the XML message that is created or processed. |
| Operation Name |
The name of the operation as defined in the input source file. |
| Rule ID |
Unique ID (jsxid) assigned by the General Interface system when the rule was created. |
| Rule Type |
The type of rule, such as WSDL, transaction, service, operation, input, output, element (E), attribute (A), complex type (C), and CDATA (D). Each rule type has an associated icon in the rules tree. For icon definitions, see Table 13. |
| Simple Type |
Set the value to 1 to denote that this rule is a simple type (http://www.w3.org/2001/XMLSchema). Simple types include string, int, href and so on. For definitions of simple types, see the XML Schema at http://www.w3.org/2001/XMLSchema. |
| Source Path |
XPath statement that points to the location of the node in the source document that was used to generate the rule. Maintains the binding between the source document and the rule node. |
| Target |
If set to a specific URI, the node name is auto-prefixed (QName) to designate the target namespace. For example, <jsx1:zipcode>. |
Settings Panel
The fields displayed in the Settings panel on the right side of the XML Mapping Utility depend on the type of rule selected in the Rules Tree panel. The type of rules include the following:
For information on how to use the Settings Panel, see Working in the Settings Panel and Communicating with a Web Service Tutorial.
Operation Rules
When an operation rule is selected in the Rules Tree panel, the following fields are displayed in the Settings panel.
For more information, see Modifying Operation Rules.
| Field |
Type |
Description |
| Endpoint URL |
|
This is the URL for the service to contact. It can be absolute (http/https) or relative (/services/address.asmx). To override this setting at runtime, call setEndpointURL on the Service instance. |
| Method |
|
When making a Service call, the jsx3.net.Request class is used to transport the call. The most common methods are POST and GET. POST is used for sending XML content with the request. GET merely calls the given URL. To override this setting at runtime, call setMethod on the Service instance. |
| |
POST |
Submits data to be processed, such as a SOAP request envelope, to the identified resource. The data is included in the body of the request. |
| |
GET |
Requests the specified resource, such as a URL. |
| |
PUT |
Uploads the specified resource. |
| |
DELETE |
Deletes the specified resource. |
| HTTP Headers |
|
Each HTTP request can send different types of information. For example, the HTTP request can send any of the following: an XML document (POST), a URL overloaded with data of its own (GET or POST), or information about the content and purpose of the request itself. The HTTP headers listed in this field are automatically generated during the initial parse. If additional headers are needed, you can add them statically to this field. You can also add them at runtime on the Service instance by calling setRequestHeader for each additional header that should be added. Other headers not listed are also sent, including the content-length and any cookies used by the service. |
Input Rules
When an input (request) rule is selected in the Rules Tree panel, the following fields are displayed in the Settings panel.
For more information, see Modifying Input Rules.
| Field |
Description |
| Stub URL |
Typically used in conjunction with the Stub Path field to support SOAP-based web services. When SOAP is used, each request document is encapsulated by a SOAP Envelope. The XML Mapping Utility treats the Envelope as a static document into which the actual request is placed. This document is generic enough to encapsulate the majority of SOAP messages. If this default document does not contain enough information, you can specify the URL for a static stub of your own. This value can be updated at runtime using the API calls, setOutboundStubURL or setOutboundStubDocument. |
| Stub Path |
Used in conjunction with the Stub URL field. Type a valid XSL query that describes where to place the generated document in the Stub document. This value can be updated at runtime using the API call, setOutboundStubPath. |
| onBeforeSend |
JavaScript statements entered in this field execute immediately before the request message is sent. This script executes in context of the Service instance. This means that the keyword, this, refers to the Service instance. For example, if you want to output the XML request to the System Log before sending it, you would enter: jsx3.log(this.getOutboundDocument().getXML()); |
Output Rules
When an output (response) rule is selected in the Rules Tree panel, the following fields are displayed in the Settings panel.
For more information, see Modifying Output Rules.
| Field |
Description |
| Stub URL |
Enter the URL for a valid XML document (the typical response) when running the XML Mapping Utility in static mode (offline). The static mode allows you to test against a typical service response. This is useful in situations where the service isn't built yet or is inaccessible. To change the mode to static, choose Project > Project Settings > Deployment. This URL can also be set at runtime using the API call, setInboundURL. For more detailed information, see Modifying Output Rules. |
| onAfterReceive |
JavaScript statements entered in this field execute immediately after the response message is received and before the mappings are applied. This script executes in context of the Service instance. This means that the keyword, this, refers to the Service instance. For example, if you want to output the XML response to the System Log each time the service responds, you could write: jsx3.log(this.getInboundDocument().getXML()); For other examples, see onAfterReceive. |
Message Rules
When message rules are selected in the Rules Tree panel, the following fields are displayed in the Settings panel. Message rules, which are children of input and output rules, include complex type, element, attribute, and CDATA rules.
For more information, see Modifying Message Rules.
| Field |
Type |
Description |
| Mappings |
|
The Mappings table is where the actual work is done. When a request message is generated or a response message is processed, each mapping listed in this table is run sequentially for the given rule. Although different mapping types exist, all mapping types provide a map between objects in the application (textbox, JavaScript variable, CDF attribute, and so on) and rules in the rules tree. For more information on mapping, see Communicating with Data Services. |
| |
Script |
Filter or JavaScript code that evaluates in context of the Service instance. For example, you can set a value: setValue("0"); |
| |
NODE |
Maps to a node in the Local Data Cache palette. Type the cache document name, two colons, and a valid XSL Query. For example, myDocument:://record[jsxid=12]. |
| |
DOM |
Maps to a GUI object in the General Interface DOM. Enter the object name. |
| |
CDF Document |
Queries for or creates a CDF document in the Local Data Cache palette. Enter the CDF document name. |
| |
CDF Record |
Queries for or creates a CDF Record as a child of the current CDF record context. The Path/Value field is not required but can be used to support recursion or hand off processing to another rule. For example, if there is another rule in your mapping rules file that has a CDF Record mapping, you can enter the jsxid for that rule. To find the jsxid, select the rule that you wish to call and click the Rule Node Profile radio button. |
| |
CDF Attribute |
Queries for or creates a CDF attribute on the nearest CDF record ancestor. Enter the attribute name, such as jsxid, jsxtext, price, and so on. |
| Restrictions |
|
When Schema or WSDL are used as the input for the XML Mapping Utility, any restrictions appear in the Restrictions table. You can also add additional restrictions on a rule. For example, you might restrict user input to be equal to dog or cat. To restrict such input, you would add two new enumeration restrictions to the rule: one for cat, the other for dog. At runtime, these restrictions can be used to validate the request document as it's created node-by-node. For more information about what's published when a node value doesn't adhere to its restrictions, refer to the ON_INVALID subscription for the Service class. For more information, see Restrictions. |
| |
length |
Specify an exact number of characters allowed in a string. For example, type 5 for a string to contain exactly five characters. |
| |
maxLength |
Specify a maximum number of characters allowed in a string. For example, type 5 for a string to contain a maximum of five characters. |
| |
minLength |
Specify a minimum number of characters allowed in a string. For example, type 5 for a string to contain a minimum of five characters. |
| |
pattern |
Specify a regular expression to validate against. For example, entering the following regular expression would ensure that only numeric content can be entered by the user: /^[d]+$/ For more information on regular expressions, see Help > Internet Resources > Regular Expressions Guide (Mozilla). |
| |
enumeration |
Specify an enumerated value to validate against. For example, you could limit the values for a stock to three values: symbol, CIK (Central Index Key), and CUSIP (Committee on Uniform Securities Identification Procedures). |
| |
maxInclusive |
Specify a maximum inclusive value. The node value must be less than or equal to the specified value. |
| |
minInclusive |
Specify a minimum inclusive value. For example, the node value must be greater than or equal to the specified value. |
| |
maxExclusive |
Specify a maximum exclusive value. For example, the node value must be less than the specified value. |
| |
minExclusive |
Specify a minimum exclusive value. For example, the node value must be greater than the specified value. |
| |
maxOccur |
Specify an inclusive maximum number of times this node can appear in the XML message. For example, type 5 for the node to appear a maximum of five times in the XML message. |
| |
minOccur |
Specify an inclusive minimum number of times this node can appear in the XML message. For example, type 5 for the node to appear a minimum of five times in the XML message. |
| |
nillable |
Set to true to allow this node to be empty without being automatically removed by the XML Mapping Utility. The XML Mapping Utility automatically removes any node from an outgoing message that doesn't have text content or descendant nodes with text content. However, if an empty node has a nillable restriction that's set to true, the XML Mapping Utility leaves the empty node untouched. If you have a rule that might be empty when the outgoing message is being created and you want to make sure that it isn't removed, add a nillable restriction to the given rule. |
| Field |
Description |
| Repeat When |
As long as the JavaScript code in this field evaluates to true, the rule and all descendant rules are run again. The JavaScript function is used to create and define a collection from a single node. The collection is added as nodes in the XML message to the server. Don't enter true in this field, because it results in an infinite loop. The Repeat When field is only applicable to outbound (input) messages. It's typically used by mapping rules that convert a JavaScript array into an XML Node-set in the outgoing message. Conceptually, this feature is similar to a do-while loop, where execution will happen at least once and continue as long as the while (Repeat When) statement is true. For examples, see Repeat When. Also note that CDF mappings automatically repeat when necessary. For more information on CDF GUI components, see Mapping Response Data to CDF GUI Components. |
Mapper Log
The Mapper Log displays information about the outcome of parsing the starting point document and testing mappings.
For more information, see Mapper Log and Mapper Log Toolbar.
| Field |
Description |
| Text area |
Displays the XML Mapping Utility log messages according to the selected log level. Use the Adjust Log Level button  to select a log level. |
Test Interface Tool
The Test Interface Tool of the XML Mapping Utility is designed to guide you through the test sequence. The Create, Send, Receive, and Apply tabs correspond to phases of sending and receiving XML messages. Clicking a tab displays data that is relevant to the current test phase.
To use the Test Interface Tool, click the Test button on the Rules Tree panel toolbar in the XML Mapping Utility.
The Test Interface Tool has four panels:
For more information, see the following topics:
Each panel of the Test Interface Tool contains this drop-down list:
| Field |
Description |
| Select |
Select the operation to test from the drop-down list. |
Create Panel
Mappings for the outbound message display on this panel.
| Field |
Field |
Description |
| Outbound Mappings |
|
Mappings of GUI objects to mapping rules for the outbound message. |
| |
Rule Name |
Name of the element (mapping rule). |
| |
Type |
Type of object that is mapped. Types include Script, NODE, DOM, CDF Document, CDF Record, and CDF Attribute. |
| |
Path/Value |
GUI component name or any associated JavaScript code for this mapping. |
| Post-Mapping Filter/Handler |
|
Filter code to execute before sending this message. |
Send Panel
The outbound message displays on this panel.
| Field |
Description |
| URL |
URL specified in the WSDL file. |
| HTTP Headers |
Header content for the message. The header text can be edited. |
| Name |
User name used for authentication if required. |
| Password |
Password used for authentication if required. |
| Method |
Method for contacting the Service. Choose from POST, GET, PUT, and DELETE. The most common are GET and POST. |
Receive Panel
The Service response displays on this panel.
| Field |
Description |
| HTTP Headers |
Header content for the response message. |
| HTTP Status |
Status of message, such as 200, 404, and so on. |
| Response |
Response message. |
Apply Panel
The inbound mappings display on this panel.
| Field |
Field |
Description |
| Pre-Mapping Filter/Handler |
|
Filter code to execute on the inbound document. |
| Inbound Mappings |
|
Mappings of response rules to application objects. |
| |
Rule Name |
Name of the element (mapping rule). |
| |
Type |
Type of object that is mapped. Types include Script, NODE, DOM, CDF Document, CDF Record, and CDF Attribute. |
| |
Path/Value |
GUI component name or any associated JavaScript code for this mapping. |
XML/XSL Merge Tool
Use the XML/XSL Merge Tool for testing the XML and HTML output from a merge operation. For more information, see Data and Cache Management.
To open the XML/XSL Merge Tool, choose Tools > XML/XSL Merge Tool.
| Field |
Description |
| URL |
The location of the XML or XSL file, either on an accessible file system or on a web server. |
| Cache |
The name of the XML or XSL file in browser cache, as displayed in the Local Data Cache palette. |
| Script |
JavaScript code that produces an XML document or a node in an XML document as output. |
| Source |
XML or XSL code typed directly into the tool dialog. If URL, Cache, or Script is used to specify the XML or XSL source, this field displays the file contents. In the case of XSL, modifications can be made before the merge operation. |
| Merge Documents |
Merges the XML document with the XSLT filter document and displays the results. |
| Rendered Output |
Displays the result of the merge operation as rendered XML or HTML (as it would appear in a browser). |
| Raw Output |
Displays the result of the merge operation as XML or HTML. |
|
|
