Table of Contents
Guide Purpose:
- This guide IS designed to:
- Show how to find vehicle breadcrumbs distribution report
- Shows how to edit distribution report
- This guide IS NOT designed to:
- Show the vehicle breadcrumbs distribution report.
How to log in to Jaspersoft
- Go to Jaspersoft portal
- Input User ID for Jaspersoft
- This is a shared user ID
- Input the password
- The user must know this password as it is a shared password. If the user does not know this password, they will need to reach out to their manager to make sure they are approved to do this task.
- Click on Login to access the report page.
How to create a Vehicle Breadcrumbs Distribution report
- Click on Library
- Select the clock icon on the vehicle Breadcrumbs Distribution report
- Click on create schedule
How to Create schedule
- Click on the Schedule button.
- Select the start date for the report
- Make sure to use the “on specific date” to start the report
- Choose the date in which you want the report to begin
- Choose the time zone of report creator
- Choose “Calendar” from the reoccurrence drop down menu
- This allows you to define how your report is being generated
- Select the month in which you want the report created
- Select “Every Month” if this is a monthly report
- Select which day/days of the month you want the report ran
- Select “everyday if this is a daily report
- Select which day or days in the month if you want it sent weekly
- For example: Choosing Wednesday means the report will be sent every Wednesday weekly
- Select the “dates of the Month if you only need it sent on specific dates within the month
- For example: if the 15th is chosen, the report will be sent on the 15th of every month.
- Select what time you want the report generated (time is entered in 24 hours increment range)
- Keep in mind that Jaspersoft is set to UTC time zone.
- Input the time to account for the difference between the creators’ time zone (EST as seen in step 3) and Jaspersoft (UTC)
- For example: If you need the report at 7:30am EST you will put in 2:30 am to account for the -5 hours’ time difference.
- Select Schedule end date for the report.
- Use this section only if an end date is required.
- You can also select the hour on the date you need the report to end.
- For example: If a customer wants the last report on the 25th, you can select hours after your report generation time to still pull report for the 25th.
- Choose the holidays the report will not be generated.
How to Create Parameters
- Click on the Parameters button
- Input “0” for the user ID
- “0” is the universal user who has access to all customers
- Select Start date
- Date ranges from today to seven days ago
- If this is to be ran daily the date should say yesterday
- For example: if today date is the 25th, three days ago would be 12am 22ndto 11:59pm 22nd
- Select End date
- Date ranges from today to seven days ago
- If this is to be ran daily, the end date should say yesterday
- For example: if today’s date is the 25th, Yesterday would be 12am 24thto 11:59pm 24th
- Select the division the tenant needs report for
- Typically, tenants will request report for one division only
- Selecting more divisions makes it harder on the system to pull reports so we recommend one division at a time
- Select vehicle(s) we need data sent on
- Selecting every vehicle will send data on all vehicles
- Selecting certain vehicles will only send data on the selected vehicles
- If no vehicles are selected, data will be sent on all vehicles.
- Insert in seconds the extent of time to delay data sent from the selected vehicles.
- For example: If data is to be sent every 15 seconds, we insert 15 into the box (15sec is the system default)
- Input the customers time zone
- For example: If a customer is in Jefferson parish LA, the time zone will be Central Standard Time.
- Most times the name of the division contains details about the county or state the vehicle(s) operates in.
- The county/state information in the division name can be looked up if there is any confusion.
- Select the breadcrumb event you want to create
- There are 2 forms of this report
- Moving is the standard report. Moving will be the only selection from the dropdown menu
- None moving is the other report (these are service verification events reports). It’s the selection of the other events from the dropdown menu
- One of each form of this report must be set up for our customers.
- There are 2 forms of this report
How to create output options
- Click on the output options button
- Create a file name for the report
- Use this naming structure (Tenant _Division/cite_VehicleBreadcrumbs_Dist_None Moving/Moving)
- Refer to the image below
- Use this naming structure (Tenant _Division/cite_VehicleBreadcrumbs_Dist_None Moving/Moving)
- Select CSV (Comma Separated Value) file as standard format for distributing data
- Select Sequential file names by timestamp (timestamp pattern: yyyyMMddHHmm) for file handling
- Select the output destination of choice
- Output To Repository means 3rdEye storing the report locally so we have a copy
- Output To FTP server means the customer wants the report sent to serve. The fields identified below must be provided for this option to be selected.
- Tenant will provide the server address
- Tenant will provide the port number
- Tenant will identify which transfer protocol to use
- Tenant must provide username and password for the FTP server
How to create Notifications
- Click on the Notifications button
- Input the email of who the report is sent to
- Include the subject line
- Subject line must match the name of the attached report to reduce any form of confusion
- Always select report files as attachments
- Input the email for whom failed notification should be sent to
- This email should be “support@3rdeyecam.com”
- Input the subject line as stated in step 3 with the phrase “- Failed to Distribute”
- This should read “Tenant _Division/cite_VehicleBreadcrumbs_Dist_None Moving/Moving – Failed to Distribute”
- Select the failure notification box
- Document the template
Dear Team,
The report Tenant _Division/cite_ VehicleBreadcrumbs_Dist_None Moving/failed to send to the end user. Please reach out and trouble shoot to resolve.
Kind Regards,
Automated report message - Select both the report job information and stack trace.
- Document the template
- Click save button.