URL syntax

You can construct your own custom URLs to launch specific IBM® Analytical Decision Management projects and bypass the Applications launch page. For example, you may want to open a specific tab of a certain version of an IBM SPSS® Modeler Advantage project. The following sections provide details for the URL syntax that can be used.

This may be useful for custom integrations with IBM Analytical Decision Management.

The username, password, pass, and provider parameters

Together, these parameters specify authentication information so the IBM Analytical Decision Management login dialog will not be displayed.

The username parameter specifies the user name with which to log in to IBM Analytical Decision Management.

Syntax:
username=<user id>

The password parameter specifies the password.

Syntax:
password=<password>

The pass parameter is an alternative to the password parameter, with the difference being that the pass parameter uses base 64 encoding for security purposes. 64-bit encoding helps hide the password from plain sight. It is not encrypted. To fully secure the password, you must use SSL.

Syntax:
pass=<base 64 encoded password>

The provider parameter specifies the security provider to use for validating credentials. A value is required for provider if the username and password parameters are used.

Syntax:
provider=<provider>

Where <provider> is one of the following values:

  • Native for the built-in security provider
  • AD_<name>/<domain> for Active Directory, where <name> is the security provider name within the system and <domain> is the DNS namespace
  • ADL_<name>/<domain> for Active Directory with local override, where <name> is the security provider name within the system and <domain> is the DNS namespace
  • ldap_<name> for OpenLDAP, where <name> is the security provider name within the system

Special characters, such as spaces, must be escaped.

Examples:
http://yourserver:8080/DM/?username=admin&password=mypassword&provider=native

The id parameter and version parameter

Together, the id parameter and the version parameter can identify a specific project (stream file) to open from the repository.

The id parameter specifies the repository object id of the project to open. See your administrator for help locating the object id of a project. The object id can be obtained by using the various APIs or by using IBM SPSS Deployment Manager client to right-click the file and view its properties.

The version parameter specifies the repository version of the project to open by using the version marker or the version label. Special characters, such as spaces, must be escaped. Omit this parameter to open the LATEST version of the project.

Syntax:
id=<object id>
version=m.<version marker>
version=l.<label>
Examples:
http://yourserver:8080/DM/?id=091e53590d73db3e0000013a5aea9840bf53&version=m.1:2006-12-04%2020:39:17.995

http://yourserver:8080/DM/?id=091e53590d73db3e0000013a5aea9840bf53&version=l.firstVersion

The tab fragment

The #T_n fragment can be used to specify the tab (page) of the IBM Analytical Decision Management application to open. 0 indicates the first tab, 1 the second, etc. -1 is used to open the Home page. This fragment is optional. If specified, it must be at the end of the URL.

For example, to launch IBM SPSS Modeler Advantage to the Data tab, specify #T_0. To launch IBM SPSS Modeler Advantage to the Modeling tab, specify #T_1. To launch to the Home page, use #T_-1.

Example:
http://yourserver:8080/DM/?id=091e53590d73db3e0000013a5aea9840bf53?username=admin&password=mypassword
&provider=native#T_1

The datasourcename and datasourcefile parameters

Together, the datasourcename parameter and the datasourcefile parameter instruct IBM Analytical Decision Management to create a data source with the specified name and source file. Default settings are used for the data source. The datasourcefile parameter must specify the full path of the file located on the IBM SPSS Modeler Server machine. When used in conjunction with the #T_ fragment for launching a specific tab, the data source will become the default data source on the specified tab. For example, #T_1 would select the data source by default on the second tab of the project and #T_2 would select the data source by default on the third tab. Note that the project will be opened with the specified data source already created. IBM Analytical Decision Management will create the data source if it does not exist. If it does exist, IBM Analytical Decision Management uses the file specified (replaces what was there previously).

These settings are not saved unless the user explicitly saves the project.

Syntax:
&datasourcefile=<full path to data on Modeler Server>
&datasourcename=<name to give data source in UI>
Examples:
http://yourserver:8080/DM/?id=091e53590d73db3e0000013a5aea9840bf53&datasourcefile= C:\Program Files\IBM\SPSS\
ModelerServer\17\Demos\DRUG1n&datasourcename=DSDrug#T_2

The template parameter

This parameter is used to launch IBM Analytical Decision Management and create a new project based on the specified application template. The user is responsible for saving the new project, if desired, with a name and location of their choosing. For example, to launch IBM Analytical Decision Management with a new IBM SPSS Modeler Advantage project:
http://yourserver:8080/DM/?template=ModelerAdvantage
Template names for the other applications are as follows:
template=CampaignOptimization
template=ClaimsManagement
template=CustomerInteractionManagement
template=DemandOptimization
template=ModelerAdvantage
template=PredictiveMaintenance
template=RulesManagement

The logout parameter

This parameter is used to force a log out from IBM Analytical Decision Management

Example:
http://yourserver:8080/DM/logout

Sending login information using the POST method

When sent on the URL as described previously, the username and password will be seen in the URL address bar of the browser. To avoid this being visible in plain sight, the username and password can instead be sent as part of contents in a "post" message.

Following is example HTML that uses JavaScript to pass the username, password, and security provider as part of the POST data. This way, the information is encoded using base 64 encoding. To security encrypt the password, you must use SSL.

A HTML example like this with an associated JavaScript (*.js) file might be used to add a button to a web page on your company’s Intranet that launches a certain IBM Analytical Decision Management project.

<html>
<head>
<script type="text/javascript" language="javascript" src="base64.js"></script>
<script type="text/javascript">

function post_to_url(path, parameter, method, user, pass, provider) {
    method = method || "post"; // Set method to post by default, if not specified.

    // The rest of this code assumes you are not using a library.
    // It can be made less wordy if you use one.
    var form = document.createElement("form");
    form.setAttribute("method", method);
    form.setAttribute("action", path + parameter);
    
    if (user != null && pass != null)
    {
        var userName = Base64.encode(encodeURI(user));
        var password = Base64.encode(encodeURI(pass));
        
        var userField = document.createElement("input");
        userField.setAttribute("type", "hidden");
        userField.setAttribute("name", "username");
        userField.setAttribute("value", userName);
        
        form.appendChild(userField);
        
        var passField = document.createElement("input");
        passField.setAttribute("type", "hidden");
        passField.setAttribute("name", "pass");
        passField.setAttribute("value", password);
        
        form.appendChild(passField);
    }
    
    if (provider != null)
    {
        var providerField = document.createElement("input");
        providerField.setAttribute("type", "hidden");
        providerField.setAttribute("name", "provider");
        providerField.setAttribute("value", provider);
        
        form.appendChild(providerField);
    }
   
    document.body.appendChild(form);
    form.submit();

}
</script>
   

</head>
    <table>
        <tr>
            <td><button onclick="post_to_url('http://localhost:9084/DM/', '', 'post', 'admin', 'spss', 'Native');">
            Test</button> </td>
            <td>Post User Info</td>
            <td>gethost() + ''</td>
        </tr>
    </table>
</html>