Folders and their settings

Discover how folders work and understand their public & privacy settings

In this topic, you’ll learn about folders within the Inkit platform. You’ll understand how they work, what kind of privacy and safety measures they provide and see how you can use them to organize data and configure your data access.

Prerequisites:

  • You know about user roles
  • You understand how API keys work
  • You know the difference between users and API keys

Read more about:

Users and API keys
Identifying your API key needs

Why use folders?

To put it simply, with folders, you can organize and categorize data. Therefore, folders are considered to be an essential component of the management & security layer to which you have access.

By keeping your data nice and tidy, you’ll find that storing, searching, and using your documents becomes significantly easier. Additionally, folders let you protect your data.

Here’s how it works: Say you wish to organize certain files in one particular category. For example, you may want to put all your generated invoices from the US in a folder called ‘Invoices_US.’

Or perhaps you’d like to grant specific user roles access to confidential documents and keep all other unwanted users out. Then you could, for example, only give admins access to those folders.

Configuring data access like this works for any type of documents, be they bank statements or patient data. Folders and their features are highly versatile and valuable for any organization that puts management efficiency and security first.

All these scenarios, and many more like them, warrant the use of folders and are available to you as you use Inkit Render.

Organizing data with folders

Generally, you can compare using folders on the Inkit platform to how you would in most operating systems. Meaning you can create as many folders as you’d like and put as many rendered documents inside them as you want.

In short, you can create a large array of different folders to categorize and organize your data.

However, as of right now, the Inkit platform only supports one layer of folders. Stay tuned, because soon we will add nested folders to give even more data management advantages.

To continue the previous example, maybe you’d like to split your invoice data by region.

Say you operated in the US, Canada, the UK, and Europe; then you could have separate folders for each one of them. You could name them ‘Invoices_US,’ ‘Invoices_CA,’ ‘Invoices_UK,’ and ‘Invoices_EU.’

Moreover, through folder sharing, you could ensure that only users and systems that function within those regions have access to these folders.

Tip: You can include a folder ID in your Render Create request and automatically let Inkit Render put the document in the correct folder.

Public and private folders

Folders can be either public or private. To utilize folder sharing and configuring data access, your folder must be private. You can make a folder private by checking the ‘private’ checkbox in the creation or edit form.

Please be aware that any public folder is accessible to any user and system within your organization, so long they have the Render.retrieve permission.

Systems or users can only write to a folder when they have both the Render.create permission and have access to that one specific folder. Access to folders is done through folder shares.

Also, note that when you create a private folder or turn a public folder into a private one, you cannot change it back to public. It is an irreversible operation.

The default folder

Every organization has a ‘default’ folder. When you do not specify a folder ID with your create requests, Inkit Render places your completed documents here.


Did this page help you?