Creating interactions

Creating or removing Interactions can now be done outside the CMS via the BMP CLI.

Create interaction

blinkm bmp create interaction <name> --type<type> --remote

Using the create interaction function will create a local version of the interaction on your computer.

Parameter

Description

Options

name

The name of the interaction

type

The interaction type

"madl" (default), or "message"

--remote

Will create the interaction locally and

on the BMP as a place holder

Create Interaction

Created Interactions will not appear on the BMP until deployed,except for --remote which will add a place holder on the BMP

Create interaction Examples

Here is an example of the BMP CLI workflow on a sample answerSpace called "myanswerSpace"

The local file

First we will bring the empty answerSpace down from the BMP

blinkm bmp pull

Here is the view from the BMP CMS, No interactions are yet created.

Now we are ready to start creating interactions.

blinkm bmp create interaction default

As the interaction type was left blank, The interaction "default" was create as a madl type

Lets now create a "message" interaction using the – type option

blinkm bmp create interaction message --type message

Now lets create an interaction using the --remote option

blinkm bmp create interaction myinteraction --remote

--remote

Note because we used --remote an empty interaction place holder now shows in the BMP CMS.

This method is ideal when wanting to reserve a unique name when developers are using both CMS and CLI at the same time.

Lets now deploy the interactions to the BMP

blinkm bmp deploy

Editing interaction files

In every interaction directory is a file called <interaction name>.json

This file containing most of your interactions settings.

The example "default.json" code

{
  "allow_mobi": "yes",
  "config": {
    "all": {
      "type": "madl code"
    },
    "default": {
      "display": "hide",
      "displayName": "default",
      "madl": {
        "$file": "default.madl.php"
      }
    }
  },
  "id": "100654",
  "name": "default",
  "registered_only": "allow all",
  "restricted": "no",
  "status": "active",
  "tags": null
}

Many items within this file can be modified to change the interactions behaviour.

Below is a list of items you can modify safely.

Item	Description	CMS Menu	Options
display	Hidden Items Are Not Displayed In Lists But Are Otherwise Still Accessible	Display	hide / show
displayName	Caption or title to display to users	Display Name
status	Inactive Items Are Hidden And Treated As Though They Do Not Exist	Status	active / inactive