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

Getting started#

This example shows how to connect to Granta MI to access version information and activity reports.

Connect to Granta MI#

First, use the ansys.grantami.system.Connection class to connect to the Granta MI server. The Connection class uses a fluent interface to build the connection, which is always invoked in the following sequence:

  1. Specify your Granta MI Service Layer URL as a parameter to the Connection class.

  2. Specify the authentication method using a Connection.with_...() method.

  3. Use the Connection.connect() method to finalize the connection.

This returns a client object, called client in these examples.

[1]:

from ansys.grantami.system import Connection

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

Access Granta MI version information#

The Granta MI version can be accessed with the SystemApiClient.get_granta_mi_version() method.

[2]:

mi_version = client.get_granta_mi_version()
print(mi_version)

26.1.0.0

The .version property is a tuple, and can be compared with a minimum required version using the > operator.

[3]:

minimum_version = (25, 2)
if mi_version.version > minimum_version:
    print("Granta MI version meets minimum requirements")
else:
    print("Granta MI version does not meet minimum requirements")

Granta MI version meets minimum requirements

Access activity report#

The activity report describes which users have accessed the Granta MI server. This report lists all user activity in the Granta MI system and includes the following information:

  • The time an activity occurred

  • Who performed the activity

  • The MI application and database that were used

  • Whether this was a read or edit activity

Use the SystemApiClient.get_activity_report() method to access the report as an iterator of ActivityItem objects.

[4]:

items = client.get_activity_report()
item = next(items)
print(item)

ActivityItem(activity_date=datetime.date(2025, 8, 4), application_names=['PyGranta RecordLists'], username='USER_1', usage_mode=<ActivityUsageMode.VIEW: 'view'>, database_key=None)