×

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

    Configuration

    This screen allows you to modify the configuration of your account. You can navigate to this page by choosing Configuration from the Account menu. Each category of configurable options is represented by a tab.

    Account configuration Tab

    Name
    The name of your company, this will be displayed next to the RunMyProcess icon.

    Country
    The country where your company is based. Please note that this has no effect on RunMyProcess behaviour including the IDE's language - each user can choose their preferred language from the MySettings application.

    Default domain name
    The Domain name set up as the default one in the Domains Tab (where default check box is checked). This domain will be used for things such as Google OpenID authentication.

    Account ID
    The ID of your account (P_customer). This ID is useful if you want to launch a process through your own javascript web page and in general to call any kind of RunMyProcess API.

    Logo
    You can change the logo displayed in the upper left part of the IDE. This logo will also be displayed in the default header of your Web Interfaces. To choose a logo, click on the Uploaded images button, a list of your uploaded files that are of type images will be displayed, once an image is selected, a preview is shown below the button:

    account logo preview

    Session timeout (sec)
    You can modify how much time a session will remain open when there is no activity. By default this value is set to 3600 seconds.

    Domains

    All your domains are displayed here. To edit a domain, click on its name, then click on the edit button :

    Domain name
    Your domain name (e.g. runmyprocess.com).

    Default domain
    Check this box to specifiy that this is the default domain for your account. If you only have one domain, it will automatically be the default one. To change the default domain, edit the domain to be specified as default, check the default box and save, the previous default domain will no longer be the default domain.

    Allow Secure Enterprise Connector connections
    Check this box if you want to use this domain with our Secured Enterprise Connector. You can learn more on provider authentication and also learn how to install the Secured Enterprise Connector.

    Secure Enterprise Connector login
    Please enter your Secured Enterprise Connector login id here, as configured in your "localConfig.xml" file of your Secure Enterprise Connector agent. You can learn more on provider authentication and also learn how to install the Secured Enterprise Connector.

    Secure Enterprise Connector password
    Please enter your Secured Enterprise Connector password here, as configured in your "localConfig.xml" file of your Secure Enterprise Connector agent. You can learn more on provider authentication and also learn how to install the Secured Enterprise Connector.

    User Metadata Tab

    Click the [Add item] button, to create a new user attribute (e.g. department, address...).

    Name
    The name of your new user attribute.

    Type
    The data type of your new user attribute; it can be "text", a "number", a "date", a "boolean" (check box), an "array" (with different 'simple' value columns), a "structure" (e.g. an address has a street number, a street name, a zip code and a city) or a custom list. The attibute can be mandatory or optional.

    info_1 Only a user with an ADMIN profile can modify a user's metadata .

    info_2 Once saved, metadata name and type can't be modified.

    User Preferences Tab

    Click the [Add item] button, to create a new user attribute (like login, password on another application...)

    Name
    The name of your new user attribute.

    Type
    The data type of your new user attribute; it can be "text", a "number", a "date", a "boolean" (check box), an "array" (with different 'simple' value columns), a "structure" (e.g. an address has a street number, a street name, a zip code and a city) or a custom list. The attibute can be mandatory or optional and you can choose whether it should be secured or not.

    info_3 Preferences can only be modified by the user it relates to.

    info_4 Once saved, a preference name or type can't be modified.

    info_5 These preferences can be used within RunMyProcess connectors or processes by using the get_preferences() freemarker function

    Authentication Tab

    Password Policy

    You can establish the rules for your password policy here. You can choose to limit the amount of possible login attempts and specify the maximum number of attempts allowed. Users who fail to login within the maximum number of attempts will be locked out of their accounts and the status of their account will be shown as black. Their account administrator will need to unlock their account before they can log on again.

    Methods

    There are three possible authentication methods for connecting to our platform :

    • Login/password : connect to our platform using your RunMyProcess login/password. You can define your own custom login page that can be either a public web interface or a public html file uploaded to our platform;
    • SSO with SAML V2 : connect to our platform using your samlv2 compliant identity provider;
    • Google OAuth2 : connect to our platform using your Google account.

    Please note that the Login/password method is always available, even if another method is selected in the authentication tab. Please note also that you can always start a Google OAuth2 authentication flow by adding from=google&domain= in the url of the resource you want to access.

    SSO authentication method

    SSO redirect
    The URL of your samlv2 compliant identify provider redirect page. The user wil be directed to this page when requesting a protected resource in RunMyProcess, without an active session. If not connected to your federated environment, the user will be redirected to your SSO login page.

    Logout redirect
    The URL you want to be used by RunMyProcess when a logout is requested by the user. This may be used to logout from all the applications available on your federated environment.

    Account management redirect
    Optional - the URL of your SSO management page.

    Name Id Format
    The Name Id of the identity provider to be used to find the user name returned to RunMyProcess. When a user is connected in your SSO, RunMyProcess will recognise this user by the login id. This login has to be the email address of the RunMyProcess account. Please therefore ensure that the provided Name Id is mapped to the field containing the email user on RunMyProcess user account.

    Entity Id The id that uniquely identifies you as a Service Provider to the Identity Provider. This is usually runmyprocess.com. However, if you are using a cloud based Identity Provider, this may not be enough to uniquily identify you as other RunMyProcess cutomers may be using the same Identity Provider. In this situation, you will have established a unique service name with Identity Provider - enter this id here.

    Certificate
    Copy and paste here the identity provider certificate issued by your SSO application. The certificate must use the PEM format.

    One Authentication method per execution mode

    You can use a different authentication method for each execution mode (LIVE, TEST, ACCEPTANCE), so that, for example, you do not have to have real users in your production identity provider to test your applications. You can use the same authentication method for all the execution modes, to do that easily, please use the copy/paste icons (1).

    authentication

    By default all accesses with no execution mode specified will be handled as LIVE executions.

    Example :

    You select the Login/password method in the TEST tab.
    You select the Google OAuth2 method in the ACCEPTANCE tab.
    You select the SSO method in the LIVE tab.

    Access Execution Mode Method used
    https://live.runmyprocess.com/live/customerId/appli/appliId LIVE SSO method is used
    https://live.runmyprocess.com/live/customerId/appli/appliId?P_mode=TEST TEST Login/password method is used
    https://live.runmyprocess.com/live/customerId/appli/appliId?P_mode=ACCEPTANCE ACCEPTANCE Google OAuth2 method is used

    Users auto-provisioning

    If you have configured a Google OpenID authentication policy for the LIVE execution mode, you will be able to configure the automatic provisioning of the users on your account.

    To do so just check the Auto-provisioning check box.

    With this option enabled, a user, who does not have a matching RunMyProcess account, logs in to the platform, his or her account will automatically be created and configured.

    The account created will configured as such :

    • name : retrieved from Google
    • login / email : retrieved from Google
    • profile : USER
    • IDE language : English
    • Application language : English

    The user created will be granted access to all the applications accessible to all the users of the account via an Everybody lane.

    If the account subscription model is User-based and id the number of users credit is insufficient, the user will be created with an ACTIVE status and an OVERDUE billing status.

    Custom Homepage Tab

    From here, you can configure your RunMyProcess account to perform a redirection from the RunMyProcess portal page to a personalized homepage. This can be achieved for each environment, namely:

    Environment Description
    Desktop Web access from a desktop environment
    Mobile Mobile access outside of RunMyApp
    Tablet Tablet access outside of RunMyApp
    RunMyApp for Mobile Mobile access using RunMyApp
    RunMyApp for Tablet Tablet access using RunMyApp

    More information can be found here.