data_entry_properties.xml file
The data_entry_properties.xml file defines the HTML properties and script that provide content for additional catalog and hierarchy elements that are displayed in the Single Edit panel.
Values
For each set of <script></script> tags, you can specify:- type
There are two types of scripts you can specify in the <type></type> tags:
- url
- Specifies a script whose
getURL(entry)function returns a URL. This URL is then used for displaying an iframe on the Single Edit panel directly after the Common Attributes section. - content
- Specifies a script whose
getContent(entry)function returns HTML content. This HTML content is then used for displaying a div on the Single Edit panel directly after the Common Attributes section.
- title
- In the <title></title> tags, specify the title of the iframe or div element.
- path
- In the <path></path> tags, specify the script and directory file path: scripts/triggers/script_Name
- extra
- Optionally, through the <extra></extra> tags, you can pass extra HTML markup to format your iframe or div elements.
File location
The data_entry_properties.xml file is located in $TOP/etc/default directory.
Single edit and multi-edit with rich search simplified user interface support
For the Single edit and multi-edit with rich search simplified screen, the data_entry_properties.xml file provides additional options to configure the behavior and display of the frames. In addition to the required parameters mentioned above, you can also specify the following optional parameters for each script:- <position></position> tags
- Specify the position of the iframe or div element for a script. The position can be tab or top. If this tag is not present for a script, the default position for its iframe or div element is top.
- <display-state></display-state> tags
- Specify the initial display state for an iframe or div element for a script which is configured to be displayed at the top position. The display state can be expanded or collapsed. If this tag is not present for a script, the initial display state for its iframe or div element is expanded.
- <refresh-on></refresh-on> tags
- Specify zero or more <action></action> tags. Each action tag represents a single action on the single edit screen on which the script should be executed again and the content of its iframe or div element refreshed. If the refresh-on tag for a script does not contain any action tags, the script will not be executed after the initial load on any action. If the refresh-on tag is not present for a script, the script will be executed again and the content of its iframe or div element is refreshed on all valid actions for the container.
- <action></action> tag
- Specify a valid action on the Single Edit screen. The valid values
of action tags for different container types are:
- Catalog
- save, refresh, revert, categorize
- Catalog Collaboration Area
- save, refresh, revert, categorize
- Hierarchy
- save, refresh, revert, modify_spec_mapping
- Hierarchy Collaboration Area
- save, refresh, revert, modify_spec_mapping
Example
<company code="trigo">
<catalog name="catalog1">
<script>
<type>url</type>
<extra>height='150'</extra>
<title>Sample Script 1</title>
<path>/scripts/triggers/sampleScript1</path>
<position>top</position>
<display-state>expanded</display-state>
<refresh-on>
<action>save</action>
<action>categorize</action>
<action>refresh</action>
</refresh-on>
</script>
<script>
<type>content</type>
<title>Sample Script 2</title>
<path>/scripts/triggers/sampleScript2</path>
<position>tab</position>
<refresh-on></refresh-on>
</script>
</catalog>
<hierarchy name="hierarchy1">
<script>
<type>url</type>
<title>Sample Script 3</title>
<path>/scripts/triggers/sampleScript3</path>
<position>top</position>
<display-state>collapsed</display-state>
<refresh-on>
<action>save</action>
<action>modify_standalone_spec</action>
<action>refresh</action>
<action>revert</action>
</refresh-on>
</script>
<script>
<type>url</type>
<title>Sample Script 4</title>
<path>/scripts/triggers/sampleScript4</path>
</script>
</hierarchy>
<collaboration-area name="catalogCA1">
<script>
<type>url</type>
<extra>height='150'</extra>
<title>Sample Script 5</title>
<path>/scripts/triggers/sampleScript5</path>
<position>top</position>
<display-state>expanded</display-state>
<refresh-on>
<action>save</action>
<action>categorize</action>
<action>revert</action>
</refresh-on>
</script>
<script>
<type>content</type>
<title>Sample Script 6</title>
<path>/scripts/triggers/sampleScript6</path>
<position>tab</position>
<refresh-on></refresh-on>
</script>
<script>
<type>content</type>
<title>Sample Script 7</title>
<path>/scripts/triggers/sampleScript7</path>
<position>tab</position>
</script>
</collaboration-area>
</company>
<catalog name="catalog1">
<script>
<type>url</type>
<extra>height='150'</extra>
<title>Sample Script 1</title>
<path>/scripts/triggers/sampleScript1</path>
<position>top</position>
<display-state>expanded</display-state>
<refresh-on>
<action>save</action>
<action>categorize</action>
<action>refresh</action>
</refresh-on>
</script>
<script>
<type>content</type>
<title>Sample Script 2</title>
<path>/scripts/triggers/sampleScript2</path>
<position>tab</position>
<refresh-on></refresh-on>
</script>
</catalog>
<hierarchy name="hierarchy1">
<script>
<type>url</type>
<title>Sample Script 3</title>
<path>/scripts/triggers/sampleScript3</path>
<position>top</position>
<display-state>collapsed</display-state>
<refresh-on>
<action>save</action>
<action>modify_standalone_spec</action>
<action>refresh</action>
<action>revert</action>
</refresh-on>
</script>
<script>
<type>url</type>
<title>Sample Script 4</title>
<path>/scripts/triggers/sampleScript4</path>
</script>
</hierarchy>
<collaboration-area name="catalogCA1">
<script>
<type>url</type>
<extra>height='150'</extra>
<title>Sample Script 5</title>
<path>/scripts/triggers/sampleScript5</path>
<position>top</position>
<display-state>expanded</display-state>
<refresh-on>
<action>save</action>
<action>categorize</action>
<action>revert</action>
</refresh-on>
</script>
<script>
<type>content</type>
<title>Sample Script 6</title>
<path>/scripts/triggers/sampleScript6</path>
<position>tab</position>
<refresh-on></refresh-on>
</script>
<script>
<type>content</type>
<title>Sample Script 7</title>
<path>/scripts/triggers/sampleScript7</path>
<position>tab</position>
</script>
</collaboration-area>
</company>