Helix IPLM query language

The Helix IPLM platform provides a powerful query language that can search for objects with a variety of functions over all the built in fields and metadata of each Helix IPLM object. Query expressions can be saved and shared with other users. Saved queries are available on PiCLI, IPLM Web, and the API. Widgets can be applied to Saved queries, and when displayed on IPLM Web, these Widgets provide a way of presenting data applicable to the set of IPs returned by the Query. Queries can be further organized into Query Folders.

Query language overview

Helix IPLM provides a powerful query language to search for objects in the system. Queries can be run from PiCLI, IPLM Web, or the API, while IPLM Web queries are run from the Advanced search Page. PiCLI queries are run via arguments to the various object list commands, examples of this can be found on the various query example pages.

Detailed information on how to use the query language can be found in the Query language details section.

Example query on PiCLI

The following query searches for IPVs created in the last two weeks.

Query Searching for IPVs within Last Two Weeks

> pi ip ls -a -q 'creation_timestamp > now()-weeks(2)'
┌──────────────────────┬────┬─────────────┬────────────┬───────────────────────────────┬─────────────────┐
│ NAME                 │ DM │ ALIASES     │ CREATED BY │ CREATED ON                    │ VERSION MESSAGE │
╞══════════════════════╪════╪═════════════╪════════════╪═══════════════════════════════╪═════════════════╡
│ drinks.vodka@3.TRUNK │ P4 │ HEAD LATEST │ admin      │ 2018-01-08 2:57:19 -0800 PST  │ test            │
│ drinks.vodka@2.TRUNK │ P4 │             │ admin      │ 2018-01-08 2:53:12 -0800 PST  │ test            │
└──────────────────────┴────┴─────────────┴────────────┴───────────────────────────────┴─────────────────┘

Saved queries

Helix IPLM Queries can be stored as Saved queries, either for personal use by the creator, or shared for wider distribution. They can be used via the '-sq' option from their associated list command. The following example runs the Saved query 'qualified' and returns the results.

Qualified Saved query Example

> pi ip list -sq qualified
┌───────────────────────────────┬────┬─────────────┬────────────┬───────────────────────────────┬─────────────────────────────────┐
│ NAME                          │ DM │ ALIASES     │ CREATED BY │ CREATED ON                    │ VERSION MESSAGE                 │
╞═══════════════════════════════╪════╪═════════════╪════════════╪═══════════════════════════════╪═════════════════════════════════╡
│ Data-Converter.sd_adc@1.TRUNK │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 15:51:25 -0400 EDT │ releasing Data-Converter.sd_adc │
│ PDK.MS90G_LP@9.TRUNK          │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 16:10:13 -0400 EDT │ releasing PDK.MS90G_LP          │
│ tutorial.MS90G@5.TRUNK        │ P4 │ HEAD LATEST │ admin      │ 2020-05-06 17:16:09 -0400 EDT │ test                            │
│ tutorial.adc@1.TRUNK          │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 14:42:22 -0400 EDT │ hier release                    │
│ tutorial.aes512@1.TRUNK       │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 14:43:07 -0400 EDT │ hier release                    │
│ tutorial.bist_sram@2.TRUNK    │ P4 │ HEAD LATEST │ admin      │ 2020-05-06 17:02:06 -0400 EDT │ ttest                           │
│ tutorial.intf_ana@1.TRUNK     │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 14:42:30 -0400 EDT │ hier release                    │
│ tutorial.io_tsmc18@3.TRUNK    │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 16:10:06 -0400 EDT │ hier release                    │
│ tutorial.proj_tech@1.TRUNK    │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 14:42:39 -0400 EDT │ hier release                    │
│ tutorial.t0@2.TRUNK           │ P4 │ HEAD LATEST │ admin      │ 2020-05-06 17:02:06 -0400 EDT │ ttest                           │
│ tutorial.timers@2.TRUNK       │ P4 │ HEAD LATEST │ admin      │ 2020-05-06 17:02:06 -0400 EDT │ ttest                           │
│ tutorial.verif_config@3.TRUNK │ P4 │ HEAD LATEST │ admin      │ 2020-03-26 16:10:08 -0400 EDT │ hier release                    │
└───────────────────────────────┴────┴─────────────┴────────────┴───────────────────────────────┴─────────────────────────────────┘
Found 12 matching object(s).

Saved queries are also available from the Advanced search page on IPLM Web. For more details, refer to the Saved queries section.

Query example pages

Below are links to the various command specific Query Example pages.

Object	Query Example Page
IPs	Querying IPs in the System
Libraries	Querying Libraries in the System
Workspaces	Querying Workspaces
Snapshots	Querying Snapshots in the System
Metadata	Querying Metadata in the System