 |
Page History
| Table of Contents |
|---|
...
NCI Enterprise Services (
...
NES)
...
| Note |
|---|
Secure Services were introduced in v3.1 of PO & PA |
Purpose
To inform our clients (consumers) how to connect to and consume our secure services.
Prerequisites
...
Email list
Subscribe to the NES-USERS-L@LIST.NIH.GOV mailing list for announcements of new releases, changes to the services, etc. You can also post to this list with any questions you may have about accessing the services. This list is intended to be fully interactive and not just for announcements from the CTRP/COPPA team - we encourage all users to ask questions and respond to anyone else's questions freely.
Legacy service/End-of-life support policy
Three versions of NCI Enterprise services are supported at any point of time - the most recent version and the previous two versions. As new versions are released, the oldest version will be retired and will no longer be accessible; although CTRP/NES development is fast-paced, it is intended that clients will have to upgrade no more than once a year. For example, as of August 2010, we support NES 3.2, as well as NES 3.1 and 3.0. NES 3.0 has reached the end-of-life (EOL) status and will be retired upon the release of NES 3.3 (late fall/early winter 2010); all users of NES 3.0 are encouraged to upgrade to 3.2 as soon as possible.
Background information
The PO/PA grid services are ISO 21090 compliant. To construct valid XML messages to send to the services, you should be familiar with the ISO 21090 Published Standard(login required). Also read the 21090 PIM (platform independent model) specification, as well as the PO and PA service PIMs available at https://ncisvn.nci.nih.gov/svn/coppa/trunk/documents/analysis_and_design/service_specifications/. A list of CTRP/COPPA roots to be used with ISO 21090 IIs can be found here.
Consuming Secure Services
| Note |
|---|
All PA services are secure (meaning authentication is required), and v3.1 and 3.2 of the PO services are secure. |
Obtaining an authorized grid account
To access secure grid services (both PO and PA services), you'll need an authorized grid account on the appropriate grid. If you intend to use the Integration tiers or a local deployment inside the NIH firewall, you should use the Stage Grid; for the Demo tier and local deployments outside the firewall, you should use the Training Grid. You can create an account using the caGrid Portal (training Portal or stage Portal) or using GAARDS-UI (see instructions for caGrid 1.3 software installation and creating an account)
...
.
Record your grid credential (aka Grid Identity) for later use.
...
An example for the training grid is:
| Code Block |
|---|
/O=caBIG/OU=caGrid/OU=Training/OU=Dorian/CN=coppagridtest
|
An example for the stage grid is:
...
| Code Block |
|---|
/O=caBIG/OU=caGrid/OU= |
...
Stage LOA1/OU=Dorian/CN= |
...
coppagridtest
|
If you're using the Integration tier, you can use the existing coppagridtest account (password is Coppa#12345). If you're using the Stage grid or would like to have your own account added to the integration tier, please email NES-USERS-L@LIST.NIH.GOVwith the grid identity to be added. If you're using your own local installations of PO/PA, see Add your own Grid Identity to PO and/or PA
...
.
Java HOW-TO
| Tip |
|---|
Each day before you start using coding and testing locallythe services, you'll want need to Login to Dorian using the GAARDS UI to extend your local grid identity certificates. Roughly ever 24 hours they expire. |
...
| Code Block | ||
|---|---|---|
| ||
steve-matyass-macbook-pro-2:cagrid smatyas$ pwd
/Users/smatyas/dev/cagrid/caGrid
steve-matyass-macbook-pro-2:caGrid smatyas$ ant security
...
|
- Click Login button and specify the following:
Code Block title Specify Login Credentials Credential Provider: Training Organization: Training Username: matyass Password: *********
They are valid for no more than 12 hours. |
To access the services using java clients, you may want to start with our sample Introduced-generated clients - instructions for running these clients via ant are available. IDs and search terms are hard-coded in those clients, so you'll need to change them and recompile as needed. You can call into those clients from your own code; we have a client package prepared for the Trial Registration Serviceto make it easier for you, and client packages for the rest of the services will be available soon.
SoapUI HOW-TO
SoapUI is a web service testing tool that allows for creating SOAP messages and using them to invoke web service end points. This tool can be convenient if you would like to call services without any coding, such as in QA. Please see these instructions for how to add grid credentials to SoapUI in order to call secure services
...
.
Consuming Unsecured Services
| Note |
|---|
Unsecure Services were available prior to v3.1 of PO & PA |
If you just want to call the services, you can use a tool like SoapUI to generate XML from the WSDLs listed below (which is what QA does). To get more involved, you can use the sample java code in coppa/code/po-grid/src/gov/nih/nci/coppa/services/entities /ServiceName/client/ServiceNameClient.java. There are similar clients for PA under coppa/code/pa-grid.
The grid services are ISO 21090 compliant. To construct valid XML messages to send to the services, you should be familiar with the spec, available at https://wiki.nci.nih.gov/display/EAWiki/ISO+21090+Data+Types (ISO_21090_20080317.zip). Also read the PIMs (platform independent models) for 21090 and the PersonService available at https://gforge.nci.nih.gov/svnroot/coppa/trunk/documents/analysis_and_design/.
PO Services
The PO services are only available from within the NIH firewall.
Service Endpoints
and will be retired when v3.3 is released. |
You can access the unsecured services (both PO and PA services) via java the same way you would access the secured services (see above), skipping the steps that involve obtaining grid credentials. You can also use SoapUI without going through the security steps described above.
PO Services
The PO services on the Integration tier are only available from within the NIH firewall, while the services on the Demo tier are accessible outside the firewall.
| Note |
|---|
Grid service version numbers are separate from web application version numbers, so the release of PO 3.5 (for example) does not imply a corresponding 3.5 release of the grid services. The next version of the grid services to be released will be 3.4, regardless of the version the PO web application is on at the time. |
Host names
| Info |
|---|
3.1 and 3.2 services require https and grid credentials, 3.0 services can be accessed via plain http without grid credentials |
Tier | Version | Host name:port |
|---|---|---|
Integration | 3.2 | |
Integration | 3.1 | |
Integration | 3.0 |
...
Demo | 3.2 |
...
...
...
...
...
...
...
...
Production | 3.2 |
...
...
...
...
...
...
Production | 3.0 |
...
Capability Services
<Base URL>/wsrf/services/cagrid/IdentifiedPerson
http://ctms-services-po-integration.nci.nih.govBusiness (since 3.1)
Core Services
<Base URL>/wsrf/services/cagrid/ClinicalResearchStaff
<Base URL>/wsrf/services/cagrid/HealthCareFacility
<Base URL>/wsrf/services/cagrid/HealthCareProvider
<Base URL>/wsrf/services/cagrid/IdentifiedOrganization
<Base URL>/wsrf/services/cagrid/IdentifiedPerson
<Base URL>/wsrf/services/cagrid/Organization
<Base URL>/wsrf/services/cagrid/OrganizationalContact
<Base URL>/wsrf/services/cagrid/OversightCommittee
<Base URL>http://ctms-services-po-integration.nci.nih.gov/wsrf/services/cagrid/OversightCommitteehttp://ctms-services-po-integration.nci.nih.govPatient (since 3.1)
<Base URL>/wsrf/services/cagrid/Person
<Base URL>/wsrf/services/cagrid/ResearchOrganization
WSDLS
The WSDLs can be accessed by appending ?wsdl to the service endpoints
XSDs
http://ctms-services-po-integration.nci.nih.gov/The XSDs are available at <base URL>/wsrf/share/schema/CoreServices/CoppaPO.xsd for each tier and version.
All types not defined by that XSD are from the ISO 21090 spec.
...
A list of service methods on the integration tier can be seen at http://ncias-s165-v.nci.nih.gov:19580<base URL>/wsrf/services, broken down by service end point; the relevant service endpoints are prefixed by "cagrid/"
PA Services
The PA services on the Integration tier are only available from within the NIH firewall.
Service Endpoints
...
, while the services on the Demo tier are accessible outside the firewall.
| Note |
|---|
Grid service version numbers are separate from web application version numbers, so the release of PA 3.5 (for example) does not imply a corresponding 3.5 release of the grid services. The next version of the PA grid services to be released will be 3.4, which will occur as part of the CTRP 3.6 release. |
Host names
| Info |
|---|
All PA services require https and grid credentials. |
Tier | Version | Host name:port |
|---|---|---|
Integration | 3.4 |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Capability Services
<Base URL>/wsrf/services/cagrid/StudyOutcomeMeasureServicehttp://ctms-services-pa-integration.nci.nih.govTrialRegistrationService
<Base URL>/wsrf/services/cagrid/StudySiteParticipationService (since 3.3)
Core Services
<Base URL>/wsrf/services/cagrid/ArmService
<Base URL>/wsrf/services/cagrid/DiseaseService (since 3.2)
<Base URL>/wsrf/services/cagrid/DocumentService
<Base URL>/wsrf/services/cagrid/DocumentWorkflowStatusService
<Base URL>/wsrf/services/cagrid/InterventionService (since 3.2)
<Base URL>/wsrf/services/cagrid/StudyOverallStatusServicehttp://ctms-services-pa-integration.nci.nih.govPlannedActivityService
<Base URL>/wsrf/services/cagrid/RegulatoryAuthorityService (since 3.2)
<Base URL>/wsrf/services/cagrid/StudyParticipationContactServicehttp://ctms-services-pa-integration.nci.nih.govStudyContactService
<Base URL>/wsrf/services/cagrid/StudyDiseaseService
<Base URL>/wsrf/services/cagrid/StudyParticipationServicehttp://ctms-services-pa-integration.nci.nih.govStudyIndldeService
<Base URL>/wsrf/services/cagrid/StudyOnholdService
<Base URL>/wsrf/services/cagrid/StudyProtocolServicehttp://ctms-services-pa-integration.nci.nih.govStudyOutcomeMeasureService
<Base URL>/wsrf/services/cagrid/StudyOverallStatusService
<Base URL>/wsrf/services/cagrid/StudyRecruitmentStatusServicehttp://ctms-services-pa-integration.nci.nih.govStudyParticipationContactService (Placeholder for future services, currently provides no service methods)
<Base URL>/wsrf/services/cagrid/StudyParticipationService (Placeholder for future services, currently provides no service methods)
<Base URL>/wsrf/services/cagrid/StudyRegulatoryAuthorityServicehttp://ctms-services-pa-integration.nci.nih.govStudyProtocolService
<Base URL>/wsrf/services/cagrid/StudyRecruitmentStatusService
<Base URL>/wsrf/services/cagrid/StudyRelationshipServicehttp://ctms-services-pa-integration.nci.nih.govStudyRegulatoryAuthorityService
<Base URL>/wsrf/services/cagrid/StudyRelationshipService
<Base URL>/wsrf/services/cagrid/StudyResourcingService
<Base URL>/wsrf/services/cagrid/StudySiteService
<Base URL>http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudySiteAccrualStatusService
<Base URL>/wsrf/services/cagrid/StudySiteContactStatusService
WSDLS
The WSDLs can be accessed by appending ?wsdl to the service endpoints
XSDs
http://ctms-services-pa-integration.nci.nih.gov/<base URL>/wsrf/share/schema/PAServices/CoppaCommons.xsd
<base URL>/http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaCommonsFaults.xsd
<base URL>/http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaPA.xsd
<base URL>/http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaPAFaults.xsd
<base URL>/http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/ISO_datatypes_Narrative.xsd
<base URL>/wsrf/share/schema/PAServices/StudySiteParticipationManagementTypes.xsd (input types for StudySiteParticipationService)
<base URL>http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaPAFaultsStudySiteParticipationViewTypes.xsd (output types for StudySiteParticipationService)
Service Methods
A list of service methods on the integration tier can be seen at http://ncias-s165-v.nci.nih.gov:19380<base URL>/wsrf/services, broken down by service end point; the relevant service endpoints are prefixed by "cagrid/"