IBM FileNet 5.5.x can be monitored using a combination of IBM-native tools, third-party enterprise monitoring systems, and custom scripts. Monitoring ensures system availability, performance, and early detection of issues across the Content Engine (CE), Process Engine (PE), Application Server, Databases, and Storage.

________________________________________

✅ Key Monitoring Areas in FileNet

Component What to Monitor

Content Engine (CE) Thread usage, cache, response time, content retrieval errors

Process Engine (PE) / BAW Queue depth, workflow performance, stuck work items

WebSphere/Liberty JVM health, GC activity, thread pools

ICN (Content Navigator) Plugin performance, slow queries, user session load

Database Connection pool, slow queries, space usage

Storage/File Systems Disk I/O, space, latency

LDAP/SSO Authentication response time, failures

Logs Errors, warnings, heap dumps

________________________________________

🔧 Monitoring Tools for FileNet 5.5.x

🧰 1. IBM FileNet and BAW Native Tools

Tool Purpose

Administration Console for Content Platform Engine (ACCE) View object store health, cache settings, CE logs

Process Designer / Process Administrator Console Monitor PE/BAW workflows, queue depths, errors

IBM Content Navigator Admin Troubleshoot ICN desktops, plug-ins, session performance

FileNet Enterprise Manager (FEM) (deprecated, still used in 5.2.x/early 5.5.x) Legacy monitoring and configuration

________________________________________

🧪 2. WebSphere / Liberty Monitoring

Tool What it Monitors

IBM WebSphere Performance Monitoring Infrastructure (PMI) JVM memory, CPU, thread pools, JDBC/LDAP connections

Liberty Monitoring via JMX/REST Lightweight alternative to PMI in Liberty

Heap Analyzer / GC logs Memory leaks, GC tuning, object retention issues

________________________________________

📈 3. Third-Party APM (Application Performance Monitoring) Tools

You can integrate FileNet with tools like:

Tool Features

Dynatrace End-to-end tracing, CE/ICN call graphs, JVM deep dives

AppDynamics Transaction tracing, PE bottlenecks, business impact

New Relic JVM monitoring, custom dashboards for ICN/CE

Datadog Custom metrics for FileNet logs, response times

Splunk / ELK (Elastic) Centralized log management, alerting, anomaly detection

These tools often connect via JMX, REST APIs, or log ingestion.

________________________________________

🗃️ 4. Database Monitoring Tools

Monitor database performance for GCD, Object Stores, and PE:

DB Tools

Db2 Data Studio, db2top, MON_GET, Optim Performance Manager

Oracle AWR reports, OEM Grid Control

SQL Server Query Store, SSMS, Performance Dashboard

________________________________________

🛠️ 5. Custom Monitoring Scripts / Health Checks

You can build custom health checks using:

• CE Java API / REST API: Check object store availability, user login, search response

• ICN Plugin Hook: Time user sessions and plugin load durations

• Cron-based scripts:

o Content storage free space

o Queue item age in PE

o Stuck workflows

________________________________________

🔔 6. Alerting & Log-Based Monitoring

Tool Use Case

Nagios / Zabbix / Prometheus Service uptime, ports, JVM health checks

Splunk or ELK Parse SystemOut.log, ce_*.log, pesvr*.log for errors

IBM Tivoli Monitoring (ITM) Legacy IBM tool for infrastructure and FileNet components

________________________________________

🧠 Best Practices for Monitoring

Area Best Practice

JVM Set GC logging and monitor memory trends

DB Watch for slow queries and index health

Storage Use fast I/O metrics and disk alerts

PE Workflows Alert on queue depth thresholds

Logs Parse for “ECMError” or PE Error codes

________________________________________

📋 Summary

Tool Type Examples

Native Tools ACCE, ICN Admin, PE Admin Console

Infrastructure WebSphere PMI, JMX, Liberty logs

Third-Party Dynatrace, AppDynamics, Splunk

DB Monitoring Db2top, AWR, SSMS

Custom Scripts REST checks, cron jobs

