Skip to main content
Gainsight Inc.

Logs

Gainsight NXT

This article supports Gainsight NXT, the next evolution of the Customer Success platform. If you are using Gainsight CS Salesforce Edition, you can find supporting documentation by visiting the home page, and selecting CS > Salesforce Edition.

Not sure what your team is using? Click here.

 

IMPORTANT - Adoption Explorer Horizon Experience

Gainsight has upgraded Adoption Explorer with Horizon Experience. Steps, images, and playable GIFs in this article will soon be updated with the Horizon Experience changes.

This article explains how admins can manually execute a job in Adoption Explorer, and the other availaible options in the Logs page.

Overview

This article is the seventh item in a series of Adoption Explorer configuration articles. Gainsight recommends you to refer to the initial articles of the series and then start with this article.

This article explains how admins can manually execute a job in Adoption Explorer, and the options in the Logs page. You can navigate to the Logs section in a project via: Adoption Explorer > Administration. Hover to the required project and select View Logs from the three-dots vertical menu.

Prerequisite

To execute a job in an Adoption Explorer project, make sure that the status of the project you want to run is Active.  

Options in Logs page

Once you are navigated to the Logs page, you will see the following options:

  1. Historical Run
  2. Refresh Logs
  3. Logs - List View
  4. Sorting and Filters 
  5. Pagination Tool

AE_LogsOverview.png

Historical Run

A project in Adoption Explorer can be scheduled automatically and manually. You can schedule a project to run automatically (either Daily/Weekly), as explained in the Setup Source Connection article. The Historical Run allows you to execute a job manually to the source level and derived measure level and you can also do a ‘Test Run’, which helps you validate if the settings and source connections are working correctly. Test Run does not load any data into the objects.

Notes: To Run/Schedule a project in Adoption Explorer, ensure that the status of the project is Active.

AE_Logs.png

Basically, the purpose of Historical Run is:

  • You can schedule a project on the historical data. For example, you can compare the Product Usage Data of the current year with the Previous Year and generate the report from the Previous Year. However, for historical data older than 45 days, the daily jobs are not executed, the application schedules weekly jobs only if the weekly sources are configured.
  • You can run on a selected source, instead of running the entire project. For example, you may want to run  on a new source that is added to the existing project.
  • You can also select a single source object and can run on the specifically selected derived measures. For example, you may want to run on a new derived measure in the existing source.

To manually run the project:

  1. Navigate to Adoption Explorer > Administration.
  2. Click on the required project.
  3. From the three-dots vertical menu on the top-right corner, select View Logs.
  4. In the Logs page, click Historical Run.
  5. Enter the required date range in the Start Date and End Date fields.

Notes:

  • If you want to run a job for a particular date, you can just enter the required date in the Start Date field, and can leave the End Date field blank.
  • Daily jobs or Weekly jobs in a project are run based on the Run day. For example, you have set the Company Information to Weekly, and selected a weekday (Ex: Dec 1st ‘18) to run the project, then only the daily jobs of the project are run, and the weekly jobs of project would not run. However, if you have selected weekend (Ex: Dec 2nd ‘18) as the run day, then not only the daily jobs of Dec 2nd ‘18, but also weekly aggregation for the week ending Dec 2nd’18 also runs, similarly Company Information object also runs.
  • If the selected data sources in a project are configured with Google Analytics (GA), you will not be able to run a project for the previous 3 days, since data will not be available as the usage data from GA will be ingested into the Adoption Explorer objects in 72 hours. For example, for 15th Jan’18, you can run for 12th Jan’18 and for the days backdated from 12th Jan’18. For more information on schedule frequency, refer Schedule Frequency.
  1. Send Job Notifications to: Enter the email address(es) in this field, to which a job notification email will be sent.
  2. Test Run: Select this checkbox to test the job. Test Run allows you to check if all the settings, source connections, etc. are working correctly. Test Run does not load any data into the objects.
  3. Selective Historical Run: This option allows you to run on a single source object, instead of running the entire project. Select this checkbox to enable Select Object dropdown list.
  4. Select Object: Select the required source object from the Select Object dropdown list. Once you select the source object, you will see the  Sources and Derived Fields options. You can select either of the two options, based on your requirement:
    1. Sources: allows you to select and run on the required sources, instead of running the entire project. Select the required sources from the Sources dropdown list.
    2. Derived Fields: allows you to run on the selected derived measures in the source object, instead of running the entire source. Select the required fields from the Derived Fields dropdown list.
  5. Click Run to execute a job on the selected source or the selected derived measures.

