Creating APIs‎ > ‎Data Explorer‎ > ‎

Author Mode

  • Modify fields, tabs, and attributes.
  • Choose which fields to display and in which order.
  • Group form fields.
  • Choose field display formats, such as labels.
  • Control form titles, such as custom form titles.
  • Customize your data content. You can select fields, rename them, and choose formatting.
  • Change the general appearance of the colors, icons, and labels in Data Explorer using Cascading Style Sheets (CSS) skins.
  • Create a managed database.

For more information about creating managed databases, see Database Creation.

  • Change the layout of each individual table when you first select the table (that is, you can determine if Grid, Form, or Child tabs are used).
  • Create refined custom defined layouts.

The following image illustrates Data Explorer in Author Mode, with a different style sheet. Customize the appearance of behavior of your forms using the widgets that display. The following image shows the widgets (in red boxes):

For more information about the Data Explorer functions, see Data Explorer.

Access Author Mode

As an admin user, you can edit settings using Data Explorer in Author Mode. For example, you can add tables, fields, rename fields, and change field types. By default, when you launch Data Explorer, you are in user mode. In user mode, the setting controls are hidden and you cannot edit settings. To edit settings, toggle to Author Mode.

Prerequisites:
  • You have a developer login using the same credentials used to access Live API Creator. For more information about admin security, see Security.
  • You are an authorized user of Author Mode.
  • You are not accessing Author Mode using an application account, such as demo.

In Data Explorer, go to Tools, Toggle Author Mode.

Note: While in Author Mode, you can toggle back to user mode by going to Tools, Toggle Author Mode.

The following image shows this option on the Tools menu in Data Explorer:

View Results of REST API Calls

You can toggle the REST Log, Grid, Form, or Child Grid on and off. You can see how REST and system-defined filters work using the REST Log, which shows you the results of all the REST API calls made to the API Server connected to this session.

Click the down arrow in the upper left of Data Explorer. The following image shows the toggle options and the REST Log:

Group Form Fields

Click the table settings icon in the Form. The Field Order tab opens in a window. The following image shows this icon and the window that opens:

Change Database Field Type Output Format

You can change how fields are displayed, such as setting a binary field type as a hexadecimal value or a text type to a WYSIWYG editor.

    1. In Data Explorer (in Author Mode), select the table containing the field you want to change from the drop-down.
    2. In the Form, next to the field name you want to change, click the field settings icon.
      The Field Details window opens.
    3. Change how the field is displayed and then save your changes.

Control Fields to Display

You can control which fields are displayed using the table settings icon. You can display fields from the current table, or join in parent tables (for example, salesrep), as shown in the following image:

Control when Fields Display

You can control the fields you want to display by defining expressions. You can also combine expressions, such as hiding a field for a specified condition or turning it red otherwise. You do this by defining multiple expressions. The settings leverage CSS syntax.

To define an expression for a field, in Author Mode, click the field settings icon next to the field name you want to define. The Field Details window opens. The following image shows this icon and the window that opens:

The following image shows a second expression for the Region field on the Field Details window:

Important! Specify expressions instead of using fixed length strings, such as:

row.employee_type.match("exempt")

For more information about Data Explorer field expressions, see Data Explorer Field Expressions.

Control when Fields to Display: Example

This example shows how to control how the Region field is displayed for Supplier:

  • Hides the Region field if you enter UK as the Country for the row.
  • Displays the color of the Region field in red if you enter New Orleans as the City for the row.
  • Otherwise, displays the color or the Region field in blue.

The Region field is visible/hidden as you step between rows or change rows. The field is visible as you enter data. In this example, if you insert a new row, the Region field is hidden if you enter the Country as UK.

Control Form Titles

By default, API Creator selects a field with a suitable name for the form title. You can control the form title. For example, you can choose to display the form title as first + last name. The following image shows Data Explorer in user mode:

  1. In Data Explorer (in Author Mode), click the table settings icon in the Form.
  2. Click the Form Window tab, enter a form title, and click Close.
    The 
    following image shows how to display the form title as first + last name:

Add Data to a Binary Type Field

Prerequisites:

  • A table is selected in the Grid.
  • The binary field exists in the table.
  • (To show an image) The API setting Permit Authorization parameter in URL is selected.
  1. In Data Explorer (in Author Mode), click the three dots next to the field to which you want to add data and then choose Upload file.
  2. Browse for the file, select and upload it, and then close the window.
    The file is uploaded.
  3. To show the uploaded file as an image or sound, click the three dots next to the field to which you have added an image and choose Show as image or Show as sound.
    The image or sound displays.
The data is added to the binary field.

Change Tables

You can edit a table name and delete tables in Data Explorer in Author Mode. You can also add tables, update a table name, and delete tables from the Integrate, Schema, Tables tab by clicking Add, Update, or Delete.

For more information about adding managed tables in your data source, Managed Data Servers.

Prerequisites:

  • (If the table is part of an existing schema) The Schema is editable field is selected.
    For more information about this field, see Manage Existing Schema.
  • The table has a primary key.
    Note: If you are using Oracle, a primary key is not required. For more information about this exception, see the Release Notes.
In Data Explorer (in Author Mode), in the Grid, select the table you want to edit or delete, and then click the settings icon. The Options window opens. Click Delete Table or Edit Table.

Control the Child Grid

You can rearrange the Child Grid using drag-n-drop, change the display name for the labels, and select the tabs to display. In Data Explorer (in Author Mode), click the child tab settings icon in the Child Grid. The Options window opens. The following image shows this icon and the window that opens:

If there are more than five active children, you can show more items by clicking the down arrow on the last tab.

Share Links with Other Team Members

You can create and edit a URL that you can share with other team members. In Data Explorer, go to Tools, Share. The Link Generator window opens. The link attribute names the starting table followed by the primary key (optional), for example:

http://localhost:8080/DataExplorer/index.html#/
link/nw:Categories/1?
server=undefined&
username=demo&
apiKey=eeb2554c79d8a26f62272753ed7493dc&