×

Please give details of the problem

Docs

Find

    Developer Guide

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

    Providers Tab

    This tab allows you to view, edit and delete the Providers currently in use and you can also add a new Provider from here.

    A Provider groups together the Connectors available at the same web address (a Provider can be thought of as an application which offers different Connectors). Each process itself is available as a Connector provided by the Provider RunMyProcess process server (see Processes Tab).

    info_1 If you want to re-use Providers (and associated Connectors) across projects we strongly advice that you create a specific project for them. For example, if you create a separate project for an email provider you can re-use it across all projects that require it, this is important as a resource can only be attached to one project.

    Configuration

    Title
    The name of the Provider.

    Tags
    A Provider can be tagged with one or more customizable fields called tags. A search by tags is accessible via the advanced search of the connector repository.

    Environment Configuration: Test, Acceptance and Live environment
    Fill in the parameters for the individual environments to optionally use different URLs or credentials for Test, Acceptance and Live state. Your project's version state (test/acceptance/live) will determine which of these Provider environments will be used during process execution.

    info_2 Click on copy / paste to copy / paste between the different environments.

    URL
    Type in the URL of the provider. The URL can contain variables or can be a variable (${url}). The following protocols are supported:

    • http:// Web Server,
    • https:// Secure Web Server,
    • smtp:// Mail sending Server,
    • smtps:// Secure Mail sending Server,
    • pop:// Used to retrieve Mail of a specified user from a mail server,
    • pops:// Used to retrieve Mail of a specified user from a mail server in a secured way (SSL encryption),
    • ftp:// Used to retrieve files from a server or to send files to a server.
    • ftps:// Used to retrieve files from a server or to send files to a server. FTP Secure (FTP-SSL) is an extension to the commonly used File Transfer Protocol (FTP) that adds support for the Transport Layer Security (TLS) and the Secure Sockets Layer (SSL) cryptographic protocols.
    • ftpes:// Used to retrieve files from a server or to send files to a server. In explicit mode (also known as FTPES), an FTPS client must "explicitly request" security from an FTPS server and then step-up to a mutually agreed encryption method. If a client does not request security, the FTPS server can either allow the client to continue insecure or refuse/limit the connection.
    • sftp:// Used to retrieve files from a server or to send files to a server. SFTP is an extension to the Secure Shell Protocol (SSH) which offers secure file transfer capability.
    • rdcp:// Used to perform request on your local Database if it has a JDBC driver (Remote Database Connector Protocol).
    • coap:// Constrained Device endpoint for Internet of Things applications.
    • coaps:// Secure Constrained Device endpoint for Internet of Things applications.

    info_3 The URL must always end with a forward slash (/) so that the concatenation of the URL and the address of a connector makes a well-formed URL.

    info_4 If all Connectors for a Provider are accessible via a simple URL e.g. "http://sdb.amazonaws.com/", you can use this URL for the Provider and use Dynamic URL with the same URL for each of the Provider's Connectors. This is because there is nothing to concatenate after the Provider's URL (see Connect / Services).

    info_5 For FTP providers, the Connector will look like : ${ftp_directory_name}/${filename_on_ftp_server}. The first parameter is optional if it's the home directory (no "/" before filename). The file transfer type should be "Binary".

    info_6 Example of configuration for Gmail server:

    • Sending email (see your webmail configuration) : "smtps://smtp.gmail.com:465/" (smtp port is 465 and smtps is for encrypted ssl connexion) or "smtp://smtp.gmail.com:587/" (smtp port is 587). Authentication Scheme is "Plain with TLS (SSL)"
    • Receiving email: "pops://pop.gmail.com:995/" (see your webmail configuration: pop port is 995 and pops is for encrypted ssl connexion). Authentication Scheme is "Basic with SSL".

    Authentication Scheme
    Select the type of authentication used to log on to the Connector's Provider. Most Providers will simply require the basic authentication, through login and password, that can either be fixed or dynamic, using variables.

    info_7 "Secured" check box for Password field will prevent the server from sending your password to the RunMyProcess user interface. Only modification of your password will be sent from UI to server.

    For HTTP/HTTPS providers:

    • None: no authentication.
    • Login/Password (basic): Easiest authentication method in the HTTP protocol, but also the least secure one since it merely uses a simple base64 encoding of login and password.
    • Custom: the authentication scheme is specific to the vendor. We build authorization custom header for request the following way : [Scheme name][space][Credentials]. Scheme name can't be a Freemarker variable : it is a fix text
    • Digest: Secured authentication method of the HTTP/HTTPS protocol, providing a handshake before sending login and password.
    • AWS Signature V2 (Header): refers to an older authentication scheme specific to Amazon S3. Please note that Signature V2 isn't supported by all AWS regions anymore thus we suggest migration to AWS V4 authentication.
    • AWS Signature V4 (Query): refers to the current AWS V4 query-based authentication scheme. Please enter your AWS Access key ID and Secret access key as credentials.
    • AWS Signature V4 (Header): refers to the current AWS V4 header-based authentication scheme. Please enter your AWS Access key ID and Secret access key as credentials.
    • Google 2L OAuth: refers to Google 2-legged OAuth. This authentication scheme, available for Google Apps Edition only, allows RunMyProcess to use Google API on behalf of a user without knowing his login/password.
    • RunMyProcess Secured Connection: Connectors attached to this Provider will use P_user credential to call a RunMyProcess internal Connector such as "Create a custom list" (see Libraries / Connectors).
    • Windows Azure: specific authentication scheme used by Windows Azure's connectors.
    • Java Keystore: allows you to join a certificate (file downloaded on RunMyProcess) with its associated password to each request. This is only available for HTTPS protocol.

    info_8 Additional Notes for AWS Signature V4 (query- and header-based):

    You can use either signature format for requests to arbitrary AWS services. Please note that the query-based authentication scheme is limited by the maximum length of a URL. In case of S3 the (POST-)payload will also not be part of the signature. Generally we recommend the use of the header-based authentication scheme unless you want to express your request entirely via the URL. You have to define the Provider according to the AWS service endpoints - see http://docs.aws.amazon.com/general/latest/gr/rande.html for details.

    • Example for an AWS RDS provider URL in the US-West-2 region:
      'https://rds.us-west-2.amazonaws.com/'
      The corresponding action portion has to be defined in the connector definition. Example:
      '?Action=DescribeDBInstances&MaxRecords=100'
      Please note that this pattern is not consistent across all AWS services (see the followup example) so please refer to the AWS REST documentation for details.

    • Example for an AWS provider URL for a S3 bucket in the AWS standard region:
      'https://bucketname.s3.amazonaws.com/'
      Example for the connector URL for an S3 GET request (download):
      'the_filename'

    As of now we are not supporting multi-part file uploads to S3 (files bigger than 5GB).

    For SMTP/SMTPS providers

    • None: no authentication.
    • Plain: plain standard scheme for send mail servers (SMTP): this is the method usually required (login is your email address, password is your email password).
    • Plain with TLS (SSL): refers to the authentication needed for email providers where you need an encrypted SSL connection (Gmail for instance).

    For POP/POPS providers

    • None: no authentication.
    • Basic: standard scheme for receiving mail via POP with simple base64 encoding of login and password.
    • Basic with SSL: same as basic but more secured since SSL encryption: used by POPS mail server.

    For FTP/FTPS/FTPES providers

    • None: no authentication.
    • Login / Password: FTP connection is done thanks to a login / password

    For RDCP providers

    • None: no authentication (it is managed within service).
    • Use Secured Enterprise Connector: check this box and select a domain if you want to give an access to RunMyProcess to your internal connectors without creating any DMZ on your local network or re-configuring your firewall. You will need to install a Java agent on your internal server that will create a fully secured tunnel between your network and RunMyProcess server. Learn more
    • With domain: this domain is defined in Account/Configuration/Domains tab. This domain will contained Login and Password fields that will be field up with same user@domain/password entered in localConfig.xml agent configuration file. (SECServerHost=SEC.runmyprocess.com and SECServerPort=4433)

    For COAP/COAPS providers

    • None: no authentication.
    • Identity/Key: a pre-shared key encryption scheme will be used.

    Usage rules

    Enable usage rules
    By checking this box, you can define a minimum delay between 2 requests execute by this provider. This can be very useful if you are using one of this Provider's Connectors in a loop so as not to overload the Provider.

    Allow a maximum of one request every
    Define an appropriate delay between two requests in milliseconds (from 0 to 5 seconds)

    Description

    Description
    Description of the Provider and its parameters if needed.

    Documentation
    URL of the documentation describing the Providers.

    info_9 A Provider can only launch five services per second.