Edit

Share via

Creating a Merge Module that Can Be Configured by the End-User

  • Article

To create merge modules, use the general guidelines that are described in the Authoring Merge Modules topic. In addition, you must do the following to create a merge module that may be configured by the end-user of the module:

  • End-users need to have Mergemod.dll version 2.0 to configure your module. Users who have earlier versions of Mergemod.dll can apply the module, but they always get the default settings.
  • Add a ModuleConfiguration Table to the merge module to identify the items that may be configured by an end-user. Add a record in this table for each configurable item. These items are substituted into the templates that are specified in the ModuleSubstitution Table. Enter a name for each configurable item into the Name field. Enter the format, type, and semantic context for each item in the Format, Type, and ContextData columns. For more information, see Semantic Types. Enter a default value for the item in the DefaultValue field using the CMSM Special Format.
  • Add a ModuleSubstitution Table to the merge module. Each record in this table corresponds to a substitution of one or more configurable items into one field of the merge module database. Enter the table, row, and column of the field that receives the substitution. Enter a formatting template for the substitution into the Value column using the CMSM Special Format.
  • Add records to the Validation Table for the ModuleSubstitution and ModuleConfiguration tables.
  • Add records to the ModuleIgnoreTable Table for the ModuleSubstitution Table and the ModuleConfiguration Table. This ensures that the module is compatible for users who have versions of Mergemod.dll that are earlier than version 2.0.