Log Analysis ELK, Splunk, Graylog

Troubleshooting slow document retrieval in IBM FileNet 5.5.x involves analyzing multiple layers of the system—from user request down to storage access. Since FileNet retrieves documents by pulling metadata from the database and content from storage, any slowness may come from network latency, cache misses, storage performance, or database inefficiencies.

________________________________________

🔍 Step-by-Step Troubleshooting Guide

✅ 1. Identify the Symptoms

• Is slowness consistent across all documents or specific classes?

• Affects all users or only a few?

• Happens all the time or only during peak hours?

• Is metadata fast but content slow?

________________________________________

🔧 2. Check the Access Path

A document retrieval typically goes through:

1. Client (e.g., ICN or custom app)

2. Content Engine (CE)

3. Database (for metadata)

4. Storage Area (for binary content)

________________________________________

🔎 3. Analyze Logs for Clues

CE Logs:

• Location: <FileNet install>/logs/ce_*.log or SystemOut.log

• Look for:

o "Content retrieval failed" or "IOException"

o "SocketTimeoutException", "FileNotFoundException"

Enable diagnostic logging temporarily if needed:

com.filenet.engine.content.*=DEBUG

ICN Logs:

• Check navigator.log for plugin or viewer slowness

________________________________________

📊 4. Check Content Cache Service

• Is the Content Cache Service enabled and working?

• If disabled or cache misses are high, repeated disk reads will cause delays.

Fix:

• Enable caching

• Tune TTL and disk space

• Place cache on SSD

________________________________________

🧠 5. Evaluate Storage Area Health

• Storage Area Types:

o File System Storage Area (FSSA)

o Advanced Storage Area (ASA)

o Fixed Content Device (e.g., IBM Cloud Object Storage)

Check:

• Disk I/O latency

• Mount availability

• Network path (for remote/NFS storage)

• Antivirus scanning interfering with reads

Tip: Manually try to retrieve a document from the storage path using the exact content URI

________________________________________

🗃️ 6. Review Database Performance

• Slow metadata read = slow document open

• Check:

o Query plans for retrieving document properties

o Indexes on frequently used document properties (e.g., DocumentTitle, DateCreated)

o DB logs for contention or long-running queries

Fix:

• Add missing indexes

• Update statistics

• Reorg tables (especially large custom property tables)

________________________________________

🔗 7. Check WebSphere / Liberty Health

• Monitor:

o Thread pool saturation

o JDBC connection pool exhaustion

o Garbage Collection (GC) activity

o High CPU

Use:

• WebSphere PMI / JConsole / Liberty Admin Center

• Enable verbose GC logs and analyze with IBM GC Analyzer

________________________________________

📶 8. Network Latency

• If FileNet storage is remote (NFS, object storage), test:

o Network hops and latency (ping, traceroute)

o Throughput with iperf

o Firewall or proxy issues

________________________________________

🧪 9. Try Programmatic Access

Use CE Java API or REST API to:

Document doc = Factory.Document.fetchInstance(os, id, null);

ContentElementList cel = doc.get_ContentElements();

Measure time to:

• Fetch metadata

• Stream content

Helps isolate whether the slowness is in UI or backend.

________________________________________

🛠️ Common Root Causes & Fixes

Cause Symptom Fix

Storage latency All content retrieval slow Optimize disk/NFS/ASA performance

Cache disabled Repeat access always slow Enable and tune cache

Missing index Slow metadata fetch Add DB indexes

GC or heap issues Intermittent slowness Tune JVM memory

Antivirus scanning storage Delays in binary reads Exclude storage path from scan

High CE load Slow overall response Add CE nodes, optimize thread pools

Large content size Single doc opens slow Use streaming viewers, prefetch

________________________________________

✅ Validation

• Use ICN or custom tools to time document open

• Compare with API test results

• Monitor CE/ICN logs during test

• Profile network and I/O stats in real-time

