caDSR content can be passively and actively retrieved through several means. Following are brief introductions on each method by caDSR product.
The CDE Browser search features provide the means to search for and retrieve CDEs, to put CDEs into a shopping cart, and to export them for download in an MS Excel or and XML document. The export contains the essential attributes of data elements, such as the Data Element Concept (DEC), the reference to the Object Class and Property, and the Value Domain (VD). If the Value Domain is enumerated, the download includes the Permissible Values.
Form Builder exports in MS Excel format and includes all the associated questions and answer lists, reference to the CDE, and limited form metadata such as the form name and section headings. All other form metadata such as attributes describing form behavior, including skip patterns, repeating groups, and default values, is available through the caDSR API.
Examples include the format for URL links to view a specific CDE by CDE id (publicID) and version via the CDE Browser interface. By using these links, application developers can provide pre-designed UI interface for displaying the details of a data entry field from the standard caDSR interfaces.
Two "views" of caDSR content are provided via the caDSR API, both generated by the caCORE SDK. Two domain models of caDSR were developed: one representing 11179 administered items, the other representing content as part of a UML class diagram. The caDSR API was created using the caCORE SDK, therefore multiple means provide programmatic access to content.
caCORE java-based clients communicate with caDSR via the Java API which contains the caDSR and UMLProject domain objects provided in the caCORE client.jar file. Developers can download the caDSR client.jar file and directly use its packages in their programs. Each Java bean object class in the caCORE caDSR and UMLProject domain packages acts as its own search criteria object and provides methods for the retrieval of attributes and related domain objects.
Domain Class Browser
Non-Java based applications can communicate via SOAP services or by using the caDSR HTTP API, and receive objects as XML. The Domain Class Browser provides a convenient way to perform HTTP queries that return any caDSR object. By default it returns HTML objects, but the generated query can be edited to return the XML object by simply changing the "...//GetHTML?query=..." to "...//GetXML?query=..." in the results. All caDSR and UMLProject objects can be transformed into XML, and XSL/XSLT is used to present data in documents, web pages or other interfaces. The caDSR API is a common artifact for all caCORE SDK generated systems.
The Semantic Integration Workbench (SIW) is a tool in the caCORE toolset that assists users in adding consistent metadata to their UML model, or verifying consistency, by matching their concepts with similar items from the NCI Thesaurus. The supports producing semantically integrated systems, with all exposed API elements having runtime accessible metadata that defines the meaning of the elements.
The documentation for the caDSR APIs is found in the caDSR API 4.1.x Guide.
Dynamic access to the caDSR is available through a Java API that emulates the features of the CDE Browser. Detailed modeling information for the caDSR Java API can be found on Interacting with caDSR and Java API Download. The caCORE Java API Tutorial developed by one of the caDSR user groups details the use of the API for querying caDSR Content.
The caDSR domain model is registered in the caDSR and can be viewed using the UML Model Browser or the CDE Browser. In the UML Model Browser, the caDSR UML Model can be found by searching for the "caCORE" project, "caDSR" sub-project. In the CDE Browser, open the caCORE Context, Classification Scheme "caCORE" and the "caDSR" domain model.
There are also two batch processing modes for import and export of Administered Components with the caDSR. Import formats supported are Microsoft Excel and UML Class diagrams. A customized Excel spreadsheet is provided by CBIIT to Context owners for imports. UML Models are translated by custom CBIIT programs whereby UML classes are mapped to caDSR Data Element Concepts and UML Class attributes are mapped to caDSR Data Elements. Export formats supported are Microsoft Excel and XML, are available via the CDE Browser. The DTD for the CDE Browser is used to capture and validate the caDSR components which are then batch loaded into the caDSR by CBIIT database administrators.
The Grid Services provide access to the caDSR content using the same domain model as the caDSR API through the caGRID.
The Sentinel Tool allows for a Process URL as a Report Recipient. Details are provided in the Sentinel Tool Online Help and on caDSR Sentinel Alert Report Process URL Recipients.
Using the URL pattern https://cdecurate.nci.nih.gov/cdecurate/View?publicId=ppp&version=vvv an HTML response will contain the details for the Administered Item Public ID and Version specified.
The Freestyle Search Engine provides results based on a weighted search algorithm. Its purpose is not to return all matches but only the most likely matches given the governors provided by the caller.
The Object Cart allows access to anything saved in a Cart. Primarily used by CDE Browser and Form Builder, however a Cart is accessible via any software through its API.