Skip to main content

Plugin Methods

Introduction​

General​

  • A Plugin Method is a configurable unit that defines how to call a specific method from a plugin to retrieve data.

Method Arguments​

  • When calling a Plugin Method, we support passing configured arguments. These arguments can be either static or dynamic. For dynamic arguments, we provide placeholders for values:
    • <Publication.Id>: Represents the current publication ID.
    • <Template.Id>: Represents the template ID of the current publication.
    • <Session.Id>: Represents the current session ID.
    • <Entity.Context>: Represents the current entity context.
    • <Metadata.{metadata_identifier}: Represents the value of publication metadata (mapped by metadata identifier).

Configuration​

ISON Configuration Details​

Sample​

<methods>
    <method id="plugin_method">
        <pluginMappedName>plugin_mapped_name</pluginMappedName>
        <methodName>method_name</methodName>
        <arguments>
            <argument key="Session.Id">&lt;Session.Id&gt;</argument>
            <argument key="Entity.Context">&lt;Entity.Context&gt;</argument>
            <argument key="Variable.name_1">value_1</argument>
            <argument key="Variable.Metadata_1">&lt;Metadata.metadata_1&gt;</argument>
        </arguments>
    </method>
</methods>

Explanation​

  • <methods>: Wrapper element for Plugin Methods configuration.
  • <method>: Each <method> element represents the configuration for a single Plugin Method.
    • Attributes:
      • id: The unique ID of the Method. This attribute is required.
    • Elements:
      • pluginMappedName: Mapped Name of the plugin. This element is required.
      • methodName: The name of the Method. This element is required.
      • arguments: Wrapper element for method arguments configuration.
      • argument: Defines an individual argument for the method call.
        • Attributes:
          • key: The key of the argument. This attribute is required.