Skip to content

Latest commit

 

History

History
88 lines (52 loc) · 5.17 KB

how-do-i-list-an-elements-connections-in-its-profile.md

File metadata and controls

88 lines (52 loc) · 5.17 KB

How do I list an element's connections in its profile?

In the profile of each element in your map, it's possible to list that element's connections, using three tools:

List of element's connections in its profile

To get started, open one of your element profiles. If you want the connection list to be in a custom field, create that field, and set its type to Text. Alternatively, you can use the Description field, since its type is Text by default.

In your custom Text field or in the Description field, add the following:

[[list ":from([label = 'My Element Label']),:to([label = 'My Element Label'])"]]

Replace both instances of My Element Label with the actual label of the element whose profile you're editing. After you click Done to save the field's content, you'll see a list of all connections leading to or from that element.

If you just want the connections leading your element, you can omit the second half of the selector. Here's what it would look like:

[[list ":from([label = 'My Element Label'])"]]

And if you just wanted the connections to the element, just omit the first half:

[[list ":to([label = 'My Element Label'])"]]

Again, replace My Element Label in all of these examples with the actual label of the element whose profile you're editing.

If your map has multiple elements with the same label, your list widget will list all connections to or from any of the elements with that label. To avoid that, you would need to replace [label = 'My Element Label'] with a more specific selector.

Visit the full guide on selectors or contact support to learn how to write a more specific selector for your use case.

Use Google Sheets to generate list widget code for all elements

If you have a lot of elements, it's pretty tedious to go through each element's profile and add the list widget code.

If you're using either Label or ID as the unique identifier for elements, you can quickly generate list widget code using a custom Google Sheets formula we created.

To get access to the custom formula, you can open our "With custom Kumu formulas" Google Sheet, then click "File" > "Make a copy" to create your own editable copy of the sheet.

Delete the example tabs in the Google Sheet, then create a new tab and copy/paste your list of elements into it, starting from cell A1. Make sure that Label is in Column A, or that you have an ID column in the sheet, filled with unique IDs for your elements.

If you don't have your list of elements on hand, you can use Kumu to export it to Excel.

In your dataset, start editing the cell directly below the column header for the field where your list of connections should go. For example, if you want to put the connection list in the Description field, and your Descrition field is in Column B of your spreadsheet, start editing cell B2 underneath the Description column header.

In that cell, type =KUMU_LIST_WIDGET_ELEMENT_CONNECTIONS( to get started.

Sample usages

KUMU_LIST_WIDGET_ELEMENT_CONNECTIONS(A2, "both")

KUMU_LIST_WIDGET_ELEMENT_CONNECTIONS(A2, "from", FALSE)

Syntax

KUMU_LIST_WIDGET_ELEMENT_CONNECTIONS(element_identifier, connection_direction, identify_by_label)

Parameter Description
element_identifier

The cell that contains the unique identifier for the element.

In most projects, this will be the element Label, but you can also use an ID column to identify elements.

connection_direction Enter "both" to list all connections from and to the element. Enter "from" to list only the connections from the element, and enter "to" to list only the connections to the element. This parameter is not case sensitive.
identify_by_label

Enter TRUE if the element's unique identifier is coming from the Label column. Enter FALSE if the element's unique identifier is coming from the ID column.

If you don't specify this parameter, it defaults to TRUE.

Given those parameters, KUMU_LIST_WIDGET_ELEMENT_CONNECTIONS returns Kumu list widget code to list all the connections that are connected from or to the specified element.

Then, you can simply import that data back into Kumu, and when you open any element profile, its connections will be listed!

edit this page