Important Nexla Help Center Update:

Nexla's Zendesk Help Center pages are being deprecated and will soon no longer be available.

Nexla Documentation is now the home for Nexla's User Guides, with improved formatting and categories that are easier to navigate, providing a better overall user experience.

Please update any bookmarks to the new Nexla Documentation site (docs.nexla.com/user-guides).

_______________________________________________

This article describes how to access the Data Flow Information screen for any data flow in Nexla and provides information about the different types of information and options provided in this screen.

The Data Flow Information screen includes the Nexla Flow Insights feature. Flow insights allow users to quickly and easily view granular details about data flows, including flow metrics, run logs, and error information. For more about viewing and using Flow Insights in Nexla, see Section 4.

1. Open the Data Flow Information Screen

On the toolbar on the left side of the screen, hover over , and select .
Optional: By default, Nexla initially shows the "Owned by Me" view in the My Data Flows screen. This view displays only flows for which the user has owner or administrator permissions. To view all accessible data flows, including those for which the user has collaborator permissions, select "Accessible to Me" from the pulldown menu on the right side of the screen.
Find the data flow of interest, and click located to the right on the flow listing. This will open the Data Flow Information screen for the selected data flow.

2. Data Flow Name & Description

At the top of the Data Flow Information screen, the name and a brief description of the selected data flow is displayed, along with additional information about the data flow. This section describes how to edit the data flow name and description from this screen and explains the additional information available in the top panel of the Data Flow Information screen.

The tile at the top left of the panel indicates the connector type used for the data source in the selected data flow.
To edit the name of the data flow, click on the name field indicated below, and make any desired modifications. Changes will be automatically saved.
To edit the description of the data flow, click on the description field indicated below, and make any desired modifications. Changes will be automatically saved.
To access a dropdown menu of functions related to the selected data flow, click in the top right corner of the panel.

Menu Options:
1. To activate the data if it has not yet been activated after creation or has been paused, click .
2. To pause the data flow, click .
3. To delete the data flow, click .
  
  This function will delete all resources in the selected data flow, including the source, any detected or transformed Nexsets, and any destinations.
4. To view access control options for the data flow, click .
  
  This function opens the Access tab in the Data Flow Information screen. See Section # for more information about the access control options available in this tab.
5. To create a copy of the data flow, including the source, all detected or transformed Nexsets, and all destinations, click .
6. To move the data flow into a project folder, click . This will open a pop-up with the options detailed below:
  - To move the data flow into an existing project, select the project from the list on the left, and click .
  - To create a new project and move the data flow into it, enter a name for the project in the Project Name field, enter a description of the project in the Description field (optional), and click .

3. Overview Tab

The Overview tab displays general information about the selected data flow.

To enter overview information about the data flow, including a more detailed description, summary, and/or FAQs, click on the text field at the top of the Overview tab to open the text editor.
1. After entering the appropriate information, click at the bottom right of the text field to save the changes.
2. Optional: To exit the text editor without saving any changes, click at the bottom right of the text field.

4. Insights Tab (Data Flow Insights)

The Insights tab displays flow execution insights, providing enhanced visibility into the the health and status of the selected data flow through a historical record of flow runs.

An overview of each run execution record is listed under this tab from the most to least recent run of the data flow.
Click to the right of a run to view information about that run according to the source, Nexset(s), and destination in the data flow.
Click at the bottom of an expanded run to view the detailed execution log for that run.

Section 4.1 provides detailed information about run execution logs and associated navigation options.

4.1 Run Execution Logs

Each run execution log provides detailed processing insights into Nexla's execution of the selected run, allowing users to easily monitor the progress of each component of the data flow. These insights include component-level data processing metrics and information about any errors that occurred during the run.

Run

4.1.1 Run Logs – General Information

Within the run log window, log entries include date-time stamps and are listed in the order of occurrence, beginning with the run start at the top of the list and continuing to the run end at the bottom.
The Nexla ID of the flow component to which an insight corresponds is listed after the date-time stamp.

4.1.2 Run/Component Metrics

Component-level metrics are provided for each component in the data flow during the run described by the selected run log.
Component-level metrics indicate the following information corresponding to the indicated component at the listed date-time stamp:
- Processed records – the total number of data records read from or written to the indicated component
- Errors – the total number of errors associated with the component detected during the run
- Size – the total data volume read from or written to the indicated component

4.1.3 Error Insights

When an error is detected during the selected run, one or more log entries will provide insight(s) into why the error occurred as well as the associated run component and any affected records.

4.1.4 Run Log Navigation Options

The menu on the left side of the run log screen can be used to navigate within the listed entries in the selected run log. These navigation options are particularly useful for longer run logs.
- Click to view log entries from the beginning of the run.
- Click to view log entries from earlier in the run than the currently displayed entries.
- Click to view log entries from later in the run than the currently displayed entries.
- Click to view log entries from the end of the run.
- For some longer run logs, additional time-span options are available in this menu. Click a listed time span to navigate to run entries corresponding to that time span.
The "Select a time range" pulldown menu on the left can be used to navigate to other run logs corresponding to the selected data flow or, for streaming data flows and/or those with longer run times, among entries within the selected run log.
- To navigate to entries within the selected run log corresponding to a time range relative to the current time, select an option under "Relative time ranges".
- To navigate to a run log and/or log entries from a specific date, select the date from the calendar, and enter the start time (24-h format) from which entries should be shown in the field below the calendar.

5. Access Tab

The Access tab provides access management options for the selected flow to facilitate sharing and collaboration, as well as a list of any users with whom the flow is currently shared and their access type(s).

Access

Users with collaborator-level access to the selected flow cannot share the flow with others. For these users, the Access tab displays an overview of the flow with the message "You have read-only permissions for this Flow".
Data flow owners and users who have been granted administrator-level access to the flow can share the selected data flow with other users or teams or with the user's entire organization. For these users, the Access tab displays an overview of the flow labeled "Invite Users to Collaborate on this Flow".
To share the selected data flow:
1. Select the user, team, or organization with whom the flow should be shared from the pulldown menu in the bottom left corner of the Access tab.
2. Use the pulldown menu on the bottom right of the Access tab to select the level of access to the data flow that should be granted to the user(s) selected in the previous step.
  
  For more information about user access levels in Nexla, see the Help Center article Nexla User Access Levels.
3. Click in the bottom right corner of the Access tab to grant the selected data flow access level to the selected user(s).
At the bottom of the Access tab, any user(s) with whom the selected data flow has previously been shared are listed, along with their access level(s).

Articles in this section

Data Flow Information & Insights

Contents:

1. Open the Data Flow Information Screen

2. Data Flow Name & Description

3. Overview Tab

4. Insights Tab (Data Flow Insights)