Source Collector Documentation Guidelines

Source Collector Documentation Input (Required)

This task must be completed by the developer when creating or updating a Source Collector. The information provided here is used to generate customer-facing documentation.

1. Collector Overview

Provide a clear, short description of what the collector does.

• What system does it connect to?
• What data does it retrieve?

Input: - Overview Description:

2. Collector Classification

Define the core behavioural attributes of the collector.

• Collection Behaviour:
  • Discrete / Cumulative
• Data Rating Model:
  • Rated / Unrated / Hybrid
• Data Capability:
  • Point-in-time only or other …

Input: - Collection Behaviour: - Data Rating Model: - Data Capability:

3. Collector Summary

Provide key metadata used in documentation.

Input: - Source Collector Name: - Version: - Vendor Name: - Product / Platform: - Short Purpose Statement (1 sentence):

4. Data Collected

Describe exactly what data is retrieved.

• What entities? (e.g. users, licences, transactions)
• What level? (per user, per tenant, per transaction)
• Any important limitations?

Input: - Data Description: - Data Granularity: - Known Limitations:

5. Prerequisites

List all required setup steps outside Varibill.

Input: - External System Requirements: - Required Access / Roles / Permissions: - Required Setup Steps:

6. Configuration Parameters

Define all required input fields for the collector.

Input (table must be completed): - Parameter list with: - Name - Description - Mandatory (Y/N) - Source location

7. Authentication Details

Describe how authentication works.

Input: - Authentication Type (e.g. OAuth, API Key, Client Secret): - Credentials Required:

8. Configuration in Varibill

Define how the collector is configured in the UI.

Input: - Hosting Provider (Cloud / Self-hosted): - Collector Type (as shown in UI): - Required Field Inputs: - Optional Field Inputs:

9. Processing Rules / Identifiers

Define how data is grouped and identified.

Input: - Default Identifier Strategy: - Supported Identifier Fields: - Recommended Grouping Logic: - Known Risks (if any):

10. Execution & Scheduling

Define how the collector runs.

Input: - Execution Type (Manual / Scheduled): - Recommended Frequency: - Performance Considerations: - Data Freshness Impact:

11. Error Handling & Validation

Provide known failure scenarios.

Input: - Common Errors: - Likely Causes: - Validation Rules: - Retry Behaviour:

13. External Documentation

Provide official vendor references (if applicable).

Input: - Documentation/API References and Links:

15. Version Notes

Track what changed.

Input: - Version: - Changes:

Definition of Done

• All sections completed
  
• Parameters table fully populated
  
• Example configuration provided
  
• Reviewed by Operations, Development and Documentation Teams