Skip to main content

Resource Search Interface

Nexla's powerful and flexible API-powered search interface makes locating any needed resource, category of resources, or data of interest—from data flows and data sources to Nexsets, data lookups, schema templates, and more—quick and easy, regardless of how many resources the user's account contains.

The resource search interface is available in screens in the Integrate and Discover sections, located at the top of the resource list.

  • Integrate Screens:

     SearchLocation1.png
  • Discover Screen:

     SearchLocation2.png

1. Video Tutorial

The video below introduces the resource search interface.


Resource searches can be performed using any number and/or combination of keywords understood by the search interface. These keywords correspond to various resource characteristics, including the name, description, data source/destination connector type, current status, Nexset attribute names, and many more.

Queries can be constructed by typing and/or selecting keyword–value pairs in the search bar (Section 2.1) or by using the Advanced Search window (Section 2.2).

  1. To begin constructing a resource search, first, click inside the search bar. This will automatically open a dropdown menu.

    To search using only a keyboard, press the / key.

  2. The dropdown menu displays a list of keywords recognized by the interface, along with a description of the characteristic to which each keyword corresponds.

      KeywordMenu.png

  3. Keywords can be added to the search by typing directly into the search bar or by selecting a keyword from the list.

      ConnectorCode.png

  4. Once a keyword has been added, it must be assigned a value. Keyword values can also be typed into the search bar or chosen from the list of recommended values.

      Recommended Values List:

    ValuesList.png

    • The list of recommended keyword values is continuously updated as text is entered in the field.
        Updated_2.png

    • Click on a recommended keyword–value pair to add it to the search.
        AddKeyword.png

  5. After entering one or more keyword–value pairs in the search bar, press the Enter key to apply the search filters and view the list of results.

  6. See Section 3 for information about the features and functions of resource query results in each screen.

2.2 Advanced Search Window

  1. To access the Advanced Search window, click the AdvSearch.png icon in the search bar.

      AdvSearch2.png

  2. Assign a value to one or more of the keywords shown in the Advanced Search window.

    • For keywords with a text field to the right, type the value into the text field.

        AdvSearch3.png

    • For keywords with a pulldown menu to the right, select the value from the menu.

        AdvSearch4.png

  3. Once all desired keyword–value pairs have been assigned, click Search.png in the bottom right corner of the window to apply the search filters and view the list of results.

      Search2.png

    • Optional: To exit the Advanced Search window without applying filters, click Cancel.png.

        Cancel2.png

  4. See Section 3 for information about the features and functions of resource query results in each screen.

2.3 Complex Queries

  • Any number of keyword–value pairs recognized by the search interface can be combined to create queries of any level of complexity, including locating individual resources of interest and identifying categories of resources. Users can apply multiple filters to easily and quickly locate resource(s) or data needed for any use case.

      DataCredentialsID.png

  • The search interface also understands additional keywords beyond those listed in the search-bar dropdown menu or Advanced Search window. These keywords can be typed directly into the search bar and assigned a value, following the format keyword:value.

    The full list of keywords recognized by the search interface is shown in Section 5.

      DataCredentialsID.png

  • If a keyword that the interface does not understand is entered, it will be indicated in strikethrough font and will not be included in the search filters.

      Strikethrough.png

3. Search Results/Resource Lists

From the resource lists displayed in screens in the Integrate section, users can easily view information about any accessible resource(s) and access many associated functions.

  • Resource lists initially display a complete listing of either owned or shared resources available in the user's account.

    See Section 4.2 to learn how to view lists of owned and/or shared resources.

  • Resource lists are updated according to any keyword–value filters applied using the search interface (Section 2).

3.1 All Data Flows

  • In the All Data Flows screen, click on any listed flow to open an expanded view of the data flow.

      ADF_Open.png

  • All information and functions available for data flows and resources in the All Data Flows screen can be accessed from search result lists.

3.2 All Projects

  • Since projects are typically collaborative projects centered around teams of users, the access keyword has the default value collaborator in the All Projects screen.

      Projects1.png

  • The search interface can be used to locate projects using keyword–value pairs.

      Projects2.png

  • Click on a listed project to open it.

      Projects3.png

  • After opening a project, the search interface can be used to locate data flows and/or resources within the project.

      Projects4.png

3.3 Sources & Destinations

  • In the Sources and Destinations screens, click on any listed resource to open the resource information screen.

      Sources3.png

  • Click the ViewDataFlow.png button in the top right corner of the resource information screen to view the data flow to which the source or destination belongs in the All Data Flows screen.

      ViewDataFlow2.png

    • When a flow is accessed in this way, the search bar in the All Data Flows screen is populated with only the data_source_id or data_sink_id keyword with the corresponding resource ID as the value (the access keyword is omitted). This means that the URL can be more easily shared with and opened by other users.

      See Section 4.1 to learn more about bookmarking and sharing search queries.

        ViewDataFlow3.png

3.4 Nexsets & Discover

  • In the Nexsets and Discover screens, the attr_name keyword can be used to locate all Nexsets that contain a specified attribute—i.e., attr_name:order_date.

      AttrName1.png

      AttrName2.png

  • Click on a Nexset to open the Nexset information screen.

    To learn more about the information and functions available in the Nexset information screen, see Nexset (Data Product) Information.

      OpenNexset.png

