RediView Documentation

Located consistently at the top of the application, the Header contains:

• RediView Logo: Clicking the logo typically navigates you back to the main Dashboard page.
• Main Navigation Menu: Provides access to different modules and sections of RediView, such as Dashboard, Reports, Parents, Producers, Regions, Plants, Users, Triggers, and Functions. The available menu items are tailored based on your assigned user role and permissions.
• Interactive Guide Button: Look for a HelpCircle icon (question mark). Clicking this button launches an interactive walkthrough for the current page, guiding you through its features.
• Theme Toggle: Allows you to switch between light and dark visual modes for user interface preference.
• User Account Menu: Displays your username or a user icon. Clicking this opens a dropdown menu with options such as User Profile (if applicable) and Sign Out.

This is the largest part of the screen, displaying the content specific to the module you have selected from the Main Navigation Menu. For instance, selecting Plants will populate this area with a list of plants and relevant management tools.

Positioned at the bottom of each page, the Footer may include copyright notices, company information, application version details, and links to support resources or privacy policies.

Upon successful login, an AuthenticatedBanner may be displayed, typically near the top of the page:

• Green Banner with ShieldCheck icon: Confirms your authenticated status, often displaying your email and session expiry time. This indicates a secure and active session.
• Amber Banner with Shield icon: Indicates that you are not currently authenticated or your session has timed out. You will need to log in again to access protected areas of the application.

Common columns: Plant Name, Machine Name, Last Load, Avg Cycle (min), Loads/Hr, Status, Sentiment, Actions.

Color-coding for status: Green (online), Yellow/Amber (warning), Red (offline/critical), Grey/Blue (unknown).

Drill down by clicking Plant Name or a "View Details" icon.

Select specific entities to scope data. Options based on user permissions.

Use the Date Range Picker for specific periods.

Line or bar chart showing production volume over time.

Line or bar chart illustrating average cycle time.

Navigate to the Parents section from the Main Navigation Menu. The ParentContent page will display a list of all Parent Companies accessible to you.

1. On the ParentContent page, click the Create Parent (or similar, e.g., Add New Parent) button.
2. The CreateParentModal will open, guiding you through a multi-step process:
   • Step 1: Basic Information
     • Company Name: (Required) The official and unique name of the parent company.
   • Step 2: Primary Contact
     • Enter details for the primary contact person: First Name, Last Name, Title, Email, Phone.
   • Step 3: Integrations
     • Configure API keys and credentials for third-party system integrations, such as TrackIT API Key, CIDRA Access Token, CIDRA Client ID, Marcotte Username, Marcotte Password, Marcotte URI, Material Receipt API Key. Provide these if applicable.
   • Step 4: Additional Settings
     • Cost Per Minute: Define the standard operational cost per minute for this parent company, used for financial calculations.
3. Complete all required fields (marked with an asterisk or otherwise indicated) and any relevant optional fields in each step.
4. Use the Next and Back buttons to navigate between the steps.
5. On the final step, click the Create button to save the new Parent Company.

1. From the ParentContent list, locate the Parent Company you wish to modify.
2. Click the Edit icon or button associated with that entry.
3. The EditParentModal will appear, pre-populated with the existing data, following the same multi-step format as creation.
4. Update the necessary information across the various steps.
5. Click the Save (or Update) button on the final step to apply your changes.

1. From the ParentContent list, locate the Parent Company to be deleted.
2. Click the Delete icon or button (often a trash can symbol).
3. A confirmation dialog will appear. Carefully review the warning message.
4. If you are certain, confirm the deletion.

Navigate to the Producer section from the Main Navigation Menu. The ProducerContent page lists Producers, often allowing filtering by the parent Parent Company.

1. On the ProducerContent page, click the Create Producer button.
2. The CreateProducerModal (multi-step) will open:
   • Step 1: Basic Information
     • Parent Company: (Required) Select the Parent Company to which this Producer belongs from the dropdown.
     • Producer Name: (Required) The name of the Producer entity.
   • Step 2: Primary Contact
     • Provide contact information for the Producer's main point of contact.
   • Step 3: Additional Settings
     • TrackIT API Key: For TrackIT system integration.
     • BCMI Organization ID: For BCMI system integration.
     • Publish IPS To Digital Plant Since: (Date Picker) The start date for publishing IPS data.
       Modifying this field may require Super Administrator privileges.
     • Cost Per Minute: Producer-specific operational cost.
     • Tolerance Goal (%): The target operational tolerance percentage.
3. Complete the form and click Create Producer on the final step.

