Skip to content

user-guide.md

Latest commit

 

History

History
196 lines (130 loc) · 5.14 KB

user-guide.md

File metadata and controls

196 lines (130 loc) · 5.14 KB

KWikSync User Guide

Back to Documentation

Overview

This comprehensive guide covers all KWikSync features and dashboards. Learn how to navigate the application, manage your data, and get the most out of your synchronization workflows.

Navigating KWikSync

Application Menu

Access KWikSync from the ServiceNow Application Navigator:

Module Description
KWikSync Hub Home page - central dashboard with overview metrics
Settings Connection Settings Configure sync credentials and schedules
Locations Site and facility management
Projects Project tracking and organization
Tickets Work order management
Tasks Task assignment and tracking
Assets Inventory and equipment
Warehouse Tracking Stock levels and logistics
Site Surveys Field assessments and inspections
Support Help resources and issue reporting

Dashboards

KWikSync Hub (Home Page)

The Hub is your central command center and home page, providing:

  • Record Counts - Total records across all modules
  • Last Sync Times - When each module was last synchronized
  • Recent Activity - Recently updated records from each module
  • Quick Navigation - One-click access to all dashboards

KWikSync Connection Dashboard

The Connection Dashboard provides real-time synchronization control:

  • Sync Controls - Manual sync buttons for each table with IDLE/SYNCING status
  • Live Activity Log - Real-time sync operation messages in the UI
  • Record Counts - Current totals for each module (Locations, Projects, Tickets, Tasks, Assets)
  • Last Sync Timestamps - Displayed on each card showing when data was last updated
  • Theme Options - Light, Dark, Contrast, and Accessible display modes

Tip: Watch the Activity Log in real-time while syncing to see progress and any issues.

Locations Dashboard

Manage geographic and site data:

  • View all synchronized locations on an interactive list
  • Filter by region, status, or customer
  • Access location details with one click
  • View related tickets and projects per location

Projects Dashboard

Track project status and deliverables:

  • Project timeline visualization
  • Progress tracking and milestones
  • Linked tickets and tasks
  • Completion percentage tracking

Tickets Dashboard

Monitor service requests and work orders:

  • Filter by status (Open, In Progress, Completed)
  • Priority-based sorting
  • Assignment tracking
  • Related task visibility

Tasks Dashboard

Manage individual task assignments:

  • Task status overview
  • Assigned technician tracking
  • Due date monitoring
  • Completion workflows

Assets Dashboard

Full inventory visibility:

  • Searchable asset catalog
  • Location-based filtering
  • Stock level indicators
  • Asset history and movements

Warehouse Dashboard

Track inventory and logistics:

  • Current stock levels
  • Minimum quantity alerts
  • Transfer tracking
  • Dispatch management

Site Surveys Dashboard

Manage field assessments:

  • Survey status tracking
  • Location-linked inspections
  • Data collection workflows
  • Report generation

Common Tasks

Searching Records

  1. Navigate to any dashboard
  2. Use the Search field at the top
  3. Enter keywords or record numbers
  4. Press Enter or click the search icon

Filtering Data

  1. Click the Filter icon on any dashboard
  2. Select filter criteria (status, date, assignee, etc.)
  3. Click Apply
  4. Click Clear to reset filters

Exporting Data

  1. Navigate to the desired table view (e.g., Locations Table, Assets Table)
  2. Apply any filters needed
  3. Use ServiceNow's built-in list export
  4. Select CSV format
  5. Download begins automatically

Note: Export functionality uses ServiceNow's native list export to CSV. Additional formats may be available in future versions.

Viewing Record Details

  1. Navigate to any dashboard with record lists (e.g., Recent Assets on Hub)
  2. Click any record row to open the full record form
  3. View all fields and related information
  4. Edit fields as needed (if you have permission)
  5. Click Save to commit changes

Dashboard Features

Dark Mode Support

KWikSync fully supports ServiceNow's dark mode and high-contrast themes:

  • Automatic theme detection
  • Optimized color contrast
  • Accessible design patterns

Responsive Design

Access KWikSync from any device:

  • Desktop browsers (full feature set)
  • Tablet devices (optimized layout)
  • Mobile browsers (essential functions)

Tips & Best Practices

  1. Start with the Hub - Check sync status daily from your home page
  2. Use Filters - Narrow down large datasets efficiently
  3. Use Connection Dashboard - Monitor syncs in real-time with the Activity Log
  4. Check the Sync Log - Review historical sync operations for troubleshooting
  5. Leverage Favorites - Pin frequently used modules

Related Guides

Back to Documentation