NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

  • Created by Unknown User (lustbaders), last modified on Jul 28, 2010

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 32 Next »

NCI Enterprise Services (NES) 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.

Consuming Secure Services (PO/PA)

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

  1. Install caGrid v1.3 locally, http://cagrid.org/display/downloads/caGrid+1.3+Installation+Quick+Start.  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.
  2. Obtain a grid credential (or Dorian User Account) for the grid trust fabric needed.  See http://cagrid.org/display/cagrid13tutorials/Create+User+Account for instructions.
  3. Record your grid credential (aka Grid Identity) for later use. An example for the training grid is: 
    /O=caBIG/OU=caGrid/OU=Training/OU=Dorian/CN=coppagridtest
    An example for the stage grid is: 
    /O=caBIG/OU=caGrid/OU=Stage LOA1/OU=Dorian/CN=coppagridtest
  4. Add your own Grid Identity to PO and/or PA to authenticate.

HOW-TO

Each day before you start using the services, you'll need to Login to Dorian using the GAARDS UI to extend your local grid identity certificates. They are valid for no more than 12 hours.

  1. Lauch GAARDS-UI and login using your CN (matyass) from your Grid Identity (e.g. /O=caBIG/OU=caGrid/OU=Training/OU=Dorian/CN=matyass)
    Launch GAARDS-UI (ant security)
    steve-matyass-macbook-pro-2:cagrid smatyas$ pwd
/Users/smatyas/dev/cagrid/caGrid
steve-matyass-macbook-pro-2:caGrid smatyas$ ant security
...
    1. Click Login button and specify the following:
      Specify Login Credentials
      Credential Provider: Training
Organization: Training
Username: matyass
Password: *********
  2. Proceed to consuming PO or PA services as normal now by invoking the APIs.

Consuming Unsecured Services (PO/PA)

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 | structuralroles]/[ServiceName]/client/[ServiceName]Client.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 ISO 21090 Published Standard (login required). Also read the PIMs (platform independent models) for 21090 and the PersonService available at https://ncisvn.nci.nih.gov/svn/coppa/trunk/documents/analysis_and_design/.

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.

Service Endpoints - 3.2 (access requires grid credentials)

Integration tier base URL: https://ctms-services-po-3-2-integration.nci.nih.gov:1522/ (coming soon)
Demo tier base URL: https://ctms-services-po-3-2-demo.nci.nih.gov:1522

<Base URL>/wsrf/services/cagrid/Person
<Base URL>/wsrf/services/cagrid/Organization
<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/OrganizationalContact
<Base URL>/wsrf/services/cagrid/OversightCommittee
<Base URL>/wsrf/services/cagrid/ResearchOrganization
<Base URL>/wsrf/services/cagrid/Patient
<Base URL>/wsrf/services/cagrid/Business

Service Endpoints - 3.1 (access requires grid credentials)

Integration tier base URL: https://ctms-services-po-3-1-integration.nci.nih.gov:19543/
Demo tier base URL: https://ctms-services-po-3-1-demo.nci.nih.gov:1521

<Base URL>/wsrf/services/cagrid/Person
<Base URL>/wsrf/services/cagrid/Organization
<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/OrganizationalContact
<Base URL>/wsrf/services/cagrid/OversightCommittee
<Base URL>/wsrf/services/cagrid/ResearchOrganization
<Base URL>/wsrf/services/cagrid/Patient
<Base URL>/wsrf/services/cagrid/Business

Service Endpoints - 3.0

Integration tier base URL: http://ctms-services-po-3-0-integration.nci.nih.gov/
Demo tier base URL: http://ctms-services-po-3-0-demo.nci.nih.gov/

<Base URL>/wsrf/services/cagrid/Person
<Base URL>/wsrf/services/cagrid/Organization
<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/OrganizationalContact
<Base URL>/wsrf/services/cagrid/OversightCommittee
<Base URL>/wsrf/services/cagrid/ResearchOrganization

WSDLS

The WSDLs can be accessed by appending ?wsdl to the service endpoints

XSDs

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.

Service Methods

A list of service methods on the integration tier can be seen at <base URL>/wsrf/services, broken down by service end point; the relevant service endpoints are prefixed by "cagrid/"

PA Services

The PA services are only available from within the NIH firewall.

Service Endpoints - 3.2 (access requires grid credentials)

Integration tier base URL: http://ctms-services-pa-3-2-integration.nci.nih.gov:1522/(coming soon)
Demo tier base URL: https://ctms-services-pa-3-2-demo.nci.nih.gov:1522

