"Where Used" Report available for Columns¶
Vinyl offers reports named Where Used available for Columns in the Data Layer and also from the Rule Detail screen, for Columns in the Business Logic Layer. These reports allow you to determine where in the application the Column is being used for any Controls on pages in the app, what Tables the Column resides in, and any Endpoints configured that reference the Column.
The main benefits to the Where Used report are to provide a Developer with a better understanding of how a Column is being used across the system. As well, if a Developer is looking to delete a Column they'll have visibility into what is impacted and needs to be modified or addressed in order to allow the Column to be deleted.
Note
The "Where Used" report will not include data for Expressions present in the Business Object's selected Columns and/or Where statements.
How to Access the "Where Used" Report - Data Layer¶
- Navigate to the App Workbench
- Click the Rules tile
- Click By Table
- Select the App Data Source containing the table you're interested in
- Locate the Table and click the corresponding Open Record icon
- Click the Open Record icon for the Column
- Click the Where Used button
How to Access the "Where Used" Report - Business Logic Layer¶
- Navigate to the Page in your application built off of the Business Object with the Column you want to review
- Click on the Action Drawer Menu > Live Designer
- Select the panel from the design view
- Click on the SQL cog icon for the Panel Source
- Click on the Columns tab
- Click the Open Record icon for the Column you want to review
- Click on More > Where Used
Where Used in Controls¶
The Where Used report is available to show information related to Controls. This option is for Columns used on UI elements (Pages, Panels, Fields, Conditional Formatting, List Bindings, etc.). Information contained in the report describes what Page and Panel (if applicable) and Control it was applied on, as well as Control Type and a short description of Use.
Note
Pages and Panels are Controls, therefore if a Panel is not listed it most likely means it is applied to a child Panel Binding Columns or Visibility Column under the Panels' Binding settings.
Where Used in Tables¶
The Where Used report is available to show information related to Tables. Information contained on this report option shows where the Column is used on a business object, and can be the target of a Column, a Join, or a Binding on an Action from an Event, indexes (Primary Key, Foreign Key, or regular indexes).
Where Used in Endpoints¶
The Where Used report is available to show information related to Endpoints. Information contained on this report option shows where the Column is a field on an exposed REST or Webhook Endpoint.