The Data Dashboard is a user interface for your data storage on the Fredhopper infrastructure.
It allows you to verify the data execution and provides access to its logs.
Before operating with the Data Dashboard, it will be useful to go through the following materials on how the data is handled for your Fredhopper environment:
Data Integration and Manipulation via REST Services API
Accessing the Data Dashboard
The Data Dashboard is accessible via the following link:
https://my.<region>.fredhopperservices.com/<cloud_account>/dashboard/
Where <region> is one of: eu1, us1, ap1, ap2, depending on which cloud region your account is.
Where <cloud_account> is your Fredhopper cloud account.
You will need your LDAP credentials to log in to this address.
How to use the Data Dashboard
The Data Dashboard provides information about the data triggers submitted by your data team.
Dashboard Interface
You will see different trigger types listed on the dashboard(fas:<trigger_type>) and depending on your implementation, there will be records for the ones you use.
The most used trigger type is fas:load-data.
The interface provides the following information:
- Trigger Time - when the execution of the job started
- Trigger/Track - link to the data processing logs
- Status - shows the status of the job
- Input Data - what type of data is submitted; if it is a full feed or an incremental. This is a direct link to the input data folder, where the file resides
- Input Data Byte Size - the size of data received (for CIDP integrations, the metadata.json file does not show the size of the whole catalog but only of this file)
- Processing Time - shows the time of the job execution. This includes ETL processing and loading the data into Fredhopper.
- Comments - might contain comments for successful execution or ETL failures
If you have a CIDP integration then you will see records under fas:activate-catalog, for catalog activation commands.
If your environment has a commit-config setup, the records will be shown under fas:commit-config-read
Switching between environments
On top of the dashboard, you will find a list of your environments and you can use these buttons to look at the data processing for each environment including the suggest service.
Switching dates
Again on top of the dashboard, you will find the following buttons:
The "Earlier" button gives the possibility to check the data execution for the previous days.
Access to the data file
Clicking on one of the files in the "Input Data" column will bring you to the Input Data folder where the data is uploaded:
The file can be downloaded for review. This contains the raw data before the ETL process.
Depending on your integration the data.zip will contain files in csv or json format.
For CIDP integration, only the metadata.json file will be shown.
Access to the data processing logs
Clicking on one of the timestamps in the Trigger/Track column will lead to the Track folder containing the logs of the ETL execution:
The "status" file contains the job status of the execution, where the different statuses are described in Trigger Status Reference.
- If this was a full reindex, it should contain the following message for successful execution:
- "SUCCESS Reindexing finished at Wed Aug 14 01:06:04 UTC 2024"
- For CIDP integrations, this file shows only "SUCCESS" for the full reindexes.
The "logs/" folder contains the logs of the ETL execution like the kitchen.log:
The run.properties, updates-failure, and updates-success files are specific for CIDP integrations.
The "status" file in this folder is relevant only for the ETL execution.
The "status" file in the Parent folder shows the status of the whole job including the loading of the data in Fredhopper.
Clicking on one of the files here, you will get the contents in a text-readable format, which is useful when checking the kitchen.log for errors.
Listing of the data directories
The folders listed under https://my.<region>.fredhopperservices.com/<cloud_account>,
are described in the File API.
By clicking on the column names you can sort alphabetically, by size, or by date in ascending or descending order.
Comments
0 comments
Article is closed for comments.