ZenTao

View as Markdown

The ZenTao connector brings approved ZenTao requirements, tasks, bugs, and optional attachments into AIvis retrieval. It reads only the project IDs and product IDs explicitly entered by an administrator and does not scan the whole ZenTao instance.

Use cases

ScenarioRecommendation
Project-status Q&AIndex requirements and tasks by project ID.
Bug retrospectivesIndex bugs by product ID, including status, description, and activity comments.
Requirement traceabilityConfigure both project IDs and product IDs when both views are needed.
Attachment retrievalEnable attachments only when content is approved and volume is manageable.
Private ZenTao deploymentsExplicitly enable private-network options after deployment review.

What it indexes

ZenTao dataScope requirementIndexing behavior
RequirementsProject IDs or product IDsIndexes title, description, status, created/updated time, and action comments.
TasksAt least one project IDReads project executions and then tasks under those executions.
BugsAt least one product IDReads bug title, description, status, and action comments.
AttachmentsUnder enabled parent objectsOptional child documents under requirements, tasks, and bugs.

Project IDs and product IDs are separate lists. Each list can contain at most 100 unique positive integers. At least one of requirements, tasks, or bugs must be enabled. Tasks require project IDs; bugs require product IDs.

The connector does not index ZenTao users, team membership, time tracking, charts, test suites, releases, document libraries, or unlisted projects/products.

Prerequisites

  • Confirm the ZenTao instance URL. Public deployments should use HTTPS.
  • Prepare a dedicated account and password that can read the target projects, products, objects, and attachments.
  • Collect the target project IDs and product IDs.
  • If ZenTao is private-network only, confirm backend network access and whether HTTP is approved.
  • Decide the AIvis access group before indexing private content.

Allow insecure HTTP can only be used after Allow private network is enabled, and should only target approved private-network ZenTao deployments. Public ZenTao instances should use HTTPS.

Where to get configuration values

Configuration valueWhere to get it
ZenTao site URLUse the ZenTao instance root URL. Public deployments should use HTTPS; API routes are usually under api.php. See RESTful API v1 configuration and FAQ.
Account / password / token validationExchange a dedicated account and password for an API Token. See ZenTao developer manual: get Token.
Project IDConfirm it from the ZenTao project URL or project list. You can also validate it with get projects (v2).
Product IDConfirm it from the ZenTao product URL or product list. You can also validate it with get products (v2).
API version differencesZenTao private deployments can differ by version; API routes and request-header casing may vary. Read API v2.0 tutorial before upgrading or switching API versions.

Configure in AIvis

In the Admin panel, open Connectors, select ZenTao, create or choose a ZenTao credential, and then enter instance URL, scope IDs, content switches, and network options.

FieldHow to fill itNotes
ZenTao site URLFor example https://zentao.example.comThe connector normalizes the root URL to the API base.
AccountDedicated read-only accountUsed to authenticate to ZenTao API.
PasswordAccount passwordStored as a protected secret.
Project IDsOne positive integer per lineRequired when tasks are enabled.
Product IDsOne positive integer per lineRequired when bugs are enabled.
Include requirementsEnabled by defaultReads project and/or product requirements.
Include tasksEnabled by defaultReads tasks under project executions.
Include bugsEnabled by defaultReads product bugs.
Include attachmentsDisabled by defaultEmits parseable attachments as child documents.
Allow private networkDisabled by defaultOnly for approved private deployments.
Allow insecure HTTPDisabled by defaultAvailable only with private-network access.

Sync behavior

The standard Admin-created ZenTao connector runs as a polling connector with checkpoint resume.

StageBehavior
Scope validationAttempts to read the first page of target project or product data before indexing.
RequirementsReads project and/or product requirement details.
TasksReads project execution lists, then task details under those executions.
BugsReads product bug details.
AttachmentsEmits attachments as child documents and records item failures when parsing fails.

The connector guards against unstable pagination, duplicate objects, and oversized inventories.

Permissions

The ZenTao account determines what AIvis can ingest, but this connector does not synchronize ZenTao members, roles, product permissions, field permissions, or per-object access into AIvis.

AIvis access settingMeaning
Private groupsOnly selected AIvis groups can search documents produced by this connector. Recommended for project, customer, and engineering data.
PublicEvery eligible AIvis user can search indexed content. Use only for projects that can be shared with that audience.
Auto permission syncZenTao is not supported for this mode.

Use AIvis Private groups for project, customer, and engineering data. Use Public only when every eligible AIvis user may search every indexed object. ZenTao is not available as an auto permission-sync source.

Verify

  1. Create a connector with one test project ID or product ID.
  2. Search known requirement, task, and bug titles, descriptions, and statuses.
  3. If attachments are enabled, upload a small parseable attachment and confirm it is searchable.
  4. Search unlisted projects or products and confirm they are absent.
  5. Test assigned and outside AIvis users.
  6. Modify one test object and confirm the next sync updates it.

Troubleshooting

SymptomWhat to check
Site validation failsBackend reachability, HTTPS for public instances, and private-network options.
Login failsAccount, password, API login ability, and password rotation.
Project or product not foundID value and account access to the target scope.
Task indexing cannot be createdA project ID is required when tasks are enabled.
Bug indexing cannot be createdA product ID is required when bugs are enabled.
Attachments are missingAttachment switch, download reachability, file type, and size.
Users can search content they should not seeRestrict AIvis groups or split connectors by project/product/audience.

Security and maintenance

  • Use a dedicated read-only account instead of an administrator account.
  • Enable private-network or insecure HTTP options only for controlled private deployments.
  • Review project IDs, product IDs, content switches, attachment settings, account owner, and AIvis groups regularly.
  • Rotate the password if it may have leaked.
  • Disable or narrow the connector when projects or products are retired.

Official references