{"id":61,"date":"2011-06-18T03:56:00","date_gmt":"2011-06-18T10:56:00","guid":{"rendered":"\/lisa\/post\/2011\/06\/18\/YAPS-on-SSRS-User-Documentation-Even-quicker-and-not-very-dirty-anymore.aspx"},"modified":"2021-11-24T11:26:37","modified_gmt":"2021-11-24T19:26:37","slug":"yaps-on-rs-docs-even-quicker-not-very-dirty-anymore","status":"publish","type":"post","link":"https:\/\/spacefold.com\/lisa\/2011\/06\/18\/yaps-on-rs-docs-even-quicker-not-very-dirty-anymore\/","title":{"rendered":"YAPS on RS Docs: Even quicker, not very dirty anymore"},"content":{"rendered":"

Last time<\/a> I wrote about an easy way to document SSRS reports, and suggested that we should try to use Report Descriptions in a disciplined manner, so that people choosing to browse RDLs (or other items) in the default Report Manager interface had a chance in heck of figuring out what each item represented.<\/p>\n

\n

Here’s something you can’t do …
— Wash<\/a><\/h4>\n<\/blockquote>\n

What I neglected to mention, because I hadn’t noticed it, was that Report Descriptions don’t show up in standard view (versus “Details View”) in the SSRS 2008 Report Manager.<\/p>\n

I didn’t notice it because I would never personally advocate using the SSRS Report Manager UI as users’ standard interface into Reporting Services.<\/p>\n

Report Manager is a nice, simple way for administrators (who are perfectly happy to work in Details view) to upload, browse, and otherwise, um, manage<\/em> reports, datasources, and related uploaded file resources. It’s not suitable for end-users, and doesn’t match the overall experience you’re trying to give end-users. It’s just plain jarring.<\/p>\n

IMHO, the best possible reason for the SSRS SOAP APIs is that they give you all the tools you need to build your own alternative RDL browse, suitable for embedding into your custom application interface. Sure, I’ll use them for programmatic invocation of RDLs<\/a> occasionally, but I really prefer the URL Access API<\/a> for that.<\/p>\n

For those of you who do<\/em> insist on exposing Report Manager to end users, I’m happy to report that this is one of many things that the SSRS 2008 R2 Report Manager fixes, or at least improves. <\/p>\n

The screen shot below shows the R2 Report Manager UI in what’s now called “Tiles View” (aka the old default\/standard view, which some of our users insisted on calling the “Hide Details View”, since there really wasn’t anything else to call it).<\/p>\n

Note that the Descriptions have to be pretty short, to avoid getting truncated with an ellipsis.  But the restriction concentrates the mind wonderfully on creating the pithy and focussed type of description that will really help your users anyway.<\/p>\n

 <\/p>\n

\"\"<\/p>\n

 <\/p>\n

\n

M: You think she’ll hold together?
Z: She’s torn plenty, but she’ll fly true.
M: Could be bumpy …
Z: Always is.
— Capn Malcolm & Zoë<\/a><\/h4>\n<\/blockquote>\n

The example image above, a set of old examples on my personal box, is lightly branded using a technique for branding RS 2008 R2 that I’ve shown you elsewhere<\/a>.  I’m experimenting at home with a proper “look” for a coming migration of SRCS’s<\/a><\/span> 400+ user-accessible reports to an R2 instance.<\/p>\n

At the same time, rest assured,  I’m also working on custom application embedding of new reports. But when you start with a catalog as deep as this one, you have to pick your battles.<\/p>\n

Most of our RDLs aren’t very complex, but a few are. And some of them were written for SSRS 2000 originally, I suspect.<\/p>\n

It will be interesting to see how our report development techniques survive the upgrade. I’ll keep you posted.<\/p>\n","protected":false},"excerpt":{"rendered":"

Last time I wrote about an easy way to document SSRS reports, and suggested that we should try to use Report Descriptions in a disciplined manner, so that people choosing to browse RDLs (or other items) in the default Report Manager interface had a chance in heck of figuring out what each item represented. Here’s somethingRead more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[],"class_list":["post-61","post","type-post","status-publish","format-standard","hentry","category-reporting"],"_links":{"self":[{"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/posts\/61","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/comments?post=61"}],"version-history":[{"count":1,"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/posts\/61\/revisions"}],"predecessor-version":[{"id":503,"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/posts\/61\/revisions\/503"}],"wp:attachment":[{"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/media?parent=61"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/categories?post=61"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/spacefold.com\/lisa\/wp-json\/wp\/v2\/tags?post=61"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}