STEPSTools

Location Skip Navigation LinksAPI DocumentationImplementation Roadmap

STEPSTools Implementation Roadmap


This is an approximation of the steps involved in implementation. Since this is a research project and the tools are still being refined, the process is not expected to be static and can, in some reasonable cases, be adapted to the needs of vendor system developers attempting to implement STEPSTools. Click on a track to view the roadmap for that track.


Choose an implementation track:

Rounding

Implementation Track

STEP Days After Start
Pre-Orientation (Things You've Already Completed)
- Interested developer reviews service documentation to familiarize themselves with the API and evaluate whether it will meet their requirements.  
Orientation
- Developer registers for online account and service authentication token here, agreeing to the service terms of use. 2
- Developer schedules Web/Phone conference (agenda) with STEPSTools technical team. 7
- Having evaluated the different methods of the service to determine which are most suitable to accomplish your team's objectives, finalize the decision on which methods of the service will be used. 5
Development
- Service Calls 30
       - Developer uses http://dev.pedstep.org sub-domain to implement STEPSTools API in test environment on their system.  
       - Developer implements use of account credentials to call service GetAuthToken method which returns token (tokens can expire, so should not be hard-coded).  
       - Developer implements selected method(s) of the service and uses STEPSTools personalized Service Log (requires login) for troubleshooting and verification of successful calls. Also see our code examples.  
- User Interface 60
       - Developer will reference STEPSTools Interface guidelines while developing interface implementation  
       - Brief (15 minute) weekly Web/Phone Conference reviews of Interface implementation progress to provide feedback to vendor throughout development process  
Testing
- Implement list of Test Cases using staging/Test service, review results in both STEPSTools log and implementation within vendor system 75
- Load testing from Developer System 80
- Web/Phone Conference to perform final review of vendor's implementation of STEPStools CDS in interface 85
Production Release
- Account is upgraded to production level 90
- Production level tokens may expire, in which case a new call to the service GetAuthToken method is required.  
 
Compounding

Implementation Track

STEP Days After Start
Pre-Orientation (Things You've Already Completed)
- Interested developer reviews service documentation to familiarize themselves with the API and evaluate whether it will meet their requirements.  
Orientation
- Developer registers for online account here, agreeing to the service terms of use (including agreement that they don't update the database, only get it from us) 2
- Developer schedules Web/Phone conference (agenda) with STEPSTools technical team. 7
Development and Testing
- Service Calls 20
      - Developer uses http://dev.pedstep.org sub-domain to develop their implementation of STEPSTools API   
      - Developer uses account to call service GetAuthToken method which returns token   
      - Developer uses returned token to call service   
      - Developer programs scheduled call to the service on schedule we recommend and uses STEPSTools personalized Service Log (requires login) for troubleshooting and verification of successful calls.  
- Schema Verification 25
      - Developer successfully builds instance of database on their side according to the schema. STEPSTools must certify as appropriate/accurate use of knowledge   
- User Interface 75
      - Developer demonstrates implementation of STEPSTools knowledge in their system.    
Production Release  
- Account is upgraded to production level 85
- Production level tokens may expire, in which case a new call to service GetAuthToken method is required.