community
cancel
Showing results for 
Search instead for 
Did you mean: 

alteryx connect Knowledge Base

Definitive answers from Connect experts.

How To: Use Custom Fields in Connect

Alteryx
Alteryx
Created on

How To: Using Custom Fields in Connect

 

This tutorial contains information about Custom Fields. You will learn how to create, assign, and configure a Custom Field in the Connect data catalog.

 

What is a Custom Field?

 

A Custom Field is an attribute assigned to an Asset (e.g. data source, workflow, report). This attribute helps to describe the Asset. Some attributes can be applied to any Asset (e.g. Owner or Description) and some are related only to a specific type of an Asset (e.g. report frequency is the Custom Field used only for reports). 

 

You can create a completely new attribute, assign it to a specific Asset type and set its value. The Custom Field is stored in the Connect data catalog.

 

Note: Some of the Custom Field types have special options as described further in the section How to create a Custom Field.

Types of Custom Fields

 

 

How to Create a Custom Field

 

This section contains information on how to create different types of Custom Fields in the Connect data catalog.

 

  1. Go to Administration → Asset ConfigurationCustom FieldsAdd Custom Field

  2. The Custom Field window opens. You can specify the Name and Type.

     How_to_create_CF_03.png
  3. You can choose from several types of Custom Fields.
     

Creating a Picker Custom Field

 

  1. Enter a Name for the Custom Field.
     
  2. Choose Picker as the Type.

  3. Specify Picker Query.

    Note: You can generate the query by setting up the Advance search and see the query by clicking View query toggle.

  4. Optionally you can specify if the Custom Field will be visible when empty, simply by checking the Visible when empty checkbox.

  5. You can also specify if the following options should be applicable for the Picker Custom Field by checking the checkboxes: 

    • Multiple Selection – when checked, this option allows you to assign multiple items to the Asset. Otherwise, only one item can be assigned. 
    • Is Inline Editable? – when checked, this option allows you to assign the value to the Picker Custom Field without editing the Asset. See How to set a Custom Field value to an Asset. 

      Picker_CF_01.png
  6. Click Save.

    Note: Once you press Save, the query of the custom field cannot be modified anymore. We recommend verifying the query using the search first to see if the query returns expected results. 

Creating a Dropdown Custom Field

 

  1. Enter a Name for the Custom Field.

  2. Choose Dropdown as the Type in the dropdown list.

  3. Optionally you can specify if the Custom Field will be visible when empty, simply by checking the Visible when empty checkbox. 

  4. Specify Dropdown Query.

    Note: The options in the Query should be separated by a new line or a semicolon.   

                Dropdown_CF_01.png
  5. Click Save.

Creating a Text Custom Field

 

  1. Enter a Name for the Custom Field. 

  2. Choose Text field as the Type in the dropdown list. 

  3. Optionally you can specify if the Custom Field will be visible when empty, simply by checking the Visible when empty checkbox.  

     Text_CF_01.png
  4. Click Save.

 

How to assign a Custom Field to an Asset type

 

This section contains information about how to assign different types of Custom Fields to an Asset in the Connect data catalog. 

  1. Go to Administration → Asset ConfigurationAsset type.

  2. Pick the required Asset type (e.g. Report as in the sample below) you want to assign the Custom Field to by clicking the Add custom field... section.                                                   
    Howto_assign_CF_toAsset_02.png
  3. Assign your Custom Field to the Asset type.

    Note: You can assign multiple Custom Fields.

  4. Click Save

How to set a Custom Field value to an Asset

 

This section contains information about how to set a Custom Field value to an Asset.

Prerequisite: The given Asset type already has a Custom Field assigned. See How to assign a Custom Field to an Asset. 

  1. Go to the page of the Asset type you want to assign the Custom Field to (e.g. Reports). 

  2. Click on the Asset you want to update with the Custom Field value (e.g. 30 min Driving Distance Analysis).

  3. Click Edit.

  4. Go to the Additional Fields section and set the values to the given Asset.

    • To set a value for the Text and Dropdown Custom Fields without clicking Edit, check the checkbox Visible when empty while creating the Custom Field. See Creating a Text Custom Field and Creating a Dropdown Custom Field.

    • To set a value for the Picker Custom Field without clicking Edit, check the checkbox Inline is editable? and Visible when empty while creating the Custom Field. See Creating a Picker Custom Field.

    • You can choose multiple items for the Picker type if the checkbox Multiple selection is checked while creating the Custom Field. See Creating a Picker Custom Field.

    • You can choose only one option for the Dropdown type.     
                                                 Howto_assign_CFValue_toAsset_03.png  
  5. Click Save.

How to search by the Custom Field

 

This section contains information about how to search by the Custom Field. 

 

  1. Click into the Search bar. Choose Advanced Search

    Search_by_CF_02.png

  2. Use the Field selector to search by the Custom Field and specify your request. 

  3. You will see the search result(s) instantly.