Report from Collection Builder

The Report from Collection retrieves a collection of records and uses those records to generate a report.

media_1481811169169.png

Select the type of datasource that will be used to generate the report.

media_1481811187651.png

The Datasource Criteria will be used to ascertain what records to be retrieved.

media_1481811195509.png

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

media_1481811216243.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481811234813.png

The Record Criteria will be used to ascertain what report to be retrieved.

media_1481811240165.png

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

media_1481811258081.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481811274520.png

Add any parameters the report may have.

Name – the name of the parameter within the report.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481811294842.png

File Path – the variable that will store the path the report will be saved too. Note: the variable will need to be set prior to this point in the script.

File Type – select the type of file the report will be saved as.

media_1481811310578.png

Click Yes to send the generated report to the default printer.

Created Script

media_1481811328635.png

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Get Records – get all records that match a specified Criteria.

media_1481811346011.png

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Report – retrieves the first report, in the database, that matches a Criteria and sets that ReportItem to a variable.

Set Report String Parameter – sets a report parameter to a value or variable that wil contain the value.

media_1481811353999.png

Generate Report with Data – sets the report datasource to a RecordCollection and generates the report.

Save Report – saves the generated report to a local file path.

Print Report – prints the report to the default printer.

Report from Record Loop Builder

The Report form Record Loop retrieves a record collection and generates a report for each individual record.

media_1481809869282.png

Select the type of datasource that will be used to generate the report.

media_1481809898707.png

The Datasource Criteria will be used to ascertain what records to be retrieved.

media_1481809993129.png

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

media_1481810022726.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481810064319.png

The Record Criteria will be used to ascertain what report to be retrieved.

media_1481810090828.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481810105693.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481810132293.png

Add any parameters the report may have.

Name – the name of the parameter within the report.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481810154229.png

File Path – the variable that will store the path the report will be saved too. Note: the variable will need to be set prior to this point in the script.

File Type – select the type of file the report will be saved as.

media_1481810174858.png

Click Yes to send the generated report to the default printer.

Created Script

media_1481810188910.png

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Get Records – get all records that match a specified Criteria.

media_1481810206834.png

Loop Record Collection – loops through each record retreived from the database.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Report – retrieves the first report, in the database, that matches a Criteria and sets that ReportItem to a variable.

Set Report String Parameter – sets a report parameter to a value or variable that wil contain the value.

media_1481810223178.png

Generate Report with Record – sets the report datasource to the current loop record and generates the report.

Save Report – saves the generated report to a local file path.

Print Report – prints the report to the default printer.

Report from Record Builder

The Report from Record Action Builder retreives a record based on its ID and generates a report with it.

media_1481809386613.png

Select the datasource that will be used to generate the report.

media_1481809411215.png

ID – select or type in the variable that will hold the record id.

Note: the ID is automatically passed into a Auto Script and held in the TargetObjectId variable.

media_1481809432186.png

The Record Criteria will be used to ascertain what report to be retrieved.

media_1481809923163.png

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

media_1481809451116.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481809469642.png

Add any parameters the report may have.

Name – the name of the parameter within the report.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481809490198.png

File Path – the variable that will store the path the report will be saved too. Note: the variable will need to be set prior to this point in the script.

File Type – select the type of file the report will be saved as.

media_1481809504189.png

Click Yes to send the generated report to the default printer.

media_1481809523198.png

Get Record Data – retrieves the record based on its ID.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Report – retrieves the first report, in the database, that matches a Criteria and sets that ReportItem to a variable.

media_1481809538388.png

Set Report String Parameter – sets a report parameter to a value or variable that wil contain the value.

Generate Report with Record – sets the datasource to a record and generates the report.

Save Report – saves the generated report to a local file path.

Print Report – prints the report to the default printer.

Create Report Builder

The Create Report Action Builder loads an existing report and generates it.

media_1481809014106.png

The Record Criteria will be used to ascertain what report to be retrieved.

media_1481809029347.png

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

media_1481809052212.png

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481809069242.png

Add any parameters the report may have.

Name – the name of the parameter within the report.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

media_1481809094496.png

File Path – the variable that will store the path the report will be saved too. Note: the variable will need to be set prior to this point in the script.

File Type – select the type of file the report will be saved as.

media_1481809115753.png

Click Yes to send the generated report to the default printer.

Created Script

media_1481809139260.png

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Report – retrieves the first report, in the database, that matches a Criteria and sets that ReportItem to a variable.

Set Report String Parameter – sets a report parameter to a value or variable that wil contain the value.

media_1481809156154.png

Generate Report – generates the report.

Save Report – saves the generated report to a local file path.

Print Report – prints the report to the default printer.

Overview of Builders

media_1481799590919.png

Action Builders are step by step wizards that help you build scripts quickly.

Click on the Action Builder and the Action Builder Wizard will pop up.

Set Report Decimal Parameter

media_1481828749994.png

Sets a ReportItem parameter to a decimal value.

media_1481828546541.png

Report – the ReportItem that has the parameters.

Parameter Name – the name of the parameter that will be set.

Parameter Value – the value or variable that will contain the value of the parameter.

Set Report Number Parameter

media_1481828704992.png

Sets a ReportItem parameter to a number value.

media_1481828522400.png

Report – the ReportItem that has the parameters.

Parameter Name – the name of the parameter that will be set.

Parameter Value – the value or variable that will contain the value of the parameter.

Set Report Date Parameter

media_1481828682637.png

Sets a ReportItem parameter to a date/time value.

media_1481828496759.png

Report – the ReportItem that has the parameters.

Parameter Name – the name of the parameter that will be set.

Parameter Value – the value or variable that will contain the value of the parameter.

Set Report Bool Parameter

media_1481828648745.png

Sets a ReportItem parameter to a bool (True or False) value.

media_1481828466319.png

Report – the ReportItem that has the parameters.

Parameter Name – the name of the parameter that will be set.

Parameter Value – the value or variable that will contain the value of the parameter.

Set Report String Parameter

media_1481828211715.png

Sets a ReportItem parameter to a string value.

media_1481828223558.png

Report – the ReportItem that has the parameters.

Parameter Name – the name of the parameter that will be set.

Parameter Value – the value or variable that will contain the value of the parameter.