Configure resource types

Resources are document objects that support a documentation project, such as videos, legacy documentation, PDF files, and so on. You can configure the resource types and descriptions that can be stored in the Content Store.

Note: This can be applied within a Hosted environment, but only within a test server.

For example, schedule charts could be added as a reference resource for a project with a long and complex timeline. The resource types and descriptions that you configured are then indexed to allow users to locate the resources through the search function.

Resource types are categories that allow users to identify resources by their function. The table at the end of this procedure provides descriptions of default resource types.

To configure a new resource type:

  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Perspective > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click Open.
  2. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
  3. When the Connect as dialog opens, type your username and password and click OK.
  4. Double-click the name of your Content Store to open a connection to it.
  5. Locate the resource.xml file in the repository's /system/conf collection.
  6. Check out the file.
  7. Open resource.xml with a text editor.
    The <resourcetypes> element lists all the types that have been configured.
    <resource>
    	<resourcetypes>
    		<type description="">pdf-graphics</type>
    		<type description="">pdf-legal</type>
    		<type description="">css</type>
    		<type description="">html</type>
    		<!-- Default type used by the import process -->
    		<type description="">unknown</type>
    	</resourcetypes>
    </resource>

    Default resource types include:

    Table 1. Default resource types
    Resource type Description
    pdf-graphics A PDF format document with graphics such as charts, timelines, or photographs.
    pdf-legal A PDF format document with legal information such as copyright notice.
    css Cascading style sheets (css) for use with project documents.
    html HTML pages, such as web help.
    unknown All non-DITA files such as PDF files or videos imported as resource objects of an undefined type.
  8. To create a new type, enter a <type> element:
    For example:
    <type>pdf-timeline</type>
    Tip: To simplify resource searches, limit your type list to broad categories (no more than 10 types).
  9. Optionally, enter a description attribute:
    <type description="IXIA project timeline">pdf-timeline</type>

    The description can be helpful for users unfamiliar with the resource types when they consult the resource.xml file.

  10. Save, close, and check in the resource.xml file.
    Note: To create a column to display resource type values in the Search Results window, modify display.xml.
  11. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their IXIASOFT CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIASOFT CCMS > Synchronize Configuration.