Leveraging Banner APIs To Streamline Your Reporting Environment

03/17/2014

Comments

Everyone loves a good shortcut to save time and make things more efficient, and when it comes to a complex system like Banner, sometimes we need all the help we can get. That’s where APIs come in.

Application Programming Interfaces allow users to access a system from outside, and dictate how software components interact with each other. We already use them every day online without even realizing it. For example, when a website asks you to log in with your Facebook username and password, that site is calling the Facebook Login API, which sends your credentials to Facebook’s servers to verify that you are who you say you are. Not only can APIs save time and eliminate frustration, but by incorporating and leveraging them in a system, they streamline processes across multiple platforms and facilitate communication with different systems.

Banner comes equipped with many built-in APIs that are waiting to be called upon, and because the same people who make the software write the APIs, they can be quite powerful. Leveraging Banner APIs can enhance many aspects of your Argos experience, but one of their biggest advantages is that they can do a lot to improve overall process flow.

Say for example, you work in a registrar’s office and have an Argos DataBlock set up to create new records in the Banner Student module. Without an API, you’d go into your Argos form, enter the information, and hit save. But then, without realizing it, you will likely have only updated the main student table, without populating or error-checking a variety of other associated tables. Using an “Insert” API though, would ensure that all of the relevant tables and checks are filled in and completed on Banner’s backend.

Think of an API as precompiled code that makes sure all your i’s are dotted and t’s are crossed (or in this case, all your fields are filled and tables are populated). You eliminate the risk of human error that comes with having to input and modify information in more than one place. It also makes it easier to ensure that all institutional processes are being followed consistently. By using APIs for things like inserting a student or updating contact information, you can ensure Banner is being modified correctly, even when you’re doing it from an outside source like Argos.

Using Banner APIs in Argos, you’ll not only save yourself a headache or two in terms of data input and integrity, but when it comes time to update from Banner 8 to Banner 9, you’ll significantly cut your chances of needing to modify your DataBlock code.  If you hardcoded the addition of new students in Banner 8, for example, when your institution moves to Banner 9 your DataBlock might no longer work because the new version requires more columns in its tables. However, the API code would be automatically updated, which would ensure that any DataBlocks using the API would make the transition smoothly.

Ready to get started? The Banner APIs that are available contain three sets of PL/SQL packages — primary, rules, and strings packages — and standard sets of procedures and functions, such as Query, Insert, Update and Delete. You’ll need to be familiar with Banner’s backend, PL/SQL, and calling procedures, plus you’ll need the necessary database permissions. And if you don’t have all those things but Banner APIs still sound like the answer to your problems, you can always ask your database administrator about incorporating APIs into your system.

Like this blog?

You might also like this On Demand webinar:

Related Posts

Evisions CO-OP: Top 10 Most Viewed Argos DataBlocks

Evisions CO-OP: Top 10 Most Viewed Argos DataBlocks

The Evisions CO-OP User Community is a collaborative place where clients can share ideas, experiences, development, forms, DataBlocks, and reports with their peers. To give you an idea of what fellow Argos users are doing and looking at, we present the Top 10 Most...

Navigating the Evisions Customer Community

Navigating the Evisions Customer Community

The Evisions Customer Community has always been an invaluable tool for clients. It serves as a resource for peers in higher ed to share knowledge and find answers. On May 7, 2019, a new community portal was launched. Why? Because we listened when our clients told us...

Shining the Light on SQL Variables in Argos

Shining the Light on SQL Variables in Argos

When an institution begins its reporting efforts – let’s say after recently changing databases or reporting tools – one of the first steps usually taken is to replicate what they had before. Often, this means creating some type of file and distributing it to users....

3 Comments

3 Comments

  1. Rhoni A. Ryan

    Great article Jeff! We use APIs here extensively here at Swarthmore, and one interesting tid-bit I just found out about Banner APIs is that all APIs are identified in the GURMESG table:

    SELECT * FROM GENERAL.GURMESG;

    Easier than looking through Banner documentation 😉
    Thanks again!
    -Rhoni

    Reply
    • Tony C

      Mr. Ryan,

      I am new to the higher ed world. I come from a MS background (C#,VB.NET and SQL SERVER). I am getting up to speed on Banner and all the programs here. I am interested in your expertise with the APIs.

      I am looking to “automate” a course setup. Basically, a faculty provides an excel spreadsheet with the courses and we want to automate the setup. I believe I need to so this in SSBSECT and SSRMEET.

      I have read about a specific Business Entity API (in the Banner API Spreadsheet by Product and Program) regarding a Course API but cannot find any documentation. Would you have some foresight or guidance? This will be a C# web application. I am fine with coding it but need a little guidance on connecting to the API and what I would be looking for.

      Thank you,
      T

      Reply
  2. Jeff O'Malley

    Thanks Rhoni! I will share this information in my presentation this weekend!

    -Jeff

    Reply

Submit a Comment

Your email address will not be published. Required fields are marked *

Share This
X