3.5 Common Components Screens

  • In any of the screens under the Common Components heading (Credentials, Lookups, Schema Templates, Reusable Transforms, and API Keys), click on a listed resource to open the resource information screen.

      Lookups.png

4. FAQs & Features

4.1 Bookmark/Share Search Queries

Each time a search is performed via the resource search interface, the URL is updated to reflect the combination of all keyword–value pairs used in the search.

  URL.png

  • For queries that are performed regularly, the URL can be bookmarked for easy navigation back to the query without re-entering the search terms each time.

  • Query URLs can also be shared with other users. When another user navigates to the query URL, the search interface will reflect all entered keyword–value pairs.

    If the recipient user has a different level of access to the resource(s)—i.e., Collaborator instead of Owner—the user will typically need to change the value of the access keyword after navigating to the query URL.

4.2 Veiw Owned/Shared Resources

The access keyword is automatically populated in the search interface in most screens. The value of this keyword determines whether owned or shared resources are displayed.

  • access:owner – When the value of access is owner, resources to which the user has Owner-level access will be displayed.
  • access:collaborator – When the value of access is collaborator, resources which have been shared with the user will be displayed.

  Access.png

To select whether owned or shared resources are displayed:

  1. Click on the access keyword.

      Access2.png

  2. Select the desired access level from the dropdown menu.

      Access3.png

  3. Press the Enter key to update the resource list according to the selected access value.

      Access4.png

4.3 Top Search Results

As keyword–value pairs are added to the search bar, the search menu will also display the corresponding top results.

  TopResults1.png

  • Click on a listed top result to open the resource.

      OpenTopResult.png

5. Recognized Keywords

The table below lists all keywords currently recognized by the search interface. Keywords are listed according to the resource type to which they apply.

5.1 Nexsets

The following keywords can be applied to Nexsets.

Search Keyword Value Type  Description
idinteger Unique Nexset identifier
data_source_idinteger Unique identifier of the data source from
 which the Nexset originates
parent_data_set_idinteger Unique identifier of the parent Nexset
copied_from_idinteger Unique identifier of the resource from 
 which the Nexset was copied
namestring Assigned Nexset designation/title 
descriptionstring Assigned Nexset description
statusstring Current status of the Nexset
(i.e., active, paused, init)
code_container_idinteger Unique identifier of the reusable transform
 used to produce the Nexset
output_schema_annotationsstring Annotation text added to a Nexset attribute
 in the applied schema template
output_schema_validation_enabled bool Boolean value indicating whether schema
 template validation is enabled
(true or false)
source_schemastring
managedbool
publicbool Boolean value indicating whether the
 Nexset is publically accessible
(true or false)
out_validation_enabledbool Boolean value indicating whether output
 validation is enabled for the Nexset
(true or false)
created_atdatetime Datetime of Nexset creation
updated_atdatetime Datetime of the most recent Nexset
 update
tagsstring Tags applied for categorization/
 identification
source_schema_propertiesobject
output_schema_propertiesobject
source_typestring
attr_namestring Name of an attribute that the Nexset
 contains
schema_attrstring Name of an attribute included in the
 applied schema

5.2 Data Sources

The following keywords can be applied to Data Sources.

Search Keyword Value Type  Description
idinteger Unique data source identifier
data_source_idinteger Unique data source identifier
connector_typestring Connector type used to create the data
source (i.e., shopify_api, snowflake,
 etc.)
data_credentials_idinteger Unique identifier of the credential used
 to create the data source
namestring Assigned data source designation/title 
descriptionstring Assigned data source description
flow_namestring Assigned name of the data flow
 containing the data source
flow_descriptionstring Assigned description of the data flow
 containing the data source
statusstring Current status of the data source (i.e.,
active, paused, init, rate_limited)
 
ingest_methodstring(i.e., POLL, API)
source_formatstring(i.e., JSON, XML, CSV, TSV)
source_configobject
template_configobject
poll_schedulestring
data_sink_idinteger Unique identifier of the data sink with
 which the data source is associated in
 a data flow
vendor_endpoint_idinteger
managedbool
copied_from_idinteger Unique identifier of the resource from 
 which the data source was copied
created_atdatetime Datetime of data source creation
updated_atdatetime Datetime of the most recent data
 source update
tagsstring Tags applied for categorization/
 identification
source_typestring
connector_namestring Name of the connector used to create
 the data source
connector_codestring Classification of the connector used to
 create the data source
source_connector_namestring Name of the connector used to create
 the data source
source_connector_codestring Classification of the connector used
 to create the data source

5.3 Data Destinations

The following keywords can be applied to Data Destinations.

Search Keyword Value Type  Description
idinteger Unique data destination identifier
data_sink_idinteger Unique data destination identifier
connector_typestring Connector type used to create the data
destination (i.e., shopify_api, snowflake
 etc.)
data_set_idinteger Unique identifier of the data set with
 which the data destination is associated
 in a data flow
