Element Details: Data Layer Plugin Call
 Back


Available in: Logi Info Source code name: DataLayerPluginCall

A Plugin Call runs a method inside of a Plugin. A Plugin is a .NET library assembly (a DLL) or Java .JAR file containing custom code that performs actions while each request is processed.

DataLayerPluginCalls can modify the XML data returned by the DataLayer. And they have full access to web request, application, session and response objects.

Element Group:Extensions and Shared Elements



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
ID
UserDefined
(Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
IncludeCondition
True
False
An expression that evaluates to a value of True or False. If the expression is blank, or evaluates to true the element is processed. If the expression evaluates to false, the element is skipped. Expressions should be in VBScript or JavaScript syntax. For .NET versions, the scripting language can be set in the _settings.lgx General element. For Java versions, the scripting language is always JavaScript. Typically, you would compare values using an operator, such as "@Session.value~ < 0". Use quotes when working with strings: "@Session.myValue~" == "SomeValue"
JavaPluginVersion
Version10
UserDefined
The JavaPluginVersion attribute determines which version of LogiPluginObjects to use in the plugin call. LogiPluginObjects is the developer API for the Info Server Java plugin system. Omitting this attribute will cause the original LogiPluginObjects to be used. Specifying "Version10" in this attribute will result in LogiPluginObjects10 being used as the developer API. LogiPluginObjects10 has all the properties and methods of LogiPluginObjects, and also has additional methods such as addDebugMessage(), replaceTokens() and getSettingsDefinition(). Leaving JavaPluginVersion blank maintains backward compatibility with older versions of Info. LogiPluginObject10 is located in the package com.logixml.plugins. The original LogiPluginObjects was in the root package. This is also a value "DotNet" which designates a plugin written in .NET and cross-compiled for Java with Mainsoft Grasshopper. This attribute has no effect on .NET Info applications, which have all the methods of both versions.
PassDataAs
XmlDocument
FileName
PassDataAs specifies how DataLayer XML data is passed into and out of a Plugin. "XmlDocument" will pass the data as an in-memory XML document object (Default). The data is added to the "CurrentData" property of the ServerObjects. "FileName" will pass the XML data with a file. There may be an input data file found in the ServerObjects.CurrentDataFile property and there will be an output filename in ServerObjects.ReturnedDataFile. These names include the fully qualified path. The default value is "XmlDocument". "XmlDocument" stores the data set in memory. Use "FileName" to reduce the amount of memory used when working with large data sets. With "FileName" the plugin can work with the data using Xml stream readers and writers.
PluginMethod
UserDefined
(Required) The name of the Plugin's method to be called.
PluginName
UserDefined
(Required) The filename of the plugin assembly, typically ending in ".dll" for .NET or a .class file in a .jar for Java. In .NET the assembly file should normally be located in the _Plugins folder, under the application root. In Java a standalone .class file goes in WEB-INF\classes under the application root. A .jar file containing. class files goes in WEB-INF\lib under the application root. You may also specify a complete absolute path to the assembly dll in .Net. This should not be done in Java. However, the full name of the Java class including package is necessary(i.e. com.logixml.plugins.SamplePlugin10).
PluginTypeName
UserDefined
The TypeName specifies the plugin's class that contains the method that will be called. The value consists of the dll's root namespace, ".", and the class name. For example: "LogiXML.SamplePlugin.Plugin". This attributes is required for .NET plugins, and is ignored for Java plugins.



PARENT ELEMENTS

Click element to drill down for more information.

DataLayer.Bookmarks
DataLayer.Cached
DataLayer.CSV
DataLayer.Definition List
DataLayer.Directory
DataLayer.ETL
DataLayer.Excel
DataLayer.Fixed Format File
DataLayer.Google App
DataLayer.Google Spreadsheet
DataLayer.GPX File
DataLayer.JSON
DataLayer.KML File
DataLayer.LDAP
DataLayer.Linked
DataLayer.Mongo Find
DataLayer.Mongo Map Reduce
DataLayer.Mongo Run Command
DataLayer.Plugin
DataLayer.REST
DataLayer.Scheduler
DataLayer.SimpleDB
DataLayer.SP
DataLayer.SQL
DataLayer.Static
DataLayer.Twitter
DataLayer.Web Feed
DataLayer.Web Scraper
DataLayer.Web Service
DataLayer.XML
Procedure.Data


CHILD ELEMENTS

Click element to drill down for more information.

Plugin Parameters


 Back to top