Lesson 4: Facets & Factors
These code samples provide a basic introduction on on setting and getting Facets and Factors on entities. For an in-depth description of Facets and their role in Avial modeling, please visit our wiki <https://docs.ledr.io/en/the-orchestra-platfrom/avial-model#facets>
Set Facets & Factors on Person Entity
- module.utils.set_person_facets.set_facet_and_factors(person_entity: AvEntity, home_address: str, work_address: str, auth: AvAuthorization)[source]
A person can have multiple addresses. Features, Facets/Factors & Factors, and Frames are Avial constructs that can be used to add additional attributes to a Fact. This function shows how facets and factors can be used for multiple addresses. When to use Features, facets, or Frames is a modeling discussion and not applicable to this lesson.
- Parameters:
person_entity – The entity ID of the person entity to add the feature.
home_address – Person’s home address.
work_address – Person’s work address.
auth – The Orchestra server authorization that allows entity operations.
How to get Facets and Factors From Entities
- module.utils.how_to_get_facets_from_entities.examples_of_get_facets_by_brute_force(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get facets from an entity, by specifying which attributes you want to get.
- Parameters:
entity – The entity ID of the entity to get the facts.
auth – The Orchestra server authorization that allows entity operations.
- module.utils.how_to_get_facets_from_entities.examples_of_get_facets_by_retrieve(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get facets from an entity.
- Parameters:
entity – The entity ID of the entity to get the facts.
auth – The Orchestra server authorization that allows entity operations.
- module.utils.how_to_get_facets_from_entities.examples_of_get_factors_by_brute_force(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get factors from an entity, by specifying which attributes you want to get.
- Parameters:
entity – The entity ID of the entity to get the facts.
auth – The Orchestra server authorization that allows entity operations.
- module.utils.how_to_get_facets_from_entities.examples_of_get_factors_by_retrieve(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get factors from an entity.
- Parameters:
entity – The entity ID of the entity to get the factors.
auth – The Orchestra server authorization that allows entity operations.