Page tree
Skip to end of metadata
Go to start of metadata

Custom Report Integration Functions

The 25Live Administration Utility can be used to integrate custom reports created by your institution into 25Live. It allows authorized 25Live users to perform the following custom report integration functions:

  • Define custom reports and add them to 25Live
  • Copy existing standard and custom report definitions as the basis for creating new custom report definitions
  • Edit custom report definitions
  • Delete custom reports from 25Live

Report Engine

When adding a report, you need to select a report engine. The choices are WebServices or Interactive Reports.

WebServices

WebServices is a method for drawing data out of your Series25 database and converting it to Extensible Markup Language (XML) format. 25Live is built on WebServices which provides an intermediate step between the Series25 database and the 25Live application.

Because XML is a standardized format that is recognizable by many applications and protocols, it is possible for Series25 data to be transformed into many different contexts. For example, it can be converted to .pdf or spreadsheet form, read as a table in a web browser, or imported into third-party applications for digital signage and other uses.

Interactive Reports

Interactive Reports produces reports in multiple formats, including .pdf, .xls, .doc, .rtf and HTML. It can also email reports. Its Designer tool, which is included with 25Live, is a desktop application that provides a drag and drop GUI interface for developing custom report templates. It lets users design, develop, and test custom reports prior to integrating them into the 25Live production environment.

The Designer creates report templates. At runtime, these templates are populated with data retrieved using the WebServices API. Templates are connected to WebServices through Data Sources which represent connections to individual WebServices. Data Sources are defined and managed within a Designer component known as the Catalog.

For information on creating Interactive Reports, see Creating Custom Reports Using the 25Live Interactive Report Designer.

Report Parameters

If you want 25Live users to specify relevant values for report generation to filter records or create a subset of data, you need to define the parameters of your custom report on the Add Report page. For example, you may want the user to supply a date range, an object, or a search as a parameter.

If you specify a search parameter, only the objects selected in the search are processed in generating the report.

If you specify an object parameter (organization, contact, requirement type, or organization type), 25Live performs error checking on the value entered for the parameter in generating the report to ensure that an existing internal identifier matches the user’s entry.

To help ensure predictable report results, it is recommended that you require a value for each of your report parameters. If you don’t, the generated report may not include all the expected data or, in some cases, any data.

You must choose the data type of each parameter you define.

If you choose...The user generating the report must...
StringEnter alphanumeric text (maximum 80 characters)
IntegerEnter a whole number
FloatEnter a number that may include a decimal
DateEnter a date
TimeEnter a time
Date/TimeEnter a date and time
DurationEnter a time duration (days/hours/minutes)
BooleanSelect Yes or No
Event SearchSelect the name of an existing event search
Organization SearchSelect the name of an existing organization search
Location SearchSelect the name of an existing location search
ResourceSelect the name of an existing resource search
ObjectSelect an organization, contact, requirement type, or organization type

To Define and Add a Custom Report

  1. In the 25Live Administration Utility, select the Reports tab.
  2. Select the Import Manage Reports task tab.
  3. Click ADD to go to the Add Report page.

  4. Enter the name of the report as you want users to see it in 25Live.
  5. Choose the Report Engine from the drop-down list.
  6. Choose the appropriate Report Group for the report from the drop-down list.
  7. In the Filename field, enter the name of the .xsl (WebServices) or .cis (Interactive Reports) file you created for the report and placed in the ASV custom reports directory.
  8. Define report parameters as needed. Enter the parameters in the order you want them presented to users generating the report. To define a parameter:
    1. Click New Report Parameter.
    2. Enter the parameter name as you want it to appear to 25Live users when they are specifying parameters for the report.
    3. Choose the parameter’s data type from the drop-down list.
    4. From the Field Mapping drop-down list, choose the field in the RPT_PARM_VALUE record where the user-supplied value for the parameter should be stored.
    5. If you chose “Object” as the parameter’s data type in step c, choose the object type from the Validation drop-down list.
    6. If the user must enter a value for the parameter, select “Yes” for Value Required.
    7. Repeat these steps to define additional parameters.
  9. Select the object security of the report for each 25Live security group. See Defining the Object Security of Reports.
  10. Click Add Report.

To Copy a Report Definition and Add a Custom Report

Rather than starting from scratch to define a new custom report, you can use the Add Report via Copy page to copy the report definition of an existing standard or custom report as the basis for defining a new custom report, and then add the new report to 25Live.

  1. In the 25Live Administration Utility, select the Reports tab.
  2. Select the Import Manage Reports task tab.
  3. Click COPY.
  4. Find the report you want to want to copy, highlight it, and click Copy.
  5. On the Add Report via Copy page, enter the name of the new report as you want users to see it in 25Live.
  6. Choose the appropriate Report Group for the report from the drop-down list.
  7. In the Filename field, enter the name of the .xsl (WebServices) or .cis (Interactive Reports) file you created for the report and placed in the ASV custom reports directory.
  8. Modify the report parameters as needed.

    To...Do this...
    Add a new parameterFollow step 8 of "To Define and Add a Custom Report."
    Modify a parameterChange the parameter fields as needed. See Report Parameters and step 8 of "To Define and Add a Custom Report" for guidance.
    Remove a parameterClick its Remove (red X) icon.
    Change the presentation order of a parameterUse the up and down arrows to move the parameter up or down in order.
    Change the report engineUse the drop-down list to change report engines. The choices are WebServices or Interactive Reports.
  9. Select the object security of the report for each 25Live security group. See Defining the Object Security of Reports.

  10. Click Add Report.

To Edit a Custom Report Definition

The Edit Reports page lets you edit the definitions of custom reports that have been previously added to 25Live. You can’t edit the definitions of standard reports, although you can copy them as the basis for defining new custom reports.

  1. In the 25Live Administration Utility, select the Reports tab.
  2. Select the Import Manage Reports task tab.
  3. Click EDIT.
  4. Find the custom report whose definition you want to want to edit, highlight it, and click Edit.
  5. On the Edit Reports page, modify the report name, report engine, report group, and/or filename as needed.
  6. Modify the report parameters as needed.

    To...Do this...
    Add a new parameterFollow step 8 of "To Define and Add a Custom Report."
    Modify a parameterChange the parameter fields as needed. See Report Parameters and step 8 of "To Define and Add a Custom Report" for guidance.
    Remove a parameterClick its Remove (red X) icon.
    Change the presentation order of a parameterUse the up and down arrows to move the parameter up or down in order.
    Change the report engineUse the drop-down list to change report engines. The choices are WebServices or Interactive Reports.
  7. Modify the object security of the report for 25Live security groups as needed. See Defining the Object Security of Reports.
  8. Click Save Changes.

To Delete a Custom Report From 25Live

  1. In the 25Live Administration Utility, select the Reports tab.
  2. Select the Import Manage Reports task tab.
  3. Click DELETE.
  4. Find the custom report you want to want to delete, highlight it, and click Delete.
  5. Click Delete Report to confirm.



Copyright © 2021 CollegeNET, Inc.  Note: This information is for CollegeNET Series25 customer use only.
Series25 Customer Resources • Terms of Use •  Privacy Policy • Learn About Series25 • Contact CollegeNET



Documentation For Administrators

25Live Pro Admin Utility Help