University of Colorado
How the ES-DOC Questionnaire works
The ES-DOC Questionnaire provides a series of webforms for users to create, edit, and publish CIM Documents. In order to do this, portions of the CIM Ontology must be registered with the Questionnaire and associated with Questionnaire Projects.
The CIM Ontology consists of a schema which defines general-purpose document types such as "Responsible Party" and "Model" and potential specializations of those document types which further refine them by adding or removing properties. For example, the CMIP6 document type "Sea Ice" is a specialization of the schema document type "Realm".
ES-DOC provides generators which transform schemas and specializations into a format suitable for registration with the Questionnaire. This is done by the ES-DOC Questionnaire Administartor.
The Questionnaire, much like CoG, is divided into separate projects. Each project maintains its own set of supported document types as well as active customizations and documents. The Questionnaire Project Administrator decides which document types their project should support.
One of the features of the ES-DOC Questionnaire is the ability to customize the look-and-feel of the editing form for particular document types for particular projects. The CIM is quite complex and it may be overwhelming to display that full complexity to users. Partly, this can be mitigated by crafting a good specialization of the CIM. But it can also be accomplished by customizing the Questionnaire. This process is described in detail in the Admin Guide.
Once a customization exists, project users can proceed to create, edit, and publish documents. This process is described in detail in the User Guide. All of the rendering of the editing forms are done automatically based on the information contained from the original ontology registration and the subsequent document customization.