Logo

Documentation

Open-source documentation for users of Advantech's WebAccess/DMP software

Public Cloud Deployment:
UI: wadmp.com
API: api.wadmp.com

Resources:
Source Repository:
github.com/wadmp/wadmp.github.io
GitHub Desktop:
desktop.github.com
Learn Markdown:
markdowntutorial.com
Project Jupyter:
jupyter.org
YouTube Channel:
WebAccess DMP
Help:
Contact Us!

Playbooks Explained

Playbook is a set of defined actions that can be run on devices.

To create a playbook, go to Playbooks -> My Playbooks in the left menu and use the grid plus icon to create a new one.

Playbooks

The playbook can be scheduled or run immediately by clicking on the calendar icon on the right.

Available Playbook Actions

When creating playbook, fill in the name, company and the device type. A playbook can be run only for single device type because of settings differences between the device types. Select the devices you want to run playbook for.

You can add these types of actions to the playbook:

  1. Set Firmware
  2. Install Router App
  3. Apply a Settings Group
  4. Reboot Devices
  5. Change Local Password

Playbooks

Playbook States

The state of the playbook can be found in the list of the playbooks or after clicking on the playbook name:

Playbooks

Once created the playbook is in the state

and can be edited or deleted.

Once the playbook is

it can be unscheduled and then goes back to Draft state.

Once run, the playbook can be in one of these states:

See the device actions details by clicking the eye icon on the right.

If the playbook is run on the offline device, the status may be “Incomplete”, but it is remembered to run the actions after the device appears online again. When the device is back online, the playbook is finished and reaches the “Completed” status.

The playbook run is affected by sync engine and by default, the actions are attempted to run 3 times (see details on sync configuration below).

You can filter the playbooks by state using this icon:

Playbooks

Sync Configuration via API

Playbooks running behaviour is affected by the sync engine. The sync engine uses the default configuration (sync type, retry interval, retry attempts) and it currently cannot be changed in the UI.

It can be changed via API call PUT /syncengine/config:

Playbooks

The default values are as follows (adjust the company_id):

{
  "sync_type": "Custom",
  "retry_interval": 0,
  "retry_attempts": 3,
  "company_id": 0
}

Explanation / other available values: