VxOWare File config guide. Section Id & Name & Description (vo_description.xml) 3 -- Id 1 -- Name 2 – Description

VxOWare

File config guide

Section Id & Name & Description(vo_description.xml)

3 -- Id

1 -- Name

2 – Description

(vo_description.xml)//OBSERVATORY//DATA_SECTIONS

<SECTION> <NAME>Help</NAME> <!– Id --> <LONG_NAME>Help docs</LONG_NAME> <!– Name --> <PATH>/</PATH> <DESCRIPTION>.. For example ...</DESCRIPTION> <!– Description --> <TREE>Help/helpTree.xml</TREE> <!– path to doc --> <SCHEMA>Help/helpSchema.xml</SCHEMA><!– path to doc --> <TEMPLATE>Help/helpTemplate.xml</TEMPLATE><!– path to doc --> <DATAXSL>Help/helpView.xsl</DATAXSL><!– path to doc --> <ADDITION_RESTRICTION>true</ADDITION_RESTRICTION>  <TOTAL_FILES>20</TOTAL_FILES>  <LAST_ITEM></LAST_ITEM> <IS_CAPABILITIES>true</IS_CAPABILITIES> <IS_FAST_INDEX>false</IS_FAST_INDEX> <DOC_NAME_TYPE>default</DOC_NAME_TYPE> </SECTION>

View in VO

Id

NameDescription

Configuration files naming rules

<TREE>Help/helpTree.xml</TREE>

where “Help” is eXist directory for all configuration files of this section; directory name can be any, but sectionId is preferred

where “helpTree.xml” is a config file name, can be any, but preferred (and used by us) naming is

[sectionId][configType].xml

[sectionId]Tree.xml<SECTION> <ID>Help</ID>  <NAME>All Help Documents</NAME> <DESCRIPTION>….</ DESCRIPTION > <NODE> <ID>AddingMetadata</ID> <!– any nodeId --> <NAME>Adding Metadata</NAME> <DESCRIPTION>….</ DESCRIPTION > <FILTER_DEFAULT>false</FILTER_DEFAULT> <!– is not used --> </NODE> <NODE> <ID>General</ID> <NAME>General Help</NAME> <FILTER_DEFAULT>false</FILTER_DEFAULT> </NODE></SECTION>

[sectionId]Template.xml

<Help> <Title>keyTitle</Title> <Annotation>keyAnnotation</Annotation> <Text>keyText</Text></Help>

Document template for the web XML editor. It is a real doc which can be filled in from web using the key-element mapping

Elements form an XML schema configuration file (see below)

Keys are unique inside the template. They are used to map web form fields to the element values by the web editor

[sectionId]Schema.xml -- XSD

[sectionId]Schema.xml<SCHEMA> <SCHEMA_NAME>Help</SCHEMA_NAME> <!– section Id --> <SCHEMA_TITLE>Help-record addition form</SCHEMA_TITLE> <SCHEMA_DESCRIPTION>Please fill in the …<SCHEMA_DESCRIPTION> <FIELD> <KEY>keyTitle</KEY> <LONGNAME>Title</LONGNAME> <DESCRIPTION>The name of the search result provider.</DESCRIPTION> <NOTE>Required</NOTE> <TYPE>text</TYPE> <DATATEMPLATE>value</DATATEMPLATE> <IS_DISPLAY_TITLE/> <IS_CAPABILITIES use="identification"/> <IS_FAST_INDEX/> </FIELD> <FIELD>  </FIELD></SCHEMA>

where <KEY>keyTitle</KEY> -- is a unique key to link web editor template (see above) and the XML document schema <Title>keyTitle</Title>

FIELD can have other FIELDs inside OR describe an element from the template (real XML document)

Равнозначная запись с точки зрения системы

<SCHEMA> <SCHEMA_NAME>Help</SCHEMA_NAME> <!– section Id --> <SCHEMA_TITLE>Help-record addition form</SCHEMA_TITLE> <SCHEMA_DESCRIPTION>Please fill …<SCHEMA_DESCRIPTION> <FIELD> <KEY>keyTitle</KEY> <LONGNAME>Title</LONGNAME> <DESCRIPTION>The name of the search result provider.</DESCRIPTION> <NOTE>Required</NOTE> <TYPE>text</TYPE> <IS_DISPLAY_TITLE/> <IS_CAPABILITIES use="identification"/> <IS_FAST_INDEX/> </FIELD> <FIELD>  </FIELD></SCHEMA>

<SCHEMA> <SCHEMA_NAME>Help</SCHEMA_NAME> <SCHEMA_TITLE>Help-record addition form</SCHEMA_TITLE> <SCHEMA_DESCRIPTION>Please fill in the …<SCHEMA_DESCRIPTION> <FIELD> <LONGNAME>fieldName</LONGNAME> <DESCRIPTION>This field contains other fields</DESCRIPTION> <FIELD> <LONGNAME>subFieldName</LONGNAME> <DESCRIPTION>This subfield contains other fields</DESCRIPTION> <FIELD> <KEY>keyTitle</KEY> <LONGNAME>Title</LONGNAME> <DESCRIPTION>The name of the search result provider.</DESCRIPTION> <NOTE>Required</NOTE> <TYPE>text</TYPE> <IS_DISPLAY_TITLE/> <IS_CAPABILITIES use="identification"/> <IS_FAST_INDEX/> </FIELD> <FIELD>  </FIELD> </FIELD> <FIELD>  </FIELD> </FIELD></SCHEMA>

FIELD view

Например

/NumericalData/AccessInformation/AccessRights/

Где синее – филды содержащие другие филды

Где красное – филд содержащий отдельный элемент

Edit form<LONGNAME/>

<DESCRIPTION/>

<DATATEMPLATE/>

12

1 – филды содержащие другие филды

2 – филды описывающие элементы

“IS_DISPLAY” elementsAll the flags listed below can be used in the XML schema document ONLY

ONCE:

• IS_DISPLAY_TITLE (required)• IS_DISPLAY_DESCRIPTION (required)• IS_DISPLAY_LINK• IS_DISPLAY_DATE_FROM• IS_DISPLAY_DATE_TO• IS_DISPLAY_N_COVERAGE• IS_DISPLAY_S_COVERAGE• IS_DISPLAY_W_COVERAGE• IS_DISPLAY_E_COVERAGE

Content of the listed elements is used to make a meta-meta record for a cross-section search inside VO

IS_CAPABILITIES

• All elements marked by this flag are searchable from outside using the standard VO “outersearch” web service and their values can be returned in the resulting XML document

• Attributes of the IS_CAPABILITIES are used to build a search form to call the “outersearch” web service. In theory VO admin can add any attributes to the element. One standard attribute is:

• use=“identification” – this field should be present on the search web form (most likely this element will be used in the search criteria)

IS_FAST_INDEX

• This flag indicates that the element will be indexed outside eXist (say, MySQL full text indexer)

• By default we do not installed external indexers, so default value of this flag is “false”

• This flag is optional (takes value “false” if omitted)

<TYPE>***</TYPE>Usually :) takes one of the values: text, multipletext, select, multipleselect

If select or multipleselect are used, then their values should be listed in the OPTION elements list <FIELD>

<KEY>keySelect</KEY>

<LONGNAME>Select</LONGNAME>

<DESCRIPTION>Select</DESCRIPTION>

<TYPE>select</TYPE>

<OPTION value="111"/>




</FIELD>

[sectionId]View.xsl

• This configuration file describes rendering of the XML records on the web page

• It is a standard XSL file