Neptune DXP Documentation
Neptune DXP - Open Edition · 25.0 MTS

Tiles and tile groups

Tile tools maintain the tiles and tile groups that make up a launchpad. A tile is the entry point that a launchpad user selects to open an application. Saves run through the same validation, hooks, development package checks, and edit locks as the Cockpit.

Required role: tile, tile-groups.

If your user account does not have this role, every tool in this group fails immediately with an access denied error. Contact an administrator to request the role, or see Access control for more information on how roles are enforced.

When you update a tile or a tile group, the fields that you send are merged with the stored record. Fields that you do not send keep their values.

Assign tiles to tile groups

Which tiles and child tile groups belong to a tile group is set on the tile group, not on the tile. save_tile cannot change the assignment of a tile.

In save_tile_group, tiles and tilegroups are arrays of { id } in display order. Each array replaces the whole assignment. To add, remove, or reorder an entry, send the complete array, not only the entries that change.

Example: To add a tile to a tile group that already contains two tiles, read the tile group with get_tile_group, append the new tile to its tiles array, and send all three entries with save_tile_group.

Delete tiles and tile groups

Deleting a tile removes it from every tile group it is assigned to. Deleting a tile group removes it from every launchpad and parent tile group that uses it.

To delete a tile, set confirm to true. Without it, the deletion is refused for every tile, and the response names the tile groups that the tile is assigned to.

To delete a tile group that still contains tiles or child tile groups, set confirm to true. Without it, the deletion is refused, and the response reports the number of assigned tiles and child tile groups. An empty tile group is deleted without confirm.

Available tools

Parameters are shown with their type and a short description. UUIDs are always strings.

Tiles

Tool Description Parameters

list_tiles

List tiles.

listOptions (object, optional). Fields: name, title, subTitle, description, type, actionType, actionApplication, actionWebApp, roleTag, tags, package, cockpitTile, blackoutEnabled, ver, createdBy, changedBy, createdAt, updatedAt.

get_tile

Return a tile by its ID.

id (string): ID of the tile.

save_tile

Create or update a tile. Omit id to create a new tile. Include id to update an existing tile.

tile (object): The tile object. System fields, such as createdBy, changedBy, and ver, cannot be set.

delete_tile

Delete a tile by its ID and remove it from every tile group. Requires confirm.

id (string): ID of the tile.

confirm (boolean, optional): Must be true to delete. Without it, the tile groups that the tile is assigned to are reported, and nothing is deleted.

Tile groups

Tool Description Parameters

list_tile_groups

List tile groups.

listOptions (object, optional). Fields: name, title, description, roleTag, package, cockpitTileGroup, inclFav, ver, createdBy, changedBy, createdAt, updatedAt.

get_tile_group

Return a tile group by its ID, including its assigned tiles, child tile groups, navbar and sidebar groups, roles, tile and group layouts, and the launchpads it is assigned to.

id (string): ID of the tile group.

save_tile_group

Create or update a tile group. Omit id to create a new tile group. Include id to update an existing tile group.

tileGroup (object): The tile group object. tiles and tilegroups are arrays of { id } in display order that each replace the whole assignment. System fields, such as createdBy, changedBy, and ver, cannot be set.

delete_tile_group

Delete a tile group by its ID and remove it from every launchpad and parent tile group. Requires confirm if the tile group is not empty.

id (string): ID of the tile group.

confirm (boolean, optional): Must be true to delete a tile group that still contains tiles or child tile groups.

Related topics