Lesson 5: Frames
These code samples provide a basic introduction on setting and getting Frames on entities. For an in-depth description of Frames and their role in Avial modeling, please visit our wiki <https://docs.ledr.io/en/the-orchestra-platfrom/avial-model#frames>
Set Frames on Person Entity
- module.utils.set_person_frames.set_person_frames(people_data: List[AvEntity], auth: AvAuthorization) AvEntity[source]
Orchestra provides a powerful construct called frames. A frame is similar to a table or Excel spreadsheet. Think of a frame as a row in a table. Each frame has the same field headings and each frame (row) has a unique key.
- Parameters:
people_data – List of people to add to frame.
auth – The Orchestra server authorization that allows entity operations.
How to get Frames From an Entity
- module.utils.how_to_get_frames_from_entity.examples_of_get_frames_by_brute_force(report_entity: AvEntity, person_entity: AvEntity, auth: AvAuthorization)[source]
- Parameters:
report_entity – The entity containing the frames.
person_entity – The entity to get the frane data for.
auth – The Orchestra server authorization that allows entity operations.
- module.utils.how_to_get_frames_from_entity.examples_of_get_frames_by_retrieve(report_entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get frames from an entity.
- Parameters:
report_entity – The entity ID of the entity wich holds the frames.
auth – The Orchestra server authorization that allows entity operations.