Please give details of the problem



    Developer Guide

      1. Todo Validation
    1. Release Your User Login
    1. Markdown Template
      1. Backloop
      2. JavaScript Inclusion
      3. Task Reminder Email
      4. Variable Mapping
      5. SubProcess
      6. PDF
    2. Trigger
      1. Lock
      2. Dynamic Variable
      3. List 1000+ Objects
      4. JSONObject Creation
      5. JSONArray Conversion
      6. Number Currency Format
      7. Error Handling
      8. JSONObject Concatenation
      9. Freemarker Container Test
      10. Number Test
      11. Loop
      12. File Visibility
      13. List Hash Sequence
      14. Special Freemarker Characters
      15. Array To List
      16. Salesforce Computation
      17. Metadata
      18. JSONObject Keys Values
    1. Delegation
    2. Access Rights
    3. Dynamic Lanes
    4. Runtime Lanes
    5. Scripted Lanes
    6. Compound Organization Hierarchy
      1. Array From WS
      2. Column Inactivation
      3. Holidays
      4. List Reinitialization
      5. ArrayJSON to JSONArray
      6. Print JSONObject
      7. Invalid Fields
      8. Number Currency Format
      9. Google Tables
      10. Initialization Widget Date
      11. Date
      12. JQuery
      13. Round
      14. Inject JSONObject
      15. Label Modification
      16. Launch Process JQuery
      1. CSS Personalization
      2. CSS Examples
      1. Tags
      2. Retrieving Variables Values
      3. Dialog Window
      4. Autocomplete Widget
      5. JavaScript Report
      6. User Lane Picker
        1. Chart Dashboard Collection
        2. Chart Dashboard
        3. Report Chart
        4. Google Visualization
      7. Collection
      8. Dynamic List
      9. Summing Array
      10. API Listener
      11. File Preview
    1. Performance
      1. Custom Login Page
      2. Redirection ExecutionMode
      3. Mobile Devices
        1. homepage.js
        2. homepage.css
      4. Logout
      5. Header
      6. Menu Bar
      7. Information Tags
      8. Basket
    1. Mobile
    2. Offline
        1. Collections
          1. Process General Tab
            1. Process Step Output Variables
              1. Process Task Email Tab
              2. Process Task SubProcess Tab
              3. Process Task Functional Tab
              4. Process Task Connector Tab
              5. Process Task Manual Tab
              6. Process Task Loop Tab
              7. Process Task Script Tab
            2. Process Step Input Variables
            3. Gate
            4. Process Step Testing Variables
              1. Process Intermediary Event
              2. Process Timer Event
              3. Process Start Event
          2. Process Variables Tab
          3. Process Measures Tab
          4. Process Design
          5. Process Input Tab
          1. Organization
          2. Roles entities
          1. Project Collection Tab
          2. Project Definition Tab
          3. Version
          4. Project Versioned Files Tab
          5. Project Files Tab
          6. Project Description Tab
          7. Project Version Tab
          8. Project Rights Tab
          1. Connectors
          2. Providers
          3. Processes
          1. Composite API Configuration Tab
          2. Composite API Design Tab
        2. Custom Lists
        3. Revision
            1. Image Widget
            2. Spinner Widget
            3. FileUpload Widget
            4. Section Widget
            5. Multi Checkbox Widget
            6. URLInput Widget
            7. RadioButton Widget
            8. Array Widget
            9. Captcha Widget
            10. Checkbox Widget
            11. Report Widget
            12. Geolocation Widget
            13. Button Widget
            14. Custom Widget
            15. TextInput Widget
            16. Tree Widget
            17. List Widget
            18. StaticText Widget
            19. HTML Editor Widget
            20. JavaScript Widget
            21. Tab Widget
            22. HTML Widget
            23. ProgressBar Widget
            24. History Widget
          1. Web Interface Stylesheet Tab
          2. Web Interface Design Tab
          3. Web Interface Analytics Tab
          4. Web Interface Collection Tab
          5. Web Interface API Tab
          6. Web Interface Implementation Tab
          7. Web Interface JS Tab
        1. Scheduled Process
        2. Messages
        1. Configuration
        2. Users
        3. Usage
        1. Connectors
        2. Process Examples
      1. Customer Management
          1. Measuring
          2. Parameters
          3. Execution Path
          4. Runtime Users
        1. Web Interface Reports
        1. Files
        2. Home
        3. My Applications
      1. Collections To Array
      2. Collections BackOffice
      3. Collection JS Freemarker
      4. Collections To List
      1. Composite API Example
      1. Process Reporting API

    How to use a Markdown template in a process

    The RunMyProcess platform allows you to upload some files in the context of a project. If this file is of type text/markdown (.md or .markdown) you are able to use it as a template and convert it to an HTML document by using the P_markdown_to_html freemarker function.

    For those who do not know what is the Markdown syntax, you can refer to the Markdown creator site.

    In the next steps of this tutorial we will learn how to upload a Markdown template into one of your project, and how to use it to render some HTML content in one of your project.

    Markdown template

    First thing first, we will have to have a Markdown template to use. Markdown format is plain text, and to be a template the text file must contain some freemarker expression, it may be as simple as variable substitution.

    Here is the template that we will use as an example for the rest of this tutorial :

    # Task assignation
    Hello ${firstname} ${lastname},  
    you have been assigned a [task](${get_task_url(false)}), please could you handle it as soon as possible.
    Thanks a lot,
    best regards,
    Your task manager.

    Template uploading

    Let's upload this template in our project :

    Markdown template uploaded file

    No magic here, we have uploaded our Markdown file, by using the Add file button, selected the Private access mode. The trick here, is to be sure that your file has an .md or .markdown extension, to make the platform recognise it as text/markdown media type file. And no worry about the content of the template, if needed you can edit it after uploading it, by pressing the page edit button in the Edit column.

    If you want to have a preview of the HTML document that will be generated from the template, you simply have to load the file, as any other uploaded file, by clicking on its name, and then clicking the link in the Name field. The template will then be displayed using a default stylesheet.

    Markdown template file

    While we are in this view, we can copy the uploaded file id, that will be needed later when we will use this file in a process.

    Using the template in a process

    Once the file is uploaded, we can use it in any process of the project. Let's create a new process that will convert the Markdown template to an HTML document, with all the variables replaced by real values, and use this HTML document to notify a user when a new task has been assigned to him/her.
    The process will be as simple as it can be : a first step will allow the variables creation, in a real application these variables would come from a Web Interface for example, or as an input of the process. Here we set some hard coded values, just for the example :

    Markdown template variables

    Then we render the Markdown template to an HTML document, by using the interpret Freemarker function:

    Markdown template rendering

    We first load the content of the template into the template variable:


    Here you have to replace uploaded-file-id by the id of the uploaded file, this information is given in the Uploaded files list view of the project.

    And then we ask Freemarker to replace the variables and execute any code that would be present in the template:

    <#assign inlineTemplate = template?interpret>
    <@inlineTemplate />

    The trick here is to use the interpret Freemarker function.

    The template content is then accessible through the task_notification_content variable, that we use in the manual task configuration (after checking the Notify by email option):

    Markdown template task

    Here we call the P_markdown_to_html Freemarker function, to get the HTML content, using no specific option, but you can have a look at the function documentation to learn how to apply a customized stylesheet for example.

    The user will receive an HTML email to notify him/her of the new task. The Markdown/Freemarker template can be as complex as Freemarker allows it, so that the content may be much more evolved than what we have shown in this tutorial.

    See also

    The official Markdown syntax
    The P_markdown_to_html Freemarker function documentation
    The interpret Freemarker function documentation
    The project files view