Analyzing IBM FileNet P8 logs is essential for identifying performance bottlenecks, diagnosing errors, and maintaining system health. FileNet P8 consists of multiple components—Content Engine (CE), Process Engine (PE), Application Server (WebSphere/Liberty), Content Navigator (ICN), and more—each with its own log files.

________________________________________

📁 Main FileNet P8 Log Files & Locations

Component Log File Name Typical Location

Content Engine (CE) ce_<date>.log, SystemOut.log, SystemErr.log <FileNet_Home>/logs/ce/ or WebSphere/logs/server1/

Process Engine (PE) pesvr_system.log, pesvr_error.log <PE_Home>/logs/ or WebSphere/logs/peApp/

Application Server SystemOut.log, SystemErr.log WebSphere/AppServer/profiles/AppSrv01/logs/<server>/

ICN (Content Navigator) navigator.log, plugin.log ICN_HOME/logs/ or WebSphere/logs/icn/

BAW / BPM / Process Designer bpm_server.log, bpm_error.log <BAW_HOME>/logs/

Installation logs install.log, upgrade.log /opt/IBM/FileNet/InstallLogs/ or similar

CPE Trace logs (optional) trace.log Configurable via ACCE or FileNet Configuration

________________________________________

🔎 How to Analyze Each Log File

🧠 1. Content Engine (CE) Logs

• Key Files: ce_<date>.log, SystemOut.log

• Look for:

o ECMError, E_CPE, ContentEngineException

o Slow method calls (e.g., GET_OBJECT, fetchInstance)

o Connection failures, storage access errors

• Tips:

o Enable verbose tracing for specific subsystems via ACCE or log4j.properties

o Use timestamps to correlate with user reports

________________________________________

🔁 2. Process Engine (PE) Logs

• Key Files: pesvr_system.log, pesvr_error.log

• Look for:

o Workflow errors: EventQueueException, F_WorkItem issues

o Queue saturation or deadlocks

• Tips:

o Search for user-defined step processor names

o Look for FNRPE error codes (e.g., FNRPE213109009)

________________________________________

🌐 3. Application Server Logs (WebSphere / Liberty)

• Key Files: SystemOut.log, SystemErr.log

• Look for:

o JVM heap dumps, GC activity

o Class loading errors or NoClassDefFoundError

o JNDI binding or connection pool errors

• Tools:

o Use IBM Support Assistant (ISA) or Eclipse Memory Analyzer (MAT)

________________________________________

🧭 4. Content Navigator (ICN) Logs

• Key Files: navigator.log, plugin.log

• Look for:

o Slow loading of desktops or documents

o Plugin initialization or authentication errors

• Plugin Errors:

o Check for java.lang.NullPointerException, ClassCastException

________________________________________

⚙️ 5. Installation & Configuration Logs

• Files: install.log, FileNetConfig.log, upgrade.log

• Purpose: Trace setup errors, misconfigurations, partial upgrades

________________________________________

📂 6. Trace Logs (Custom Logging)

• Enable CPE or PE trace logs via:

o log4j.properties or tracelog.properties

o ACCE > Logging > Add new logger (e.g., com.filenet.api.*)

________________________________________

🧰 Tools for Log Analysis

Tool Purpose

grep / findstr Search by keywords or error codes

Splunk / ELK Centralize and search across nodes

Notepad++ / LogExpert Large file parsing, bookmarks

IBM Log Analysis Tool Import logs and analyze stack traces

________________________________________

⚠️ Common Errors and Their Meaning

Error Code Meaning

E_CPE2305 Object not found

E_CPE5015 Permission denied

FNRPE213109009 Workflow system error

ECMError General CE issue

NullPointerException Likely plugin or code bug

________________________________________

🧪 Best Practices

• Rotate logs: Avoid giant files by setting log rotation policies

• Timestamp correlation: Always capture the time user reports an issue

• Enable debug logging temporarily: Avoid leaving it on in production

• Centralized logging: Use tools like Splunk for alerting and pattern detection

________________________________________

✅ Summary: What to Analyze by Log

Log File Focus

ce.log Document & metadata access, storage issues

pesvr.log Workflow issues, queue failures

