General
The Autodesk Forma Source Client configuration establishes the connection between Integrator and Autodesk Forma and defines how source data is collected.
This article describes how to configure authentication, connection settings, and source behavior.
For module behavior overview, see: [CROSS-REFERENCE: Autodesk Forma Source Module Overview]
For technical details, see: [CROSS-REFERENCE: Autodesk Forma Source Technical Details]
Prerequisites
Before configuring the client, an Autodesk Platform Services (APS) application must be created.
The APS application provides:
- Client ID
- Client Secret
- Callback URL
These are required for authentication.
APS Application Configuration
In Autodesk Platform Services:
- Create a new application
- Select the tradition web application type
- Add the redirect (callback) URL from Integrator
The callback URL must match exactly to ensure successful authorization.
Client Configuration
Client ID and Client Secret
Enter values from the APS application.
Scopes
Defines the permissions requested by the integration.
Note: Changing scopes requires reauthorization.
Use Rate Limiter
When enabled:
- Controls request rate
- Reduces risk of throttling
- Improves stability for large collections
Authorization
To authorize the client:
- Click Authorize Client
- Log in to Autodesk
- Accept permissions
- Return to Integrator
After authorization:
- Token details are visible
- Expiration and refresh timestamps are tracked
Connection Settings
Defines which Autodesk Forma environment is used.
Steps:
- Select client
- Select hub
- Select project
- Click Save
Use Test Connection to validate access.
Source Settings
Folder Selection
- Browse folder tree
- Select source root folder
Stored Values
- Folder ID
- Folder Name
Excluded Extensions
Defines file types to exclude (comma-separated).
Example:
dwg, pdf, tmp
Include All Versions
- Enabled: Collect all versions
- Disabled: Collect latest version only
Use Checksum Filter
- Skips unchanged files and versions
- Improves performance for recurring runs
Clear Checksum History
Clears stored checksums to force full reprocessing.
Get Custom Attribute Definitions
Fetches available custom attribute definitions for review.
Create Transaction
Starts manual collection.
Save Changes
Stores configuration.
General Settings
Task Scheduler
Controls automated execution.
Activation
- Enable or disable scheduler
Schedule Types
- Interval-based (e.g., every X hours)
- Weekly (specific days)
- Monthly (specific date)
Monitoring
- Last Run shows last execution time
- Next Run shows scheduled execution
History
Displays:
- Collection events
- Progress updates
- Warnings and errors
Useful for monitoring and troubleshooting.