DataHub Reports provide several options to combine many jobs into a single report for review. Reports are generated by category, individually selected jobs or by convention job parent (user account mapping, network home drive mapping or folder mapping job types).
Reports are separated by two tabs so you can clearly distinguish between jobs that are actively transferring content and simulation jobs that imitate transfer.
If no category is defined during job creation, it will be assigned to the default job category.
Generate Report
Select Report Type
Define what the report will contain
Create a Job with Category
A category for your job is defined outside the transfer block in your JSON; in the section as schedule or job stop policy.
Category Name:
- User-defined string
- Any unique string will be recognized as a new category and job_category_id will be generated
Category is defined outside of the transfer block
|
Example Job JSON
|
Add a Job to an Existing Report
To add a job to an existing report, modify your job JSON to include the job category ID rather than the name
Identify your job category ID by listing all existing reports
- Find the report you want your job to be added to
- Capture the category ID from this report
List All Existing Reports
|
Example: List All Existing Reports Response
|
Example Job JSON to add Job to Existing Report
|
If the report was created with a manual list of jobs, it can be updated to include the new job or jobs to add to the report.
Example: List All Existing Reports Response with Manually Defined List of Jobs
|
A job can be added to this report by submitting a PATCH request for this report ID. For example, the following request will add the job with ID 87c53b88142940cf88a35a7e78b8db60
to the report above.
PATCH {{url}}v1/reports/4d804a381c414ad39e816245196414f4
|
Get Job Category ID
In order to create a new report, you will need to get the job category ID.
Reports | Get current job's category ID
|
Reports | List all job category ID's
|
Jobs that were created without a category fall into the Default category
Default category ID = -1
Create a New Report
To create a new report, you must use the job_category_id. The category string name will not be accepted
Create New Report | POST {{url}}v1/reports
|
Create a New Report for Simulation / Analyzer Jobs
To create a new report for simulation / analyzer jobs, you must use the corresponding job_category_id as well as simulation_mode:true parameter.
POST {{url}}v1/reports
|
List Reports
Reports | List All Reports
|
Report | List Report by ID
|
Report Stats and Transfer Items
Reports | Get Transfer Items for Report by ID
|
Reports | Get transfer stats for Report by ID
|