Define custom properties for resources

You can create custom properties for resource objects so that users can enter additional information about resources that are not directly managed by the IXIASOFT CCMS, such as videos, legacy documentation, etc. The custom properties ensure that this content is indexed and can be searched easily.

For example, you could create a custom property called ISBN to store the document number for legacy documentation. You could also create a property to indicate whether a resource should be included in builds when documentation is built every night.

Figure: Configuring properties for a resource


When a user configures custom properties for a resource, the information is written into the Indexed Content file of the resource as metadata, as shown in the example below.
<metadata class="- topic/metadata ">
   <othermeta class="- topic/othermeta " content="false" name="user:build"/>
   <othermeta class="- topic/othermeta " content=" 1-23456-789-0" name="user:ISBN"/>
</metadata>
Note: You should make these configuration changes in the Test environment and test them before copying them to the Production environment. In a dedicated SaaS deployment, after testing the changes, ask IXIASOFT Customer Support to copy the changes to the Production environment.
  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the userproperties.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. Locate the "resource" object element:
    <objecttype type="resource">
  5. Use the <property> element to give the custom property an ID and a name:
    For example:
    <property id="isbn" label="ISBN Number">
    </property>
    <property id="build" label="Include in build">
    </property>
    Note: The label value appears in the Property column of the User Properties dialog box as shown in the screenshot above.
  6. If applicable, enter an <allowedvalue> element for each possible value of the property:
    <property id="build" label="Include in build">
       <allowedvalue>true</allowedvalue>
       <allowedvalue>false</allowedvalue>
    </property>
  7. Repeat the previous steps to create additional custom properties if desired.
  8. Save, close, and check in the file.
  9. 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.