1. From the ProducerContent list, click Edit for the desired Producer.
2. The EditProducerModal will load with existing data.
3. Make necessary changes across the steps and click Save (or Update).

1. Locate the Producer in the ProducerContent list.
2. Click the Delete action.
3. Confirm the action in the confirmation dialog.

Navigate to the Region section. The RegionContent page displays Regions, usually filterable by Parent Company and Producer.

1. On the RegionContent page, click Create Region.
2. The CreateRegionModal (multi-step) will appear:
   • Step 1: Basic Information
     • Producer: (Required) Select the Producer this Region falls under.
     • Region Name: (Required) The name for the new Region.
   • Step 2: Primary Contact
     • Enter contact details for the Region.
   • Step 3: Additional Settings
     • TrackIT API Key: Region-specific key, if applicable.
     • Cost Per Minute: Region-specific cost, if applicable.
3. Fill out the details and click Create Region on the final step.

1. From the RegionContent list, click Edit for the target Region.
2. The EditRegionModal opens. Modify details as required and click Save.

1. Locate the Region in the RegionContent list.
2. Click the Delete action.
3. Confirm the deletion.

Navigate to the Plants section. The PlantContent page lists all Plants, with filters for Parent Company, Producer, and Region.

1. On the PlantContent page, click Create Plant.
2. The CreatePlantModal is a comprehensive multi-step modal:
   • Step 1: Plant Location
     • Parent Company: (Required) Select the Parent.
     • Producer: (Required) Select the Producer (options filtered by selected Parent).
     • Region: (Required) Select the Region (options filtered by selected Producer).
     • Redi-View Display Name: (Required) The name that will be displayed for this plant within RediView.
   • Step 2: Basic Information
     • Plant Code: (Required) A unique identifier for the plant.
     • Plant Alias: An alternative name or shorthand.
     • Cost Per Minute: Plant-specific operational cost.
     • Plant Location, Plant Address.
     • Control System Type: Select from available types (e.g., CB, MC).
     • Brand, Serial Number.
     • External Identifier: A unique ID for linking with external systems
       Super Administrator may have exclusive rights to edit this
       .
   • Step 3: Advanced Settings
     • Machine Name: (Required) The network name or critical identifier of the plant's primary machine or control system.
     • Device Health Check Name, Host Machine Name.
     • Time Zone: Select the plant's operational time zone.
     • Units Of Measure: Choose between US (Imperial) or Metric.
     • Week Start Day: (e.g., Sunday, Saturday).
     • Lane Two Name, Lane Two Sequence Codes: For plants with multiple lanes.
     • Active (Checkbox): Indicates if the plant is currently operational.
     • Has Mixer (Checkbox): Indicates if the plant is equipped with a mixer.
   • Step 4: Database Settings
     • Database Host: Network address for the plant's local database, if applicable for data integration.
     • Blinky Host: Network address for integration with a "Blinky" light status system.
     • Disable VSC Configure (Checkbox): Setting related to Verifi Service Configure (typically enabled by default, meaning VSC is disabled).
   • Step 5: Contact Information
     • Provide primary contact details specifically for this plant.
3. Carefully complete all required fields and relevant optional information across all steps.
4. Click Create Plant on the final step.

1. From the PlantContent list, click Edit for the specific Plant.
2. The EditPlantModal will open, pre-filled with existing data, using the same multi-step structure.
3. Make the necessary modifications and click Save Plant.

1. Locate the Plant in the PlantContent list.
2. Click the Delete action.
3. Confirm the deletion in the prompt.

This functionality is typically located within the Triggers module, possibly under a "Categories" or "Manage Categories" sub-section.

1. Click the Create Trigger Category button.
2. The CreateTriggerCategoryModal will open, usually with tabs for different settings:
   • Basic Information Tab:
     • Category Name: (Required) A descriptive name for the category (e.g., "Production Efficiency Alerts," "Material Variance Triggers").
     • Category Name English, Spanish, Language1, Language2: Provide translations if your RediView instance is multilingual.
   • Settings Tab:
     • Allowed UOM: Select the Unit of Measure (e.g., Volume, Weight, Time, Count) to which triggers in this category primarily apply.
     • Trigger Limit Fields (Checkboxes): Select which specific limit parameters (e.g., LowerLimitPercent, ChangeUpperLimit, UpperLimitMax) should be available and configurable when creating Triggers assigned to this category. This tailors the Trigger creation form.
     • Alert Class Peers: An advanced field, potentially for grouping related alert classes for specialized reporting or handling.
