Dashboards can both be stored to git and released from file, enabling controlled deployment of dashboards via your git workflow.

Export Pulse Dashboard to Files

You can export Pulse dashboards to file using the Admin Menu

Then clicking Download Export.

This will produce a zip file download named pulse-export-DATEtTIME.zip which inside has the following folder structure:

Export Structure

pl-config
├── readme.txt
└── servers.txt
├── dash
    ├── 1_Trade_Surveillance.json
    ├── 2_Trade_Blotter.json
    ├── 3_FX_Dash.json
    ├── 4_Algo_Control.json
    ├── 5_TS.json
    └── 6_OHLC.json

• pl-config - Is short for PuLse config. It's a folder that can contain structured data for later importing to another Pulse instance. Currently it only supports dashboards but the folder structure allows for potentially adding more in future.
• dash - A folder with one JSON file per dashboard. The beginning number is the dashboard id.
• dash/1_dashboard_name.json - Each JSON file starts with the dashboard id number and contains a JSON representation of a dashboard..
• readme.txt - Provides a text only listing of users, teams, then dashboards. These are for human viewing purposes only. It can be useful to check this into git to track differences between servers.
• servers.txt - Provides a text only listing of servers with passwords blanked out. These are for human viewing purposes only.

Sample File

[ { "id" : 1, "version" : 0, "name" : "Trade Surveillance", "defaultParams" : "", "tags" : "demodb", "comment" : "", "ppublic" : true } ,["-----------------------------------------------------"], { "global" : { "tabEnableClose" : false, "tabEnableFloat" : true, "tabSetAutoSelectTab" : true, "splitterSize" : 1, "splitterExtra" : 10, "tabEnableRenderOnDemand" : false }, "borders" : [ ], "layout" : { "type" : "row", "id" : "#481b8859-f414-4607-9872-130e1c4e7aa5", "children" : [ { "type" : "row", "id" : "#b5276340-8bc2-4eee-8d2d-bd6260c59d2b", "children" : [ { "type" : "tabset", "id" : "#da8ae848-2486-4d4b-9e84-42a2c90652c1", "weight" : 72.79069767441861, "children" : [ { "type" : "tab", "id" : "#64750278-fef2-4742-a2ef-f3e9ad21fc79", "name" : "TAQ", "component" : "timeseries", "config" : { "dashstate" : { "chartType" : "timeseries", "queryable" : { "serverName" : "DEMODB", "refreshPeriod" : 250, "clientLimit" : 0, "query" : "SELECT time,bid,ask,\n buy as buy_SD_TRIANGLE,4+BUY_QUANTITY/50.0 AS BUY_SD_SIZE, \n sell as sell_SD_TRIANGLE,4+SELL_QUANTITY/50.0 AS SELL_SD_SIZE,\n hedger_buy as hedger_buy_SD_CIRCLE,4+hedger_BUY_QUANTITY/50.0 AS hedger_BUY_SD_SIZE, \n hedger_sell as hedger_sell_SD_CIRCLE,4+hedger_SELL_QUANTITY/50.0 AS hedger_SELL_SD_SIZE\nFROM taq\nORDER BY TIME ASC;", "serverCmd" : "" }, "subConfig" : { "overrideJson" : { "custom" : { "dataZoom" : { "show" : true } } }, "colConfig" : { }, "gridConfig" : { }, "interactiveConfig" : { }, "actionHandlers" : [ ] } } } } ], "active" : true }, { "type" : "tabset", "id" : "#cbc2dab4-2685-4a98-9725-567022d6c4bb", "weight" : 27.209302325581394, "children" : [ { "type" : "tab", "id" : "#d09e019f-2e79-4934-a375-0a885c9f999f", "name" : "Risk Position", "component" : "timeseries", "config" : { "dashstate" : { "chartType" : "timeseries", "queryable" : { "serverName" : "DEMODB", "query" : "SELECT time,5000 AS ulimit,-5000 as dlimit, COALESCE(buy_quantity,0)-COALESCE(sell_quantity,0) AS action, \n SUM(COALESCE(buy_quantity,0)-COALESCE(sell_quantity,0)) OVER(ORDER BY TIME ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW) AS Position \nFROM taq\nORDER BY TIME ASC;\n ", "refreshPeriod" : 250, "serverCmd" : "", "clientLimit" : 0 }, "subConfig" : { "overrideJson" : { }, "colConfig" : { }, "gridConfig" : { }, "interactiveConfig" : { }, "actionHandlers" : [ ] } } } } ] } ] } ] } } ]

Deploy Dashboards From Files.

1. Pulse watches for a folder named pl-config relative to its' current working directory.
   (This will be the same folder that it's database file is in).
2. If a JSON file with a particular structure was placed at: pl-config/dash/12_name.json
3. Pulse will assume the dashboard id is 12
4. If that dashboard id doesn't exist, it will be created using the details within the json file.
5. If that dashboard id exists already. It will update the existing dashboard details, including changing the owner if specified.

Note: The reason for changing the owner is to maintain consistency. Creating a dashboard from a file behaves exactly the same as if an admin tried updating the data in the UI.

Upload Scenarios

Scenario	Description	Result
JSON was invalid	There will be an error in the Pulse logs.	Update happens
userName or teamName specified but don't exist	There will be an error in the Pulse logs. No partial update is attempted as it could reveal data to an inappropriate user.	No update will happen.
userName or teamName not specified in JSON	Current owner maintained.	Update happens