Overview
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
Alternatively, you can do this yourself. A new administrative user and blank map project can be created using the admin mojos. Use this option when no administrative users exist or can be accessed, i.e.:
- Starting in a blank environment.
- Existing administrative users cannot be accessed (e.g. users are no longer active and their authentication details cannot be retrieved).
To create the admin user and blank project, execute the following commands:
cd code/admin/loader mvn clean install -PCreateMapAdmin -Drun.config=YOUR_CONFIG_VARIABLE -Dmap.user=DESIRED_USER_NAME
Executing this command will:
- Create a new map user will be created with the following default values. To edit these, edit the map user from the Application Administration widget.
- System user name: DESIRED_USER_NAME
- User's full name: DESIRED_USER_NAME
- Email: Not set
- Application Role: ADMINISTRATOR
- Create a new map project with blank or default values will be created with the name Blank Project. If that project already exists, the new project will be named Blank Project 2 (or 3, 4, ...)
After execution, log in as the specified user to edit the blank project, create new projects, or perform other administrative tasks.
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 - TODO: make new page out of this (and link that page at top level)
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
- Defining alternative workflows:
- (e.g. LEGACY and CONSENSUS workflows are not implemented yet) - link to other documentation.
- Computing workflow - use mojo - link to mojo. - needs to be done whenever termionlogy changes
- Nightly automations
- daily reports generation
- qaCron
References/Links
- n/a