3. Complete the required information and click Create Trigger Category.

1. From the list of Trigger Categories, select the one you wish to edit.
2. Click the Edit action. The EditTriggerCategoryModal will load.
3. Update the category's name, translations, UOM, or associated limit fields.
4. Click Save Changes.

1. Locate the Trigger Category to delete.
2. Click the Delete action and confirm.

Navigate to the main Triggers section from the application header. This page will list all configured Triggers.

1. On the Triggers page, click the Create Trigger button.
2. The CreateTriggerModal is a detailed, multi-tab interface:
   • Basic Information Tab:
     • Description: (Required) A clear, concise description of what the trigger monitors (e.g., "Plant Alpha - Cycle Time Exceeds 45 Minutes").
     • Scope Selection (Parent, Producer, Region, Plant): (At least one level in the hierarchy must be specified beyond "None" or "All" unless it's a global trigger type).
       • Parent Company: Select the Parent Company.
       • Producer: Optionally, select a Producer under the Parent.
       • Region: Optionally, select a Region under the Producer.
       • Plant: Optionally, select a specific Plant.
       • Selecting "None" or "All" at a level generally means the trigger applies more broadly within the higher selected scope.
     • Trigger Type: (Required) Select a pre-defined Trigger Type from the dropdown. These types are often derived from your Trigger Categories and determine which parameters are relevant.
       Only 'available' trigger types can be selected.
     • Load Size Bucket: (Optional) Apply this trigger only to loads falling within a specific size range.
     • Report Material Group Member: (Optional) Link this trigger to a specific material group for context.
     • Item Code: (Optional) If the trigger pertains to a specific material or item, enter its code here.
     • Unit of Measure (UOM): Select the UOM relevant to the trigger's logic, if applicable.
   • Time Intervals Tab:
     • Time Frame: Define how often the trigger condition is evaluated (e.g., Seconds, Minutes, Hours, Days, Per Load).
     • Time Frame Interval: The numeric interval for the selected time frame (e.g., if Time Frame is Hours and Interval is 4, the condition is checked every 4 hours).
   • Alert Limits Tab (Standard Operational Limits):
     • Define the primary thresholds. The specific fields available depend on the selected Trigger Type.
     • Examples: UpperLimit, LowerLimit, UpperLimitPercent, LowerLimitPercent, ChangeUpperLimit, ChangeLowerLimit, ChangeUpperLimitPercent, ChangeLowerLimitPercent.
   • Critical Limits Tab (Maximum/Escalation Limits):
     • Define more extreme thresholds that may indicate a critical or escalating issue.
     • Examples: UpperLimitMax, LowerLimitMax, UpperLimitPercentMax, LowerLimitPercentMax, and corresponding "Change" variants.
3. Carefully configure all relevant parameters across the tabs.
4. Click Create Trigger.

1. From the Triggers list, locate the Trigger you wish to modify.
2. Click the Edit action. The EditTriggerModal will open with its current configuration.
3. Adjust parameters as needed across the various tabs.
4. Click Save Trigger.

1. Locate the Trigger in the list.
2. Click the Delete action and confirm.

This information might be accessible via an action on the Triggers list (e.g., "Manage Users," "View Assignments") or on a dedicated Trigger User management page.

1. This process is typically initiated either from a specific Trigger's action menu or through a general "Assign Trigger to User" interface.
2. The CreateTriggerUserModal will open:
   • User: (Required) Select the target user from a dropdown list.
   • Trigger: (Required) Select the specific Trigger you are configuring notifications for. (This may be pre-filled if you initiated this from a particular trigger's context. If a defaultTrigger is passed, it will be pre-selected and potentially read-only).
   • Notification Limit: Choose how frequently the user should be notified if the trigger condition persists (e.g., None, Minute, Hour, Day).
   • Period Duration (Hrs): If a Notification Limit (other than None) is selected, specify the duration in hours for that limit (e.g., if limit is Hour and duration is 1, the user gets one alert per hour while the condition is active).
   • Active (Switch/Checkbox): Enable or disable notifications for this specific user-trigger assignment.
3. Click Create Assignment (or Save).

1. Locate the specific user-trigger assignment you need to change.
2. Click the Edit action. The EditTriggerUserModal will load the current settings.
3. Adjust the Notification Limit, Period Duration, or Active status.
4. Click Save Changes.

1. Find the assignment to remove.
2. Click the Delete or Remove Assignment action and confirm. The user will no longer receive alerts for that specific trigger.