IMPORTANT: In the PX enabled projects, the Trigger backfill from Gainsight PX toggle is displayed. This option helps you to trigger backfill/historical data from PX. For more information on how to trigger Backfill from Gainsight PX, refer to the Backfill Data when the PX Product Tree is modified section of the Enable Gainsight PX Data in Adoption Explorer article.

Logs - List View

Once you run a job, the status of the job is shown in the first column of the Logs table. If a job was recently updated to run, but you have not left this screen, you need to click Refresh Logs.

You can see the following details in the Logs table:

  • Status: Identifies the status of the job. The various statuses are:
    • SCHEDULED: This status is displayed when there are other job executions in-progress.
    • STARTED: This status is displayed when the job is started for execution.
    • SKIPPED: This status is displayed when you execute a job older than the last 45 days. This means, daily jobs older than the last 45 days will not be executed, the system will schedule only weekly jobs for the skipped date range, only if the weekly sources are present.
    • SUCCESS: This status is displayed when the job is successfully executed.
    • PARTIAL SUCCESS: This status is displayed when there is any invalid data in the source records.
    • FAILURE: This status is displayed when the job fails to execute.
    • ABORTED: This status is displayed when you stop the execution of a job. To learn more about how to abort a job, refer to the Abort Job section of this article.
  • Run Date: is the date for which you want to execute the run. If you have selected a Date Range from one week to another week, then Adoption Explorer will automatically run for all the weekly schedules in the project.
  • Frequency/Action: This column displays the values either Daily/Weekly.
  • Start Time: is the time at which the job execution starts.
  • End Time: is the time at which the job execution ends.
  • Type: You can see the schedule type in the last column of the Logs table. The schedule type can either be SCHEDULER or MANUAL or TEST RUN. If the job execution is Automatic, you will see the type as SCHEDULER and if the execution is manual, you will see MANUAL or MANUAL, TEST (if you have selected the Test Run option in Run Now).

AE_Logs_ListView.png

View Job Details

To view the details of the job: 

  1. Click on a job from the Logs list view.
  2. In the Job Details window, click  on the workflow to see the list of objects/sources on which you have run the job.
  3. Click the info icon for the object/derived field, to see the detailed information of the job.
  • Data Process: This is the stage where the data from source files are picked, extracted for specific data, formats and are applied with the appropriate functions etc. Once the extraction and transformation begins, you will see the status as STARTED, and once the job is complete, you will see the status as SUCCESS.

  • Data Load: This is the stage where the data extracted from the previous step is loaded into the Adoption Explorer objects. Until the extraction and transformation step is complete, you will see the status here as QUEUED, and once the data load begins, you will see the status as STARTED, and once the job is complete, you will see the status as SUCCESS.

If the current job you are looking at is in-progress, you can click Refresh Status to refresh the job status.

Once the Data Process, and Data Load tasks are successful, you will see the options for previewing and downloading the data.

  • Preview: Click this icon to preview the results in a new window. You can see the number of records displayed in this page.
  • Download: Click this icon to download the results of the selected object/derived field.

If the execution of the Data Load task is Partially Success, you can Preview and/or Download the invalid reasons.

Abort Job

You can also abort a job when the job run is in-progress using the Abort Job option beside the Refresh Status button. Abort Job option is enabled for any job scheduled for a run. You can use this option when the job is initiated unintentionally or if the job is not configured as required.

AE_Logs_JobAbort.png

Apply Filters

Filtering the logs helps you easily track and view the status of the job executions for a project. You can configure filters using the AND and OR logic by applying the appropriate operator and value combination for the fields. The following fields are available:

  • Status
  • Run Date
  • Start Time
  • End Time 
  • Frequency
  • Type 

AE_Logs_Filters.png

Pagination Tool

If you have run too many jobs, you can use the pagination tool to navigate through different pages and view multiple jobs based on your filter selection.

Fetch Adoption Explorer Logs Using REST APIs

Gainsight allows admins to fetch Adoption Explorer Project execution status, using Rest APIs. With the Adoption Explorer REST APIs, admins can access and check the status of the Project Logs from the external systems. These APIs allow admins to fetch the Project Log details upto Job and Sub Job levels. Admins can also fetch the data process/load information of a job, sub job and Company data resolution details with csv links.

Example Business Use Case: All the teams who benefit from accessing Adoption Explorer do not always use Gainsight. Such customers expect a better Gainsight integration with the systems of their choice. In such scenarios, Adoption ExplorerAPIs allow customers to access and check the job statuses from their external systems. Customers who have the development resources can use these APIs to build tighter and more customized integrations between Gainsight and other systems they use.

For more information on how to fetch AE Logs via APIs, refer to the Adoption Explorer APIs article.

  • Was this article helpful?