NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be will be undergoing maintenance on Monday, June 24th between 1000 ET and 1100 ET.
Wiki will remain available, but users may experience screen refreshes or HTTP 502 errors during the maintenance period. If you encounter these errors, wait 1-2 minutes, then refresh your page.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{scrollbar:icons=false}
h1. {

Page info

...

title
title

Initial Analysis:

Item

Information/Response

Date

03/10/2010

...

Requirement # unique id <SemConOps Initiative>.<analysts

...

initials><requirement

...

number>

...


e.g.

...

Init1dbw1

...


(eventually linked to Use Cases)

Init1dbw13

Originator/Customer's

...

Name

...

:

...

Bob

...

Friemuth

...

for

...

AGNIS

...

Metadata

...

Tool

Originator/Customer's

...

Company

...

:

Mayo

Summary of requirement initial analysis, by Reviewer: (as unambiguously as possible, describe who (List of Actors) is interacting with the system, what the business goal is and how the system might support the actor's ability to acheive their goal)

In the course of retrieving the metadata for a CRF from the caDSR, the
metadata curator using the generates a request to retireve a Form from caDSR. The AGNIS Metadata Tool sends a large number of web service requests to the cadsrapi40Service web service. This can take a long time, due to the large number of round trips to the server. One possible way to improve performance would be to implement a caDSR API that, instead of returning only one object at a time, could return a graph of objects in response to a single web service request. This would move processing to the server side, where it can be done more efficiently, and also improve performance by reducing the number of round trips to the server.
For example, a caDSR client tool such as the AGNIS Metadata Tool might benefit from an API capable of returning a graph of objects such as the following in response to a single query.  
The RULES (skip to/from instructions, default values or repeating group information) around the question might also be useful, such as the order of the question in the form.


> Question
>   |-- definitionCollection
>   |-- designationCollection
>   |-- instruction
>   |-- dataElement
>   |     |-- dataElementConcept
>   |     |    |-- definitionCollection
>   |     |    |-- designationCollection
>   |     |    +-- referenceDocumentCollection
>   |     |          +-- attachments
>   |     |-- definitionCollection
>   |     |-- designationCollection
>   |     |-- referenceDocumentCollection
>   |     |    +-- attachments
>   |     +-- valueDomain
>   |           |-- definitionCollection
>   |           |-- designationCollection
>   |           +-- referenceDocumentCollection
>   |                 +-- attachments
>   |-- referenceDocumentCollection
>   |     +-- attachments
>   +-- validValueCollection
>         |-- definitionCollection
>         |-- designationCollection
>         |-- instruction
>         |-- referenceDocumentCollection
>         |     +-- attachments
>         +-- valueDomainPermissibleValue
>              +-- permissibleValue
>                    +-- valueMeaning
>                           |-- definitionCollection
>                           |-- designationCollection
>>>>>>>>>>>>>>>>>>>>>>>>>>>>|-- conceptCollection
>                           +-- referenceDocumentCollection
>                                 +-- attachments
>  

Recommended Next Step Enter one: Follow-up interview, Observe, Use Case Template (text), Use Case Model (formalized/UML diagram), Group Discussion, Prototype, Waiting Room

Use Case Template to describe the 'graph' in more detail


Wiki Markup
 | Mayo |
| *Summary of requirement initial analysis, by Reviewer:* (as unambiguously as possible, describe who ([List of Actors|https://wiki.nci.nih.gov/x/ewtyAQ]) is interacting with the system, what the business goal is and how the system might support the actor's ability to acheive their goal) | In the course of retrieving the metadata for a CRF from the caDSR, the \\
metadata curator using the generates a request to retireve a Form from caDSR.  The AGNIS Metadata Tool sends a large number of web service requests to the cadsrapi40Service web service.  This can take a long time, due to the large number of round trips to the server.  One possible way to improve performance would be to implement a caDSR API that, instead of returning only one object at a time, could return a graph of objects in response to a single web service request.  This would move processing to the server side, where it can be done more efficiently, and also improve performance by reducing the number of round trips to the server. \\
For example, a caDSR client tool such as the AGNIS Metadata Tool might benefit from an API capable of returning a graph of objects such as the following in response to a single query. &nbsp; \\
The RULES (skip to/from instructions, default values or repeating group information) around the question might also be useful, such as the order of the question in the form. \\
\\
\\
> Question \\
>&nbsp;&nbsp; \|-\- definitionCollection \\
>&nbsp;&nbsp; \|-\- designationCollection \\
>&nbsp;&nbsp; \|-\- instruction \\
>&nbsp;&nbsp; \|-\- dataElement \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|-\- dataElementConcept \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;\|-\- definitionCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;\|-\- designationCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;+-\- referenceDocumentCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-\- attachments \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|-\- definitionCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|-\- designationCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|-\- referenceDocumentCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;+-\- attachments \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \+-\- valueDomain \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- definitionCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- designationCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \+-\- referenceDocumentCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \+-\- attachments \\
>&nbsp;&nbsp; \|-\- referenceDocumentCollection \\
>&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \+-\- attachments \\
>&nbsp;&nbsp; \+-\- validValueCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- definitionCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- designationCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- instruction \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- referenceDocumentCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|&nbsp;&nbsp;&nbsp;&nbsp; \+-\- attachments \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \+-\- valueDomainPermissibleValue \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-\- permissibleValue \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-\- valueMeaning \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- definitionCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \|-\- designationCollection \\
>>>>>>>>>>>>>>>>>>>>>>>>>>>>\|-\- conceptCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \+-\- referenceDocumentCollection \\
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \+-\- attachments \\
> &nbsp; \\ |
| *Recommended Next Step* Enter one: Follow-up interview, Observe, Use Case Template (text), Use Case Model (formalized/UML diagram), Group Discussion, Prototype, Waiting Room | Use Case Template to describe the 'graph' in more detail |
\\
{scrollbar:icons=false}