Skip to content

Grunt plugin that uploads zipped extension files during development

License

Notifications You must be signed in to change notification settings

CognosExt/grunt-cognos-ext-upload

Repository files navigation

grunt-cognos-ext-upload

CircleCI Greenkeeper badge

Use Grunt to upload your IBM Cognos Analytics custom extensions directly from your local machine into your cognos installation without opening your browser.

Getting Started

This plugin requires Grunt >=0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-cognos-ext-upload --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks("grunt-documentation");

Usage

Table of Contents

gruntUpload

Grunt Cognos Extension Upload

In your project's Gruntfile, add a section named cognos_ext_upload to the data object passed into grunt.initConfig().

Parameters

  • grunt
  • options Object
    • options.name string Name of the extension as found in the specs.json (TODO: read the name from the specs.json)
    • options.user string Cognos Username with enough priviliges to upload (new) extensions
    • options.password string Password of the user
    • options.namespace string The Cognos namespace id, if not the default
    • options.url string URL of the homepage of your Cognos 11 installation (eg. https://localhost/ibmcognos )
    • options.type string type of upload. Default is 'extensions', for themes use 'themes'.
    • options.zipfile string name of the zipfile to upload. Defaults to dist/extension.zip
    • options.timeout number Timeout of connection in milliseconds, defaults to 60000
    • options.ignoreInvalidCertificates boolean Ignore invalid ssl certificates. Default is false.
    • options.debug string Creates more output

Examples

grunt.initConfig({
  documentation: {
      default: {
          options: {
              name: 'My_Theme',
              user: "admin",
              password: "secret",
              namespace: "MyNameSpace",
              url: "https://localhost/ibmcognos",
              type: "themes",
              zipfile: "dist/mytheme.zip",
              timeout: 30000,
              ignoreInvalidCertificates: true,
              debug: false
          }
      },
  }
});

About

Grunt plugin that uploads zipped extension files during development

Resources

License

Stars

Watchers

Forks

Packages

No packages published