×

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

    Connectors

    This page displays a list of all connectors in use and allows you to create a new connector. A connector refers to the web service offered by a provider (e.g. the European Central Bank offers access to the Euro rate exchange as a service).

    New Connector
    Allows you to create and configure a new connector.

    Search zone
    Allows you to perform a simple search on a connector name.

    Edit Search
    Allows you to refine your search by specifying a provider, tag or protocol. Please note you can use CTRL + click to select several criteria.

    Reset
    Cancels all search filters previously set.

    Publish
    Allows you to publish your service in "Libraries / Connectors" so that all RunMyProcess's customers can use them.

    info_1 Only connectors used in a project version in Live state can be published.

    info_2 Your published connectors will not appear immediately in "Libraries / Connectors"; RunMyProcess's technical teams will first verify your connectors (object, description, ...) before publishing them.

    Configuration accordion

    Title
    Connector name.

    Provider
    Select the provider from the list. You must create a provider before you can add a connector.

    info_3 Only providers from your connector's project will be displayed.

    server_go.png Open provider
    Click this button to open the definition and description of the provider.

    Dynamic endpoint
    Check this box if the provider returns a dynamic URL after authentication. You must then fill the dynamic URL field.

    info_4 Some connectors' providers generate a dynamic URL whenever you initialize a session on their platform (ex: salesforce.com or taleo.com), this is called a a dynamic endpoint.

    info_5 This endpoint must be used for all exchanges with the connector's provider rather than its actual static URL, during the whole duration of the session.

    Dynamic URL
    Type in a variable that defines the dynamic URL of the connector returned by the provider (i.e. ${url}). This variable will be defined during process execution by using Output variables Tab of a Task.

    info_6 This field only appears if the "Dynamic endpoint" field is checked.

    info_7 If all connectors from a provider are accessible via a "simple URL" like "http://sdb.amazonaws.com/", put this URL for Provider and use Dynamic URL with the same URL (not a variable in this case) for each connector of this provider since there is nothing to concatenate after the provider's URL.

    Provider URL
    The live URL of the provider associated with this connector.

    info_8 This field only appears if the "Dynamic endpoint" field is not checked.

    Connector URL
    Type in the partial URL for the connector so that Provider URL concatenated with Connector URL gives the full URL for the connector.

    info_9 This field only appears if the "Dynamic endpoint" field is not checked.

    info_10 The URL of a connector consists of the URL of its provider (ending necessarily with the character "/") completed by the extension for the connector (not starting with a "/").

    Architecture
    Protocols used to transmit a message:

    • REST/XML-RPC: the connector is using HTTP as the transport and XML as the encoding. REST stands for Representational State Transfer and XML-RPC stands for XML Remote Procedure Call
    • SOAP 1.1: the connector is a SOAP service (Simple object Access Protocol) conforming to version 1.1 of the specification.
    • SOAP 1.2: the connector is a SOAP service (Simple object Access Protocol) conforming to version 1.2 of the specification.

    Method
    Select the method to use to pass information on to the provider: GET, POST, PUT, DELETE, HEAD, PATCH or LIST, RENAME, MKDIR, RMDIR (for FTP/FTPS/FTPES provider only).

    info_11 All the HTTP methods support the TLS SNI extension apart from the PATCH method.

    info_12 RENAME FTP method will act as a MOVE.

    Result Format
    Select the format of the result sent by the provider/connector to RunMyProcess, so that RunMyProcess can parse the results. The available formats are:

    • XML (extensible markup language): This is the default format.
    • CSV (comma separated values): List of sets of values separated by commas; this format is compatible with spreadsheets for example.
    • TEXT: Plain text, no analysis is made of the message.
    • EDI (electronic data exchange): Standard data format for B2B exchanges; several business uses of this standard are handled automatically.
    • JSON (javascript object notation): Serialization format for Javascript objects; very easily interpretable by a Web browser.
    • URL encoding: Syntax equivalent to an encoded URL.
    • HTML (hypertext markup language): No analysis is made of the message.
    • Name=value: List of pairs; Name and value.
    • File: the service returns a file (download service for instance) which is stored on the RunMyProcess platform.

    Accept media type
    Select the media type that RunMyProcess will receive from the connector. The value of this field is transmitted in the HTTP header named 'Accept'. By default, this field is set to application /*.

    New partial url

    info_13 This field only appears if the method used is RENAME. It allows you to type new partial path/name of file (cf. Connector url field).

    Content type

    info_14 This field only appears if the method used is PUT, POST, HEAD or PATCH.

    Select the content type the connector is expecting. The value of this field is transmitted in the HTTP header named 'Content-Type'. By default, this field is set to application /*.

    info_15 If "Method" is equal to "POST" or "PUT" and "Content type" is equal to "multipart/xxx", a "Media type" field appears to define "Content type" of file. This functionality is used for instance to add a file to a Google Site cabinet

    info_16 You can configure a custom content type by choosing "Custom" from the "Content type" list. The allowed characters in a custom content type are described in the regular expression: a-zA-Z0-9_-.*+./

    Character set
    Select the character set used by the connector. If you set the value to --Automatic--, RunMyProcess will analyze the return of the connector to see if a charset is defined : if none, it will use UTF-8 charset which is the default value.

    Result transformation
    Allows you to write a Freemarker script to treat return from connector before getting it in P_result variable in a process. For instance, with the following Output script :

    1
    2
    3
    4
    <node>
        <Id>${Envelope.Body.loginResponse.result.sessionId}</Id>
        <Url>${Envelope.Body.loginResponse.result.serverUrl}*</Url>
    </node>
    

    you can get SessionId and URL of a Salesforce Login service by entering ${P_result.node.Id} and ${P_result.node.Url} instead of ${P_result.Envelope.Body.loginResponse.result.sessionId} and ${P_result.Envelope.Body.loginResponse.result.serverUrl}.

    info_17 The result format of the treatment must be the same as the Result format

    Content

    info_18 This field only appears if the method used is PUT, POST or HEAD.

    It is used to define the content sent to the connector.

    Configuration accordion for RDCP provider

    Title
    Connector name.

    User name
    Id : Unique ID of the service. The ID is generated and cannot be modified.
    Provider url : Address to access server where JDBC connector is set up. It can be localhost if using Secured Entreprise Connector.

    User name
    Login to connect to your database (e.g. root).

    Password
    The user's password to connect to your database.

    Database
    Type of database to connect to (Firebird, IBM DB2, Informix, Microsoft SQL Server, My SQL, Oracle, Postgre SQL, Sybase) : it will modify automatically JDBC class name and Url JDBC fields

    JDBC class name
    Name of JDBC class (e.g. : com.mysql.jdbc.Driver); this depends on the database type.

    Database address
    Address of database within your LAN (accessible via JDBC driver). If request must be sent to //localhost:3306/nycodb, database address will be localhost.

    Port
    Port of request. In the example above, it would be 3306.

    Database name
    Name of the database. In the example above it would be nycodb.

    Query string
    Parameter to be sent to JDBC driver.

    Url JDBC
    JDBC url : it is build automatically thanks to the fields above.

    SQL query
    Your SQL request (ex. SELECT * FROM customers LIMIT 0 , 30)

    Result format
    Results of request can be parsed in XML or JSON

    Advanced parameters

    Additional parameters
    Click this button to add a custom header (SOAPAction for instance) or a cookie if the connector requires specific information. A cookie can be used to emulate web browser behavior or for some SaaS application like Netsuite.com.

    info_19 Example: Add parameter of type Cookie; name is _basecamp_session; value is ${P_cookie._basecamp_sessionp} or Add parameter of type Custom Header; name is SOAPAction; value is Login or for RunMyProcess WS versioning RMPData-Version for name and v1_0 for value.

    info_20 You can't add an Authorization header since it will be overwritten by provider authentication method.

    Attached files
    Click this button to add one or several files that will be sent with the content when calling the connector (multipart format).

    • Name is the name of the file (ex. mypicture.jpg)
    • Reference is the ID of the file on RunMyProcess server: it should be a variable (ex.: ${fileId}). Indeed, when you upload a file on RunMyProcess server or when you are getting a file in a connector, RunMyProcess is saving the file on the server with a unique identifier.

    Description accordion

    Description
    Description of the connector and its parameters if needed