×

Please give details of the problem

Docs

Find

    Developer Guide

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

    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 :

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    # 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:

    1
    ${file_content("uploaded-file-id","none")}
    

    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:

    1
    2
    <#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