Topic: Report Tools
Version(s): Version 5.1 and up 
Editions: All Editions

---

Report Tools

1. View Report  - Displays results
   
1. Displays the toolbar 
2. Hide Controls - Hides report filters at the top of the screen
   
1. Show Controls - Displays report filters at the top of the screen
3. Show Schedules  - Displays list of scheduled reports
   
4. Show Instances - Displays list of previously ran and pending reports. Click on the status to review the job log.
   
5. Close  - Close out of the report popup.

View Report

Toolbar

The report toolbar provides page navigation, zoom, refresh, search, export, print, and data feed functionality for reports that are rendered in the HTML rendering extension.

The following table describes commonly used features of the report toolbar. Each feature is identified by the control that you use to access it.

	Page Navigation Controls	Open the first or last page of a report, scroll through a report page by page, and open a specific page in a report. To view a specific page, type the page number and press ENTER.
	Page Display Controls	Enlarge or reduce the size of the report page. In addition to percentage-based changes, you can select page width to fit the horizontal length of a report page in the browser window, or whole page to fit the vertical length of a report in the browser window. a zoom option is supported by Microsoft internet explorer 5.5 and later.
	Search Fields	Search for content in the report by typing a word or phrase that you want to find (the maximum value length is 256 characters). The search is case-insensitive and stars at the page or section that is currently selected. only visible content is included in a search operation. to search for subsequent occurrences of the same value click next.
	Export Formats	Open a new browser window and render the report in the selected format. The formats that are available are determined by the rendering extensions that are installed on the report server. Click Export to view the report in the selected format. Word view the report in Microsoft Word, a .docx file Excel view the report in Microsoft Excel, an .xlsx file PowerPoint Each page in the report becomes an individual slide in PowerPoint. PDF view a report using a client-side PDF viewer. You must have third-party PDF viewer to use this format Accessible PDF TIFF file - recommended for printing view the report in the default TIFF viewer. For some Microsoft Windows clients, this is the Windows Picture and Fax Viewer. Select this format to view a report in a page-oriented layout. MHTML (web archive) View the report in an MIME-encoded HTML format that keeps images and linked content together with a report CSV (comma delimited) View a report in a comma-delimited format. The report opens in an application that is associated with the CSV file type. XML file with report data View a report in XML syntax. Reports viewed in XML open in a new browser window Data Feed View a report in a flattened representation of the report data.
	Go Back To Parent Report Icon	Will be grayed out if no parent report.
	Printer Icon	Open a print dialog box so that you can specify print options and print a report. on first use, clicking this icon prompts you to download the print control.
	Report Refresh Icon	refresh the report. data for live reports will be refreshed. cached reports will be reloaded from where they are stored.

*Please note that OrderLogix does not support all formats for all reports.  We do our best to make the "Export Formats" available in all reports, but there are limitations with certain reports that will not allow them to export in all formats. Please contact Support should you feel your report not exporting correctly is a mistake. 

1. None - the job will only run within OLX and job history will only be available via Process History or Show Instances.
   
2. FTP
   
1. 
   
2.  if the delivery method is email of ftp and the file contains sensitive data, an encryption method must be selected, or the file will not be delivered.
3. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
   
4.  allows you to test connection from the system to the Server address provided
5. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
   
6. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
7. Username - This is the username for the remote server.
8. Password - This is the password for the remote server.
3. SFTP (SSH)
   
1. 
   
2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
3.  allows you to test connection from the system to the Server address provided
4. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
   
5. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
6. Username - This is the username for the remote server.
7. Password - This is the password for the remote server.
4. FTPS (SSL)
   
1. 
   
2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
3.   allows you to test connection from the system to the Server address provided
4. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
   
5. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
6. Username - This is the username for the remote server.
7. Password - This is the password for the remote server.
5. Email
   
1. 
2.  if the delivery method is email of ftp and the file contains sensitive data, an encryption method must be selected, or the file will not be delivered.
   
3. From Address
   
1. The email used here should be setup in your system already
4. Email Address
   
5.  allows you to test connection from the system to the email address provided
   
6. CC
   
7. Subject
   
8. Message
   
9. Alias
   
1. There may or may not be alias available to be inserted into the email template. Each report will be different.

1. None
   
1. no encryption method will be used
   
2. 
   
3. File Name - Name of file created from job and sent to option set on Delivery tab.
   
   
2. Zip 
   
1. 
   
2. File Name - Name of file created from job and sent to option set on Delivery tab.
   
3. File Password entered here is the password needed to unzip the file and pull the information into the external system.
   
4. Confirm Password entered above.
3. PGP
   
1. 
   
2. File Name - Name of file created from job and sent to option set on Delivery tab.
3. PGP Key Option - select the PGP from the drop down.
1. Secure Downloads (orderlogix.com)
   

Delete Existing Schedule

Creating Schedule

Have the configuration and delivery already set for job being scheduled. You will have to save the job after changes are made to any settings.

To create a schedule, navigate to schedule editor popup on the right side of the screen.

To modify an existing schedule click on the maximize arrow beside the schedule name and the attributes for that schedule will be displayed.

To close the view of that schedule click on the minimize arrow beside the schedule name and you will be returned to the list of the schedules in the editor.

To add a new schedule click on the Add  button located in the Edit Schedules window and a new schedule will appear:

The toggle  button allows you the option to setup the new schedule either based off Time or Linked to another scheduled job.

Time - Schedule Type

1. New Schedule - Enter the name of the schedule. 
   
2. Choose when the schedule will run from the Month, Day, Hour, and Minute drop down menus.
   
1. Month,
   
1. Every - to run the schedule every month, select every.
2. Month Specific - to run the schedule only one specific month you can select the name of the month.
2. Day,
   
