Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Table of Contents
maxLevel2

Create interaction

Code Block
languagebash
themeRDark
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 DescriptionOptions
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

 
Info
titleCteate Create Interaction

Created Interactions will not appear on the BMP until deployed, Except 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

...

pull the empty answerSpace down from the BMP.

Code Block
languagebash
blinkm bmp pull

Here is the view from the BMP CMS,

...

no interactions are yet created.

Image RemovedImage Added

Now we are ready to start creating interactions.

Code Block
languagebash
themeRDark
blinkm bmp create interaction default

...

Once the interaction has been created you will notice the newly created files in your local project.

Image Added

Info

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

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

Code Block
languagebash
blinkm bmp create interaction message --type message

Image RemovedImage Added

Now lets create an interaction using the --remote option

Code Block
languagebash
themeRDark
blinkm bmp create interaction myintercationmyinteraction --remote

Image Removed

Image RemovedOnce the interaction has been created you will notice the newly created files in your local project.

Image Added

Info
title--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.

Image Added

Lets now deploy the interactions to the BMP

Code Block
languagebash
themeRDark
blinkm bmp deploy


Editing interaction files
Anchor
InterEdit
InterEdit

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

This file containing most contains most of your interactions settings.

Code Block
languagejs
themeRDark
titleThe example "default.json" code
collapsetrue
{
  "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
}

...

Below is a list of items you can modify safely.

 
ItemDescriptionCMS MenuLabelOptions
displayHidden Items Are Not Displayed In Lists But Are Otherwise Still Accessibleitems are not displayed in lists but are otherwise still accessibleDisplayHide hide / Showshow
displayNameCaption or title to display to usersDisplay Name    
statusInactive items are hidden and treated as though they do not existStatusactive / inactive