Path changes to atolcd-cde-plugin, placeholder change in indicatorMap…

…ping property interface, function checkColor enhanced Change-Id: Id3bd9ebbc198e11a9bbca03ba7733c41367d6f16
atolcd · Feb 14, 2018 · 8bab03a · 8bab03a
1 parent c30ba7d
commit 8bab03a
Show file tree

Hide file tree

Showing 13 changed files with 319 additions and 319 deletions.
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@ Works with Pentaho 6.0 and above.
 
 Installation instructions
 ---------------------
-1. **Install the Pentaho plug-in atolcd:** start Pentaho BI Server and open it in a browser; search for the plug-in atolcd in Pentaho Marketplace and install its latest version; clear browser’s cache and restart Pentaho server.
-2. **Include Atol CD input types:** reopen Pentaho in browser; open the installation page of atolcd plug-in (menu Tools > Atol CD Plugins); click on the button “Click here to finish plugin installation”; clear browser’s cache and restart Pentaho server.
+1. **Install the Pentaho plug-in Atol CD Plugins:** start Pentaho BI Server and open it in a browser; search for the plug-in Atol CD Plugins in Pentaho Marketplace and install its latest version; clear browser’s cache and restart Pentaho server.
+2. **Include Atol CD input types:** reopen Pentaho in browser; open the installation page of Atol CD Plugins (menu Tools > Atol CD Plugins); click on the button “Click here to finish plugin installation”; clear browser’s cache and restart Pentaho server.
 3. **Installation complete**.
 
 To get more information about this plugin, please refer to our [documentation](https://github.com/atolcd/pentaho-cde-atolcd-plugins/blob/master/docs/SVG%20Component/README.adoc).

diff --git a/build.properties b/build.properties
@@ -1,11 +1,11 @@
 # Stage: TRUNK | STABLE | BETA | other branch
 project.stage=SPARKL
 project.stage.name=Sparkl
-project.version=1.0
+project.version=1.0.1
 project.revision=${project.stage}-${project.version}
 # Version: a numeric value or SNAPSHOT. SNAPSHOT is replaced by DSTAMP
 package.url=not defined
-ivy.artifact.id=atolcd
+ivy.artifact.id=atolcd-cde-plugin
 ivy.artifact.group=Atol CD
 impl.title=Provides components for Community Dashboard Editor.
 project.description=Provides components for Community Dashboard Editor.

diff --git a/cpk.xml b/cpk.xml
@@ -29,6 +29,6 @@
         <company_name>Atol CD</company_name>
         <company_url>www.atolcd.com</company_url>
         <creation_date>2017-07-26</creation_date>
-        <version>1.0</version>
+        <version>1.0.1</version>
     </info>
 </cpk> 
diff --git a/dashboards/admin/main.cdfde b/dashboards/admin/main.cdfde
@@ -42,7 +42,7 @@
      {
       "name": "expression",
       "type": "JavaScript",
-      "value": "function() {\n    var dialog = Dashboards.getComponentByName('${c:dialog}');\n    \n    sparkl.runEndpoint('atolcd', 'includeAtolcdInputTypes', {\n        success: function(data) {\n            Dashboards.decrementRunningCalls();\n            \n            var message = 'Plugin correctly installed.';\n            \n            if (data.resultset.length > 0) {\n                var resColNum = data.metadata.filter(function(column) {\n                    return column.colName == 'result';\n                })[0].colIndex;\n                \n                if (typeof resColNum !== 'undefined') {\n                    var contains = data.resultset[0][resColNum];\n                    \n                    if (contains == 'contains') {\n                        message = 'Plugin already correctly installed.';\n                    }\n                }\n            } else {\n                message = 'Transformation configuration error.';\n            }\n            \n            dialog.open({\n                message: message,\n                dialogClass: 'closeButtonVisible'\n            });\n        },\n        error: function() {\n            Dashboards.decrementRunningCalls();\n            dialog.open({\n                message: 'Error while installing plugin.',\n                dialogClass: 'closeButtonVisible'\n            });\n        }    \n    });\n} "
+      "value": "function() {\n    var dialog = Dashboards.getComponentByName('${c:dialog}');\n    \n    sparkl.runEndpoint('atolcd-cde-plugin', 'includeAtolcdInputTypes', {\n        success: function(data) {\n            Dashboards.decrementRunningCalls();\n            \n            var message = 'Plugin correctly installed.';\n            \n            if (data.resultset.length > 0) {\n                var resColNum = data.metadata.filter(function(column) {\n                    return column.colName == 'result';\n                })[0].colIndex;\n                \n                if (typeof resColNum !== 'undefined') {\n                    var contains = data.resultset[0][resColNum];\n                    \n                    if (contains == 'contains') {\n                        message = 'Plugin already correctly installed.';\n                    }\n                }\n            } else {\n                message = 'Transformation configuration error.';\n            }\n            \n            dialog.open({\n                message: message,\n                dialogClass: 'closeButtonVisible'\n            });\n        },\n        error: function() {\n            Dashboards.decrementRunningCalls();\n            dialog.open({\n                message: 'Error while installing plugin.',\n                dialogClass: 'closeButtonVisible'\n            });\n        }    \n    });\n} "
      },
      {
       "name": "failureCallback",
@@ -227,49 +227,49 @@
  "datasources": {
   "rows": [
    {
-    "id": "ATOLCD_CPKENDPOINTS",
-    "name": "ATOLCD Endpoints",
+    "id": "ATOLCD-CDE-PLUGIN_CPKENDPOINTS",
+    "name": "ATOLCD-CDE-PLUGIN Endpoints",
+    "type": "Label",
+    "typeDesc": "<i>Group</i>",
     "parent": "UnIqEiD",
     "properties": [
      {
       "name": "Group",
-      "type": "Label",
-      "value": "ATOLCD Endpoints"
+      "value": "ATOLCD-CDE-PLUGIN Endpoints",
+      "type": "Label"
      }
-    ],
-    "type": "Label",
-    "typeDesc": "<i>Group</i>"
+    ]
    },
    {
-    "id": "f2f0e205-3654-ca0d-4d78-28a6e0d066fc",
-    "meta": "CPK",
-    "meta_endpoint": "includeAtolcdInputTypes",
-    "meta_pluginId": "atolcd",
-    "parent": "ATOLCD_CPKENDPOINTS",
+    "id": "e915526d-9226-b2d6-cb0a-1a27d01069f7",
+    "type": "Componentsatolcdcdeplugin_includeAtolcdInputTypes_CPKENDPOINT",
+    "typeDesc": "includeAtolcdInputTypes Endpoint",
+    "parent": "ATOLCD-CDE-PLUGIN_CPKENDPOINTS",
     "properties": [
      {
       "name": "name",
-      "type": "Id",
-      "value": "includeAtolcdInputTypesEndpoint"
+      "value": "includeAtolcdInputTypes",
+      "type": "Id"
      },
      {
       "name": "stepName",
-      "type": "String",
-      "value": "OUTPUT"
+      "value": "OUTPUT",
+      "type": "String"
      },
      {
       "name": "kettleOutput",
-      "type": "kettleOutputCustom",
-      "value": "Inferred"
+      "value": "Inferred",
+      "type": "kettleOutputCustom"
      }
     ],
-    "rowName": "includeAtolcdInputTypes Endpoint",
-    "type": "Componentsatolcd_includeAtolcdInputTypes_CPKENDPOINT",
-    "typeDesc": "includeAtolcdInputTypes Endpoint"
+    "meta": "CPK",
+    "meta_pluginId": "atolcd-cde-plugin",
+    "meta_endpoint": "includeAtolcdInputTypes",
+    "rowName": "includeAtolcdInputTypes Endpoint"
    }
   ]
  },
- "filename": "/system/atolcd/dashboards/admin/main.cdfde",
+ "filename": "/system/atolcd-cde-plugin/dashboards/admin/main.cdfde",
  "layout": {
   "rows": [
    {
@@ -677,4 +677,4 @@
   ],
   "title": "main"
  }
-}
+}
diff --git a/docs/SVG Component/SVG Component installation.adoc b/docs/SVG Component/SVG Component installation.adoc
@@ -24,7 +24,7 @@ Below are the prerequisites for SVG Component:
 
 == Plug-in content
 
