File templates

"File Templates" are predefined models that contain structured information to simplify the creation and sharing of files. They allow you to generate endpoints for file downloads, ensuring that data is accessed securely and in a controlled manner.

How to access File Templates

When you click "File Templates" in the left-hand menu, you'll see a list of all configured templates, along with the option to add a new one.

Add template

To add a new template, follow these steps:

  1. In Data Management, go to the "File Templates" section.

  2. Click "Add Template".

  3. Fill in the following fields:

    • Template name

    • Type: Choose CSV, JSON, Parquet, or Excel

    • Directory

    • File name

    • Read groups: define which groups can read the file. By default, the group is "default."

    • Write groups: define which groups can write to the file. By default, the group is "default."

    • Tags

    • Create endpoint for download: by enabling this option, a URL is generated and associated with a security token. To share the "file template," copy this URL.

    • Basic authentication: allows you to configure which users can access the endpoint, further protecting the file downloads.

Tela de criação de um template de arquivo

After filling in the fields, simply click "Save". Done! Your "file template" is now available.

Change Token

Changing the token allows you to maintain control over who can access the files, ensuring that only authorized users have access.

To change the token, follow these steps:

  1. Acesse a seção "Templates de arquivo", na barra lateral esquerda.

  2. Click on "Edit" (pencil icon) for the desired file.

  3. Click on "Change Token" to generate a new token

Tela para alterar o token

When a new token is generated, the old token is invalidated. This means that any URL with the old token will no longer work, and only the URL with the new token will allow access to the file.

  1. Click "Save". Done! The token has been changed.

Edit a File Template

To edit a file template, follow these steps:

  1. Go to the "File Templates" section in the left-hand menu to view all created templates.

  2. Hover over the desired template and click the three-dot icon.

  3. Select "Edit".

  4. Make the necessary changes and click "Save". Done! The file template has been updated.

Delete a File Template

To delete a template, follow these steps:

  1. Go to the "File Templates" section in the left-hand menu to view all created templates.

  2. Hover over the desired template and click the three-dot icon.

  3. Select "Delete".

  4. Type the name of the template and click "Delete" to confirm the action. Done! The template has been deleted.

Read also: Data Consumers.

Last updated