Managing Product Subscriptions in the Trimble Cloud Console

Introducing subscriptions menu

As a consumer, Subscriptions between your application and the API Product can be viewed and managed in the ‘Subscriptions’ menu.

For a consumer to manage their subscriptions:

User must be part of a team and must be assigned a role. A member with any role can access the Subscriptions menu. API visibility and team roles.

Steps on how to manage the subscriptions:

• If subscriptions exist for your team, Subscriptions menu will list all the subscriptions of ‘Pre-Production’ & ‘Prod’ based on environment drop-down selection in Navigation bar.
• Expanding an API Product will list down all the subscriptions with the following detail in table format (Application Name, Subscribed Date, Status of the Subscription with Edit & Delete Actions)
• Deleting the subscription will remove the Subscription between the API Product & the Application
• Edit icon will navigate the user to ‘Subscription Detail’ page
• In the Edit Subscriptions page, user will be allowed to do the following actions:
  • View the subscribed information of API Product & Application
  • Linked API & Event Services
  • Able to configure existing & new Event Configuration using Add New Event Configuration in Event Configuration section
  • Remove Subscription

Subscriptions Menu List Page:

Subscriptions Menu Summary Page:

What does subscription status indicate?

• —> Icon denotes the ‘Subscription In Review’
• —> Icon denotes the ‘Subscription Denied’
• —> Icon denotes the ‘Subscription Approved’

Creating new Event configuration

New event configuration can be created within a subscribed Product. Configuring Events to a subscribed product will allow users to consume messages produced by a Kafka producer using their application token.

• Service

  • The Service dropdown lists all available events and their versions associated with the product.
    • Example: Data Ocean - v1: “Data Ocean” is the name of the event, and “v1” is its version.

• Service Deployment The Service Deployment field specifies the environment where the event is deployed. It can be one of the following:

  • dev
  • qa
  • stage
  • production

• Description

  • The Description field provides a short description of the subscription. This should explain why you need to subscribe to the event in the specified environment.
    • Example: “Subscribe to Data Ocean events in the production environment for real-time data analytics.”

• Filter

The filter operates by taking a regular expression (regex) as input, which it applies to a specified field within each message produced. It evaluates the content of the field, and only those messages that satisfy the regex condition are passed through to the consumer. This ensures that the consumer receives messages tailored to specific criteria, reducing unnecessary processing and allowing for more precise, efficient data consumption.

• Usage:

  • Enter a regex pattern in the text box to filter messages.
  • Click the Verify button to ensure the regex pattern is valid.

• Example:

  • Regex pattern: source=^events.*
  • This pattern would filter messages in which the source field should begin with “events”. The below sample payload will satisfy the filter condition and will pass to the subscribed consumer

  { “id”: "" “specversion”: “1.0”, “source”: “eventssample”, “type”: “Product”, “time”: “2021-10-12T07:20:50.520Z”, “subject”: “Test subject”, “datacontenttype”: “application/json”, “dataschema”: “https://cloud.api.trimble.com/events/registry/1.0/schematype/data/namespaces/test/events/test/v1.0”, “data”: ”{“message”: “dev.v1.0”,“uuid”: “78706795-eae0-403b-9aba-63a2356d3219”,“status”: “test”}” }

• Add Event Configuration

  • Procedure:

    • Ensure all required fields (Service, Service Deployment, Description) are filled.
    • If required, provide a regex pattern in the Filter field and verify it.
    • Click the Add Event Configuration button to create the subscription.

    By following the above steps, users can efficiently subscribe to an event.