Harness the Power of Built-in Banner Functions

01/08/2014

Comments

Let’s get a virtual show of hands…how many of you have mastered the art of manually gathering a student’s home address? It works fine, right? That is, until you have students that don’t have that particular address type. How about calculating a person’s age? That one’s a little easier, but still has its quirks. Alright, one more: How many of you have tried your hand at manually calculating a student’s GPA and total credit hours? That’s one that will haunt you in your sleep. Fear not—I have a remedy for those sleepless nights. It’s Banner to the rescue!

It turns out that there are a bunch of handy little functions that come built-in with your Banner implementation. They’re all hiding under the BANINST1 schema, the same schema that houses all of those object access views that so many of you love. These functions are used by Banner in many different places – forms, procedures, and yes, even those object access views. I have found in my travels that many database administrators keep these functions hidden away for security purposes, so you might need to talk to that person to see if they will give you access to use them in your Argos queries.

These functions don’t actually change any data in the Banner database. They simply give easier access to the information, or give you a way to easily calculate certain metrics without turning into an insomniac. In addition to making your code cleaner and easier to read, these functions may also be updated when there are Banner upgrades. So in the case that a table gets some significant updates, the functions against that table will also be updated. You will not need to go into every one of your queries and make changes to adjust for those changed fields.

Each function does something different, so it is very important to know what the purpose of the function is, what parameters (or variables) it requires to run, and what it actually passes back for output. In some cases, the function will return just a single value result. In others, it returns a string of delimited values that need to be broken up into smaller bits. And finally, some simply return a ‘ROWID’, which is the Oracle pointer to the location of the matching record in the database. The best way to learn what these functions do would be to look at the code, either using a database tool, such as SQL Developer or Toad, or by sitting with a DBA or an IT staff person who can show you what each of them does.

For reference, we’ve put together a brief rundown of some more popular functions we use in Solutions Development, along with the Ellucian-provided comments found within the function. Take a look:

BannerFunctions_ReferenceTable_thumbnail

Of course, the functions on that list are just the tip of the iceberg. There are many, many more functions in BANINST1 that could potentially make your queries much cleaner and easier to code. You may also find a function that is close to what you want, but missing a few key pieces of information or special processing specific to your institution. In those cases, you may want to create your own local functions that use existing Banner functions as a starting point. You can even create a whole new custom function of your own, from scratch. By creating local functions, you can extend the usefulness of your Banner implementation, without actually changing the Banner code. Remember, the creation of custom functions may be limited to your institution’s programming staff, so be prepared to provide them with as much information as possible so they can create the function of your dreams!

If you are using functions (standard or custom) that you think we should all hear about, please share it in the comments below! We love to hear how our customers are using our products to do some nifty tricks!

Like this blog?

You might want to check out this On Demand webinar:

Vicki Wayne is the Head of Client Success at Evisions. She has been in the higher education industry since 1998, gaining experience in both public and private institutions along her way to joining Evisions in 2012. Vicki is a certified Project Management Professional and has extensive functional and IT knowledge. She graduated from Purdue University in 2002 with a Bachelors of Management Information Systems, and in 2006, she received her master’s degree in Information Systems Management from Keller Graduate School.

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....

9 Comments

9 Comments

  1. Jay Thompson

    I have a lengthy (about 400 lines) text file that documents the built-in Banner functions that I have discovered (so far). Can the file be posted in this forum or would it be better to post it somewhere else?

    Reply
    • Vicki Wayne

      Jay –
      We’re trying to find out the best way for you to share this 😀 I’d love to peek if you’re willing to share, drop me a note via e-mail! — Vicki

      Reply
      • Jay Thompson

        How can I send an e-mail using this forum?

        Reply
    • Shaunna Jagneaux

      I would love to see your file!

      Reply
        • Daniel Chek

          Hi Jay,

          Would you mind sharing your text file of Banner functions. My email is d_chek@uncg.edu.

          Thanks so much,
          Dan

          Reply
          • Eric Goldman

            Hi Dan,

            Jay never provided us the file, and I don’t think he’s still with that college. But if I learn otherwise, I’ll let you know.

            Eric Goldman
            Marketing Communications Specialist
            Evisions

  2. Judy Hefner

    Vicki, I noticed that the quick reference lists f_a* to f_g*, is this page one of a several page document? I use f_format_name in any query requiring a full name – commonly I use the following syntax: f_format_name(‘LFMI’, spriden_pidm) because Last, First Middle-Initial works well for reporting on financial accounts.

    Thank you,
    Judy

    Reply
    • Vicki Wayne

      Judy – these are just a handful of our more popularly used functions – there are certainly more, but I don’t have them documented as part of a larger document.

      Reply

Submit a Comment

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

Share This
X