Integrating Reports with Automated JAMS Jobs

JAMS includes a JAMSReport Execution Method to streamline reporting by allowing you to create scheduled Jobs to send out reports. For example, you could use the JAMSReport Execution Method to create a failure report at the beginning or end of the week.

When the JAMSReport Jobs are configured, they may be automated like any other JAMS Job with the use of a Schedule Trigger. See Triggers for more information. You can also use an Email Report Schedule Item to send the report to a list of recipients. See Reports for more information on configuring this and a connection to a mail server.

Using Parameter Values with Reports

When the Job is submitted to run, you can manually enter the Parameter values, or you can set up default values on the Parameters. These default values ensure the JAMSReport Job always runs with the proper information to be emailed, printed, or saved to location on a drive.

You can use the Report Designer option in JAMS to create custom reports and then run them from a JAMSReport Job. Any Parameter values that are present on the Job are automatically mapped to matching Parameter names on the report at execution time.

note

When a report is selected in the JAMSReport’s Job source, Parameters from the Report definition in the Report Designer are not automatically pulled into the Job’s Parameters tab, so they need to be added manually, if required.

Parameters to Add By Report Type

The date/time format may vary based on your region/PC settings.

The default StartDate/EndDate will vary by the type of report. Ensure you set these values as needed for your report data. The default date/time format is shown in the sections below for the default value.

Audit Trail

Parameter Name	Data Type	Default Value
Server	Text	""
StartDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
EndDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
UserName	Text	""
ObjectType	Text	"Any"

Current Schedule

Parameter Name	Data Type	Default Value
Server	Text	""
StartDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
EndDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
JobName	Text	*
SubmittedBy	Text	*
IncludeCompleted	Boolean	False
IncludeExecuting	Boolean	True
IncludeHolding	Boolean	True
IncludePending	Boolean	True
IncludeRetained	Boolean	False
IncludeTimed	Boolean	True
IncludePrerequisite	Boolean	True
IncludeResource	Boolean	True

Job Definition

Parameter Name	Data Type	Default Value
Server	Text	""
JobName	Text	*
FolderName	Text	\
Recursive	Boolean	False

Folder Definition

Parameter Name	Data Type	Default Value
Server	Text	""
FolderName	Text	\

History

Parameter Name	Data Type	Default Value
Server	Text	""
StartDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
EndDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
JobName	Text	*
FolderName	Text	\
SubmittedBy	Text	*
CheckScheduled	Boolean	True
CheckHold	Boolean	True
CheckStart	Boolean	True
CheckCompletion	Boolean	True
IncludeSuccess	Boolean	True
IncludeInformational	Boolean	True
IncludeWarning	Boolean	True
IncludeError	Boolean	True
IncludeFatal	Boolean	True
SearchRecursively	Boolean	True

Projected Schedule

Parameter Name	Data Type	Default Value
Server	Text	""
StartDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
EndDate	DateTime	mm/dd/yyyy hh:mm:ss AM/PM
JobName	Text	*
FolderName	Text	\
IncludePlanned	Boolean	True
IncludeRepeated	Boolean	True
IncludeTriggered	Boolean	True

Setting Up a JAMS Report Job

Before You Begin

Ensure you have created a JAMS Credential with the appropriate permissions to run the Job. See Working with User Credential Definitions for more information.

If you want to add an Email Schedule item, ensure you have a mail server configured in the Connection Store. See Connections to Mail Servers for more information.

1. Click Definitions from the Shortcuts menu.
2. Click a Folder where the Job will be saved.
3. Click + to add a new Job.
4. In the Name field, enter a name for the Job.
5. In the Execution Method field, select JAMSReport.
6. Click Ok.
7. Click the Source tab.
8. Define the report properties as desired for the report.

Report Job Property	Description
Report Name	Select a predefined JAMS Report.
Export Path	Enter the location where the report should be saved.
File Name	Enter the name for the report file.
Print Queue	Enter a printer queue to output the report.
Export Format	Use the drop-down menu to define a file format for the report. The supported formats include: PDF, HTML, CSV, RTF, Text, Xls (Excel) or Print. Note that using the Print option will send the report output directly to the default printer.
Number of Copies	Set the number of copies to print.
Margins	Enter the margins of a report page (measured in hundredths of an inch). When setting this property, the value should be entered as “Left,Right,Top,Bottom”. For example, a 1” top and bottom with .75” side margins would be entered as “75,75,100,100”.
Paper Height	Enter the height of the report page, measured in hundredths of an inch. This property can be enabled only if Paper Kind is set to Custom.
Paper Width	Enter the width of the report page, measured in hundredths of an inch. This property can be enabled only if Paper Kind is set to Custom.
Orientation	Select the page orientation - landscape or portrait.
Paper Kind	Enter the type of paper for the report. If this is set to Custom, the printer paper is selected according to the property's value, and its size is set to the Page Height and Page Width Paper Name property values.
Paper Name	Enter the name of the custom paper that is used in the output printer. This can only be set if the Paper Kind is set to Custom.
Printer Name	Enter the printer to use for outputting the report.

9. Define additional Schedule Items, Parameters, Security, Properties, and Documentation as desired.

note

To schedule the report job, add a Schedule Trigger to the Job. See Triggers for more information. A Report Job may also be manually submitted at any time.

10. Click the Properties tab.
11. In the Execute As field, select a JAMS Credential to run the Job.
12. Click Save and Close.