Jama Connect Interchange for Excel Functions Quick Start Guide

Published Date: July 2nd, 2026
Audience: Everyone
Products and Versions Covered: 

• Jama Connect Interchange™ 
  • JCI Module: Excel Functions

Summary

Integrating Jama Connect Interchange (JCI) with an Excel workbook enables advanced calculations, relationship analysis, field inheritance, and many other use cases that extend the capabilities of Jama Connect. 

While building an integration in Jama Connect Interchange is straightforward, first-time users may benefit from step-by-step guidance and supporting documentation to ensure a successful setup.

Resolution

This article explains how to configure an integration between Jama Connect and an Excel workbook using Jama Connect Interchange (JCI), along with recommended best practices.

It does not cover how to design or configure the Excel workbook itself.

Before You Begin

Before configuring the integration, ensure that you have:

• Jama Connect Interchange (JCI) instance.
• Administrator or appropriate configuration permissions in Jama Connect.
• A dedicated JCI service account with a Named Creator license.
• An Excel workbook that has been fully tested.
• The workbook attached to a Jama item.

Definitions

System Architecture

Because the Excel workbook is stored as an attachment to a Jama item, only one connector is required to connect JCI to the Jama Connect instance. The integration maps fields from Jama items to individual cells or columns within the attached Excel workbook.

Connect Jama Connect and JCI

Create a dedicated service account in Jama Connect for JCI using a Named Creator license.

Add this account to a user group with access to every project that the integration will update.

Using a dedicated service account provides two important benefits:

• The audit trail clearly identifies changes made by JCI.
• A Named Creator license prevents JCI from being locked out due to concurrent user licensing limitations.

Prepare the Excel Workbook

Before you begin, verify that the following prerequisites have been met::

• Verify that all formulas produce the expected results using representative sample data.
• Attach the workbook to a Jama item. Container item types, such as Components or Sets, are recommended.

Best Practices:

• Break complex formulas into helper cells.
• Match picklist display names exactly.
• Avoid VBA macros whenever possible.
• Create a worksheet legend documenting formulas, item types, and input/output color coding.
• Restrict editing permissions if necessary.

Create the JCI Connector

1. Sign in to Jama Connect Interchange.
2. Select Connectors.
3. Click Add Connector.
4. Select Jama Connect.
5. Enter a connector name.
6. Enter the Jama Connect URL.
7. Configure authentication.
8. Click Save.

When connector configured correctly, the JCI service account can successfully authenticate and has permission to update all required projects.

Create the Integration

1. Select Integrations.
2. Choose Jama Connect to Excel Functions.
3. Select Single Project or Multiple Projects.
4. Click Next.
5. Select the connector.
6. Enter the Project ID containing the workbook.
7. Select the project(s).
8. Click Next.
9. Name the integration using a convention such as Connector_Workbook.
10. Leave Select Frequency at its default value during initial setup.
11. Click Submit.

Configure Field Mapping

Disable the integration before making mapping changes.

To create a Field Mapping Group:

1. Open the Field Mappings tab.
2. Click Add New Field Mapping Group.
3. Select Explorer.
4. Choose the target items.
5. Click Create.

Then we can map Jama fields to individual workbook cells:

Data Direction indicates for:

• Left arrow: Import values from Excel into Jama Connect.
• Right arrow: Export values from Jama Connect into Excel.

Testing the Integration

JCI synchronizes only items that have changed since the integration was enabled. After modifying the field mappings, run a Full Sync from the Dashboard to apply the updated mappings to all applicable items.

Troubleshooting tips

Monitoring

After enabling the integration, review the Log tab to confirm that synchronization completed successfully. If errors occur, use the log details to help identify and resolve the issue.

Best Practices

Follow these best practices to improve the reliability, maintainability, and performance of your integration:

• Use a dedicated JCI service account to clearly identify integration activity in the Jama Connect audit trail.
• Validate workbook formulas using representative sample data before attaching the workbook to Jama Connect.
• Break complex formulas into helper cells to simplify troubleshooting and ongoing maintenance.
• Avoid using VBA macros whenever possible, as they can introduce security risks and increase maintenance complexity.
• Ensure picklist values match exactly to the display names configured in Jama Connect.
• Adopt a consistent naming convention for connectors and integrations to simplify administration.
• Document your workbook by including a legend that explains formulas, input and output cells, and the associated Jama item types.
• Disable the integration before modifying field mappings to prevent unintended synchronization during configuration changes.
• Run a Full Sync after updating field mappings to apply the changes to all applicable items.
• Verify that the latest version of the workbook is attached before enabling or running the integration.

Additional Resources 

• Success Programs
• Risk Management: Advanced Use Cases with JCI
• Troubleshooting complex calculations in Jama Connect Interchange™ (JCI) XLS functions

Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or ideas for improvement below.