Search
Welcome to
Papirfly Help & Keepeek Center
Type your question in the search bar or select one of the topics below.
Type your question in the search bar or select one of the topics below.
With categories for Produce, now the same system for taxonomy used in Place for media assets can be used to categorize and filter both templates and documents. Categories are assigned to templates and then inherited by their child documents.
Both the template and document lists have a dedicated filter for categories. By opening this menu you can select from one or more categories to refine each list respectively to find the exact template or document needed.
One or more categories can be selected from the category list. Categories are hierarchical and you can individually select parent and/or child nodes in the tree as desired.
You can refine and limit the categories listed by entering a search team with the category menu. The search will show results for any string match regardless of casing or position within the category name.
By default the Or operator is selected. This means any of the categories matched in the filter will be shown in the results.
By using the And operator, then the filter will only show matching results for those templates and documents that belong to all categories.
Categories are assigned to templates through the Template settings dialog. Once opened, click on the Categories tab to manage the assigned categories to the template. You can assign multiple categories to the template. For child category nodes, parent nodes are automatically assigned to maintain the hierarchical structure. Documents will automatically inherit the assigned category from the template.
Only template admins can access the template settings and assign categories.
Template admins can access the category manager from the Home tab in Produce. Click on the cog icon and select Category manager from the menu.
Local categories are limited to Produce. Any categories created with local categories active will only be visible in the Produce app.
Global categories are available to all apps using the category manager. These categories can be shared with Place media assets as well as Produce templates and documents.
From the category manager select Local categories or Global categories from the dropdown as desired to create and edit categories for each.
To add a category, click the Add new button. This will create the new category at the base (root) level.
To add a child category to a parent node, click the Add button (denoted by the + icon) to add the category in the desired position within the tree.
To edit a category's settings, click the cog icon open the settings panel. From there you can set the name, translation names, colors, and more.
The Folders menu option in Produce Launcher enables you to organize templates and their belonging documents in a way that fits the business, e.g. per campaign, type of templates, brands, etc.
The main navigation panel in Produce Launcher has a new button added for the “Folders” tab. Clicking on this will either display an empty page (if no folders have yet been created) or showing all folder the Produce admin has already added.
The folders will (just as the “Home” tab) show the Templates on the top, and their connected Documents below:
Produce Template Admins can add folders in multiple levels and name them, via the new Folders option found in the main menu to the left in the Launcher.
A template can only belong to one Folder at a time.
The Template can be added to a Folder by two options:
Via “Add Template” button - Select Template:
Via the Template settings - Folder tab:
To get started with Keepeek API, you need to have a valid account on a Keepeek instance. If you have admin access to your Keepeek instance, follow the steps below to create an account, if not, ask an admin to do it. To create an account, go to the settings:
Then click on the "Users" menu:
Then click on the "Create a user" button:
Fill in the form with the user's information and click on the "Save" button.
You now have a user you can use to authenticate to the Keepeek API! We are now going to see how to authenticate to the Keepeek API, by using the user we just created on a simple api call. To check if your user is correctly created, you can use the following url with your user's login and password (do not forget to replace apiUrl with your Keepeek instance url):
Or use this curl command (do not forget to replace apiUrl with your Keepeek instance url and login:password with your base64(login:password))
curl --location --globoff '{{apiUrl}}/api/dam' --header 'Authorization: Basic login:password'
If you have a 200 response, your user is correctly created and you can now use it to authenticate to the Keepeek API, congratulations!
Now that you have a working user, you can create your first media on you Keepeek instance ! Please note that this works for media that are less To create this media in Keepeek, we will create a new folder, import the file in Keepeek, then create a media in the folder with the imported file.
{{apiUrl}}api/dam/folder-tree
Fill your user and password :
Fill the body with the name of your folder 
Or use this curl command (do not forget to replace apiUrl, the authorization and the body to fit your configuration):
curl --location --globoff '{{apiUrl}}api/dam/folder-tree' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic login:password' \
--data '{
"title":"My new folder"
}'
If the folder is successfully created, the API returns a 201 Created status code and a location of your new folder in the location header.
The mandatory headers are :
Use the body to to put the binary of the file
Or use this curl command (do not forget to replace apiUrl, the authorization, the headers and the file to fit your configuration):
curl --location --globoff '{{apiUrl}}api/dam/files' \
--header 'X-KPK-FileName: test.jpg' \
--header 'Content-Type: image/jpeg' \
--header 'Content-Length: 157' \
--header 'Authorization: Basic Basic login:password' \
--data '@/home/user/images/photo1-eo.jpg'
If the upload is successful, the API returns a 201 Created status code and a file descriptor (in _links.self.href.
{
"id": "xxxx",
"expirationDate": "2024-09-04T15:15:42.200Z",
"fileName": "test.jpg",
"fileContentType": "image/jpeg",
"size": 157,
"_links": {
"self": {
"href": "{{apiUrl}}api/dam/files/x73esh6e"
}
}
}
Do a GET request on this path :
Or use this curl command (do not forget to replace apiUrl and the authorization to fit your configuration):
curl --location --globoff '{{apiUrl}}api/dam/folders/589' \
--header 'Authorization: Basic login:password
You will get a response of this form :
{
"id": 589,
"title": "My new folder",
"description": "",
"path": "/My new folder",
"_links": {
"self": {
"href": "{{apiUrl}}api/dam/folders/589"
},
"curies": [
{
"name": "kpk",
"href": "{{apiUrl}}api/doc/rels/{rel}",
"templated": true
}
],
"kpk:medias": {
"href": "{{apiUrl}}api/dam/folders/589/medias"
},
"kpk:folder-tree-node": {
"href": "{{apiUrl}}api/dam/folder-tree/589"
},
"kpk:responsible-users": {
"href": "{{apiUrl}}api/dam/folders/589/responsible-users"
}
}
}
The kpk:medias link is the one we are interested in, it is the link to the medias in the folder. Now we will create the media in the folder by sending a POST request on the kpk:medias link. Change the url to your own needs, and in the body, use the url of the file descriptor returned in the file upload step.
"_links": {
"self": {
"href": "{{apiUrl}}api/dam/files/x73esh6e"
}
}
If the media creation is succesful, you should receive a 201 Created status code and a location of your new media in the location header.
Congratulations ! You juste uploaded your first media in Keepeek !
Soon, we will see how to search your image using the search ability of the API !
To go further, you can check the other type of connection wich is JWT token connection on the section below. If you want to know more about the Keepeek API, you can check the other sections of this documentation.
This article will guide you through your first InDesign upload into produce. It will be a very simple guide focusing on the essentials to get a document uploaded and will not include advanced features or functions.
In this guide I will add references to other guides that may be relevant, but you should not need any additional references to complete these steps.
Make sure you have installed the plug-in.
After installing, you may need to restart your InDesign software. When installed, it should appear here:
There are no log-ins or accounts needed to just use the plug-in and create the package. It works as an exporter which creates a file for you that later may be uploaded into Produce.
Create a document of any size. Add one or more image frames.
Recommended content for your first upload:
Note: You may use text blocks in this first test upload also, though note that there are some items you wish to look into later when it comes to working with text.
Optimization and setup guide for InDesign documents: See this guide
Once you have a simple base document, we can continue to the next step.
Now we need to open the plug-in as the next steps are done in there.
Since we have a very simple document, the only setting we need to adjust is inside "template settings"
Change the "Template name" to anything that makes sense for you. In this example, I named it "Simple document".
Click the save button to confirm your choice.
All you need to do now is click "export"
You will get a processing screen. Once the bar fills up, you will be asked to save the package to disk. Put it somewhere you can find easily later as this file we will be uploading into produce in the next step.
This next step is done inside the Produce application.
In your platform, find the product selector and open produce.
Navigate to the template section and click "new template".
---
In the modal, make sure to fill in the "name" field, then click on the "design" tab.
Click on the "design file" tab, then click on "browse" to open the file selector.
Select the file you exported from InDesign and click open.
You will see a processing window with a loading bar. Once this finishes, you see this window:
Click "Finalize in editor" and now your document is uploaded into Produce.
In your Produce application, the template should show up and you can celebrate that you have completed your first template upload.
The file you uploaded needs to be configured and managed so that it becomes a usable template for your users.
Note: Images are not imported so you need to upload your image files into one of your Place archives and and add them to the template.
Following is a couple of guides for more advanced document creation, how to configure your template and how to manage visibility and access:
The purpose of this page is to allow you, at a glance, to understand the possible actions available in the new interface.