Object model: the basics

Author/Assessor: Anna Dowling

The following outline will give the reader a summary of the main domain objects associated with the Dig Portal application.

• company_config - The Dig Portal is configured using the company_config domain. This assigns all of the default display options for the application specific to which Customer is using it. Only one company_config object can be active per application.
• ticketer_config - The ticketer_config domain stores the sql queries used in the application associated with a specific customer and the database profiles from which these are pulled. The ticketer_config is then set on the company_config.
• marker_color_config - The marker_color_config domain stores the settings for alarm marker colors that get displayed on the map. For example, the Critical alarm color is red.
• database_profile - The database_profile domain stores entries for the database server connections to other application databases which are used in the Dig Portal. These are set at a company_config level per customer.
• cluster - The cluster domain stores entries for all of the CBYD specific areas (i.e. CBYD - New York DS). In terms of the Dig Portal application, these are configured on a customer basis subject to their snmp_config within the application. This ticketer_config is then stored in the active company_config object.
• cluster_group - The cluster_group domain stores references to a group of clusters that can be configured to show multiple clusters (i.e. by region, or with multiple carriers)
• cluster_group_cluster - The cluster_group_cluster domain is a join table which stores the relationship between the cluster table and the cluster_group table.
• network_element_communication_failure_identifier - Used to store information about identifiers used to determine whether a network element is suffering a communication failure. For example: An element with an alarm present with an alarm identifier of 'linkDown' will have suffered a communication failure and this should be displayed on the client.
• sql_query - The sql_query domain stores all of the queries which are used to display alarms, network elements and tickets on the map.
• uploadable_file - The uploadable_file domain stores the reference to any file uploaded to a network_element via the dig portal. It also stores the location of the file on the filesystem.
• cluster_uploadable_file - The cluster_uploadable_file domain is a join table which stores the relationship between the cluster and uploaded files associated with that cluster.
• map_overlay - The map_overlay domain stores the reference to the kml map overlay associated with a specific location on the map. There are currently three different map_overlay_types used in the Dig portal. These are FIBER, WEATHER_WARNING and WEATHER.
• shiro_user - The shiro_user domain stores user account details for the Dig Portal application.
• shiro_role - The shiro_role domain stores user role information associated with access limitations in the Dig Portal applications. For example the role Administrator has access to the admin pages in the Dig Portal etc.
• shiro_user_shiro_role - The shiro_user_shiro_role domain is a join table which stores the relationship between the shiro_user table and the shiro_role table, creating the link between users and their assigned roles.
• shiro_user_cluster - The shiro_user_cluster domain is a join table which stores the relationship between the shiro_user table and the cluster table, creating the link between users and their assigned clusters.
• shiro_user_cluster_group - The shiro_user_cluster_group domain is a join table which stores the relationship between the shiro_user table and the cluster_group table, creating the link between users and their assigned cluster groups.
• shiro_role_permissions - Permissions are assigned through the table shiro_role_permissions. This is done at a database level to populate this field. This table stores a reference to the shiro_role_id and a permissions string for the grails gsp view permissions.
• dig_portal_column_preferences - The dig_portal_column_preferences domain determines which columns are displayed on the main Dig Portal landing page.
• dig_portal_config - The dig_portal_config stores references to the criticalThreshold for fiber, the warningThreshold for fiber, the digTicketResultsLimit for the portal and email recipients for fiber cut reports.
• email_recipient - The email_recipient domain stores an entry for emails configured to receive the CBYD notifications.
• geographic_location - The geographic_location domain is used to store the association of states to Map Overlays in the Dig Portal. This enables us to show map overlays for “fly to address” searches for associated states.
• map_overlay_geographic_location - The map_overlay_geographic_location domain is a join table which stores the relationship between the map_overlay table and the geographic_location table, creating the link between overlays and states.

The following assessment is to test your knowledge of the basic object model outlined above for the Dig Portal. Please have a member of the team review this assessment with you.

This assessment assumes that you have a basic working knowledge of MySQL and have completed the MySQL assessment prior to this.

1. Set up a connection to the Dig Portal RDS instance and locate the dig_portal application database. (If you need assistance in establishing this connection please contact a member of the team.)
2. In the MySQL prompt, Describe the contents of the following tables: cluster, cluster_group, map_overlay, marker_color_config, dig_portal_config.
3. Join an entry of the shiro_user table to the shiro_role table.
4. Join an entry of the cluster table to the cluster_group table.
5. Locate the active company_config entry for the Dig Portal.
6. Locate the active database_profile entry for the ticketer application.
7. Find the uploaded files directory on one of the application handlers for the Dig Portal using the relative table in the database. (If you need assistance in establishing this app handler connection, as it is on AWS, please contact a member of the team.)
8. Find the relevant ticketer_config entry associated with the active company_config.
9. Join an entry of the shiro_user table to the cluster table to determine an cluster assignment for that user account.
10. Join an entry of the shiro_user table to the cluster_group table to determine a cluster_group assignment for that user account.
11. Find the list of email recipients for fiber cut reports associated with the active Dig Portal configuration.
12. Join an entry of the map_overlay table to the geographic_location table.