-SVG Component is included inside the Pentaho plug-in *atolcd*, and contains:
+SVG Component is included inside the Pentaho plug-in *Atol CD Plugins*, and contains:
 
 * *“component.xml”*: the XML metadata file describing the structure of the editor HTML page to be built by Pentaho server and to be rendered by browsers for this specific component.
 * *“SVGComponent.js”* and *“SVG.js”*: the JavaScript files defining all behaviors of the component and how it will be rendered in CDE dashboards.
@@ -35,8 +35,8 @@ SVG Component is included inside the Pentaho plug-in *atolcd*, and contains:
 
 SVG Component is a *CDE component* and a plug-in conceived for *CDE*, whereas CDE itself is a plug-in of *Pentaho BI Platform*. In order to install SVG Component on CDE and Pentaho, you should complete the following steps:
 
-. *Install the Pentaho plug-in atolcd:* start Pentaho BI Server and open it in a browser; search for the plug-in *atolcd* in Pentaho Marketplace and install its latest version; clear browser’s cache and restart Pentaho server.
-. *Include Atol CD input types:* reopen Pentaho in browser; open the installation page of *atolcd* plug-in (menu *Tools > Atol CD Plugins*); click on the button “*Click here to finish plugin installation*”; clear browser’s cache and restart Pentaho server.
+. *Install the Pentaho plug-in Atol CD Plugins:* start Pentaho BI Server and open it in a browser; search for the plug-in *Atol CD Plugins* in Pentaho Marketplace and install its latest version; clear browser’s cache and restart Pentaho server.
+. *Include Atol CD input types:* reopen Pentaho in browser; open the installation page of Atol CD Plugins (menu *Tools > Atol CD Plugins*); click on the button “*Click here to finish plugin installation*”; clear browser’s cache and restart Pentaho server.
 . *Installation complete*.
 
 {empty} +
