Skip to content

Creating custom plug-ins

A custom plug-in is a reusable Java class that you create to run a task. You can create custom plug-ins such as custom workflow actions, plug-ins to run when a page is rendered, plug-ins to store multi-locale text strings and plug-ins to run when a file is uploaded.

  • Creating a custom button class
    You can create custom button classes that dynamically add custom actions to the authoring interface. Custom buttons are used to integrate third-party tools into the authoring interface without using a custom element. For example, you can use a custom button that adds automatic profiling of a content item or that adds or changes elements on the item forms.
  • How to create a rendering plug-in class
    A rendering plug-in is a reusable class that you create to run a task at render time. It can be referenced within web content by using a plug-in tag. For example, you might write a plug-in that uses attributes from the current user's profile to determine whether the body of the plug-in tag is rendered or not. A rendering plug-in class requires you to reference a set of web content API methods.
  • How to create a custom workflow action class
    You can create custom workflow action classes to add custom workflow actions to a workflow.
  • Creating a Text Provider class
    A text provider is used to provide localized text that can be used within web content item forms. For example, a text provider can be used to localize the field labels or help text within an authoring template so that each user sees the labels or help text in their own language.
  • Creating a Text Provider Factory class
    A text provider factory is used to provide multiple text providers that can be used within web content item forms. Text provider can be used to localize the field labels or help text within an authoring template so that each user sees the labels or help text in their own language. A text provider factory can make multiple such text providers available.
  • Creating a file upload validation class
    A file upload validation plug-in is started anytime a file is uploaded into Web Content Manager. This includes uploading files into file resource, image and stylesheet elements, and images that are uploaded into rich text or HTML elements. The plug-in is called within the "validation" processing that is used by Web Content Manager when uploading files.
  • Creating an item validation plug-in class
    An item validation plug-in is used to validate a TemplatedDocument prior to it being committed to the repository. It is invoked as part of the standard item validation step. For example, saves occurring in the authoring interface, public API or REST API.
  • Creating a subscriber class
    A subscriber plug-in is used to run extra functions on the subscriber that can be used to determine if the subscriber is ready for syndication when a syndication event is started.
  • Creating a syndicator class
    A syndicator plug-in is used to run extra functions on the syndicator when a syndication event is started.
  • Creating a context processor class
    When configured, a context processor plug-in is started by the web content viewer portlet before rendering and allows the current context, such as the item to display, to be modified.
  • Creating an operation check class
    The OperationCheckPlugin plugin is used to control whether an operation within the system should continue or whether it should be stopped. The extension is called prior to committing a Web Content Manager operation to evaluate whether the operation should be allowed to continue. The plug-in can return an error message to be shown to the user.
  • Creating a content page resolution filter class
    A content page resolution filter is used to customize the behavior of the content page resolution filter chain. This method is used to tailor the response to a web content request in several ways, including overriding the content item that is displayed or the portal page that is used to display a content item in the web content viewer.
  • Creating a content URL generation filter class
    A content URL generation filter is used to customize the URLs that are generated by a web content viewer. By creating a plug-in that implements a content URL generation filter, you can tailor the URLs to content items.
  • Deploying custom plug-in applications
    You must deploy your custom plug-in applications on your server before they can be used in your web content system.

HCLSoftware U learning materials

For an introduction and a demo on using DX for developers, go to DX for Developers (Advanced). To try it out yourself, refer to DX Setup Local Java Development Environment Lab.