SystemOut.log JVM, JDBC, LDAP issues

navigator.log UI, plugin, session problems

install.log Setup failures

If an Object Store becomes unavailable in IBM FileNet P8, it affects access to documents, workflows, and metadata associated with that store. Here's a structured approach to identify, isolate, and resolve the issue:

________________________________________

🧭 Step-by-Step Troubleshooting & Recovery Plan

✅ 1. Confirm the Issue

• Check if the issue affects:

o One object store or multiple?

o Only metadata or also document retrieval?

• Error messages in applications like ICN or custom UI may show:

o FNRCE0000E, E_OBJECT_STORE_UNAVAILABLE, or NullPointerException

________________________________________

🔍 2. Verify Object Store Registration

Use ACCE (Administration Console for Content Platform Engine):

• Navigate to Object Stores under the domain

• Ensure the affected store:

o Appears in the list

o Has correct symbolic name

o Shows valid connection status

If it's missing:

• Re-register using FileNet Enterprise Manager (FEM) (if used)

• Or ACCE > New > Object Store

________________________________________

🧪 3. Check Connection to Database

Each Object Store has a dedicated DB or schema.

• Use ACCE > Object Store > Properties to check the DataSource JNDI name

• Confirm the following:

o Database is running

o JNDI data source exists and is correct

o App server (WebSphere/Liberty) can connect to DB

To test DB:

• Try manual JDBC connection or use database client

• Look for JDBC errors in SystemOut.log or CE logs

________________________________________

🧰 4. Review Logs

Check the following log files on the Content Engine server:

Log Look For

ce_<date>.log DatabaseUnavailableException, SQLException

SystemOut.log JNDI lookup errors, DB pool issues

ICN navigator.log OS-specific plugin or permission errors

________________________________________

⚙️ 5. Restart CE or Application Server

• If the DB was down or connection was stale, restarting CE may re-establish the link

• Restart sequence (if needed):

1. CE server (WebSphere or Liberty)

2. Workflow server (if using PE/BAW)

3. ICN or front-end apps

________________________________________

🔒 6. Check Permissions and Security

• Confirm the service account has:

o Access to the Object Store DB

o Proper roles assigned in FileNet (e.g., Object Store Administrator)

• Also verify the object store was not deleted or disabled by mistake

________________________________________

🛡️ 7. Validate GCD & CPE Configuration

The Global Configuration Database (GCD) maps object stores:

• Use ACCE > Domain > Object Stores

• Validate that:

o Object store definition exists

o Data source is correct

o BootstrapCEURI is correctly configured

________________________________________

🧪 8. Test from Code/API

You can validate from a small Java or REST test:

Connection conn = Factory.Connection.getConnection("http://ce-server:9080/wsi/FNCEWS40MTOM");

Domain domain = Factory.Domain.fetchInstance(conn, null, null);

ObjectStore os = Factory.ObjectStore.fetchInstance(domain, "TargetOS", null);

Watch for:

• ConnectionException, ObjectStoreNotFoundException, ECMError

________________________________________

🧹 9. Advanced: Recreate or Rebind Object Store

If corruption is suspected:

• Use ACCE or Config Manager to rebind the OS to its database

• Validate that the DB schema and ACLs are intact

________________________________________

🔁 10. Recovery or Failover

If you have:

• HA/DR setup, switch to secondary CE or DB

• Backup/Restore, consider restoring the OS DB (with guidance from IBM support)

________________________________________

🧠 Summary of Common Causes

Cause Symptom Fix

DB Down or Network Issue Object store not accessible Restart DB, verify JNDI

Misconfigured JNDI CE can't connect to DB Fix JNDI resource

Permissions issue OS shows "unauthorized" Check CE/DB user permissions

GCD corruption OS missing from ACCE Restore GCD or re-register OS

App server stale connection Inconsistent behavior Restart CE or refresh datasource

Troubleshooting broken workflows in an IBM Business Automation Workflow (BAW) and FileNet environment requires a multi-layered diagnostic approach—since workflows span design, runtime engines, integration with Content Engine (CE), and possibly external services.

