This project is an OpenNTF project, and is available under the Apache License V2.0. All other aspects of the project, including contributions, defect reports, discussions, feature requests and reviews are subject to the OpenNTF Terms of Use http://openntf.org/Internal/home.nsf/dx/Terms_of_Use.
This toolkit includes two main areas of functionality:
To use these tools you will need:
The Dashboard tool uses the nw.js package to implement the user interface, and on some operating system versions such as CentOS there have been issues with some of the dependency packages for nw.js. We've also had reports of issues on Windows 10. If the install fails during the nw.js installation phase, or if the Dashboard doesn't launch successfully, you can try installing and running nw.js (https://www.npmjs.com/package/nw) on its own to see if it's a compatibility problem with that library.
For any issues you encounter, please report them in the Issues area of this project (https://github.com/OpenNTF/WebDevToolkitForDx/issues). We try to respond promptly to reported issues.
You must first install Node.js. Node.js version 0.12 is the minimum version and has had the most testing.
Download the digexp-toolkit.zip file from here: https://github.com/OpenNTF/WebDevToolkitForDx/releases/download/1.8/digexp-toolkit.zip
First, extract the file on your workstation. Then if you are on Windows, run
install.cmdor if you are on Mac or Linux, run:
sudo chmod a+x ./install.sh
sudo ./install.shThis will install the two main programs, dxdashboard (for the dashboard UI) and dxwcmdesigns (the command line support for accessing WCM design libraries). That completes the installation.
If you are behind a proxy server, the nw package used by the Dashboard requires setting the http_proxy environment variable prior to running install. See this page for more information: https://www.npmjs.com/package/nw.
For the Script Portlet "Push" support, you will need to have the Script Portlet command line client support installed and configured, and you will need to have the "sp" command on your system path. See this documentation for more on installing the Script Portlet command line client: http://www-01.ibm.com/support/knowledgecenter/SSHRKX_8.5.0/script/script-portlet/cmd_line_push.dita
If you are upgrading an existing installation you should remove it using uninstall and then install the new version. See instructions for uninstall below.
If you want to uninstall the toolkit, if you are on Windows, run
uninstall.cmdor if you are on Mac or Linux, run:
sudo chmod a+x ./uninstall.sh
sudo ./uninstall.shThis is a Node.js-based "dashboard" that runs on your laptop and lets you work with your Portal Themes, WCM design libraries, and Script Portlet applications in a simple user interface.
Key features:
To launch the dashboard, run the following command:
dxdashboardWhen you first run the dashboard, you should go to the "Settings" tab to configure your file locations and Portal server settings.
After setting a folder for Script Portlet applications in the settings tab, the
toolkit provides a graphical interfaces for pushing script portlet applications.
Pressing the "push" button will invoke the sp command and push the
application to the active server specified in the settings. If an sp-config.json
file exists, it will be used when pushing the application. Pressing the gear button
will open a dialog for editing the application's sp_config.json file.
In the same dialog box (at the bottom), there is an option to set a pre-push command which can be used for minifying javascript, transpiling coffeescript, SASS, etc., running a gulp or grunt build process, or launching other tools. This command will be run from the application's directory and will be run when pressing the push button or when the application's folder is being watched.
Pressing the run button will runt the script portlet on a test server and open it in your browser. The test server is a small Express server that includes handling for WCM tags and Ajax Proxy requests:
Pressing the "SP Lint" button will run a linting utility for Script Portlet that will analyze the script portlet application and detect possible issues in the code where it is recommended to follow best practices.
To work with theme files locally, first click "Get Themes" followed by "View Server Themes," then you will see a list of themes on the server. For any themes you want to access, enter the name to use for the local file folder and click "Create Theme Folders." Then to download the theme files, click the "Pull" button for the theme. Once you have pulled files for a theme, the "Pull" button will download only the files that have been changed on the server. To update the server with your local changes, click "Push Updates." You can also enable "Watch" to cause a push of updated files whenever change is made in your local folder.
To work with WCM design files locally, first click "Get Libraries" followed by "View Libraries." Then select the library or libraries you want to work with and click "Download Selected Libraries." To update the server with new or modified files, click "Push Updates" or "Push All." The "Pull" button will download all files. The "Watch" button will watch for changes to files in the local folder and push those changes automatically. Note that the "Push" commands won't delete any components on the server; for that you would need to use the WCM Authoring tools.
See below for details on the components that are supported with the WCM features.
Note that all the functionality for push/pull of WCM design files is available from the Dashboard user interface. For the command line support, use:
$ dxwcmdesigns <command> [options]The commands are described below.
Usage:
$ dxwcmdesigns init [options]Running this command will display a prompt to select a WCM library. A subdirectory will be created (in the current working directory) and the selected library will be downloaded in it.
The available options are:
-d, --dir: The directory that will contain the WCM library. By default, it will be
the current working directory.-h, --help: Displays the help for the init command.Usage:
$ cd <path to the wcm library>
$ dxwcmdesigns push [options]Running this command will push the source files to WCM and update the library on the server.
The available options are:
-a, --all: Pushes all files if specified. If it's not specified, then only
the files that have been modified since the last push/pull will be pushed.-d, --dir: The local directory of the WCM library. By default, it will be
the current working directory.-v, --verbose: To get verbose output.-h, --help: Displays the help for the push command.Usage:
$ cd <path to the wcm library>
$ dxwcmdesigns pull [options]This command will download any remote changes to the WCM library. First run dxwcmdesigns init
to initialize the WCM library before using dxwcmdesigns pull.
The available options are:
-d, --dir: The local directory of the WCM library. By default, it will be
the current working directory.-v, --verbose: To get verbose output.-h, --help: Displays the help for the pull command.The supported WCM types are:
Other Component types and Content Items are not supported.
There are some options that can be set to control some of the behavior when downloading from WCM. To do this, open the ".settings" file in the folder for a library and add an "options" object. There are some options that you can set as shown here:
"options": {
"includeMeta": false,
"filterComponentId": true,
"pullParallel": true,
"trial":true,
"include":[
"PresentationTemplate",
"LibraryStyleSheetComponent",
"LibraryImageComponent"
]
},To turn on the trial features for all libraries you can set an environment variable DIGEXP_TRIAL=true.