Print

Print


Hello,

Not on Alma, but in a different reporting system- 

We follow a similar structure to what Jordan described with personal folders for in progress objects & a production folder for finalized objects, but we handle naming slightly differently.

For any reports that are being put into production, we have a weekly code review where team members will present new reports. Once any necessary changes or issues are addressed, new reports are assigned a production ID such as PB_015. (PB is our reporting area, and distinguishes us from other teams). We have a master document that is indexed by report ID and holds a description of each production report, who originally created it, date it was approved, change log, etc. 

We try to write reports as templates so for example instead of writing a report specifically for orthopedics, if it is a generalizable report we would write it in such a way that it can have a parameter supplied at run-time. Then outputs of data from that report can be named according to report ID, parameter, and date such as PB_015_Ortho_202107

We are a big enough shop and have had enough turnover over time that we don’t require notifying the original report writer if you need to change a report, but we DO have code review and a documented process to ensure changes to a report don’t adversely or unexpectedly affect any report users.  This has worked pretty well for us, and having the master document for all reports also helps us keep track of things like which report templates get retired from production, which is hard to do without a centralized place to record such metadata. 

Hannah

> On Nov 5, 2021, at 11:22 AM, Jordan Pedersen <[log in to unmask]> wrote:
> 
> We have a handful of people creating reports, and follow this structure:
> 
> 
>  1.  In the Alma/UniversityofToronto/SharedFolders directory, each person with 'Design Analytics' should have their own named folder (e.g.- Jordan's report)
>  2.  A shared folder called 'Production' will house the reports that have been added to the Objects' list in Alma and are in active use by report consumers. These reports should follow the following naming conventions, and should NOT be moved out of folder or edited without notifying the report owner.
>  3.  Naming conventions for the reports in 'Production' - first component of the report name should be the AUTHOR'S initials, followed by a meaningfully descriptive report title.  If the report is being created for one specific individual or library's use, add the suffix 'For Klara/For Dentistry' to the end of the report name.
> 
> 
> ________________________________
> From: Code for Libraries <[log in to unmask]> on behalf of Hammer, Erich F <[log in to unmask]>
> Sent: Wednesday, November 3, 2021 1:02 PM
> To: [log in to unmask] <[log in to unmask]>
> Subject: [CODE4LIB] Analytics naming conventions
> 
> Hi.
> 
> We have (belatedly) realized that we would be much better off with a firm naming convention for our Alma analytics reports.  Currently, it's rather chaotic and nobody can identify what is important and what is left-over junk except (sometimes) the individual creators.
> 
> There are a few discussions about analytics naming conventions online, but they are focused on ecommerce sites.  We can use some of their thinking to create our own convention, but I thought maybe my job could be a bit easier if someone else has already done this.  ☺
> 
> So... Does anyone here have a working, analytics-reports, naming convention (and are willing to share it)?
> 
> Thanks,
> Erich
> 
> 
> 
> --
> Erich Hammer            Head of Library Systems
> [log in to unmask]         University Libraries
> 518-442-3891              University @ Albany
> 
> "Extraordinary claims require extraordinary evidence."
>                                      -- Carl Sagan