Using the Persistent Mobile Foundation Operations console

The Persistent Mobile Foundation (PMF) Operations console is a web-based UI which enables simplified work flows for both the developer and the administrator to create, monitor, secure and administer applications & adapters.

Jump to

Usage

As a developer

  • Develop applications for any environment and register them to PMF.
  • See all your deployed applications and adapters at a glance through the Dashboard.
  • Manage and configure registered applications, including Direct Update, remote disablement, and security parameters for application authenticity and user authentication.
  • Set up push notification by deploying certificates, creating notification tags, and sending notification.
  • Create and deploy adapters.
  • Download samples.

As an IT administrator

  • Monitor various services.
  • Search for devices that access PMF and manage their access rights.
  • Update adapter configurations dynamically.
  • Adjust client logger configurations through log profiles.
  • Track how product licenses are used.

Access the console

The PMF Operations Console can be accessed in the following ways:

Locally installed PMF

  • Desktop browser - From your browser of choice, access the following URL with the username/password as admin/admin.

    http://localhost:9080/mfpconsole

  • Command-line - From a Command-line window, with the PMF CLI installed, run the following command.

    pmfdev server console

Remotely installed PMF

  • Desktop browser - From your browser of choice, access the following URL. The host server can be either a customer-owned server.

    http://the-server-host:server-port-number/mfpconsole

  • Command-line - From a Command-line window, with the PMF CLI installed,

  1. Add a remote server definition.

    • Interactive Mode - Run the following command and follow the on-screen instructions.

      pmfdev server add

    • Direct Mode - Run the following command with the following structure.

      pmfdev server add [server-name] --URL [remote-server-URL] --login [admin-username] --password [admin-password] --contextroot [admin-service-name]

      Example

      pmfdev server add MyRemoteServer http://my-remote-host:9080/ --login TheAdmin --password ThePassword --contextroot mfpadmin

  2. Run the following command.

    pmfdev server console MyRemoteServer

Dashboard page

PMF Operations Console → Home → Dashboard

The Dashboard page displays the deployed projects.

Applications page

PMF Operations Console → Left pane → Applications

Displays list of deployed PMF applications. Click a {Application name} to further view the following.

{Application name}

  • Versions - View details of the application version.
  • Android (latest)/iOS (latest)
    • Management - Manage and configure registered applications.For more information, see Managing applications.
    • Authenticity - Secure your application by using the predefined PMF application-authenticity security check (appAuthenticity).
    • Security - Configure application security parameters, such as the default token expiration value, map scope elements to security checks, define mandatory application scopes, and configure security-check options.
    • Log Filters - Administrators can use log profiles to adjust client logger configurations, such as log level and log package filters, for any combination of operating system, operating system version, application, application version, and device model. When an administrator creates a configuration profile, the log configuration is concatenated with responses API calls such as WLResourceRequest, and is applied automatically.
    • Configuration Files - Displays configuration files such as Application Runtime-Configuration JSON File, Application-Descriptor JSON File, and Client Configuration File (mfpclient.properties).
  • App Settings - Configure the display name of the application in the console as well as the application type and licensing.
  • Live Update Settings - Define and serve different configurations for each segment of users of an application by using Live Update.
  • Push - Set-up Push notifications and related parameters, such as certificates and GCM details, define tags, as well as send notifications to devices.

Register an application

PMF Operations Console → Left pane → Applications → New

  1. Specify the basic application values and click Register application.

  2. Your new application registers and then {Application Name} {Platform} {Platform Version} | {Application ID} page opens.

  3. Click Get Starter Code to download the starter code for your application.

Similarly, from this page you can set up Authenticity, Push notifications, or download CLI.

Managing applications

PMF Operations Console → Left pane → Applications → {Application name}

Manage and configure registered applications by using following options.

Adapters page

Creating adapters

PMF Operations Console → Left pane → Adapters → New

Create an adapter and download Starter Code.

