Back up your Help Center articles at the click of a button!

176 Kommentare

  • Jennifer Rowe
    Zendesk Documentation Team

    You are such an overachiever, Felix! (We love it! :)

    1
  • Kim R Robinson

    I know you have done a lot of work improving this. I have a question, though, so once the HTML files of each article is backed up, is there an automated way to put them back up in the event all is lost or is it going to be just copy and paste?

    1
  • Jennifer Rowe
    Zendesk Documentation Team

    Agreed that Felix is a ROCKSTAR!

    1
  • Duke Oliver

    Heya! I love this tool, but am having an issue. Only about half of our articles get backed up (I'm using v0.6). The ones not getting backed up seem to be random, though I wonder if it's related to this message:

    1
  • Felix Stubner

    @Duke - Hey, thanks so much for giving kBackup a try. Sorry to hear that you are having an issue here. It appears that the way that images are backed up varies very widely from user to user. This is like a way images are stored which I did not account for.

    I will need to investigate what exactly gets returned and what the URL string is, could you email me at felix.stubner@gmail.com with your Zendesk sub-domain.

    Speak to you soon!

    1
  • Howie Paul

    HI Felix, Great tool, seems to be downloading ATM so I hope it all works out!

    I wonder if you have a similar tool for uploading?

    Im looking to upload to a sandbox so would love to be able to do this with minimal fuss - just as kBackup appears to achieve!

     

    thanks

    Howie

    1
  • Felix Stubner

    @Howie - Thanks for getting in touch, glad to hear all is well with kBackup. At the moment I don't have a tool available for easily reuploading all the data. Should something like that be available in the future I'll keep the post updated. If you have any other questions lemme know, have a lovely week!

    1
  • Erica Clayton

    Hey Felix!  Just wanted to say THANK YOU for this app!  Wow, you saved my butt.  Your instructions were so clear and easy to follow, it only took a few seconds from start to finish to download our HC articles.  I appreciate your contribution to making all our lives easier :) 

    1
  • Felix Stubner

    @Erica - You are very welcome and I am glad to hear that the app helped to make your life a little easier. Have a lovely weekend! :) 

    1
  • Jeremy Robinson
    Community Moderator

    @Felix Stubner This looks like a fantastic tool, you did a really great job, and I would love to use. Any timeline or insight into availability for a potential Mac-friendly or unix/linux version of this?

    1
  • Felix Stubner

    Devan - Community Manager - Thanks for the nudge.

    Miles Dunn - A Mac version isn't currently available I'm afraid. I have considered creating one in the past and may do so but don't have an ETA. If you don't have access to a Windows machine, you may get it to work using a software such as Wine that emulates Windows. Hope that helps!

    1
  • Devan - Community Manager
    Zendesk Community Team

    Hello Felix Stubner,

    Way to be a "Titan" with your response there!

     

    1
  • Wes Drury

    @Felix - Thanks for this as I'm sure users will find it useful.  I was gonna test it out but as soon as I hit the backup button I immediately get a message thats its complete however the folder is empty.  I tried on two different accounts with the same results.  Got any suggestions, as I made verified the Password Access was checked and I already had .net 4.6 on my CPU.

    0
  • Felix Stubner

    @Wes - Thanks for trying out the app. Sorry to hear you are running into some issues with it. 

    I will try my best to get this sorted out for you. To get started could I ask you for some additional info:

    1. When you click the backup button did you select a folder or do you get the "backup complete" message straight away after clicking the button?
    2. Do you have write access to the folder you are trying to back up to?
    3. What type of user do you have in your Zendesk? E.g. Admin, Agent, End-User
    4. What is your Zendesk subdomain?

    Once I have this info I'll go ahead and investigate the issue and I'm sure we'll find a solution :)

    0
  • Jason

    The tool did seem to work but it only downloads about 1/2 of our articles. I wonder if some criteria must be met before the file is generated? 

    0
  • Felix Stubner

    @Jason - Thanks for giving the app a try. There isn't any specific criteria as such, the way the app works is that it calls the articles.json API endpoint which will return 30 articles (per request) and a flag to show whether there are more articles available or not. So it will iterate through the pages of articles until it sees the flag to say that next_page is null. When it sees this flag it will stop pulling content as that is all the content there is to get.

    So the only reason I can think is that the rate limit was hit. The rate limit serves as a break for API requests so that after x requests it will time out and you have to wait 1 minute or so to make another request to the API.

    It's possible this may be the reason only half of the articles were downloaded. 

    Would you be able to tell me how many articles in total you have in your help center? You should be able to see that when you are in the Help Center by clicking 'Articles' and then 'Manage Articles'.

    If it is the rate limit, don't worry I am already working on the next release of the app that will include functionality to deal with the rate limit and continue after the time-out period ;)

    0
  • Wes Drury

    @Felix - See below.

    1.  Yes select the folder on my desktop and got the message right away

    2.  Yes I have full acess.

    3.  I'm an Admin in my Zendesk account

    4.  moderatorwes is the subdomain.

    @Jason glad to hear it worked for you.  Wonder if you hit the API paging limit.

     

    0
  • Jason

    I have 148 articles, 20 of which are in draft. Any chance this could also pull the image files down as well? If we lost the content, this app would save our text but not the images. 

    And thanks for pulling this together! It is just what we need.

    0
  • Felix Stubner

    @Wes - Thanks for getting back to me with the info. I just debugged it using the sub-domain moderatorwes and the call for this sub-domain returned no data. I have also checked on moderatorwes.zendesk.com/hc/en-US and there does not appear to be any content on this sub-domain. The tool will only pull content from a specific Zendesk sub-domain so in case you have your accounts set up as spoke accounts please be aware that content will not be pulled from those, but that might be a nice enhancement for the future. I tested the app with one of your other sub-domains which has content (mw-insightly.zendesk.com) and I was able to successfully pull all articles. 

    @Jason - Thanks for getting back to me on this. I will do some more testing with regards to drafts, however it should get all content, drafts or not. Could you provide me with your Zendesk sub-domain and I will investigate this.

    With regards to images, this is functionality that I will be working on after I have completed the functionality that handles rate limiting. Some additional features that I have been thinking about:

    • The ability to view the collection of backed up articles directly through the tool.
    • The ability to retrieve cached help center content from the web as outlined here.
    • Version control for backed up content.
    • Ability to edit articles using the tool.
    • Ability to restore backed up articles in the event content was mistakenly deleted or needs to be retrieved.

    If you have any additional suggestions on features you'd like to see let me know! :) 

    0
  • Wes Drury

    @Felix - I thought about that after I sent the message.  I do have articles for that account they are just selected as Agent Only.  So to be clear the articles need to be viewable and can't be locked to Agents Only.  Appreciate your help and nice job on the app.

    0
  • Jason

    Felix, subdomain is goldsim. I would say about half of our articles are "agent-only" but I checked the downloaded articles and found that they included both public and agent-only articles so I know it wasn't agent-only that stopped the download.

    0
  • Felix Stubner

    @Wes - I see, I will check up on the documentation about the API to see if there is a limit on which articles can be retrieved. 

    @Jason - Thanks I will check it out in a little while and get back to you. 

    Just to be sure I understood correctly, when you say that the articles are 'agent-only' do you mean that they have been placed in a Section which has the 'Who can view?' option set to 'Agents and managers'?

    Thanks again for giving the app a try, really appreciate it!

    0
  • Jason

    Felix,

    Sorry I wasn't clear before. Yes, we have 2 categories in which all sections in there are set to only be viewed by agents and managers. We have another category where only 1 section among others is set to agents and managers viewing. We have 2 more categories in which all sections are set to anyone to view. 

    0
  • Felix Stubner

    @Jason, Wes: After some debugging and comparing results of backed up articles it looks like there was an issue with passing the credentials to the API. I've resolved the issue and can confirm that all help articles that your user has access to will be backed up. 

    I have updated the download link in the post with the latest version of the app, give it a try and let me know how you get on.

    0
  • Julius Hernandez

    @Felix:

    Nice job. It's working perfectly.

    Thanks so much for working on this. Really need it.

    0
  • Felix Stubner

    @Julius - Glad to hear that it's working for you. 

    Keep an eye on this post as I will be adding some additional functionality to the app including the backing up of images contained in a post. 

    But of course if there is any additional functionality that users would find useful, don't hesitate to leave a comment.

    0
  • Wes Drury

    @Felix - Looks like it working now.  I'll recommend it to a few of my clients.

    Additional functionality would to be able to push an article back into the HC but I know that would take some time as the structure would need to be in place.  I could see where a user may want to push all their articles into their Sandbox and store copies there.  

    0
  • Jason

    It works now. Thank you! This is exactly what we need. 

    I also look forward to the added capability of downloading the images too.

    0
  • Felix Stubner

    @Wes - Glad to hear it's working correctly for you now after the update. The ability to restore articles is on my list of features to add, but it may take a little while until I have a good base built. Good idea about the sandbox environment, I will have to see what I can do there as the I don't have the functionality available on the plan I am on. Nonetheless I have noted it down as a future enhancement.

    @Jason - Very happy to hear that you are getting good use out of the application. I am currently working on the downloading and backing up of images for the next release.

    I'll post an update when it's out and you can take it for a test drive ;)

     

    0
  • Jessie Schutz
    Zendesk team member

    Hey Felix!

    This is really great! If you're interested in possibly getting your app added to our App Marketplace, you can find the information on how to get started here: Publish your app.

    Thank you again for putting in the work on this! I know many people will find it useful. :)

    0

Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.

Powered by Zendesk