Download this example as a Jupyter notebook or a Python script.

---

Searching

This notebook demonstrates how to search for record lists using SearchCriterion and BooleanCriterion.

Note

Running this notebook requires permissions to request publication of, to publish, and to revise a record list. Contact your Granta MI administrator for more information.

Connect to Granta MI and create a record list

Import the Connection class and create the connection. See the Getting started example for more details.

from ansys.grantami.recordlists import (
    BooleanCriterion,
    Connection,
    RecordListItem,
    SearchCriterion,
    UserRole,
)

connection = Connection("http://my_grantami_server/mi_servicelayer").with_autologon()
client = connection.connect()

Create some record lists for use in this example:

• identifier_a: Published, empty

• identifier_b: Published, populated

• identifier_c: Revision of identifier_b

• identifier_d: Unpublished

See the Publishing, revising, and withdrawing record lists example for more details.

list_a = client.create_list(name="Approved materials - Metals")
list_a = client.request_list_approval(list_a)
list_a = client.publish_list(list_a)

list_b = client.create_list(name="Approved materials - Ceramics")
client.add_items_to_list(
    list_b,
    items=[
        RecordListItem(
            "9716c5a3-da85-4126-a922-3fbb854656d8",
            "d352fd12-c342-41c1-9da7-dac0dac1c6d9",
            "c61e8f3a-d7e1-4b7f-8232-b2495eae6c15",
        )
    ],
)
list_b = client.request_list_approval(list_b)
list_b = client.publish_list(list_b)

list_c = client.revise_list(list_b)
list_d = client.create_list(name="My personal list")

Search for a record list by name

Use the name_contains keyword argument for the SearchCriterion constructor to specify a search criterion based on the record list name.

results = client.search_for_lists(SearchCriterion(name_contains="Approved materials - Ceramics"))
results

[<SearchResult name: Approved materials - Ceramics>,
 <SearchResult name: Approved materials - Ceramics>]

Search for ‘personal’ record lists

A ‘personal’ record list is a list that the current user has created for their own use. It is owned by the current user, is not published, is not awaiting approval, and is not a revision of another list. Lists are generally in this state if they are created in the Favorites or Explore apps and are not submitted for publication.

To search for a list of this type, use the SearchCriterion below. Set is_internal_use=False to exclude transient record lists created by Granta MI for internal use only, which would otherwise be returned by this search.

criterion = SearchCriterion(
    is_published=False,
    is_revision=False,
    is_awaiting_approval=False,
    is_internal_use=False,
    user_role=UserRole.OWNER,
)
results = client.search_for_lists(criterion)
results

[<SearchResult name: IntegrationTestList_19a0adca-179e-4b52-a0eb-52bd853d87d4>,
 <SearchResult name: IntegrationTestList_6bfe2a72-1baa-4adc-94f7-9ec5f110a6d0>,
 <SearchResult name: IntegrationTestList_6f35d35c-ee80-44e9-b100-c35606b8f4bc>,
 <SearchResult name: IntegrationTestList_ef8fb6be-49c9-4e85-9ecb-c2f0dd3de499>,
 <SearchResult name: My personal list>]

Search for a record list by contents

Search for record lists that contain a specific record with the contains_records keyword. Specifying include_items=True when calling search_for_lists will populate items on the results.

criterion = SearchCriterion(contains_records=["c61e8f3a-d7e1-4b7f-8232-b2495eae6c15"])
results = client.search_for_lists(criterion, include_items=True)
results

[<SearchResult name: Approved materials - Ceramics>,
 <SearchResult name: Approved materials - Ceramics>]

results[0].items

[<RecordListItem(database_guid='9716c5a3-da85-4126-a922-3fbb854656d8', record_history_guid='c61e8f3a-d7e1-4b7f-8232-b2495eae6c15')>]

Search using a complex criterion

Build complex queries with BooleanCriterion. For example, search for published record lists following the naming convention “Approved materials - {Material family}”, but specifically only metals and ceramics.

criterion = BooleanCriterion(
    match_all=[
        SearchCriterion(
            name_contains="Approved materials",
            is_published=True,
        ),
        BooleanCriterion(
            match_any=[
                SearchCriterion(
                    name_contains="Metals",
                ),
                SearchCriterion(
                    name_contains="Ceramics",
                ),
            ]
        ),
    ]
)
results = client.search_for_lists(criterion)
results

[<SearchResult name: Approved materials - Ceramics>,
 <SearchResult name: Approved materials - Metals>]