RESTful Data Source Options dialog

This dialog appears when you click the RESTful button in the JSON Connection Wizard. It helps you to receive remote data via the REST web service. See the dialog.

The following are details about options in the dialog:

Via REST Web Service

Specifies whether or not to receive remote data via the REST web service. It is disabled for a local file. If not, remote data is received via the protocol in the URL. If true, the remote data is provided by REST web services on the application server. The engine will use the REST web service client API (such as the JAX-RS client API of Java EE) to get remote data from REST web services on the application server and the URL, the HTTP method (GET, POST etc.), MIME types and so on need to be specified to setup the connection. Generally only the HTTP.GET method can be used to get remote data.

MIME Type

Specifies the MIME type for REST web service data sources. Select the type from the drop-down list or input the type in the text box. Available only when Via REST Web Service is true.

User Name

Specifies the user name for remote data authentication.

Password

Specifies the password for remote data authentication.

HTTP Advanced Options

Click to show/hide the advanced options for HTTP.

• Method
  Select an HTTP method from the drop-down list to send the request, which can be GET or POST.
• Headers
  Specifies the user defined HTTP headers.
  • 
    Opens the Create Parameter dialog to create a parameter.
  • 
    Adds a new HTTP header.
  • 
    Removes the selected HTTP headers.
  • Name
    Specifies the name of the HTTP header. Double-click in the line to edit the name.
  • Value
    Specifies the value of the HTTP header. You can use parameters or constant level formulas predefined in the current catalog data source or the special field User Name in the URI or parameter string, and the format of the predefined parameters used in the string is "@" + parameter name. For example, if the parameter string of a class is SQL=select * from employee, and you want to use the parameter sql in a catalog to replace the part after "=" in the string, then the parameter string of the class will be SQL=@sql. Moreover, if a parameter string contains characters, such as @, '.' or double quotation marks, or other strings that do not need to be parsed, quote the whole string with double quotation marks. If the special field User Name is used, when clicking Next, the Security Identifier dialog will pop up for you to specify the security ID (SID), which refers to the user name, used to generate the JSON schema. While, at runtime, you can go to the General category of the Options dialog by clicking File > Options on the menu bar to set the User Name option.
• Body
  Specifies the user defined HTTP body. You can use parameters or constant level formulas predefined in the current catalog data source or the special field User Name in the URI or parameter string, and the format of the predefined parameters used in the string is "@" + parameter name. For example, if the parameter string of a class is SQL=select * from employee, and you want to use the parameter sql in a catalog to replace the part after "=" in the string, then the parameter string of the class will be SQL=@sql. Moreover, if a parameter string contains characters, such as @, '.' or double quotation marks, or other strings that do not need to be parsed, quote the whole string with double quotation marks. If the special field User Name is used, when clicking Next, the Security Identifier dialog will pop up for you to specify the security ID (SID), which refers to the user name, used to generate the JSON schema. While, at runtime, you can go to the General category of the Options dialog by clicking File > Options on the menu bar to set the User Name option.
• Edit Format

  Opens the Edit Format dialog to specify the format of the values referenced in the HTTP headers or body.

  • Name
    Displays names of the referenced parameters/formulas.
  • Format
    Specifies formats for the referenced parameters/formulas.
  • OK
    Accepts changes and closes the dialog.
  • Cancel
    Does not retain changes and closes the dialog.
    

OK

Applies the changes and closes the dialog.

Cancel

Cancels the changes and exits the dialog.

Help

Displays the help document about this feature.

Related topics:

• Setting up a JSON connection