...
Documentation on creating and configuring a map project. This page covers the various aspects of the tool that are customizeable and how to use them.
Customizeable Features
- Map Projects and Map Project Metadata
- Project Scope
- Custom Terminologies
- Customizing the Index Viewer
- Project Specific Algorithm Handlers
- Custom Workflow Paths
- Including custom code in deployment
Creating a New Administrative User and Blank Map Project
Importing an Existing Map Project
TODO
Identifying and Loading Terminologies.
... "source" and "destination" terminologies...
Creating and Configuring a Map Project
A map project can be created completely from scratch or the empty project created in the "Starting from Scratch" section can be used.
- Creating metadata to support the project
- Top-level project metadata
- Advices
- Principles
- Relations
- Preset age ranges
- Creating users to support the project.
- Specialists
- Leads
- Admins
- Discuss how authentication interacts with map users. Ihtsdo implementation creates a map user when a user who hasn't logged in before logs in.
- that user can then be added to projects as other roles
- OR the users could be created first, knowing that the authentication environment will have that user and wire its role before that user ever logs in.
- Defining scope for the project
- Scope includes concepts
- Scope excludes concepts
- alternative: export project, fix scope list, then remove and re-import project.
- Uploading a map principles document/editorial guide.
- Project specific algorithm handler (see section below)
Loading Legacy Map Record Data
... from RF2 data.
Customizing Release Process
..describe default release -link to other page on this for default behavior and executions
- Editing cycle begin
- Release begin
- Release processing
- Release finish
Customize ReleaseHandler and create your own mojos.
Defining Reports and QA Checks
refer to documentation on this.
- Report definitions
- QA check definitions
Developing Project-specific Code
Fork the IHTSDO github project.
Customizing webapp
- develop enhancements in generalizeable way (e.g. how header icon and title work)
- develop modularized additional widgets (e.g. in js/widgets)
- develop additional dashboards
Customizing functionality
Other Considerations
...
- (e.g. LEGACY and CONSENSUS workflows are not implemented yet) - link to other documentation.
...
Prerequisites
The Mapping Tool requires an administrative user and at least one project to exist in order to function. If no project exists, either:
- Import a map project (see Map Project Import and Export), or
- Create a new map administrator, which will automatically create a blank project if none exist (see Creating an Administrative User).
Creating new projects requires at least two terminologies to be loaded (i.e. the source and destination terminologies)..
Basic Configuration
Each step of creating and configuring a project is documented in the following pages
- Creating a New Project
- Adding Metadata to a New Project
- Setting Project Scope
- Managing Reports and QA Checks
- Customizing the Index Viewer
- Including custom code
Other Considerations
- Creating Custom Workflow Paths, e.g. implementing Legacy Workflow Path and Consensus Path.
- Automating QA and reporting. See Maintenance and Automations.
- Creating a Custom Release Process
...
References/Links
- n/a