Hosted by CU logo University of Colorado
Boulder
Powered by ESGF-CoG logo
Welcome, Guest. | Login | Create Account
ES-DOC-Models logo
You are at the CoG-CU node
 

ES-DOC Questionnaire Help

What is the role of an ES-DOC Questionnaire Project Administrator?

An ES-DOC Questionnaire Project Administrator is a special kind of Questionnaire Project Member with additional responsibilities. They can modify certain project details. They can also manage project membership requests. And tey can customize the look-and-feel of the Questionnaire editing forms for particular document types for their project.

 

In order to become a Questionnaire Project Administrator, a request must be made to the ES-DOC Questionnaire site administrator.

 

Figure 1

 

The top portion of the main project page (Figure 1) provides links to perform administrative tasks.

 

Modifying project details

 

Click on the "manage project" button to modify project details.

 

Figure 2

 

The left-hand side of the page (Figure 2) displays all project details that can be modified. Note that a project's name cannot be modified.

 

Managing project members

 

The right-hand side of the page (Figure 2) displays all of the current project members and all of the users whose membership is pending.

 

For pending members, an administrator need only to click the "approve" button to move them into the current project members list. Once there, they will be able to create and edit CIM Documents on behalf of the project.

 

Customizing document types

 

Click on the "customize questionnaire" button to customize the look-and-feel of the Questionnaire editor forms for particular document types.

 

Figure 3

 

The project customization page is structured similarly to the man project page: there is a section at the top to create new customizations for particular document types and a section at the bottom to edit existing customizations.

 

The document type customization page is shown below.

 

Figure 4

 

It is divided into three sections. At the top there is a place to fill in details about the customization itself: its name, a description, and whether or not it is the default customization. Although there can be multiple cusotmizations for any given document type, only the default cusotmization is ever used. Next, there is a place to fill in details about the document type being customized: how to refer to it in the editing form, and so on. Finally at the bottom, there is the main part of the form where details about document properties are entered.

 

Each property is assigned to a particular category. If no category in the CIM has been assigned then a default "uncategorized" category is assigned during customization. All categories apart from the uncategorized category appear as tabs in the editing form. Category details such as their names can be altered by clicking on a category widget to bring up the category customizing form (Figure 5). The order that categories appear in can be altered by simply dragging and dropping the category widgets.

 

Figure 5

 

Similarly, the order that properties appear in can be altered by dragging and dropping the corresponding accordion headers. Opening up an accordion header reveals the property customizing form (Figure 6). The sample shown below is for a relationship property that does not link to another CIM Document; Each different type of property has a different set of customizable options.

 

Figure 6

 

Depending on how the property is defined in the CIM certain options may be disabled or unavailable. In the case of relationship properties, there may be an option to customize the how the related CIM entity is rendered in the editing form. Clicking on the "customize subform" button will bring up a dialog box containing a customizer form for that related CIM entity. If that entity has relationship properties, then another dialog box could eventually be opened, and so on.

 

Once all of the properties in a (potentially very large) document hierarchy have been customized, the customization should be saved. In the first instance, a Questionnaire Project Administrator may simply want to create a customization with all of the default options and then review the look-and-feel of the resultant editing form, only returning to change customization details where the editing form is confusing or otherwise unsuitable for their project. This is a complex process and it is assumed that the Questionnaire Project Administrator will be working closely with the ES-DOC team to arrive at a suitable customization.

 

 


Back to main help page.

Last Update: April 9, 2017, 10:07 a.m. by Allyn Treshansky