This is the multi-page printable view of this section.
Click here to print.
Return to the regular view of this page.
Configuration
How to configure PageJinn
In addition to the actual software, a configuration file config.json is written to the PageJinn home directory (by default, the user’s Documents folder) during installation:
/Users/[username]/Documents/PageJinn/PAG/config.json
The configuration file contains default settings that affect the behavior of PageJinn.
You will probably need to change some of the settings, such as the path to your K4 system and user and password, before PageJinn is ready for use.
You can change the configuration file by hand. However, all important and necessary settings for operation can also be made within PageJinn.
1 - Configure PageJinn
Configuration via GUI.
If PageJinn cannot connect to the K4 system because the access data is not stored in the configuration file or is invalid, the PageJinn settings area is automatically displayed.
You can also show the window at any time by clicking on the gear icon.
| Preference |
Meaning |
|
| API-User |
A K4 user with Admin rights for all publications |
|
| Password |
Password of the API User |
|
| K4 Server Address |
The URL of the K4 System |
|
| Show issues of last years: |
Display issues of the last n years |
|
| Write Log file |
A log file will be written inside a folder PageJinnLogs within the home directory of PageJinn |
|
| Allow user to zoom |
If activated, it is possible to zoom in and out |
|
| Show layout name with PageRange |
Der Seitenbereich eines Layouts wird mit in den Namen des Dokuments geschrieben |
|
Make changes if necessary. If you click Save, the values are written to the configuration file and are permanently available, otherwise only for the current session.
2 - Template file
Creating a Template File
PageJinn requires access to an InDesign template file to display and create InDesign pages for each publication.
This template file (.indt) must be located locally in the PageJinn/PAJ directory. See directories).
However, you should keep this file in the K4 system. Check in an InDesign file as a template named PageJinn into the K4 template issue. This file should contain only one page and should contain a sample page for each section you use. Also make sure that there are no missing fonts in this document.
If PageJinn does not find a local .indt file at startup, it will try to download the PageJinn template file from the K4 system. From the information in the file (height, width, sample pages), an additional template.json file is created
Attention
If there is no local .indt file and there is none in the K4 system, the publications will not be displayed in PageJinn.
If you subsequently change the K4 template file, for example to create new master pages, click Update Template in PageJinn afterwards.
3 - Configuration File
Description of the Configuration File.
A configuration file is automatically created when PageJinn is installed. The entries necessary for functionality can be made via the GUI. If you change this file manually, consider the json format.
Tip
Load the config file with a browser like Firefox to be sure that no syntax error has crept in.
Example of a Configuration File:
{
"PAGKEY":"U2FsdGVkX1854bQMq5zpFXrQkFabckQHKI/Z7Yv36fo=",
"DEBUG":true,
"APILog":true,
"hideAfterCheckout":false,
"advancedWorkFlow":true,
"LayoutNameWithPageRange":false,
"InDesign":"Adobe InDesign 2021",
"showLayoutNameInStatusBar":false,
"K4Version":"10",
"homeDir":"~/Documents/",
"bgColor":"#aabbcc",
"serverAddress":"http://127.0.0.1:9090/K4Server",
"apiuser":"PageJinn",
"apipw":"k4",
"apiremember":false,
"enableUserZoom":false,
"issueYearsToDisplayBeforeCurrent":"1",
"monthNames":["Januar","Februar","März","April","Mai","Juni","Juli","August","September","Oktober","November","Dezember"],
"dayNames":["Sonntag","Montag","Dienstag","Mittwoch","Donnerstag","Freitag","Sonnabend"],
"dueDateName":"Due Date",
"showDueDate":true,
"nameView":"name",
"NFR":false,
"1332490595545":
{"mdId":153,"mdType":2,"mdColor":"rgb(0,255,0)"}
}
| Config name |
Meaning |
Note |
| PAGKEY |
The license key you receive when you buy PageJinn |
|
| DEBUG |
Set this to true to have PageJinn write a Log file |
|
| APILog |
Logging of the API functions |
|
| hideAfterCheckout |
Hides the PageJinn window after Check-Out of documents |
not currently active |
| advancedWorkFlow |
Is K4 Advanced Workflow for Layouts active? |
|
| LayoutNameWithPageRange |
The page range will be written into the Layout name |
|
| InDesign |
The used InDesign version |
|
| showLayoutNameInStatusBar |
Should the name of the Layout be displayed |
|
| K4Version |
The used K4 version |
Only needed for API functions, all version starting from K4 10 are supported |
| homeDir |
The folder with the PageJinn customer data including this config file |
|
| bgColor |
The background color of PageJinn |
|
| serverAddress |
The URL of the K4 System |
|
| apiuser |
A K4 user with Admin rights |
This User must have access rights for all publications you want to manage with PageJinn |
| apiremember |
The password for the apiuser |
|
| enableUserZoom |
Allow user to zoom in and out |
We recommend to leave this set to false |
| issueYearsToDisplayBeforeCurrent |
The number of years to go back from the current to display issues |
|
| monthNames |
The names of the months used in the header |
currently deactivated |
| dayNames |
The names of the week days used in the header |
currently deactivated |
| dueDateName |
The name for the dueDate |
currently deactivated |
| nameView |
This enty indicates which which information is displayed in the name field |
set automatically by PageJinn |
| NFR |
Is there a NFR key? |
This will bring up additional functions. You need a valid NFR key to use this |
| 1332490595545 |
K4 publikation Id |
This entry will be written by PageJinn automatically. Do not change it! |