________________________________________

🧭 Step-by-Step Guide to Troubleshoot Broken Workflows

✅ 1. Identify the Nature of the Break

Determine:

• Is the workflow not starting, stuck, or failing at a specific step?

• Is it system-wide or limited to specific users, queues, or applications?

• Is it a BAW (BPMN) workflow or a FileNet Case Manager (ICM/PEC) workflow?

________________________________________

🔍 2. Use Admin Tools to Locate Issues

🔧 In BAW:

• Workflow Admin Console: Check failed instances

• Process Inspector (in Process Admin Console or Process Designer)

o Look for:

 Red X on steps

 Data mapping errors

 Integration failures

🔧 In FileNet (Case Manager / Process Engine):

• PE Process Administrator (PA):

o Look at the event logs, workflow definitions, and in-flight workflows

• ACCE (for CE logs or queue status)

________________________________________

🔎 3. Review Logs for Errors

Logs to check:

Component Log File Location

BAW bpm_server.log, SystemOut.log WebSphere /logs/<node>/

Process Engine pesvr_system.log, pesvr_error.log /logs/pe/

CE ce_<date>.log, SystemOut.log /logs/ce/

ICN / Case Manager navigator.log /logs/icn/

Common Errors:

• FNRPE213109009: Workflow system error

• NullPointerException, ECMError, MappingException

• ConnectionRefused, DataMappingError

________________________________________

🛠️ 4. Check Workflow Definitions

• Confirm the process is deployed correctly in:

o BAW Process Center

o Case Builder (for ICM/PEC)

• Revalidate:

o Mappings between variables and external services

o Integration service configuration

o Data types (especially with JSON/XML adapters)

________________________________________

🧪 5. Diagnose Failed Steps

For broken or stuck tasks:

• Use Process Inspector to check variable values

• Re-execute failed steps (if enabled)

• Check if the step requires a manual trigger, or external service call (e.g., REST API, ECM operation)

________________________________________

🔄 6. Check Workflow Queues & Rosters (PEC)

• Open Process Administrator → Queues

o Look for:

 Blocked or unassigned work items

 Work items with exceptions

 Queues not associated with users/groups

• Use reassign or force start to debug behavior

________________________________________

🔗 7. Check External Integrations

If the workflow step involves:

• FileNet Content Operations (document retrieval, folder creation)

• External APIs (REST/SOAP services)

• Email/ICN/Plug-ins

Then:

• Check network/firewall access

• Review integration response or timeouts

• Test connector directly (e.g., via Postman or standalone script)

________________________________________

🔐 8. Permission and Role Checks

• Confirm:

o Workflow participants have required permissions

o System users (e.g., pe_service, bpm_service) are not expired/locked

o Case stages have valid role mapping

________________________________________

🚨 9. Database/Engine Health

• Workflow engine queues could be stuck if:

o The PE database is locked or bloated

o Connection pool is exhausted

o Server is under heavy load

Use:

• WebSphere monitoring tools

• Database logs

• Queue reprocessing scripts if needed

________________________________________

🧹 10. Restart Services if Needed

• If queues are hung or stuck:

o Restart Process Engine / BAW server

o Clear and reinitialize in-memory caches (as per IBM guidelines)

o Use ProcessAdminService to unlock or terminate stuck instances

________________________________________

🧠 Common Causes & Fixes

Problem Cause Fix

Workflow doesn't start Wrong trigger or event subscription Check start conditions or FileNet Event Action

Workflow stuck at step Integration error or missing input Check mapping and logs

Task not assigned Queue/user mismatch Review queue configuration

Null values in variables Incorrect data mapping Validate using Process Inspector

External system call failed Timeout / 500 error Test API/service separately

________________________________________

✅ Summary Checklist

• Confirm if workflow is BPMN (BAW) or PEC-based

• Use admin tools to trace instance failure

• Analyze logs (pesvr, bpm, navigator, ce)

• Validate integration points and step mappings

