wiki:Software/Manual/WizardWalkthrough

Version 6 (modified by smith@…, 6 years ago) (diff)

--

Walkthroughs - Using the Raptor Wizard

Walkthrough 1 - JUSP and Shibboleth IdP data broken down by department for a particular month

In this walkthrough, we have the following scenario. We've looked at the JUSP data and found that Science Direct is the most used resource in terms of downloads. So, we want to take that data and alongside it show authentications to Science Direct via SAML (the Shibboleth IdP) broken down by departments. This will allow you to get a rough idea of which departments might be the biggest users of this particular resource.

So we'll be using the Wizard to graph JUSP data for a given time period (the previous month), and for the same time period, Shibboleth IdP authentications broken down by department.

Step 1 - Loading the wizard

Click on the wizard tab of Raptor Web.

Step 2 - Creating a new report

Click on the "Create a new report" icon.

Step 3 - Choosing the reporting period

For this example, we want to look at the last calendar month's data. So in the dropdown, choose "Last Month".

Click next.

Step 4 - Choosing the event types

We want to look at JUSP data and Shibboleth IdP data. So in the dropdown, choose "JUSP Monthly" and click on add, then "ShibbolethIdP" and click on add again.

Click next.

Step 5 - Choosing which functions to use

For the JUSP data, we'd like to view all JUSP data for Cardiff for the chosen time period. So make sure the institution parameter for the JUSP data shows "car".

For the Shibboleth IdP data, we would like to group the data according to department. In Raptor this Group By field is "principalInformation.school", so choose that in the dropdown.

Click next.

Step 6 - Graph Options

The first set of options you can modify are which series are to be displayed, and appropriate filters. For the Jusp data, we want to show all JUSP data unfiltered, so simply leave these alone. For the Shibboleth IdP data we want to show only logins to Science Direct, so we need to apply a filter. Click on the add filter button, and set up a filter for "resourceId" "EQUALS" "https://sdauth.sciencedirect.com/" (the entityId for the Science Direct SAML Service Provider).

Click on Save, then next.

The second set of options you can modify are transformations to the data (for example sorting, cutting rows, etc). In this walkthrough, we don't need to use any of these, so click Next.

The third set of options are graph display options - type of graph, size, etc. For now the defaults are fine, but you might want to give the Graph a meaningful title - note that if you save this Report for reuse later, its name is derived from the Graph Title. So enter a title, e.g. "Science Direct usage in JUSP and Shib IdP broken down by school, last month".

Click next.

Finally, if you have multiple graphs (i.e. multiple data types), you are prompted whether you want the graphs to appear side-by-side or on top of each other.

Make your choice and click next.

Understanding the Results

You should now be presented with the data you requested. That is, JUSP usage for the last month in the top graph, of which Science Direct JR1 downloads dominate, then underneath, Shibboleth IdP authentications to the Science Direct SAML SP broken down by school. You can see that in this case, there are three departments which dominate the downloads.

Limitations

Using Raptor with data of differing types, such as JUSP and Shibboleth IdP, has certain limitations. For example, in this walkthrough, we used authentications to the Science Direct SAML SP to get an indication of which departments might be responsible for all of those JR1 JUSP downloads in Science Direct. However, the Science Direct SAML SP is actually a single SAML SP run by Elsevier that is responsible for authentications to both Science Direct and to Scopus. So, when using the Raptor wizard, all such conclusions must be considered purely indicative and not absolute.

Saving the report for reuse

If you wish to save this report for reuse in the future, simply click on the "save" button above the top graph.

Now, when you click on the "Wizard" button, this report will show in the list of saved reports. Click on the graph icon to the left of the title to rerun that Report! (Note that these reports are Dyanmic - e.g. one using "Previous SCONUL year" as a timeframe will always run for the previous SCONUL year relative to your current date.

Attachments