PMF Workstation Installation Guide

Overview

Follow this installation guide in order to setup your workstation for development using PMF.

DevKit Installer

The PMF Developer Kit Installer will install a ready-to-use PMF, database and runtime on your developer machine.

Prerequisite:
The installer requires Java installed.

  1. Install Oracle’s JRE.

  2. Add a JAVA_HOME variable, pointing to the JRE

    Mac and Linux: Edit your ~/.bash_profile:

     #### openJdk JAVA
     export JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk17.0.13.jdk/Contents/Home"
    

    Windows:
    Follow this guide.

Installation

Get the PMF DevKit package from the Downloads page, and unzip the package.

Starting and stopping the server

Open a command-line window and navigate to the extracted folder location.

Mac and Linux:

  • To start the server: ./run.sh -bg
  • To stop the server: ./stop.sh

Windows:

  • To start the server: ./run.cmd -bg
  • To stop the server: ./stop.cmd

Accessing the PMF Operations Console

You can access the PMF Operations Console in the following ways:

console

PMF CLI

The PMF CLI is a command-line interface enabling you to register applications in the PMF, pull/push application from/to the PMF, create Java and JavaScript adapters, manage multiple local and remote servers, update live applications using Direct Update and so on.

Prerequisite:

  1. NodeJS and NPM are requirements before you can install the PMF CLI.
    Download and install NodeJS v10.24.0 and NPM v6.14.11.

    To verify the installation, open a command-line window and execute: node -v.

  2. Some CLI commands, such as creating, building and deploying adapters require Maven. See the next section for installation instructions.

Installation of PMF CLI

Open Terminal and execute: npm install -g pmfdev-cli.

Mac and Linux: Note that you may need to run the command using sudo.
Read more about fixing NPM permissions.

To Verify the installation, open a command-line window and execute: pmfdev -v or pmfdev help.

console

Adapters and Security Checks

Adapters and Security Checks are your door-way to introduce authentication and other security layers to your application.

Prerequisite:
Apache Maven is a required to set-up before you can create adapters and security checks.

  1. Download the Apache Maven .zip
  2. Add a MVN_PATH variable, pointing to the Maven folder

    Mac and Linux: Edit your ~/.bash_profile:

     #### Apache Maven
     export MVN_PATH="/usr/local/bin"
    

    Windows:

    Follow this guide.

    Verify the installation by executing:

     mvn -v
    

Usage

With Apache Maven installed, you can now create adapters either via Maven command-line commands, or by using the PMF CLI.
For more information, review the Adapters tutorials.

Last modified on