Data Export Services Overview

What is a data export service?

Janrain’s data export service is a scheduled process that runs regularly to deliver profile data to a client’s SFTP (Secure File Transfer Protocol) server. Once configured, Janrain delivers select data from new and updated records to a client’s SFTP server in a CSV (Comma Separated Values) file. This allows the data to be used by other systems as needed.

Examples of data export service uses

Data exports can be used in a variety of ways, including:

  • Adding user profile information to a marketing mail service (such as MailChimp) for newsletters

  • Updating CRM systems, such as Salesforce

  • Running user analytics to measure site effectiveness, marketing success, etc.

In all cases, data exports can be planned to run at regular intervals.

Overview of data export configuration process

Setting up data export services is a detailed process. Janrain will first set up and configure the data export service in a client’s Development environment. Once the client has tested and verified that the files are being delivered correctly to the SFTP server, Janrain will configure the data export service for the Production environment with the same settings.

Janrain will guide clients through each step, providing detail on what is needed and what to expect. This is an overview of the process; more detail is available below in Setting up export services.

  1. Client provides Development environment information

    1. Application ID

    2. Entity types and specific attributes to be exported

    3. SFTP access information

    4. Desired timing of service (interval and time of day)

  2. Janrain delivers CSV file for each configured entity type to the SFTP server

  3. Client tests delivered files and verifies they are correct

  4. Client provides Production environment information

    1. Application ID

    2. Entity types and specific attributes to be exported

    3. SFTP access information

    4. Desired timing of service (interval, time of day, and/or event trigger)

  5. Janrain delivers CSV file for each configured entity type to the SFTP server

  6. Client tests delivered files and verifies they are correct

Setting up export services

The process of setting up data export services is kicked off by sending a request to Janrain. Once the request is received, Janrain will document the request along with known details and timing expectations. This document will be discussed with the client; the process will proceed once all details are agreed upon.

Janrain will then configure export services for the client’s Development environment. In order to accomplish this, the client will need to provide Janrain with the following information:

  • Desired timing for exports

  • Application ID for Development environment

  • Entity type(s) to be exported

  • Attributes to be exported for each entity type (these will be used as column headers in the resulting CSV file)

  • SFTP access information:

    • server URL

    • username and password

    • file prefix (to specify the location on the server)

    • desired datetime format for the CSV filename

Upon successful receipt of the exported CSV file, the client will then provide the same information for their Production environment. Upon successful receipt of the exported CSV file from Production, the service will be established. Once the exported file is successfully delivered to the SFTP server, the client will be able to use the data as needed.

Note: The client is responsible for ensuring the connection to and space available on the SFTP server. The client is also responsible for the maintenance and/or deletion of outdated exported files.

What to expect from Janrain

The data

The data export will be comprised of one CSV file for each entity type that has been configured. The CSV will be named according to the format “entitytype_datetime” and will contain

  • Header row based on attribute names

  • Comma-separated list of attributes, one row for each profile

The configuration process

Depending on the complexity of the data involved, configuring export services can take several days. Janrain will work closely with the client in order to ensure successful configuration. In most cases, the client will work with their Customer Success Manager and a Technical Consultant to establish the service.

Related Articles