EBMS Tickets

Issue Number 304
Summary Change CAM Board Name
Created 2015-07-21 15:41:12
Issue Type Task
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To alan
Status Closed
Resolved 2015-10-30 15:08:04
Resolution Fixed
Path /home/bkline/backups/jira/oceebms/issue.165675
Description

The CAM Board is changing its name. We should discuss in an upcoming CDR/EBMS meeting what will be affected by this change in the EBMS.

Comment entered 2015-10-05 11:07:59 by Kline, Bob (NIH/NCI) [C]

We'll need more specific requirements before we can assign story points for this ticket.

Comment entered 2015-10-05 15:33:52 by Juthe, Robin (NIH/NCI) [E]

Aside from needing to know the new name (which I will get for you but I don't believe has been finalized yet), do you need to know each page the Board name appears on? Or does changing the Board name in one place populate it elsewhere in the system?

Comment entered 2015-10-05 15:49:47 by Kline, Bob (NIH/NCI) [C]

A little of both. For some appearances, the ebms_board table tells the software what to display. For others, we were told "that's too long; use .... instead here."

Comment entered 2015-10-13 23:05:51 by alan
I searched the EBMS code looking for uses of "CAM", "cam", and
"Complementary" in the EBMS.  Here is what I found:

  reports.inc:
     if ($board == 'Cancer Complementary and Alternative Medicine')
       $board = 'Cancer CAM';

  about.inc:
    'Cancer Complementary and Alternative Medicine',
    'Experts in the fields of oncology, pharmacology, natural ' .
    'products, drug discovery and development, traditional ' .
    'Chinese medicine, acupuncture, and homeopathy.',

  roster.inc:
    'Cancer Complementary and Alternative Medicine',
    'Experts in the fields of oncology, pharmacology, natural ' .
    'products, drug discovery and development, traditional ' .
    'Chinese medicine, acupuncture, and homeopathy.',

  home.inc:
    'Cancer Complementary and Alternative Medicine',
    'Experts in the fields of oncology, pharmacology, natural ' .
    'products, drug discovery and development, traditional ' .
    'Chinese medicine, acupuncture, and homeopathy.',

Three of these are identical and might either all be revised
identically, or all refer to the same piece of text.  The one in
reports.inc should be very easy to fix too.

Unless this misses something really important, I think these changes
will be straightforward.


However, a search for the "board_name" database column finds 142 uses
in the system!  There are lots of menus, displays, and printouts on
which board names appear.  The big issue in these uses is that the CAM
board has the longest name.  Here are the lengths of all of the board
names:

Length  Name
------  ---------------------------------------------
   15 | Adult Treatment
   45 | Cancer Complementary and Alternative Medicine
   15 | Cancer Genetics
   19 | Pediatric Treatment
   24 | Screening and Prevention
   30 | Supportive and Palliative Care

If the new name is the same or very similar length, I expect that the
current EBMS graphic design should work fine.  If it's longer, then
there may be screens that get ugly or even break (text split across
lines, extending beyond borders, overlapping strings, making tables
too large, etc.) and which users will want to change.  If we have to
have meetings, mockups, graphic designers, and detailed additional
programming and "theming" because the name is longer, I think the
effort involved will likely dwarf the effort that we'd have if we
change the name to something close to the existing length.

If the new name is significantly shorter, there could also be some
screens that get funky, for example with text flows that look quite
different or screens with more empty space to the right of board names
than we'd like.  However I think the risk is less.

We could change any of the other board names with much less impact
because the long CAM name defines what the displays have to do and
leaves room for plenty of change in other board names.

If there is a significant length change we'll have to do a lot of
testing, potentially looking at every one of the 142 uses, to be sure
that it still works okay.
Comment entered 2015-10-14 16:12:25 by Juthe, Robin (NIH/NCI) [E]

The new name for the CAM Board is:

Integrative, Alternative, and Complementary Therapies

This appears to be 53 characters, 8 more than the previous name.

Do we have any wiggle room, or do we need to have precisely the same number of characters (or fewer) as the previous name? To achieve the same number of characters, if necessary, we could use:

Integrative Alternative Complementary Therapy

Comment entered 2015-10-15 10:07:39 by alan

I will implement the new name on DEV and we'll look at it. We may find that no changes are required and the wiggling is fine, or we may find that a few small changes are required, or we may find it's a big deal. The change is easy to make, after which we'll see where we are.

Comment entered 2015-10-15 11:49:03 by alan

I implemented the new name on DEV and tried a number of tests.

So far, everything looks fine. Some columns in the screen displays wrapped around to a second line, but nothing looked ugly or impractical.

For test purposes, I changed the Test Board Manager from Cancer Genetics to the Integrative... board. I propose to do the same on QA and then someone can test it by signing on as Test Board Manager on DEV, seeing Integrative... and as Test Board Manager on QA, seeing Cancer Comp..., and compare the screens.

Should I do that?

Comment entered 2015-10-15 11:53:00 by Juthe, Robin (NIH/NCI) [E]

I think we should keep the genetics Board association but add the Integrative Board (in other words, associate the account with two Boards). I can make the changes.

Comment entered 2015-10-16 14:24:56 by Juthe, Robin (NIH/NCI) [E]

Still testing, but we've noticed one thing so far -

The Board Membership Activity report appears to be breaking because of a character limit on the sheet name. I will post a screenshot of the error message.

Comment entered 2015-10-16 15:06:13 by Kline, Bob (NIH/NCI) [C]

That's why the code cited above in reports.inc was changing the tab name to "Cancer CAM"; the test needs to be modified to look for the new name.

Comment entered 2015-10-19 10:02:26 by alan

I'll do that, but what do we want the abbreviation to be?

If we use the same strategy of using an acronym, it would be Cancer "IACT". Or with a nod to Apple we could use "iACT" or "iAct". Or for a catchier abbreviation, how about "INTACT"?

Or we could leave it as Cancer CAM.

Comment entered 2015-10-20 12:03:38 by Juthe, Robin (NIH/NCI) [E]

Let's change it to IACT. (No cancer beforehand.)

Thanks!

Comment entered 2015-10-29 11:50:33 by alan

I'm going to go ahead and implement all of the changes on DEV, including the IACT acronym and the changes to the messages.

Comment entered 2015-10-29 17:00:00 by alan

I've made all of the changes but ran into a snag.

The changes I made were to:

  1. Replace the name Complementary, etc. with Integrative, etc.

  2. Replace the abbreviation 'cancer-cam' with iact, which also changes 'cancer-cam-board' with 'iact-board'
    The second one caused a problem because of the link to cancer.gov in the following URL:
    "http://www.cancer.gov/cancertopics/pdq/cancer-cam-board"
    Changing that to "http://www.cancer.gov/cancertopics/pdq/iact-board" won't work unless and until the cancer.gov page and link route are changed - which presumably needs to be done at some point, at least for the page itself.

There would seem to be several choices here:

  1. Change everything to iact and coordinate with cancer.gov to fix the problem at that end at the same time that this iteration of EBMS goes live.

  2. Leave all instances of "cancer-cam" alone where they are used in links. Only use IACT when it is displayed to a user.

  3. Change everything on EBMS except the link to cancer.gov. Kick the decision can down the road as to whether we should leave it that way permanently or coordinate a change with cancer.gov.

For now I am implementing solution 3 and commenting the code to say why the link says "cancer-cam" instead of "iact". My theory is that it's better to have fewer rather than more potentially puzzling links that don't reflect current practice.

If someone has a better idea, let me know.

Comment entered 2015-10-29 17:03:45 by Juthe, Robin (NIH/NCI) [E]

Where is the link to the Board page on Cancer.gov? Is it only on the About page? If so, then I agree with #3 since we have another ticket in this release to make the about page editable (see OCEEBMS-235) and we can update the URL if/when it changes on Cancer.gov.

Comment entered 2015-10-29 17:26:47 by alan

Yes, it was the About page. That's the only place I saw it.

It may still be necessary to coordinate with CG if they have a hard wired link somewhere to get to the page. I'll see what I can find out.

In the meantime, I'll leave solution 3 in place, comment it in the code, and make a link between this issue and OCEEBMS-235.

Comment entered 2015-10-29 18:05:22 by alan

Changes to the Integrative... links in the About page to the Roster and Summaries pages need to be coordinated with cancer.gov. This should be part of the considerations for other changes to the About page as part of the OCEEBMS-235 issue.

Comment entered 2015-10-29 18:10:10 by alan

The work on this is complete and checked into version control.

We may or may not do further work if it is decided in the future to change the linking URLs from the about page to the Summaries and Rosters pages on cancer.gov.

Comment entered 2015-10-30 15:08:04 by Kline, Bob (NIH/NCI) [C]

I have completed the work on the task for making the About PDQ page editable by the users, so that should take care on any changes to the links on that page (in fact, I'm encouraging the users to do their testing of my ticket by changing those links). So I'm moving this ticket into the Done pile.

Comment entered 2015-11-13 15:13:05 by Juthe, Robin (NIH/NCI) [E]

It doesn't look like the CAM Board name changes made it to QA. The Board name doesn't appear to be updated anywhere. (I know we'll need to update it ourselves on the About page.)

Comment entered 2015-11-13 15:50:19 by Kline, Bob (NIH/NCI) [C]

I scanned all the iteration 1 tickets for changes required for the deployment outside the code in version control, but I must have missed this step here. I've added the database change to the deployment script and applied it to QA. Please check again.

: Any other manual steps I should be aware of for your tasks?

Comment entered 2015-11-13 15:55:09 by Juthe, Robin (NIH/NCI) [E]

Thanks. So far, so good. I'm letting Robin B know so she can continue testing this as well.

Comment entered 2015-11-17 10:12:45 by alan

All of the code changes affecting the name change were in version control and should have been applied, but they were not the changes that affect most board name displays. The main change to the board name was in the database. I was of two minds about scripting that change. Would it be safer to create a ticket for someone (on the Database Team I presume) to run the script on Stage and Prod, or to just have a site manager do it. I came down on the side of using the site manager. However I should have documented that in this JIRA issue.

Comment entered 2015-11-17 10:15:51 by Juthe, Robin (NIH/NCI) [E]

We've verified these changes on QA.

Comment entered 2015-11-18 17:33:18 by Juthe, Robin (NIH/NCI) [E]

Just adding a note to ourselves that we will need to update the CAM Board name on the About Page.

Comment entered 2016-04-01 14:51:18 by Juthe, Robin (NIH/NCI) [E]

Verified on PROD.

Attachments
File Name Posted User
screenshot-1.png 2015-10-16 14:25:12 Juthe, Robin (NIH/NCI) [E]

Elapsed: 0:00:00.000220