Tutorial: Adding and exporting custom fields

You can add custom fields to users in the Developer Portal. In addition, the custom fields can be exported.

Before you begin

You must have administrator access to complete this task.

About this task

You can add multiple various types of data to user records, such as department names, accounting information, addresses, and additional custom information that you might want to collect from your API consumers. The custom data that is added to user records can be collected and used by exporting.

By completing the tutorial, you can add custom fields to a user, and export the user records and the field through a custom View.

Any custom fields that are added to a user will remain in the Developer Portal database.

Procedure

  1. To add custom fields for a user:
    1. On the administrator dashboard, click Configuration > People > Account settings > Manage fields.
    2. Enter Department number in the Label text field for Add new field.
    3. Select Integer from the Field type drop-down list.
    4. Ensure that Text field is selected from the Widget list.
    5. Click Save, then Save field settings.
      You have added a custom field to your user record.
  2. To enable the modules that allow user records and fields to be exported through a custom View:
    1. On the administrator dashboard, click Modules.
    2. Identify and enable the Views Data Export and Views UI modules.
    3. Click Save Configuration.
  3. To add a View to export user records and fields:
    1. On the administrator dashboard, click Structure > Views.
    2. Click Add new view.
    3. Enter Employee information in the View name text field.
    4. In the Show section, select Users from the first drop-down list.
    5. Click Continue & edit, then click Save.
  4. To configure a page that can export data:
    1. Under Displays in the Employee information (User) view, adjacent to Page, click +Add > Data export.
    2. In the Data export settings section, click No path is set.
    3. In the text field, enter employee_information, then click Apply.
    4. In the Data export settings section, click None, select the Page check box, then click Apply.
    5. Click Save.
  5. To configure the format in which your data is exported, and the fields that are exported:
    1. In the Format section, click CSV file.
    2. Select the XLS file radio button, click Apply,
    3. Select the Provide as file check box, then click Apply.
    4. In the Fields section, click Add.
    5. Select User from the Filter drop-down list, then select the check boxes for the following fields from the list of available fields:
      • User: Department number
      • User: E-mail
      • User: First name
      • User: Last name
    6. Click Apply (all displays), then click Apply (all displays) for each field.
    7. Click Save.
  6. To export the user data that you have specified:
    1. Enter the data export URL that you have specified.
      For example:
      https://www.portal_host_name/employee_information

Results

You have exported the specified user data as an .xls file.