As described in Files Overview, file upload objects allow users to directly upload files into the cloud storage that the Syntasa platform is installed. This is useful to load small files for experimentation and testing, especially for users without direct access to the cloud storage.
Creating a new file upload object only requires a few pieces of information before uploading files. Once uploaded, the files can be used from code processes and notebooks.
Various file types are supported, including a generic option "Other", but specifying the type and format, when applicable, enables the file object to be utilized in the future for features that expect a certain file type. For example, a certain process type within an app may expect JSON; the app canvas will only file upload objects of that type to be connected to the process.
The following file types and formats are available:
- Data - Data files can be of the following file formats: Delimited, JSON, Parquet, Avro, Other
- Python Whl
- Syntasa Object
File upload attributes
The following fields define the runtime template object within the Syntasa application.
- Name - The name of the file upload object must be unique across all file upload objects. In the future, this name will show up in the file upload node within apps.
- Description - Provide information explaining the purpose of the file upload object. This is especially useful if the file upload object is to be shared with other users.
- Tags - All objects throughout the Syntasa application support tags to help organize and search for related instances.
- Type - As described in the above section, the type of files that are to be uploaded to the object. This can only be changed if the existing files are deleted from the object.
- File Format - Applicable for Data type objects, defines the format of the data file(s) being uploaded to the file upload object.
- Delimiter - Applicable for Data type objects with the file format of Delimited, defines the column delimiter used in the files.
- Upload - It is required that the file upload object have at least one file for the object to be able to be created or updated. The path to where the files are uploaded is fixed based on the system's infrastructure configuration, the user who created the object, and the name of the object.
Sharing and permissions
When creating a new app or resource, the sharing option selection will be available to make the component available as Private, Public, or Group. Regardless of the selection, a user with the role of System Admin will always have access to all apps and resources.
The sharing option selected at the time of creating the component can be changed by the owner or a system administrator. The owner of the app or resource is by default the user that is creating the component. This can be changed, if needed, by the owner or the system administrator, after the component is created.
When editing a component, the owner and sharing option is visible and can be changed by the owner or system administrator. For other users, when editing a component, the sharing option and owner settings are hidden.
- Private - Private can be set by the owner (or the system administrator) to limit access to the component only to the owner. System administrators can also access components set to private.
- Public - Public is the default setting and is the behavior of all components before Syntasa 5.2, i.e. before the sharing functionality was available, as all users have access to the component (except apps that are in a module, Synthesizer, Composer, Orchestrator, and the user's role is such that they do not have access to that module).
- Group - Group can be set by the owner (or the system administrator) to limit the access to the component to the user group(s) assigned to the component. As with private, the system administrator can view components with the sharing option set to group regardless if they are a member of the group.