Documentation Center

Description of Custom Modules

Custom modules are Perl modules that inherit from delivered custom modules.

Custom modules are located in the Contenta_home/encaps/adapters/custom directory. The current base custom modules are CustomGetDocDefault.pm, CustomGetDocFetchDefault.pm and CustomPutDocDefault.pm.

To specialize the behavior of the adapters, you can create your own custom module derived directly from the base modules or you can inherit from one of the custom modules derived from a base. You then override some or all of the subroutines prototyped in the delivered base modules. The modules typically used as a starting point by programmers are:
  • CustomGetDocEpicCat.pm
  • CustomGetDocFrameCat.pm
  • CustomGetDocXmetalCat.pm
  • CustomPutDocEpicCat.pm
  • CustomPutDocFrameCat.pm
  • CustomPutDocXmetalCat.pm
  • CustomGetDocFetch.pm
  • CustomGetDocEpicCat.pm

In the following example the module CustomGetDocEpicAcme.pm started as a file copy of CustomGetDocEpicCat.pm. A few edits were made to render it into a distinct Perl package that inherits from the original module and its ancestor modules. The details are explained in the section titled, Creating a Custom Module.

Example, inheritance hierarchy:
CustomGetDocDefault.pm <= CustomGetDocCatDefault.pm <=
CustomGetDocEpicCat.pm <= CustomGetDocEpicAcme.pm