Wire Harness Insertion

Wire Harness Insertion Quick Start Application.

Overview

The Wire Harness Insertion quick start application provides users the ability to run through a wire harness assembly flow. The application can be used in two different data source modes: demo data and integrated data.

When configured for demo data, the wire harness data comes from a static data set that has already been embedded in the application. Any data changes would require publishing a new version of the app.

When configured for integrated data, the wire harness data comes from an external data source and requires a Skylight extension (aka data connector). This allows for the data to be dynamic and customized to each deployment's specific needs and data source.

Deployment Guide

1. Download the Application Bundle

2. Import the Application Bundle

  1. Navigate to the Skylight web portal. Select Applications on the sidebar and clickin the lower right corner to add a new application.

  2. Select Import file, then choose the application bundle .zip file you downloaded.

  3. The application will now appear in the application list. Hover over the application and click Open Dashboard to configure further.

3. Add Users & Configure Application Roles

The wire harness insertion quick start application includes the following roles, which give different application permissions:

Role

Permissions

User

Retrieve and view wire harnesses from data integrated from an external source.

Demo User

Retrieve and view wire harnesses from the built-in demo data.

Manager

Set the data in a harness session. (This role should only be used for the Extension when the application is configured for integrated data)

To add users to the application:

  1. Open the Application Dashboard, and select Permissions on the sidebar.

  2. Click the button to Add users.

  3. Type the name(s) of the user(s) or group(s) you wish to add and choose a role. Then select ADD USERS(s) to give them access to the application.

If a user is granted both the User and Demo User roles, the Demo User role takes priority.

4. Publish the Application

The application must be published in order for it to be sync'd to users' devices. To publish the application:

  1. Open the Application Dashboard.

  2. Click the publish button.

  3. A confirmation dialog will appear. Click PUBLISH to make the application available to all users.

Integration Guide

If you are only using the application with demo data, and not integrated data, then you can skip this section.

Users must be assigned the User role and removed from the Demo User role in order to view data from an external source.

The Wire Harness Insertion Quick Start application can be configured to populate harness data from an external data source (e.g., databases, REST API, static files, etc.) that is managed outside of Skylight. In this case, an "extension" (aka data connector), authored using Skylight's C# Integration SDK, is used to transfer data between Skylight and the external system. NET Core 3.1 is required to use this data connector.

1. Install the Skylight C# SDK

If you haven't already, follow the steps to install the C# Skylight SDK on your machine.

2. Download the Data Connector Bundle

The Wire Harness Insertion Data Connector is a .NET Core 3.1 console app. Download the bundle and extract it into a working directory.

3. Configure Data Connector Logging

Change the log4net.config file accordingly to meet the logging needs of your project. You can choose the logging library of your choice.

4. Configure Data Connector User Credentials

Create a dedicated Skylight user account for the data connector, add it to the application, and ensure it is assigned a Manager role for the application.

Configure the user credentials in the data connector using the following env variables:

  • SkylightUsername: Username for the data connector's Skylight user account

  • SkylightPassword: Password for the data connector's Skylight user account

  • SkylightRealm: Skylight domain name

  • SkylightWebUrl: Skylight web URL

If more than one data connector will be running on the same host machine, the name of the env variables will need to be modified to avoid conflict since each data connector should use a different set of credentials. For example, instead of SkylightUsername, change it to be SkylightInsertionUsername. SkylightRealm and SkylightWebUrl can be shared by multiple data connectors if they are connecting to the same Skylight instance.

5. Configure the Data Source

By default, HarnessManager reads static data from a JSON file whose filename matches the harnessID requested.

To integrate with a different data source, modify HarnessManager.GetHarness() to retrieve the harness data from your data source and place it into the Harness object.

6. Build & Run the Data Connector

Build the data connector console app and run it with the dotnet run command.

User Guide

Harness QR Codes

If your application is deployed to use the built-in demo data, you can download the following document which includes QR codes that can be scanned for the harnesses.

Screen glare can prevent the scanner from correctly recognizing the codes. Best practice is to print the document.

If your application is deployed to use data from an external system with the extension, then the QR codes are determined by the items in that system.

Loading a Harness

1. Select Scan Harness and use your device's camera to scan a QR code for the harness.

2. Wait while the harness data is retrieved. If there is an error in retrieving the harness data, the message Failed to retrieve harness will be displayed. If the harness has already been retrieved the message Harness is already active will be displayed.

3. The scanned harness will be displayed on the list. Select the harness to view connectors.

Viewing Connector Details

1. Select a connector to view its details.

2. The connector menu will be displayed. Select a menu item to view its details.

A connector includes:

Basic Info

Notes

Tools

Strip & Crimp

Wire Insertion Diagram

The wire insertion area contains an overview diagram of entire connector's pins. Swipe to view the diagrams for individual wires (or a group of wires). Select the insertion diagram to get more wire info.

Closing Harnesses

Select Close All Harnesses to clear out all of their current active harnesses.

Other Information

Requirements

Known Limitations

  • Currently does NOT support voice search to look for specific connector or wire name

  • Extension (PROD deployment) does not support large harness data set

Release Notes

1.1.0

  • UX Enhancements

  • Rename Extension to Data Connector

  • Does NOT support voice search to look for specific connector or wire name

  • Extension does not support large harness data set; needs to be updated to support large data set via multiple API requests

1.0.0

  • Does NOT support voice search to look for specific connector or wire name

  • Extension does not support large harness data set; needs to be updated to support large data set via multiple API requests

0.0

  • Pre-release of the Wire Harness Quick Start Application, not updated for skylight.global

  • Does NOT support voice search to look for specific connector or wire name

  • Extension does not support large harness data set; needs to be updated to support large data set via multiple API requests