1. Daily - to run the schedule every day, select daily.
   
1. A list of the days of the week will display. Select the day(s) you want the schedule to run:
2. 
   
2. Date Specific - to run the schedule on a specific date you can select the numerical value of that date. 
   
1. example 15 = 15th of the month
3. Hour, 
   
1. Every - to run the schedule every hour, select every.
   
1. If Every is selected you will notice a settings icon display beside Hour - 
   
2. Click on the settings icon to display the Hourly Options popup
   
1. 
   
2. Range Start - this designates what time of the day the job will begin running.
   
1. Click on the clock icon immediately to the right  to display the Time Picker popup with a list of every hour.
   
2. 
   
3. End - this designates what time of the day the job will stop running.
1. Click on the clock icon immediately to the right  to display the Time Picker popup with a list of every hour.
   
2. 
   
4. Add Time - this will set the times for the job to run between the above Start and End range
   
1. Toggle the Add Timebutton
   
2. select the duration of how often the job should run between the Start and End range
   
1. 
   
3. click on Add once you've made your selection
   
1. The schedule times will display beside a red X
   
1. 
   
4. Click on the red X to delete any time listed that you do not want the job to run.
   
5. If you have time listed in this box the Minute option will be disabled
5. Close - this will close the popup
2. Hour Specific - to run the schedule only during a specific hour you can select the hour.
   
1. example am 08 = 8:00 am - 8:59 am
4. Minute
   
1. Enabled
   
1. Every - this will run the job every minute of the hour/s selected.
   
2. Every 5 - this will run the job every 5 minutes of the hour/s selected.
3. Every 10 - this will run the job every 10 minutes of the hour/s selected.
4. Every 15 - this will run the job every 15 minutes of the hour/s selected.
5. Every 30 - this will run the job every 30 minutes of the hour/s selected.
6. 00 - 59 - this will run the job only for the specific minute of the hour/s selected.
   
1. example: if you select 03 here the job will run 1:03, 2:03, 3:03 etc. 
2. Disabled
   
1. 
   
2. if utilizing time management from the Hour gear icon the Minute option will be disabled
   
1. if only utilizing start and end time from the Hour gear icon you will still be able to use the Minute option
3. Schedule is Active - check this box to activate schedule
   
1. Uncheck this box to deactivate a schedule
4. If you need to delete the schedule click the delete  icon.
   
5. Click Alert envelope to setup the Process Alert

Linked - Schedule Type

1. New Schedule - Enter the name of the schedule. 
   
2. Choose when the schedule will run:
   
1. Job Type - drop down provides different types of jobs within your system to narrow down the options for the Schedule drop down (see below)
   
2. Schedule - drop down provides a list of all schedule jobs within the above selected Job Type
   
3. Condition -
   
1. Unconditional - Every time the above selection runs, the newly created job will run directly after
   
2. On Success - Only if the above job runs successfully will the newly created job will run directly after
3. On Failure - Only if the above job fails will the newly created job will run directly after
3. Schedule is Active - check this box to activate schedule
   
1. Uncheck this box to deactivate a schedule
4. If you need to delete the schedule click the delete  icon.
   
5. Click Alert envelope to setup the Process Alert
   

If the job is linked to another job you will not see any records in the Show Upcoming section.

Process Alert

Process Alert notify you of key pieces of information for the task depending on the status; Unconditional, Successful, or Failed. Process Alerts are a great way to stay proactive within your system.

1. Click on the "Alert" Envelope  located beside the "Schedule is active" checkbox and a Process Alert window will appear.
   
   
2. Enter the name of the Alert.
   
3. Select from the drop down menu whether the alert should be sent unconditionally, if the job runs Successfully, or on Failure.
   
   
4. Enter the from email address to match the DefaultDeliveryProfile setup in your instance.
5. Enter the email address that the processing alert is to be sent to. 
   

   Note: You can verify the email address by clicking on the  "Validate Email" button .
   
6. Enter any CC recipients in the "CC" field, and separate multiple addresses by semi colons.
   
7. Enter the subject of the email.
   
8. Enter the body of the email message.
   
9. Place the cursor where you wish to add an alias.
   
1. Select the alias from the drop down menu.
   

   EndTime - {EndTime} is Job Ending Time
   

   JobLog - {JobLog} is the job log messages
   

   JobName - {JobName} is Job {FileName} 
   

   JobStatus - {JobStatus} is Job Status e.g Pending, Running, Succeeded, Failed, Cancelled, SysCancelled
   

   StartTime - {StartTime} is Job Starting Time
   

   
   
2. Click the Insert  button.
   
10. If you need to have more than one alert set up with different criteria for a given job, select the "Select Other" button  which will prompt a dialog box asking if you want to keep changes for this alert. 
    
    
11. By clicking "OK" you will be brought to the process alert lister screen, allowing you to add multiple alerts and edit any existing alerts.
    
    

• Click the  Save button, the changes will be saved and the Edit Schedule window will close.
  
• To cancel any of the current changes you have made, click the  Cancel button. This will close the Edit Schedule window without saving any changes.

Show Instances

Clicking the Show Instances  button will display a popup that lists the most recently ran jobs followed by scheduled upcoming jobs for this section of your system.

1. ID - this is the jobID; can be referenced on the Process History screen
   
2. Name - name of the job
   
3. Start - day and time the job started; can be referenced on the Process History screen
4. Status -
   
1. Pending - job will run at a future date
   
2. Succeeded - job ran successfully but may or may not have errors found within the job log
   
3. Failed - job did not complete due to an error
   
4. SysCancelled - job was cancelled

Clicking on the status of jobs that have already ran will display a popup with the job log.