> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.alephant.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.alephant.io/_mcp/server. # TAPD > Configure the TAPD connector to index requirements, tasks, bugs, and optional attachments from explicitly approved workspaces. The TAPD connector brings approved TAPD project-management content into AIvis retrieval. It indexes only the project workspace IDs explicitly entered by an administrator; it does not scan the whole company and does not provide a WPS entry point. ## Use cases | Scenario | Recommendation | | ------------------------ | -------------------------------------------------------------------------------------- | | Requirement and bug Q\&A | Index requirements, tasks, and bugs by TAPD workspace ID. | | Project retrospectives | Use descriptions, status fields, owners, creators, and reporters as retrieval context. | | Attachment retrieval | Enable attachments only when content is approved and volume is manageable. | | Multi-project governance | Split connectors by customer, business line, or project audience. | | Incremental-sync testing | Validate objects around modified-time boundaries. | ## What it indexes | TAPD data | Indexing behavior | | ------------ | ------------------------------------------------------------------------------------ | | Requirements | Title, description, status, owner, creator, created time, and updated time. | | Tasks | Title, description, status, owner, creator, created time, and updated time. | | Bugs | Title, description, status, current owner, reporter, created time, and updated time. | | Attachments | Optional child documents under enabled requirements, tasks, and bugs. | The connector requires 1 to 100 unique positive-integer workspace IDs and at least one of requirements, tasks, or bugs. It does not index project-member permissions, iterations, time tracking, boards, reports, workflow settings, or unlisted projects. ## Prerequisites * Prepare a TAPD API username and API password. * Confirm the API account can read the enabled object and attachment APIs in each workspace. * Collect the target workspace IDs from TAPD project URLs or administration pages. * Decide whether attachments should be indexed. * Decide the AIvis access group before indexing private content. * Allow the AIvis backend to reach `api.tapd.cn`. ## Where to get configuration values | Configuration value | Where to get it | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | API user / API password | Check `api_user` and `api_password` in the TAPD company Open Platform settings. See [TAPD Open Platform: API configuration guide](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/API%E9%85%8D%E7%BD%AE%E6%8C%87%E5%BC%95.html). | | Project workspace ID `workspace_id` | In TAPD, open the project workspace and check the project ID from the project-name area, or validate it with [get workspace information](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/workspace/get_workspace_info.html). Read [API usage notes](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/%E4%BD%BF%E7%94%A8%E5%BF%85%E8%AF%BB.html) first. | | Requirement fields and readability | Call [get requirements](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/story/get_stories.html) with the target `workspace_id` to verify access. | | Task fields and readability | Call [get tasks](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/task/get_tasks.html) with the target `workspace_id`. | | Bug fields and readability | Call [get bugs](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/bug/get_bugs.html) with the target `workspace_id`. | ## Configure in AIvis In the Admin panel, open **Connectors**, select **TAPD**, create or choose a TAPD credential, and then enter workspace IDs and content-type switches. | Field | How to fill it | Notes | | -------------------- | ----------------------------- | -------------------------------------------------- | | API user | TAPD API username | Used for TAPD Open API requests. | | API password | TAPD API password | Stored as a protected secret. | | Workspace IDs | One positive integer per line | Only listed workspaces are indexed. | | Include requirements | Enabled by default | Reads requirement fields. | | Include tasks | Enabled by default | Reads task fields. | | Include bugs | Enabled by default | Reads bug fields. | | Include attachments | Enabled by default | Reads supported attachments under enabled objects. | ## Sync behavior The standard Admin-created TAPD connector runs as a polling connector with checkpoint resume. It processes each workspace and then each enabled stage: requirements, tasks, and bugs. | Stage | Behavior | | ------------------- | -------------------------------------------------------------------------------------- | | Inventory | Reads objects in the sync time window and orders them by modified time and ID. | | Body parsing | Converts TAPD HTML descriptions into searchable text and stores status/owner metadata. | | Attachments | Emits attachments as child documents; each object is capped at 1000 attachments. | | Incremental updates | Modified objects update stable document IDs instead of creating duplicates. | ## Permissions The TAPD API account determines what AIvis can ingest, but this connector does not synchronize TAPD members, roles, field permissions, or per-object access into AIvis. | AIvis access setting | Meaning | | -------------------- | ---------------------------------------------------------------------------------------------------------------------- | | Private groups | Only selected AIvis groups can search documents produced by this connector. Recommended for project and customer data. | | Public | Every eligible AIvis user can search indexed content. Use only for projects that can be shared with that audience. | | Auto permission sync | TAPD is not supported for this mode. | Use AIvis **Private** groups for project or customer data. Use **Public** only when every eligible AIvis user may search all indexed content. TAPD is not available as an auto permission-sync source. ## Verify 1. Create a connector with one test workspace. 2. Search known requirement, task, and bug titles and descriptions. 3. If attachments are enabled, upload a small parseable attachment and confirm it is searchable. 4. Modify one test object and confirm the next sync updates it without duplication. 5. Search unlisted workspace content and confirm it is absent. 6. Test assigned and outside AIvis users. ## Troubleshooting | Symptom | What to check | | -------------------------------------------- | ---------------------------------------------------------------------------- | | Authentication fails | API username, API password, and API entitlement. | | Workspace validation fails | Workspace ID must be a positive integer and readable by the API account. | | One object type is empty | Check the content switch and API permission for that object type. | | Attachments are missing | Check the attachment switch, attachment API permission, file type, and size. | | Incremental results are missing | Check modified-time windows and reconcile with a full diagnostic sync. | | Users can search content they should not see | Restrict AIvis access groups or split connectors by project/audience. | ## Security and maintenance * Use a dedicated TAPD API account instead of a personal high-privilege account. * Review workspace IDs, content switches, attachment settings, API owner, and AIvis groups regularly. * Measure parsing cost before enabling large attachment sets. * Rotate the API password if it may have leaked. * Disable or narrow the connector when a project ends. ## Official references * [TAPD Open Platform: API configuration guide](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/API%E9%85%8D%E7%BD%AE%E6%8C%87%E5%BC%95.html) * [TAPD Open Platform: get requirements](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/story/get_stories.html) * [TAPD Open Platform: get tasks](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/task/get_tasks.html) * [TAPD Open Platform: get bugs](https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/bug/get_bugs.html) ## Related pages * [Connectors & Indexing](/aivis/knowledge/connectors) * [Index Settings](/aivis/knowledge/index-settings) * [Users, Groups & Roles](/aivis/governance/users-and-groups)