Adapter properties

PMF Operations Console → Left pane → Adapters → {Adapter name}

Displays list of deployed adapters. After an adapter is deployed, it can be configured in the console. You can then update an adapter on-the-fly by updating its properties without needing to re-build and re-deploy the adapter artifact.

Important: Though you can enter any character (including special character) as an input in the all Adapter configuration fields, if your input contains harmful patterns, content indicative of XSS, HTML, script injection, or SQL injection you get Invalid payload error error on the UI and the logs display the following.

[ERROR ] com.ibm.mfp.admin.services. UserConfigRestServiceHelper - setUserConfig - 
Harmful content detected in the adapter configuration. Correct the input and try again.
[ERROR ] FWLSE3051E: Invalid payload. See additional messages for details. java.lang.IllegalArgumentException
[ERROR] Exception Server returned HTTP response code: 400 for URL:

Runtime settings page

PMF Operations Console → Left pane→ Runtime Settings

Displays Runtime properties, Persistent Mobile Foundation Server keystore, and Confidential clients. You can edit the Runtime properties.

Error log page

PMF Operations Console → Left pane→ Error log

Displays a list of failed management operations that were initiated from the PMF Operations Console, or from the command line, on the current runtime environment.

Use the log to see the effect of the failure on the servers.

Devices page

PMF Operations Console → Left pane→ Devices

Displays list of devices that access the PMF and can manage access rights.

Administrators can search for devices by using either user ID or using a Device display name. The user ID is the identifier that was used to log-in.
A Device display name is a name that is associated with the device to distinguish it from other devices that share the user ID.

Download Center page

PMF Operations Console → Left pane→ Download Center

Use this page to download a snapshot of the various development artifacts of PMF for offline usage.

Analytics Console

PMF Operations Console → Top left corner → Analytics Console

Click to open and log in to the PMF Analytics Console.

Settings

PMF Operations Console → Top left corner →

The Settings have following options.

  • Download Audit Log - View audit log Licenses page
  • Sign out - Log out of application
  • About - View the release version for PMF Operations Console and support information

Licenses

PMF Operations Console → Top left corner → → Licenses

License terms vary depending on which edition (Enterprise or Consumer) of PMF is being used.
License tracking is enabled by default and tracks metrics relevant to the licensing policy, such as active client devices and installed applications. This information helps determine whether the current usage of PMF is within the license entitlement levels and can prevent potential license violations.

By tracking the usage of client devices and determining whether the devices are active, administrators can decommission devices that should no longer be accessing the service. This situation might arise if an employee has left the company, for example. provides a license tracking report for the Client Device metric, the Addressable Device metric, and the Application metric. The report also provides historical data.

In the License Tracking page, to download the License Tracking report in a CSV file format, click Actions → Download Report.

UI Label Downloaded Report
Addressable Device License Tracking - TargetCategory
- ActiveClientDevices
- ActiveAddressableDevices
Number of Days Set for Decommissioning a Client Device DecommissionWhen
Time Interval Set for Running the Decommissioning Task DecommissionInterval
Number of Days Set for Archiving Decommissioned Client Device Records ArchiveDecommissionedInterval
Number of *Active Client Devices MaximumClientDevices
Highest number of active client devices in the last 90 days ReportedOn

The report also displays details for the Historical log for Client Devices and Historical log for Addressable Devices.

Developer Center

PMF Operations Console → Top left corner → Developer Center

Click to access the PMF documentation site with documentation for various releases, release notes, and to download artificacts and samples.

Actions drop-down

PMF Operations Console → Top left corner → Actions

The Actions drop-down on the Dashboard page provides quick access to the following console actions.

  • Applications
    • Register Application
    • Import Application
  • Adapters
    • Deploy Adapter
    • Import Adapter
  • General
    • Download Samples
    • Download Developer CLI

Depending on the page, the Actions drop-down may show additional console actions.

▲
Last modified on