@@ -45,9 +45,9 @@ Above is the standard installation process for Pentaho 6.0 and above, and Requir
 
 IMPORTANT: Atol CD input types inclusion is compulsory, otherwise you will not be able to input information into the 3 properties “*SVG file*”, “*Legend*” and “*indicatorMapping*”. Input types are JavaScript objects defining the way data are input into properties. Each property is associated with exactly one input type, but each input type can be associated with many properties. The association between properties and input types is described in “*component.xml*”.
 
-IMPORTANT: Browser’s cache clearing and Pentaho server restart are also compulsory. The restart will allow Pentaho server to identify the new plug-in *atolcd* and to render the new *SVG Component*. Major browsers often store JS and CSS files in their cache so that data can be served faster in the future. Therefore, cache clearing will force browsers to update CDE interface with the new SVG Component. These two actions will also help updating an old version of SVG Component.
+IMPORTANT: Browser’s cache clearing and Pentaho server restart are also compulsory. The restart will allow Pentaho server to identify the new plug-in *Atol CD Plugins* and to render the new *SVG Component*. Major browsers often store JS and CSS files in their cache so that data can be served faster in the future. Therefore, cache clearing will force browsers to update CDE interface with the new SVG Component. These two actions will also help updating an old version of SVG Component.
 
-NOTE: We have tested this installation process on *Pentaho 5.x*. You will need to install the specific and corresponding version of SVG Component for Pentaho 5.x, containing some minor changes compared to its standard version. Also, you cannot properly open the installation page of atolcd plug-in (incompatibilities with old versions of Pentaho). Thus, you have to manually include Atol CD input types, by opening the file */pentaho-solutions/system/pentaho-cdf-dd/editor.includes.properties* and add the path to the JS file containing these input types: “*../atolcd/js/cdf-dd-components-atolcd.js,*” at the end of the line “*scripts=[...]*”.
+NOTE: We have tested this installation process on *Pentaho 5.x*. You will need to install the specific and corresponding version of SVG Component for Pentaho 5.x, containing some minor changes compared to its standard version. Also, you cannot properly open the installation page of Atol CD Plugins (incompatibilities with old versions of Pentaho). Thus, you have to manually include Atol CD input types, by opening the file */pentaho-solutions/system/pentaho-cdf-dd/editor.includes.properties* and add the path to the JS file containing these input types: “*../atolcd-cde-plugin/js/cdf-dd-components-atolcd.js,*” at the end of the line “*scripts=[...]*”.
 
 {empty} +
 
@@ -61,10 +61,10 @@ For *legacy / non RequireJS dashboards*, in order to use the export feature, you
 
 {empty} +
 
-There is another way to deploy SVG Component without installing the plug-in *atolcd*:
+There is another way to deploy SVG Component without installing the plug-in *Atol CD Plugins*:
 
-. Go to the *https://github.com/atolcd/pentaho-cde-atolcd-plugins[GitHub page]* of the plug-in *atolcd* and download its latest version (as a compressed file).
-. Extract the downloaded file, then compress the folder */atolcd/resources/components/SVG* as a ZIP file.
+. Go to the *https://github.com/atolcd/pentaho-cde-atolcd-plugins[GitHub page]* of the plug-in *Atol CD Plugins* and download its latest version (as a compressed file).
+. Extract the downloaded file, then compress the folder */atolcd-cde-plugin/resources/components/SVG* as a ZIP file.
 . Start Pentaho server, upload the ZIP file to the folder *Public/cde/components* in Pentaho repository (if you cannot find it, menu *View > Show Hidden Files*).
 . Copy the file *cdf-dd-components-atolcd.js* to */pentaho-cdf-dd/js*, manually change the file *editor.includes.properties* as above (now with “*js/cdf-dd-components-atolcd.js,*”).
-. Clear browser’s cache, restart Pentaho server.
+. Clear browser’s cache, restart Pentaho server.