Views for Mashups and Mashables : Creating Pluggable Views or Libraries : Configuration Properties for Pluggable Views or Libraries
Configuration Properties for Pluggable Views or Libraries
When you import pluggable views or pluggable libraries, import adds them as pluggable libraries with local resources by default. See Example: Default Library Import with No Properties for an example.
You can use configuration properties to change this default or to manage other aspects of a pluggable view or pluggable library. Configuration properties can:
*Identify this as a pluggable view and help to integrate it with the MashZone NextGen View Gallery.
*Define dependencies on other libraries and ensure that MashZone NextGen can successfully load this pluggable view or library.
*Identify library resources when all resources are hosted externally.
*Manage ppluggable view and library versions and updates. See Managing Updates and Library Versions for more information on this usage.
*Provide other metadata for the view or library.
You set view/library configuration properties in either a properties file that you add to the library resources or in an Apache Ant™ build file. See Library Projects Folders and Configuration Files or Ant Tasks and Sample Build File to Import Pluggable Views or Libraries for more information.
See Pluggable View or Library Configuration Properties for a complete list of properties that you can use.
For examples of how properties affect imports, see:
*Example: Default Library Import with No Properties
*Example: Controlling the Library Import Process
*Example: Basic Library Import Properties
*Example: Pluggable View Import Basics
*Example: Pluggable View Import with Device Compatibility
*Example: Pluggable View Import with View Gallery Properties
*Example: Pluggable View Import with Library Dependencies
*Example: Pluggable Library Import for an Externally Hosted Library
Pluggable View or Library Configuration Properties
id
The ID for this pluggable library or pluggable view. This must match the name of the root folder that contains the resources for this view or library and must be a unique library name in this MashZone NextGen Repository.
Library IDs should be limited to ASCII letters, numbers and the dash(-) or underscore (_) characters.
Note:  
For custom apps, this ID is the library name in the App Spec.
name
The title to display in the MashZone NextGen View Gallery for a pluggable view.
Capitalization is unimportant in view titles as they display in a fully capitalized font.
View titles should be short. Titles with more than 14 characters may be truncated with a trailing ellipsis (...). The complete title is shown as a tooltip.
description
An optional, short description of the purpose of this pluggable library or pluggable view. For pluggable views, this displays as a tooltip in the View Gallery.
type
subtype
For pluggable views, the category in the View Gallery where this pluggable view should be listed. This can be the name of an existing category or a new category name.
If you omit this property, pluggable views are listed in the Pluggable Views category in the View Gallery. See Example: Pluggable View Import with View Gallery Properties for examples.
thumbnailUrl
An optional URL to the image to display in the View Gallery for this pluggable view. This URL may be relative, pointing to an image in folders for this library, or an absolute URL.
Note:  
Thumbnail images for pluggable views should be 72 pixels square.
If you omit this property, MashZone NextGen will use the image, if any in the /thumbnail folder of the pluggable view. If no /thumbnail folder is present and you omit this property, a default image is used:
helpUrl
A URL to an HTML page with user assistance information to help them configure a view using this pluggable view library. This help topic opens in a new window from the ? button in the Create View wizard.
This can be a relative URL, within the folders of the pluggable view, or an absolute URL.
version
The version number to use for this pluggable library or pluggable view. If omitted, this defaults to 1.
For more information on library versions, see Managing Updates and Library Versions.
defaultVersion
Whether this version of the pluggable library or pluggable view is considered the default version. This defaults to true.
Whether a view or library is the current default also determines whether existing views in mashables, mashups or apps use this version of the pluggable view or library. For more information on version control and updates to MashZone NextGen artifacts, see Managing Updates and Library Versions.
libPath
*For all pluggable views or for pluggable libraries with local resources that you host in MashZone NextGen, this property is calculated by MashZone NextGen.
*If this is a pluggable library with resources that are hosted externally, this property is the base URL to prepend to all JavaScript and CSS resources for this library. See Example: Pluggable Library Import for an Externally Hosted Library for an example.
js
An optional, comma-separated list of the JavaScript resources to include in this pluggable view or pluggable library.
*For all pluggable views or for pluggable libraries with local resources that you host in MashZone NextGen, this property is most commonly calculated by MashZone NextGen based on the JavaScript files found in the /js folder of the pluggable view or library.
If you want to exclude some files in this folder, you can use this property to list only those files that should be included in MashZone NextGen.
*For pluggable libraries that are hosted externally, list the specific JavaScript files to include in this library relative to the URL in the libPath property. See Example: Pluggable Library Import for an Externally Hosted Library for an example.
css
An optional, comma-separated list of the CSS resources to include in this pluggable view or pluggable library.
*For all pluggable views or for pluggable libraries with local resources that you host in MashZone NextGen, this property is most commonly calculated by MashZone NextGen based on the CSS files found in the /css folder of the pluggable view or library.
If you want to exclude some files in this folder, you can use this property to list only those files that should be included in MashZone NextGen.
*For pluggable libraries that are hosted externally, list the specific CSS files to include in this library relative to the URL in the libPath property. See Example: Pluggable Library Import for an Externally Hosted Library for an example.
dependsOn
If this pluggable library or pluggable view uses bundled libraries or other pluggable libraries, list the IDs of those libraries separated by commas. This information allows MashZone NextGen to ensure that all dependencies are loaded before loading this library.
Important:  
MashZone NextGen includes certain "third party software" which JackBe licenses from third parties. Pursuant to the JackBe EULA for MashZone NextGen, all MashZone NextGen users are bound by the license terms and conditions of any third party software licenses. You may review these Third Party Licenses at http://documentation.softwareag.com/legal/.
Software AG does not and cannot authorize any use of third party software that is not permitted by these third party software licenses. You may, however, be able to obtain licenses directly from third parties. In addition, any other software that you add and/or use in connection with MashZone NextGen is subject to its own licensing requirements and may void the terms of the EULA for MashZone NextGen.
loadConfirmation
A boolean expression containing one or more JavaScript namespaces or objects from this library that must exist at runtime to confirm that this library is completely loaded. For example:
MyOrg && MyOrg.MyView
This expression is not required but is highly recommended to ensure that libraries for pluggable views or custom apps are properly loaded before rendering. See Example: Basic Library Import Properties for an example.
desktop
Whether this pluggable library or pluggable view is compatible with desktop devices. Defaults to true.
Views created from this pluggable view inherit this device compatibility. This, in turn affects device compatibility for apps create from these views. See Example: Pluggable View Import with Device Compatibility for more information.
mobile
Whether this pluggable library or pluggable view is compatible with mobile devices. Defaults to true.
Views created from this pluggable view inherit this device compatibility. This, in turn affects device compatibility for apps create from these views. See Example: Pluggable View Import with Device Compatibility for more information.
hidden
Whether this pluggable library or pluggable view should be hidden in the App Editor, and thus not available for use in custom apps.
This defaults to false meaning the library will be visible in the App Editor. Change this to true to keep this pluggable view or library off the list of available, named libraries that users can add to custom apps.
createdBy
An optional username for the user who should be registered as the owner of this pluggable view or pluggable library.
If omitted, MashZone NextGen uses the username you specify when you register and upload the pluggable view or library as the owner.
Copyright © 2013-2016 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback