Summary
The IBM MobileFirst Platform plugin provides functionality for deploying artifacts, including mobile application artifacts to an IBM MobileFirst Server. IBM MobileFirst Platform was previously known as IBM Worklight.
Compatibility
The HCL Launch automation plugin for IBM MobileFirst Platform is compatible with IBM MobileFirst Platform Foundation versions 6.3, 7.0, 7.1, 8.0, Bluemix-Hosted and IBM Worklight versions 6.0 through 6.2.
IBM Worklight prior to version 8 require the worklight-ant-deploy.jar for the agent to use.
This plugin requires HCL Launch version 7.0 or later.
This plugin runs on all operating systems that are supported by the HCL Launch agent.
Installation
See Installing plugins in HCL Launch for installing and removing plugins.
History
The following table describes the changes made in each plugin version.
Plugin history details
| Version |
Description |
| 13 |
Minor enhancements |
Usage
The IBM MobileFirst Platform plugin for HCL Launch is part of a complete process for building and deploying mobile applications.
Step palette
To access this plugin in the palette, click Mobile > IBM MobileFirst.
Important properties in the plugin steps
Step properties are described briefly in the properties table for each step. This section provides more information about the details and implications of selected important properties.
- Application Center Ant JAR File Path
- The path to the Application Center Deploy Tool Ant JAR file,
applicationcenterdeploytool.jar. It is used to interact with the Application Center.
- The version of the Ant JAR file you use must match the version on the target server. An Ant JAR file is included in this plugin for deploying artifacts to the Worklight Version 6.0.0 Server. The default path to use this file is
${PLUGIN_HOME}/lib/applicationcenterdeploytool.jar.
- Disable SSL Security Checking
- The Security Risk option allows you to publish on secure Application Center hosts without verification of the SSL certificate.
- Disabling the security checking can be helpful when testing localhost with temporary self-signed certificates. It should never be done on production or public systems.
- JSON4J JAR file path
- The path to the JSON4J JAR file,
json4j.jar. The version of the JSON4J JAR file you use must match the version on the target server. An Ant JAR file is included in this plugin for deploying artifacts to the Worklight Version 6.0.0 Server. The default path to this file is ${PLUGIN-HOME}/lib/json4j.jar.
- Label
- This property is in the Upload Application to Application Center step. Normally, the label is taken from the application descriptor that is stored in the file to be uploaded. If the application descriptor does not contain a label, the fallback label is used.
- Secure
- The Security Risk option determines whether to communicate with the Worklight server in a secure way. The default is No.
- Set this value in accordance with your security policies. Transmitting without security is a security risk, especially outside a firewall.
- Worklight Ant JAR File path
- The path to the Worklight Ant Deployer JAR file. The file to use differs by Worklight server version.
- For Versions 6.2 and 6.1 use
worklight-ant-deployer.jar.
- For Version 6.0.0 use
worklight-ant.jar.
- The version of the Ant JAR file you use must match the version on the target server. An Ant JAR file is included in this plugin for deploying artifacts to the Worklight Version 6.0.0 Server. The default path to this file is
${PLUGIN_HOME}/lib/worklight-ant.jar.
Steps
The following process steps are available in the IBM MobileFirst plugin.
Change Application Configuration
Changes an applications configuration on IBM MobileFirst. Note: This step is for server 6.2 or later.
Input properties for the Change Application Configuration step
| Name |
Type |
Description |
Required |
| Application Name |
String |
The application name to reconfigure. |
Yes |
| Configuration File |
String |
The .json or .xml file path containing the applications new configuration. |
Yes |
| Environment |
String |
The name of the environment. |
Yes |
| Password |
Password |
The users password to access the IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Runtime |
String |
The runtime on which to change the applications configuration. |
Yes |
| Secure |
Boolean |
Whether to transmit in a secure way. Utilized in versions 6.2 to 7.1. |
No |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user.For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access a secure IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Version |
String |
The name of the version. |
Yes |
| Worklight Ant JAR File Path |
String |
The path to the Worklight Ant Deployer JAR (worklight-ant-deployer.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/worklight-ant.jar. Required for server versions less than 8.0. |
No |
Delete Adapter
Deletes the adapter from the IBM MobileFirst server. Note: This step is for Worklight and IBM MobileFirst servers 6.2 and later.
Input properties for the Delete Adapter step
| Name |
Type |
Description |
Required |
| Adapter Name |
String |
The adapter to delete from the IBM MobileFirst server. |
Yes |
| Password |
Password |
The users password to access the IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Runtime |
String |
The runtime on which to remove the adapter. |
Yes |
| Secure |
Boolean |
Whether to transmit in a secure way. Utilized in server versions 6.2 to 7.1. |
No |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access a secure IBM MobileFirst server.
Note: This property is required for Worklight 6.2 and later. |
No |
| Worklight Ant JAR File Path |
String |
The path to the Worklight Ant Deployer JAR (worklight-ant-deployer.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/worklight-ant.jar. Required for server versions less than 8.0. |
No |
Delete Application
Delete an application from IBM MobileFirst.
Note: This step is for Worklight Server 6.2 or later.
Input properties for the Delete Application step
| Name |
Type |
Description |
Required |
| Application Name |
String |
The name of the Worklight application to remove. |
Yes |
| Environment |
String |
The applications environment. Only required if using IBM MobileFirst v8+. |
No |
| Password |
Password |
The users password to access the IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Runtime |
String |
The runtime on which to remove the IBM MobileFirst application.
Note: This property is required for Worklight 6.2 or later. |
No |
| Secure |
Boolean |
Whether to transmit in a secure way. Utilized in server versions 6.2 to 7.1. |
No |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access a secure IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Version |
String |
The applications version number. Only required if using IBM MobileFirst v8+. |
No |
| Worklight Ant JAR File Path |
String |
The path to the Worklight Ant Deployer JAR (worklight-ant-deployer.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/worklight-ant.jar. Required for IBM MobileFirst versions less than 8.0. |
No |
Deploy Adapter
Deploys the adapter to IBM MobileFirst.
Input properties for the Deploy Adapter step
| Name |
Type |
Description |
Required |
| Adapter Files |
String |
A list, separated by commas or newline characters, of IBM MobileFirst Adapter (.adapter) files to deploy to the IBM MobileFirst Server. |
Yes |
| Password |
Password |
The users password to access the IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Runtime |
String |
The runtime on which to deploy the adapter. Note: This property is required for Worklight 6.2 and later. |
No |
| Secure |
Boolean |
Whether to transmit in a secure way. Utilized in server versions 6.2 to 7.1. |
No |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access a secure IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Worklight Ant JAR File Path |
String |
The path to the Worklight Ant Deployer JAR (worklight-ant-deployer.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/worklight-ant.jar. Required for server versions less than 8.0. |
No |
Deploy Application
Deploys an application to IBM MobileFirst.
Input properties for the Deploy Application step
| Name |
Type |
Description |
Required |
| Application Files |
String |
A list, separated by commas or newline characters, of the Worklight Application files to deploy to the Worklight Server. Specify .wlapp files for IBM MobileFirst pre-v8 and .json or .xml files for IBM MobileFirst v8+. |
Yes |
| Password |
Password |
The users password to access the IBM MobileFirst server. Note: This property is required for Worklight 6.2 and later. |
No |
| Runtime |
String |
The runtime on which to deploy the IBM MobileFirst application. Note: This property is required for Worklight 6.2 or later. |
No |
| Secure |
Boolean |
Whether to transmit in a secure way. Utilized in server versions 6.2 to 7.1. |
No |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access a secure IBM MobileFirst server.
Note: This property is required for Worklight 6.2 and later. |
No |
| Worklight Ant JAR File Path |
String |
The path to the Worklight Ant Deployer JAR (worklight-ant-deployer.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/worklight-ant.jar. Required for IBM MobileFirst versions less than 8.0. |
No |
Deploy Web Resource
Deploys a web resource compressed file (.zip) for a specific application version. Note: This step is for MobileFirst 8.0 or later.
Input properties for the Deploy Web Resource step
| Name |
Type |
Description |
Required |
| Application Identifier |
String |
The MobileFirst application in which to deploy the web resource archive. |
Yes |
| Environment |
String |
The MobileFirst applications environment in which to deploy the web resource archive. |
Yes |
| Password |
Password |
The user password that is required to access the Application Center. |
Yes |
| Runtime |
String |
The MobileFirst runtime in which to deploy the web resource archive. |
Yes |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access the Application Center. |
Yes |
| Version |
String |
The MobileFirst applications version number in which to deploy the web resource archive. |
Yes |
| Web Resource File |
String |
The name of the web resource (.zip) file to deploy to the IBM MobileFirst Server. |
Yes |
Remove Application from Application Center
Removes the native application from the IBM MobileFirst Application Center.
Input properties for the Remove Application from Application Center step
| Name |
Type |
Description |
Required |
| Application Center Ant JAR File Path |
String |
The path to the Application Center Deploy Tool Ant JAR (applicationcenterdeploytool.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/applicationcenterdeploytool.jar. |
Yes |
| Application Package |
String |
The package name of the application to remove from the Application Center. |
Yes |
| Context |
String |
The context of the Application Center. For example, applicationcenter. |
Yes |
| Disable SSL Security Checking |
Boolean |
Disables SSL security checking. Use of this flag is a security risk. |
No |
| JSON4J JAR File Path |
String |
The path to the JSON4J JAR (json4j.jar) file. The
Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/json4j.jar. |
Yes |
| Operating System |
Enumeration |
The operating system of the application to remove from the Application Center. Values are all, Android, and iOS. |
No |
| Password |
Password |
The user password. The default value is: ${p:environment/applicationCenterPassword}. |
Yes |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access the Application Center. |
Yes |
| Version |
String |
The internal version (not the commercial version) of the application to remove from the Application Center. |
No |
Upload Application to Application Center
Uploads the application to the IBM MobileFirst Application Center.
Input properties for the Upload Application to Application Center step
| Name |
Type |
Description |
Required |
| Active |
Boolean |
Store the application in the Application Center as an active application. |
No |
| Application Center Ant JAR File Path |
String |
The path to the Application Center Deploy Tool Ant JAR (applicationcenterdeploytool.jar) file. The Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/applicationcenterdeploytool.jar. |
Yes |
| Context |
String |
The context of the Application Center. For example, applicationcenter. |
Yes |
| Description |
String |
The description of the application to upload to the Application Center. |
No |
| Disable SSL Security Checking |
Boolean |
Disables SSL security checking. Use of this flag is a security risk. |
No |
| File |
String |
The Android application package (.apk) or iOS application (.ipa) file to upload to the Application Center. |
Yes |
| Force Upload |
Boolean |
Force existing applications to be uploaded to the Application Center. |
No |
| Installer |
Boolean |
Store the application in the Application Center with the installer flag. |
No |
| JSON4J JAR File Path |
String |
The path to the JSON4J JAR (json4j.jar) file. The
Worklight 6.0.0 Server can use the value: ${PLUGIN_HOME}/lib/json4j.jar. |
Yes |
| Label |
String |
The fallback label in the Application Center. |
No |
| Password |
Password |
The user password. The default value is: ${p:environment/applicationCenterPassword}. |
Yes |
| Ready for production |
Boolean |
Store the application in the Application Center with the ready-for-production flag. |
No |
| Recommended |
Boolean |
Store the application in the Application Center with the recommended flag. |
No |
| Server Path |
String |
The URL to the IBM MobileFirst server and role of the MobileFirst authorized user. For Worklight versions 7.1 and older, the default path is /worklightadmin. For MobileFirst versions 8.0 and newer, the default path is /mfpadmin. |
Yes |
| User |
String |
The user name that is required to access the Application Center. |
Yes |
Summary
Usage
Steps
