Custom Fields

Custom fields are used to capture additional information about developers' organizations and applications in the registration and application forms. When enabled, custom fields appear on the form's Additional Info tab.
apidp31
Custom fields are used to capture additional information about developers' organizations and applications in the registration and application forms. When enabled, custom fields appear on the form's Additional Info tab.
Web Administrators and Administrators can use the Manage Custom Fields page to create, edit, enable, disable, and delete custom fields.
The API Package, Organization Name, and Organization Description custom fields come with the API Portal. You can edit, enable, and disable them.
To open the Manage Custom Fields page:
  1. Log in to the API Portal as a Web Administrator or Administrator.
  2. On the Dashboard, select
    Site Settings
    Custom Fields
    . The Manage Custom Fields page displays a list of existing Custom Fields.
The API Package Custom Field
An API package is an account plan that includes APIs and API groups. The API Package custom field is a menu of API packages. When enabled, the API Package menu appears on the registration form's Additional Info tab.
To allow Org Administrators to easily choose an API package while registering for an organization account, the Web Administrator or Administrator can enable and edit the API Package custom field.
Business Managers and Administrators determine which account plans are included in the API Package menu. For more information, see "Create Account Plans".
When an Org Administrator registers for an account, the API Portal assigns a default package if the API Package field is not enabled, or if it is enabled but the Org Administrator does not choose an API package.
Creating Custom Fields
This section describes how to create and customize a field for the registration form or application form.
After you create a custom field, if you want to add it to the form, you must enable it. For more information, see "Manage Custom Fields".
To create a custom field:
  1. Log in to the API Portal as a Web Administrator or Administrator.
  2. On the Dashboard, select
    Site Settings,
     
    Custom Fields
    . The Manage Custom Fields page displays a list of existing Custom Fields.
  3. Click
    Create New Field
    . The custom field dialog box opens.
  4. Complete the fields as shown below.
    Creating a Custom Field
    Setting
    Description
    Form
    From the menu, choose where the field will appear:
    Application:
    Displays the field in the
    Additional Info
    tab of the Application form.
    Registration:
    Displays the field in the
    Additional Info
    tab of the Registration form.
    Field Name
    Enter a unique field name. This is the label that appears in the form.
    Make this field required?
    Select this check box to make this a mandatory field on the form. Clear this check box to make the field optional.
    Data Type
    Choose the type of data that will be stored: Text, Number, Date, or Special. The Special data type is a menu of options.
    Field Type
    Choose the field type.
    Note:
    The selected
    Data Type
    determines which field types are available. Some data types have only one field type.
    Options
    The Options fields appears on the dialog box only if the selected
    Data Type
    is
    Special
    , which is a menu.Use this field to specify which options are available in the menu. The options field lets you do the following:
    • Add an option by clicking
      Add
      and typing the option in the field that appears.
    • Change the order of options by dragging them up or down.
    • Make an option the default by clicking the green check mark icon beside it.
    • Delete an option by clicking
      x
      beside it.
  5. Click
    Save
    when done.