Specifying the Availability of TeaOperations in TIBCO Enterprise Administrator Clients

Users can connect to the TEA server using one of three clients - the TEA Web User Interface, the Shell, and Python scripts. However, not all TEA operations can be supported in all clients. When coding a method that is annotated with TeaOperation, the agent developer can specify which clients expose that operation.

To do so, in the TeaOperations annotation, supply the attribute hideFromClients, which can have one or more of the following values:

  • ANY - operation is not available to any client

  • PYTHON - operation not available from the Python client

  • SHELL - not available from the Shell

  • WEB_UI - not available in the Web User Interface

  • If you do not specify this attribute, the operation is exposed in all clients.

Example - using a single value

@TeaOperation(name = NAME, description = "Ping agent", hideFromClients={ClientType.ANY})

Example - using multiple values

@TeaOperation(name = NAME, description = "Ping agent", hideFromClients={ClientType.SHELL, ClientType.PYTHON})

Note: The internal attribute has been deprecated. Use the hideFromClients attribute instead.
Note: If the TeaOperations name contains an invalid character, the operation are not be available in the Python binding. You can retrieve a list of omitted operations at the respective object types. For example, you can retrieve the list of omitted operations for a provisional product and its members as follows: 
>>> import tibco.tea
>>> tea = tibco.tea.EnterpriseAdministrator()
>>> prod = tea.product_with_provisional_api(<product_name>)
>>> prod.omitted_operations
>>> prod.members[<member_name>].omitted_operations