• Check user roles, queues, and assignments

• Restart or reset instances if necessary

Security validation failures in IBM FileNet are often caused by misconfigurations in authentication, authorization, or directory services. These failures typically prevent users or services from accessing content, performing operations, or integrating with other components like IBM Content Navigator (ICN), Process Engine (PE), or Business Automation Workflow (BAW).

________________________________________

🔐 Common Causes of Security Validation Failures in FileNet

1. LDAP / Directory Service Issues

• Incorrect user or group mappings

• LDAP server unreachable or credentials invalid

• Group membership not synchronized

• Case-sensitive group names (FileNet is case-sensitive)

Symptoms:

• Login failures

• Users can't see Object Stores or folders

• Permissions appear to be missing

Fix:

• Verify LDAP settings in WebSphere/Liberty

• Use wsadmin or ACCE to test user lookups

• Sync or restart LDAP configuration

________________________________________

2. Incorrect Access Control Lists (ACLs)

• Users lack sufficient permissions on objects (e.g., class, document, folder)

• No access to Object Store or Domain level

• Inherited permissions disabled

Symptoms:

• FNRCE0000E with E_NO_ACCESS, E_PERMISSION_DENIED

• User can log in but can't access specific documents

Fix:

• Use ACCE or FEM to inspect effective permissions

• Adjust security inheritance

• Assign Read, Write, Execute, or Delete roles as required

________________________________________

3. Kerberos / SSO Misconfiguration

• Incorrect SPNEGO setup

• Missing or invalid service principal

• Time desynchronization across servers

Symptoms:

• "Authentication failed" with SSO

• SPNEGO token errors in logs

Fix:

• Confirm Kerberos keytab and realm config

• Check clock sync (NTP)

• Use browser tools to test SSO headers

________________________________________

4. JAAS or J2C Alias Misconfigurations

• Application server’s JAAS login module misconfigured

• Wrong J2C authentication alias used for PE or CE

Symptoms:

• Login errors when launching workflows or CE API access

• java.security.AccessControlException

Fix:

• Go to WebSphere → Security → JAAS Login Configurations

• Ensure correct alias with username/password is set

________________________________________

5. SSL/TLS Certificate Problems

• Expired or mismatched certificates (between CE, PE, ICN, LDAP, or DB)

• Insecure TLS version disabled (e.g., TLS 1.0 deprecated)

Symptoms:

• SSLHandshakeException, javax.net.ssl.SSLPeerUnverifiedException

Fix:

• Validate certificates using tools like keytool or browser dev tools

• Ensure CA certificates are trusted on both sides

________________________________________

6. Incorrect Security Principal in Workflows

• Work items fail if the system user has insufficient access

• Workflows initiated by anonymous or expired users

Symptoms:

• Workflow step errors (FNRPE213109009, WorkItem processing failed)

Fix:

• Verify user launching workflow has proper role

• Set system or service account as workflow owner

________________________________________

7. Expired/Locked User Accounts

• User or service account is locked out or password expired

Symptoms:

• Unexpected login failures or intermittent access issues

Fix:

• Check AD/LDAP logs

• Unlock or reset credentials as needed

________________________________________

8. Improper ICN Desktop / Repository Configuration

• Mismatch between users and repository permissions

• Desktop security mappings misaligned with FileNet ACLs

Symptoms:

• Users can log in to ICN but can't access desktops or search

Fix:

• Check ICN Admin → Desktop configuration

• Confirm repository roles and user mapping

________________________________________

9. Global Security Policies

• WebSphere Application Server global security is turned off or misconfigured

• FileNet relies on WAS to enforce access control

Fix:

• Enable and configure global security in WAS admin console

• Use federated repositories or standalone LDAP

________________________________________

🧰 Useful Tools for Debugging

Tool Use

ACCE Check and edit ACLs, user mappings

wsadmin Test LDAP lookup

ICN logs (navigator.log) Detect frontend authorization errors

CE logs (ce_<date>.log) Look for E_NO_ACCESS, ECMError, etc.

