Setting Up your TRS Application

Setting up your TRS Application

The TRS Application Setup screen allows you to set up the report/process parameters, files, and screen links associated with a report or process. Additionally, you can add a Personify application/subsystem to the TRS system and define the parameters and files so that the related reports/processes function adequately.

Do not change the base parameters as it may cause the process to fail. However, you can change the checkboxes.

To create a new application setup:

1. From the toolbar, select Reporting > TRS Application Setup.

2. Click Create New.
The Reports Maintenance screen displays, as shown below.

3. Select the Subsystem from the drop-down.

4. Enter the Application.

5. Enter the Description.

6. Select the Submit Type from the drop-down.
If you select "Available for Batch Submission" or "Available for Both", please see Adding Job Files to a Report.
If you select “Available for Online Submission” or “Available for Both”, please see Adding Linked Screens to a Report.

7. Select the Application Type from the drop-down.

8. Enter the Program.

9. Enter the Job Priority.

10. Check the checkboxes that apply:

· Allow Concurrent Runs

· Allow Job Cancellation

Be careful when selecting the Allow Concurrent Runs checkbox because some reports, such as revenue recognition, will clog data.

11. Enter the Help Text for the report.

12. To add parameters to the report, perform the following:

a. Click Add.
A new row displays in the table and is selected by default.

b. Enter the Parameter Name.

c. Enter the Parameter Caption.

d. Enter the API Property Name.

Currently, it is not possible to enter a default value for a date parameter in an online report; when set to 'date', the default value is forced to be in the mm/dd//yyyy format, but if the user navigates back to submission, the date picker is blank. If you would like to default the date to today, you can do so by entering {ServerDate} in the API Property field in the Report Maintenance screen.

e. Enter the Data Field Name.

f. Enter the Default Value.

g. Enter the Display Order.

h. Select the Data Type from the drop-down.

i. Enter the Parameter Length.

j. Select the Control Type from the drop-down.

k. Select the Convert Case from the drop-down.

l. Select the Parameter Size from the drop-down.

m. Enter the Help Text for the parameter.

n. Enter the List SQL.

o. Check the checkboxes that apply:

i. Required

ii. Read Only

iii. Advanced Parameter

iv. Spell Check

v. Multi Select

13. Click Save.

14. You can then Upload the Report File and Refresh the Report Setup Parameters.

Screen Element	Description
Subsystem	Drop-down. The name of the subsystem with this report/process.
Application	Text box. The abbreviation and numerical representation of the name of the report/process application.
Description	Text box. The description of the report/process.
Submit Type	Drop-down. This describes the availability of the batch in the application and how to submit the job.
Application Type	Drop-down. This describes the type of application that this record represents. For example, Batch Executable or Crystal Report.
Program	Text box. The name of the application or crystal report format that needs to be launched to run this application.
Job Priority	Text box. This is the priority assigned to this job. The TRS daemon accesses jobs by priority, i.e., if two jobs are in the queue and one has priority 100 and the other one has a zero priority, then the 100 is picked up first. This can usually be kept zero in the TRS database table, however, while submitting the job, the TRS Job Parameter Setup screen assigns a default priority of 100 if it is zero, otherwise, it would carry the non-zero value from this table.
Help Text	Text box. This pertains to the end-user, this field provides non-technical help text as it relates to the purpose of this batch application. The help text is supplied by TMA Resources for base reports, but you can modify it as necessary.
Allow Concurrent Runs	Checkbox. When checked, Personify allows the process to run concurrently.
Allow Job Cancellation	Checkbox. When checked, indicates the user can submit a request for the job to be cancelled.
Job Parameters
Add	Button. When clicked a new parameter is added to the report.
Delete	Button. When clicked, the highlighted parameter is deleted from the report.
Parameter Name	Text box. The name of the parameter. This should be the same name that is expected by the batch process in the XML file.
Parameter Caption	Text box. The caption that displays when you submit a job. This is a description of the parameter name.
API Property Name	Text box. The property name of the parameter in the API.
Data Field Name	Text box. The parameter name that will be used to link the Data Field Name from screens for online reports.
Default Value	Text box. The default value supplied for the parameter. This value is used by submission screen if no value is specified for this job.
Display Order	Text box. The order in which the rows appear in the grid.
Data Type	Drop-down. The type of data that must entered in the field, for example, a date or a number.
Parameter Length	Text box. The maximum number of characters in a parameter.
Control Type	Drop-down. This indicates what type of control will be used to display the parameter.
Convert Case	Drop-down. The case the entered text will be converted to.
Parameter Size	Drop-down. The size of the parameter.
Help Text	Text box. This pertains to the end-user, this field provides non-technical help text as it relates to the purpose of this parameter.
List SQL	Text box. The free-form SQL Statement used to populate a list of values. This will make the parameter a link. Click Test to verify that the code was entered correctly. When you click Test, if you receive an "Invalid SQL statement" error, please verify that your SQL statement contains a where clause. If the TrapMissingWhereClause in the config.xml is set to "True", the system will check to see if there is a where clause. If there is no where clause, the system will look to see if the number of rows returned would be less than or equal to MaxSelectMissingWhereClause. If not, the system displays the error message.
Test	Button. When clicked, the List SQL code is tested to verify it was entered properly.
Required	Checkbox. When checked, indicates the parameter is required for the end-user to select the value.
Read Only	Checkbox. When checked, you will not be able to change the values specified at the time of submission.
Advanced Parameter	Checkbox. Select if the parameter is to be included in the Advanced Parameter tab on the Job Submission screen.
Spell Check	Checkbox. This indicates that the Microsoft Word will check for spelling errors on entered values.
Multi Select	Checkbox.