Custom Recipe Collections

Custom Recipe collections are templates that enable an admin to selectivity expose activities that may be specific to a certain use case to a given number of users. Once the custom recipe collection template has been exposed to a user, he/she can create activities from the exposed custom recipe collection template through the create activity sidebar.

To create or edit a custom collection template follow the following steps;

  • Go to the admin section and click on the "Custom recipe collections" option
  • When in the "Custom recipe collections" section, click the "Upload ckbk file" option to create a new custom recipe collection template. Alternatively click on any one of the listed custom recipe collection templates in order to start editing them.

GitHub integration

When editing a custom recipe collection template you are provided with the option to link it up a file in the activities-and-templates repository in Github. Typically, this is the version controlled representation of the custom recipe collection template cookbook JSON.  

The following operations are provided under the Github integration section;

  1. Ability to link a recipe collection template to a file in Github activities-and-templates repository. To do this insert the path to the file in Github into the "File location in Github" text box.

    To get the location in github for a given file, open the file in your browser from the Github website and copy all the contents after "<github.com>/activities-and-templates/blob/master/". For example; given the following url in the web browser address bar, https://github.com/frontlinesms/activities-and-templates/blob/master/templates/surveys/2%20question%20generic/Survey%20with%202%20questions%20and%20top%20level%20keyword.ckbk

    The file location in Github will be; templates/surveys/2%20question%20generic/Survey%20with%202%20questions%20and%20top%20level%20keyword.ckbk

  2. Ability to update file in Github with cloud hosted custom recipe collection template. When a custom recipe collection template has already been linked to a file in Github, you are provided with the ability to update the file in Github with the contents of custom recipe collection template. This is only possible if the custom recipe collection template has changes that are not available in the associated file in Github. To do this, click on the "Push local changes to Github" button.

  3.  Ability to update recipe collection template with changes from Github. If the custom recipe collection template is different from the associated file in Github, you are provided with the option to update the custom recipe collection template with the contents of the associated file in Github.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.