ldapsearch / ldp.exe Validate LDAP connection

________________________________________

✅ Summary Checklist

• Test LDAP connection and group resolution

• Verify object permissions using ACCE

• Check JAAS and J2C aliases in WebSphere

• Inspect SSL certificates between components

• Confirm user/group security roles and inheritance

Debugging a FileNet ICN (IBM Content Navigator) plug-in that’s not loading properly involves checking multiple layers: the deployment state, JavaScript/Java errors, server logs, and plugin configuration. Here’s a structured approach to identify and fix the issue.

________________________________________

🧭 Step-by-Step Debugging Guide for ICN Plug-in Loading Issues

________________________________________

✅ 1. Check Plug-in Deployment Status

In the ICN Admin desktop:

• Go to Administration → Plug-ins

• Ensure the plug-in:

o Is listed

o Shows "Loaded = true"

o Doesn’t display errors in the status or description

If it fails to load:

• Check if it’s signed (if using browser strict mode)

• Ensure it’s compatible with the ICN version (especially for 5.0 vs 5.5+)

________________________________________

🔍 2. Check Plug-in Registration

If the plug-in JAR is manually copied, check:

• The plug-in is in the correct ICN plug-ins directory (e.g., .../ECMClient/plugins)

• It is registered via ICN Admin or with the ConfigService API

You can register with:

com.ibm.ecm.configuration.PluginConfigService.addPlugin(pluginFile)

________________________________________

📁 3. Verify Java Class Errors

Check WebSphere/Liberty logs (SystemOut.log, navigator.log) for:

Common Errors Cause

ClassNotFoundException Class not in JAR, wrong path

NoClassDefFoundError Missing dependency

IllegalArgumentException: Plugin already registered Duplicate plug-in name or conflict

ClassCastException ICN API version mismatch

Use jar tf yourplugin.jar to inspect contents.

________________________________________

🧪 4. Test Plug-in Load via URL

Try accessing the plug-in endpoint directly:

http://<ICN-HOST>:<PORT>/navigator/plugin/<pluginName>/

If it fails:

• Check Web.xml mapping (for old-style plug-ins)

• See if it's returning 404 (not deployed) or 500 (internal error)

________________________________________

🧠 5. Browser Console Debugging

Use Developer Tools (F12) in Chrome/Firefox:

• Look for JavaScript errors (e.g., require is not defined, dojo load error)

• Network tab → check for failed plugin.js loads or CORS issues

🔎 Plugin client code must use Dojo correctly (no global JS functions or DOM-ready logic outside Dojo's AMD loader)

________________________________________

⚙️ 6. Plugin Descriptor Check (plugin.xml)

Ensure plugin.xml is:

• Present and well-formed

• Has correct <id>, <version>, and required <class> entries

Bad XML causes silent failure on loading.

________________________________________

🔐 7. Check Permissions

• Make sure the users trying to use the plug-in have permission to:

o Use the desktop it’s associated with

o Access plug-in features (like custom actions, menus, or layouts)

• Use ICN Admin > Desktops > Features to confirm plug-in is enabled

________________________________________

🧰 8. Re-deploy or Clear Cache

Sometimes the plug-in is cached or partially loaded:

• Restart WebSphere/Liberty

• Clear ICN and browser cache

• Re-register the plug-in

• Use Ctrl + Shift + R in the browser to force reload static assets

________________________________________

🔁 9. Upgrade Compatibility Check

• Ensure the plug-in uses correct ICN JavaScript and Java APIs for the version

• Check for deprecated API calls in:

o plugin.js

o feature.js

o Custom services or actions

Use the ICN Extensibility API Docs for reference.

________________________________________

✅ Summary Checklist

✅ Checkpoint ✔️ Done?

Plugin shows “Loaded = true” in ICN Admin

JAR structure contains correct classes and plugin.xml

Browser console shows no JS errors

Logs are free from ClassNotFound or ClassCast errors

URL /plugin/<name>/ loads

Plugin is attached to desktop and enabled

ICN and browser cache cleared