data_credentials_idinteger Unique identifier of the credential used
 to create the data destination
vendor_endpoint_idinteger
data_map_idinteger Unique identifier of the schema template
 associated with the data destination in a
 data flow
data_source_idinteger Unique identifier of the data source
 associated with the data destination in a
 data flow
namestring Assigned data destination designation/title 
descriptionstring Assigned data source description
flow_namestring Assigned name of the data flow
 containing the data destination
flow_descriptionstring Assigned description of the data flow
 containing the data destination
statusstring Current status of the data source
(i.e., active, paused, init,
rate_limited)
sink_formatstring Format of data sent to the data destination
(i.e., JSON, XML, CSV, TSV)
sink_configobject
template_configobject
sink_schedulestring
managedbool
in_memorybool
copied_from_idinteger Unique identifier of the resource from 
 which the data destination was copied
created_atdatetime Datetime of data destination creation
updated_atdatetime Datetime of the most recent data
 destination update
tagsstring Tags applied for categorization/
 identification
sink_typestring
connector_namestring Name of the connector used to create
 the data source
connector_codestring Classification of the connector used
 to create the data destination
sink_connector_namestring Name of the connector used to create
 the data destination
sink_connector_codestring Classification of the connector used to
 create the data destination

5.4 Projects

The following keywords can be applied to Projects.

Search Keyword Value Type  Description
idinteger Unique project identifier
namestring Assigned project designation/title
descriptionstring Assigned project description
client_identifierstring
client_urlstring
copied_from_idinteger Unique identifier of the project from which
 the project was copied
created_atdatetime Datetime of project creation
updated_atdatetime Datetime of the most recent project update 

5.5 Lookups

The following keywords can be applied to static and dynamic Lookups.

Search Keyword Value Type  Description
idinteger Unique lookup identifier
namestring Assigned lookup designation/title 
descriptionstring Assigned lookup description
publicbool Boolean value representing public accessibility 
 of the lookup (true or false)
data_typestring
data_formatstring Format of data to which the lookup is applied
(i.e., JSON, XML, CSV, TSV)
emit_data_defaultbool
use_versioningbool Boolean value indicating whether versioning
 is enabled for the lookup (i.e., true or
false)
data_defaultstring
data_defaultsobject
data_mapobject
map_entry_countinteger
map_entry_schemaobject
data_sink_idinteger Unique identifier of the data sink with which
 the lookup is associated in a data flow
map_primary_keystring Attribute specified as the primary key in the
 lookup
managedbool
created_atdatetime Datetime of lookup creation
updated_atdatetime Datetime of the most recent lookup update
tagsstring Tags applied for categorization/
 identification

5.6 Credentials

The following keywords can be applied to Credentials.

Search Keyword Value Type  Description
idinteger Unique credential identifier
connector_typestring Classification of the connector with which
 the credential is used
namestring Assigned credential designation/title 
descriptionstring Assigned credential description
vendor_idinteger
verified_statusstring Boolean value indicating whether the
 credential has been verified (i.e., true or
false)
verified_atdatetime Datetime at which the credential was last
 verified
managedbool
copied_from_idinteger Unique identifier of the resource from 
 which the credential was copied
created_atdatetime Datetime of credential creation
updated_atdatetime Datetime of credential update
tagsstring Tags applied for categorization/
 identification

5.7 Schema Templates

The following keywords can be applied to Schema Templates.

Search Keyword Value Type  Description
idinteger Unique schema template identifier
data_credentials_idinteger Unique identifier of the credential associated
 with the schema template
namestring Assigned schema template designation/title 
descriptionstring Assigned schema template description
detectedbool
managedbool
templatebool
publicbool Boolean value representing public accessibility
 of the schema template (i.e., true or false)
schemaobject
annotationsobject
validationsobject
data_samplesobject array
copied_from_idinteger Unique identifier of the resource from 
 which the schema template was copied
created_atdatetime Datetime of schema template creation
updated_atdatetime Datetime of schema template update
tagsstring Tags applied for categorization/
 identification

5.8 Code Container (Transforms)

The following keywords can be applied to Code Containers (Reusable Transforms).

Search Keyword Value Type  Description
idinteger Unique code container identifier
data_credentials_idinteger Unique identifier of the credential
 associated with the code container
runtime_data_credentials_idinteger
namestring Assigned code container designation/title 
descriptionstring Assigned code container description
reusablebool Boolean value indicating whether the code
 container is reusable
publicbool Boolean value representing public
 accessibility of the code container
(i.e., true or false)
resource_typestring Type of resource with which the code
 container is associated (i.e., source, sink,
transform, "error, validator)
output_typestring Type of output associated with the code
 container (i.e., record, attribute)
code_typestring Type of code included in the code container
(i.e., jolt_standard, jolt_custom,
python, javascript)
code_encodingstring Type of encoding associated with the code
 container (i.e., none, base64)
code_configobject
codestring String of code included in the code
 container
managedbool
copied_from_idinteger Unique identifier of the resource from 
 which the code container was copied
created_atdatetime Datetime of code container creation
updated_atdatetime Datetime of code container update
custom_configobject
tagsstring Tags applied for categorization/
 identification