×

Please give details of the problem

Docs

Find

    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 generate a PDF file

    This tutorial explains how to create a PDF document from a MS Word template with RunMyProcess. To create the template, you can use Word 2003 or 2010, it does not work with Word 2007.

    Configuration of the MS Word template

    • Download the XSL-FO converter spreadsheet

    • Launch the .exe file to extract the spreadsheet

    • Create a template with word 2003 or 2010.

    • Go to the "Save as" menu and select "Word 2003 XML document" in the "Save as type" option (if you are not using word 2003).

    • Select the option "Apply transform" and select the "Word2FO.xsl" style sheet you have just extracted (by default C:\Office Samples\OfficeWordWordMLtoXSL-FO\Word2FO.xsl)

    Creation of the variable used to generate the document

    In your process, create a variable that contains all the variables you want to use in your template with the following structure. In the following case, we use the variables var_1 and var_2 to create our PDF document

    1
    {"my_var_main":{"var_1":"value_1","var_2":"value_2","my_array"}}
    

    If you want to use an array of values to create your PDF document, use this syntax:

    1
    {"my_var_main":{"var_1":"value_1","var_2":"value_2","my_array":[{"name":"John","age":"35"},{"name":"Jessica","age":"28"}]}}
    

    Capturedecran_2012-09-19_a_16.59.21

    Configuration of the template

    • Open the template with a text editor and save it with a .xsl extension

    • Add the following lines before the <fo:root> element

    Code

    1
    2
    3
    <xsl:stylesheet version="1.1" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" exclude-result-prefixes="fo">
        <xsl:output method="xml" version="1.0" omit-xml-declaration="no" indent="yes"/>
        <xsl:template match="my_var_main">
    

    where my_var_main is the name of the main element of your JSON that contains all the variables you want to write in your documents.

    • Add the following lines add the end of the document, after the </fo:root> element

    Code

    1
    2
        </xsl:template>  
    </xsl:stylesheet>
    
    • To add a variable in your template, add the following tag

    Code

    1
    <xsl:value-of select="var_1"/>
    

    where var_1 is the name of one of your variable

    • To add an array of variables, add the following tag to the main template

    Code

    1
    <xsl:apply-templates select="my_array"/>
    

    and create the template for each line of the array. To do so, add another tag with the content of a line of your array after the </xsl:template> tag of the main template. Here is an example of the template of a line

    Code

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <xsl:template match="my_array">  
        <fo:table-row>  
            <fo:table-cell>  
                <fo:block>  
                    <xsl:value-of select="name"/>  
                </fo:block>  
            </fo:table-cell>  
            <fo:table-cell>  
                <fo:block>  
                    <xsl:value-of select="age"/>  
                </fo:block>  
            </fo:table-cell>  
        </fo:table-row>  
    </xsl:template>
    
    • you can also use the if function

    Code

    1
    2
    3
    <xsl:if test=&#39; age &gt; 30 &#39;>  
    ...some output if the expression is true...  
    </xsl:if>
    
    • for more details about the xsl functions, here is a tutorial.

    • if your array has more than one page and you want the header of the array to be displayed on top of each page, you just have to put the header of the array in a header tag. See the example below:

    Code

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    <fo:table>  
        <fo:table-column column-number="1" column-width="230.3pt" />  
        <fo:table-column column-number="2" column-width="230.3pt" />  
        <fo:table-header>  
            <fo:table-row>  
                <fo:table-cell>  
                    <fo:block>  
                        <fo:inline>
                            <fo:leader leader-length="0pt" />Column 1 title
                        </fo:inline>  
                    </fo:block>  
                </fo:table-cell>  
                <fo:table-cell>  
                    <fo:block>  
                        <fo:inline>
                            <fo:leader leader-length="0pt" />Column 2 title
                        </fo:inline>  
                    </fo:block>  
                </fo:table-cell>  
            </fo:table-row>  
        </fo:table-header>  
        <fo:table-body>  
            <xsl:apply-templates select="my_array"/>  
        </fo:table-body>  
    </fo:table>
    

    Configuration of the process to use your template

    • After the configuration of the template is done, upload it to RunMyProcess in Desktop -> Files
      Capturedecran_2012-09-19_a_16.59.21

    • In your process, select the activity type script
      Capturedecran_2012-09-19_a_15.52.37

    • In the script tab, select PDF Transformation
      Capturedecran_2012-09-19_a_15.53.48

    • Click on Uploaded XSL files and select your file
      Capturedecran_2012-09-19_a_15.54.58

    • In Data source, enter the name of the variable that contains all the variables you want to use to generate the PDF
      Capturedecran_2012-09-19_a_15.58.55

    • In the ouput parameters of the task, add a variable with the value ${P_result.id} to store the id of the file
      Capturedecran_2012-09-19_a_17.37.12

    The configuration is done!

    Example

    Here is an example of an XSL-FO template.

    Below you can find the structure of the variable used to generate the PDF file:

    1
    {"my_var_main":{"client_name":"My company","users_array":[{"name":"John","age":"35"},{"name":"Jessica","age":"28"},{"name":"James","age":"52"}]}}
    

    This template was use to generate this PDF file.

    Known issues

    The transformation of the .doc document to an xsl document has some issues.

    • The cells of the arrays may appear to be filled in black. If so, change the propertie background-color="black" of the <fo:table-cell> tags to background-color="white"

    • The header of the document may be overridden by the body of the document. To fix that, increase the height of the top margin of the documents. This property can be found as follows:

    Code

    1
    <fo:layout-master-set><fo:simple-page-master><master-name="section1-odd-page"> (and <master-name="section1-odd-page">)<fo:region-body margin-top="10pt">
    
    • The attribute font-family="Arial" for example does not work. Whichever the font-family specified into the template, it will display Times New Roman. However, if no font-family is specified anywhere into the template, it will display Arial.