Add custom export templates: where to create the folder "export" and how to modify export.en.xlf?

[marylou]

I am trying to add custom templates to our Kimai installation.

I tried to follow the Kimai documentation and adapt it to the Cloudron installation.

• I copied, renamed and adapted one of the default templates.

• I created a folder in "data" called "export".
  Since in Cloudron plugins are installed in /data/plugins rather than in var/plugins, I thought it might work.

• Similarly, I created a folder "translations" and added a copy of export.en.xlf that included my custom template.

• I reloaded the kimai cache and restarted the app.

bin/console kimai:reload --env=prod

Unfortunately, my template is not shown in the export window.

I suppose that adding a folder "export" to "data" does not work. With regard to invoice templates, @girish suggested that you can perhaps add a default directory for templates.

Maybe configuring the directory data/export through the config key kimai.export.documents in local.yaml could do the trick as suggested in the Kimai documentation, but I don't know how to do that.

And I am not sure how to modify the export.en.xlf either.

Any help would be much appreciated.

[marylou]

Hi @joseph,

Thank you for your reply in the other thread on invoice templates, but I am trying to add export templates, not invoice templates.

They need to be in a directory called "export": https://www.kimai.org/documentation/export.html

So I tried adding to local.yaml

kimai:
    export:    
                documents:    
                        - '/app/data/export/'

Unfortunately,my templates are not added to the dropdown menu.

When I try to change documents to "templates", I get the following error message when I try to rebuild the cache:

ERROR] Unrecognized option "template" under "kimai.export". Available options are "defaults", "documents".      

When I use "defaults", the default templates disappear from the menu.

kimai:
    export:    
               defaults:    
                        - '/app/data/export/'

So I guess I could try to copy the defaults into the folder and point to defaults.

[marylou]

Copying the default files into the folder did not work.

[girish]

Have you tried settings documents instead of defaults ?

[marylou]

I tried documents first, then defaults.

[marylou]

What I don't understand is how Kimai should know what to call the additional template in the dropdown menu.
This is why I think it it's necessary to also modify the export-en.xlf.

Edit: I suppose it will get an id once it is located and the translation file would translate the ID into whatever "resname" you select. So I should expect to see an ID in the dropdown.

[marylou]

I also tried.

• 'app/data/export/'
• '/data/export/'
  I reloaded the cache every time. The additional templates do not appear.

[girish]

@marylou maybe https://git.cloudron.io/apps/kimai-app/-/merge_requests/6 works... I have published a new package that uses /app/data/export . Can you try?

[marylou]

Updating now.
Just to be sure: I delete the path I added to local.yaml, correct?

[marylou]

YEAH!!!!!!!

Thank you SO SO SO much, @girish.

Fun fact: the order of the menu buttons changed (for lack of a better word, it is also the word used in the kimai documentation) from CSV / Excel / Print / PDF to CSV / Excel / PDF / Print.

But there is now a fifth template in the PDF dropdown and it has the file name as a name.
Again, thank you so much!!!

[msbt]

@girish I'm afraid this update removed the custom invoices templates, I can't create new invoices because the templates are now "missing". Could you symlink that path again? /app/data/invoices was used for templates, /app/data/data/invoices/ for exported pdfs (https://www.kimai.org/documentation/invoices.html#create-your-own-invoice-document for reference)

[girish]

@msbt oh, i didn't realize that path was in use. will put it back

[girish]

@msbt published

[msbt]

@girish thanks, appreciate it! already tested, templates are back

[marylou]

And mine are still there.