<Base URL>/wsrf/services/cagrid/ArmService
<Base URL>/wsrf/services/cagrid/DocumentService
<Base URL>/wsrf/services/cagrid/DocumentWorkflowStatusService
<Base URL>/wsrf/services/cagrid/PlannedActivityService
<Base URL>/wsrf/services/cagrid/StudyContactService
<Base URL>/wsrf/services/cagrid/StudyDiseaseService
<Base URL>/wsrf/services/cagrid/StudyIndldeService
<Base URL>/wsrf/services/cagrid/StudyOnholdService
<Base URL>/wsrf/services/cagrid/StudyOutcomeMeasureService
<Base URL>/wsrf/services/cagrid/StudyOverallStatusService
<Base URL>/wsrf/services/cagrid/StudyParticipationContactService
<Base URL>/wsrf/services/cagrid/StudyParticipationService
<Base URL>/wsrf/services/cagrid/StudyProtocolService
<Base URL>/wsrf/services/cagrid/StudyRecruitmentStatusService
<Base URL>/wsrf/services/cagrid/StudyRegulatoryAuthorityService
<Base URL>/wsrf/services/cagrid/StudyRelationshipService
<Base URL>/wsrf/services/cagrid/StudyResourcingService
<Base URL>/wsrf/services/cagrid/StudySiteAccrualStatusService
<Base URL>/wsrf/services/cagrid/TrialRegistrationService

Service Endpoints - 3.1 (access requires grid credentials)

Integration tier base URL: http://ctms-services-pa-3-1-integration.nci.nih.gov:19343/
Demo tier base URL: https://ctms-services-pa-3-1-demo.nci.nih.gov:1521

<Base URL>/wsrf/services/cagrid/ArmService
<Base URL>/wsrf/services/cagrid/DocumentService
<Base URL>/wsrf/services/cagrid/DocumentWorkflowStatusService
<Base URL>/wsrf/services/cagrid/PlannedActivityService
<Base URL>/wsrf/services/cagrid/StudyContactService
<Base URL>/wsrf/services/cagrid/StudyDiseaseService
<Base URL>/wsrf/services/cagrid/StudyIndldeService
<Base URL>/wsrf/services/cagrid/StudyOnholdService
<Base URL>/wsrf/services/cagrid/StudyOutcomeMeasureService
<Base URL>/wsrf/services/cagrid/StudyOverallStatusService
<Base URL>/wsrf/services/cagrid/StudyParticipationContactService
<Base URL>/wsrf/services/cagrid/StudyParticipationService
<Base URL>/wsrf/services/cagrid/StudyProtocolService
<Base URL>/wsrf/services/cagrid/StudyRecruitmentStatusService
<Base URL>/wsrf/services/cagrid/StudyRegulatoryAuthorityService
<Base URL>/wsrf/services/cagrid/StudyRelationshipService
<Base URL>/wsrf/services/cagrid/StudyResourcingService
<Base URL>/wsrf/services/cagrid/StudySiteAccrualStatusService
<Base URL>/wsrf/services/cagrid/TrialRegistrationService

Service Endpoints - 3.0

Integration tier base URL: http://ctms-services-pa-3-0-integration.nci.nih.gov/
Demo tier base URL: http://ctms-services-pa-3-0-demo.nci.nih.gov/

<Base URL>/wsrf/services/cagrid/ArmService
<Base URL>/wsrf/services/cagrid/DocumentService
<Base URL>/wsrf/services/cagrid/DocumentWorkflowStatusService
<Base URL>/wsrf/services/cagrid/PlannedActivityService
<Base URL>/wsrf/services/cagrid/StudyContactService
<Base URL>/wsrf/services/cagrid/StudyDiseaseService
<Base URL>/wsrf/services/cagrid/StudyIndldeService
<Base URL>/wsrf/services/cagrid/StudyOnholdService
<Base URL>/wsrf/services/cagrid/StudyOutcomeMeasureService
<Base URL>/wsrf/services/cagrid/StudyOverallStatusService
<Base URL>/wsrf/services/cagrid/StudyParticipationContactService
<Base URL>/wsrf/services/cagrid/StudyParticipationService
<Base URL>/wsrf/services/cagrid/StudyProtocolService
<Base URL>/wsrf/services/cagrid/StudyRecruitmentStatusService
<Base URL>/wsrf/services/cagrid/StudyRegulatoryAuthorityService
<Base URL>/wsrf/services/cagrid/StudyRelationshipService
<Base URL>/wsrf/services/cagrid/StudyResourcingService
<Base URL>/wsrf/services/cagrid/StudySiteAccrualStatusService
<Base URL>/wsrf/services/cagrid/TrialRegistrationService

WSDLS

The WSDLs can be accessed by appending ?wsdl to the service endpoints

XSDs

<base URL>/wsrf/share/schema/PAServices/CoppaCommons.xsd
<base URL>/wsrf/share/schema/PAServices/CoppaCommonsFaults.xsd
<base URL>/wsrf/share/schema/PAServices/CoppaPA.xsd
<base URL>/wsrf/share/schema/PAServices/CoppaPAFaults.xsd
<base URL>/wsrf/share/schema/PAServices/ISO_datatypes_Narrative.xsd
<base URL>/wsrf/share/schema/PAServices/CoppaPAFaults.xsd

Service Methods

A list of service methods on the integration tier can be seen at <base URL>/wsrf/services, broken down by service end point; the relevant service endpoints are prefixed by "cagrid/"

  • No labels