Artifacts
Artifacts are non-sensitive files that your connections need to run, such as protocol data dictionaries or custom schema definitions. You upload them to the platform once, give them a name, and any adapter can reference them by that name.
What kinds of files are artifacts?
| File type | When you need it |
|---|---|
| Protocol data dictionary | When connecting to a system that uses custom or non-standard message formats |
| Schema definition | When a transformer or processor requires a custom schema file |
Artifacts are for non-sensitive reference files only. The platform does not manage certificates, private keys, or any sensitive material. If your connections require encryption, your infrastructure team handles this at the network edge. See Security for details.
Uploading a file
- In the Portal, go to Artifacts
- Click Upload Artifact
- Select the file from your computer
- Give it a clear name (e.g.,
venue-x-dictionary) - Click Save
The file is stored and is now available for any adapter to use.
Using an artifact in an adapter
When you're setting up an adapter and a form field asks for a dictionary or schema file, it will show a dropdown instead of a file upload. Select the artifact you uploaded by name.
Updating a file
If a format file changes:
- Go to Artifacts
- Upload the new file with the same name as the old one
- The platform replaces it
The change doesn't take effect on running connections immediately. To apply it, go to the adapter, disable it, then enable it again.
Deleting a file
You can only delete an artifact if no adapters are currently referencing it. If you try to delete one that's in use, the Portal will tell you which adapters need to be updated first.