Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Manage Sources
The Manage Sources screen appears when you click on Data Sources from the Manager.
Description:
Use Manage Sources to manage the data sources that have been added to the platform using Source Builder.
Field | Description | Note |
---|---|---|
Source name | Name of the Data Source. | |
Date/Time | Date and time of source ingestion. | |
State | State of the data source. Saved: The data source has been saved, but requires further modification before it can be Tested and Published. Published: The data source has been successfully tested and published. Documents are generated and queries will return data to the visualizations. Suspended: The data source has been suspended. Related documents are no longer returned to queries or visualizations. |
|
Data Group | Data Group to which the data source belongs. | |
Actions | List of potential actions to be performed, depending on the data source "state." Edit: Edit a source for re-publishing. Republish: After making changes to the data source, re-publish the source so that the changes will be reflected in queries and visualizations. Test: Test the source to ensure that it is formatted properly and returns the desired results. Delete: Delete the data source from the platform. View: View the source without editing capabilities.
|
Edit Data Source
The following fields appear when you click on Edit Data Source.
Field | Description | Note |
---|---|---|
Choose a Source Template | Leave empty to edit raw JSON/Javascript or start from one of the available source templates. TODO: will this be a standardized list of source templates that need to be documented? | |
Toggle JSON/JS Editor JSON: This is the full source including all fields. JS: The global script that all other elements can use - all of the logic can be written in here as separate functions, and then the scriptlets in other pipeline elements can be simple calls to these functions, to maximize the maintainability of the code in the source. | ||
Validate | Validates any changes made in the JSON editor. | |
Scrub | Scrubs the JSON editor. When copying an existing source into the New Source window, the existing source should be "scrubbed" first. Scrubbing sources removes all fields added by the server after publishing, just retaining the actual ingest logic. It should be used before copying/templating. | |
Revert | Reverts the JSON code to its original state. | |
Test | Select the amount of source documents that should be included in the test. Less verbose tests can often yield more usable results. Possible settings: 1, 10, 20. | |
Full Text | Enable/disable the document full text to be returned during testing. Full text can often be quite long and cumbersome for testing purposes. | |
Update Test Mode | TODO: Need to determine what this means. | |
Test Source | Click to Test the Source. | |
Save Source | Click to Save the source without publishing. | |
Publish Source | Click to Publish the source. The source will be ingested by the platform and returned to queries and visualizations. |
Panel | ||||||
---|---|---|---|---|---|---|
In this section:
|
Panel |
---|
Related Documentation: |