Software Documentation

Software Documentation

Site Layout and Rack Layout DiagramsDocumentation

Pro Last updated: December 29, 2024

4 Text box variables

Site layout and rack layout diagrams contain an optional information panel on the right of the page that displays a variety of information tailored to the purpose of the diagram, such as whether the diagram is for a client, or the authority having jurisdiction, or the display operator’s crew, or the personnel who assemble single-shot racks in advance to bring to the shoot site.

You choose what information to display by configuring the diagram template (blueprint), which is accessed from the blue gear menu in the upper right corner of the rack layout window.  The diagram template contains eight configurable text boxes, and the text boxes can contain variables that refer to information from the diagram or the show.  The table below shows the list of variables available to you and their meaning.

 

Table 1 – Variable meanings in site layout diagrams and rack layout diagrams

Variables Meaning in site layout diagrams Meaning in rack layout diagrams
{diagram_title} The title of the diagram, from the diagram template. Same as for site layout.
{diagram_page_number}, {number_of_diagram_pages} <undefined> Rack layout diagrams contain a collection of diagram pages, such as one diagram page per position, or module, or rack.  Each diagram page typically consists of a diagram and a table of information.  If the table is short, it may fit on the same page as the diagram, in which case the diagram page requires just a single page of paper, but if the table doesn’t fit on the same page as the diagram, the diagram page may require multiple pages of paper for the overflow.  Whereas the page number in the upper right of the page counts the pages of paper, the {diagram_page_number} counts the diagram pages.
{position} <undefined> The name of the position containing the information shown in the diagram page.
{universes}, {sections} The union of universes or sections of all events in all positions passing the site layout’s position name filter. The union of universes or sections of all events in the diagram page’s position, whether included in the shown racks or not.
{number_of_modules}, {number_of_rails}, {number_of_ematches}, {number_of_pins_used}, {number_of_pins_total}, {number_of_devices}, {number_of_universes} The count of modules, rails, etc. of all events in all positions passing the site layout’s position name filter. Total pins is based on used or pre-allocated modules. The count of modules, rails, etc. of all events in the diagram page’s position, whether included in the shown racks or not. Total pins is based on used or pre-allocated modules.
{rack_counts_table}, {rack_totals_table} A table of counts of racks in all positions passing the site layout’s position name filter.  The table includes the counts, rack names, and sizes. A table of counts of all racks in the diagram page’s position.  The table includes the counts, rack names, sizes, and angles.
{module}, {rail}, {rack_number}, {rack_cluster}, {rack_name}, {rack_manufacturer}, {rack_notes} <undefined> The union of module numbers, rail numbers, etc. of events included in the diagram page’s “consists-of” specification, and if the specification is “PER MODULE” then also the diagram page’s position’s pre-assigned rails (or modules thereof) that match the diagram page’s module, and if the specification is “PER POSITION” then also all the diagram page’s position’s pre-assigned rails (or modules thereof).
{annotation} <undefined> The union of annotations of racks in rack clusters that are associated with racks that are included in the diagram page’s “consists-of” specification and filter.  Rack diagrams often have a single annotation per rack cluster, describing the entire cluster of racks, but the annotation itself in the user interface is associated with a specific rack.  This definition of the {annotation} variable ensures that if the rack layout diagram displays any of the racks in a rack cluster, the {annotation} will include the annotation describing the cluster.