Create a query for third-party applications

Use this procedure to create a query for accessing Aspen data via a third-party application.

To create a query:

  1. Log on to the District view.
  2. Select Tools > Queries.
  3. Select Options > New Query.
  4. Use the table to complete the fields.
    FieldDescription

    Query name

    Type a descriptive name for the query.

    Root table

    Use the drop-down to select the root table that has the field or fields you want to access. Click Set.

    Related tables

    If you want to join a related table, select it in the Related tables field, and then click Join.

    Selected tables

    This field is automatically populated when you set the Root table.

    Available fields

    Use the drop-down to select the field you want to use.

    Output fields

    Click Add to populate this field based on the selection you made in Available fields.

    Filter fields

    Click Filter to open the New Query Filter pop-up. Enter a Parameter, and select an Operator.

    Example: If you are querying to determine who is buying a lunch, you may look for the value in the Buy Lunch field on the Student Lunch table. The parameter in this case would be Y, and the operator would be Equals.

    Sort fields

    If you have more than one field you are collecting data from, you can determine the order using this field.

    Security roles

    Use the drop-down to select a security role. Click Add to apply the security role you selected. The security roles should match the roles the user has in the OAuth access point.

    Selected roles

    This field is automatically populated with your selection in the Security roles field.
  1. Click Save.