Exporting Entities and Relationships

You can export entities and relationships by using the Export application in Console.

To do so, use the following steps:
  1. From the Tenant Management section, select the Export application. Alternatively, you can use the top menu in Console to open the Export application.

    Note: Before doing an export, you must select a tenant by using the Tenant Selector.

    For the selected tenant, the Export Home page lists all Pending (In Progress) and Completed (Finished and Failed) jobs.

    The Pending and Completed job lists show the job creator, job name, status, duration and the job start or end details, in the respective lists.

  2. You can view the details of any pending or completed export job by clicking the job from the respective list.

    The Details panel appears.

  3. Use the following steps to create a new export job:
    1. You can create a new export job by using the + New Export Job button at the top.

      The Create a new export page appears.

      The Create a new export page lists the Entity Types and Relationships available in your tenant configuration. None of the entity types or relationships are selected, by default.

      In the Entity types section, you can use the Sort and Filter icon () to sort the entity types in the order of Name or number of Attributes. In addition, you can choose to view only the non-abstract entities or all the entities by using the appropriate option from the Filter By section in the Sort and Filter dialog box. By default, only the non-abstract entities are displayed.

      You can create a new export job in two easy steps: Select the entities/relationships that you want to export and provide the job details. You can optionally apply filters to specify the date range for the export job.

    2. Select the Entity types that you want to export. The Selected attributes column lists the number of attributes selected for each entity type.

      When you select an entity type, the Select attributes panel appears. It lists all the attributes related to the selected entity type. The attributes appear selected or deselected based on how you select the entity type. If you click the entity type icon, the attributes appear selected in the Select attributes panel. However, if you click the entity type row to select the entity type, the attributes do not appear selected by default.

      Important: By default, the Select attributes panel displays only the non-hidden attributes. You can use the Sort and Filter icon to change your preference.
      Note: Selecting or deselecting the Attribute name checkbox (first checkbox below the Search column) allows you to select/deselect all the attributes at one go.

      You can also use the Unselect all items option to deselect the attributes, and, select only the attributes that you want to export.

      On clicking the Sort and Filter icon () in the Select attributes pane, you can select any one of the four available filter options. You can choose to view only the non-hidden attributes, or, only the required attributes, or, only the analytics attributes, or, all the attributes (irrespective of their hidden/required/analytics status).

      You can use the Search attributes column to look for particular attributes of the selected Entity Type.
      Note: If you have searched for an attribute, when you click the Attribute name checkbox, only the attributes displayed as the results are selected.

      While selecting the attributes, if you select a nested/parent attribute, all the child attributes are also selected, by default. You can still make changes and select/deselect the individual child attributes, if required. Only the selected child attributes are exported.

      You may need to scroll the list to view all the attributes. Besides the attributes that are specific to the selected entity type, you can select the Basic or system attributes too, if required.

    3. You can close the Select attributes panel when you finish selecting the attributes for an Entity type.

      The Entity Types list shows the exact number of selected attributes against each entity type.

    4. You can select the attributes for another entity type, or, move on to selecting the relationships for export. Click the Relationships that you want to export.

      You can use the Sort icon to sort the relationships in the order of relationship’s name or the number of attributes.

    5. Click Continue on the top right corner. Alternatively, you can click Filter mentioned as the second step in the center of the page on top.

      The Filter page appears. You can specify the date range for which you want to export the dataset. All the records for the selected Entity Types and Relationships that were modified between the specified date range are exported. The types of changes include all crosswalk, entity, group, interaction, relationship and match changes.

    6. Select the From and To dates from the month calendar.

    7. Click Continue. The Job Details screen appears.

      Specify a relevant name for the export job. The system specifies a combination of date and time as the default job name. For example: Untitled Export Job...DateandTime.

      Select the Export Operation Values (OV) only option to export only those attribute values that were selected by the survivorship rules. You can select CSV Flattened, CSV Exploded or JSON as the File Format of the exported files.

      If you use small datasets and process the output files manually, you may want to produce a single output file as the result of your export task. Select the Produce a single output file checkbox to create a single output file.

    8. Click Run to start the export job.

      While the export job runs, it is listed in the Pending jobs list as an In Progress job. After the job is over, it is listed in the Completed jobs list on the Export page.

      On completion of the export job, Console sends you an email notification. It includes a link to the exported data. You can click the link to download the exported files until the validity mentioned in the email. If for some reason, the export job was not successful, you will still be notified by an email.

      Though entities and relationships are exported in separate files, they reside in the same location.