Configurable URL Call

General (Configurable URL Call)

The Cockpit 10 call can be controlled by specifying special URL parameters. This corresponds to an extended predefined login.

The following variants are available:

• Logging in to a repository
• Logging in to a predefined CSP Server
• Predefined login type
• Executing a local export

You can find a description of the employed parameters under: cockweb.cfg: Predefined logins (Microsoft IIS).

Logging in to a Repository

A connection is automatically established to a predefined repository on a specified CSP Server. Three different ways of logging into CSP Server are available.

The parameters security and target are optional, see cockweb.cfg: Predefined logins (Microsoft IIS).

Integrated Windows User

Syntax:

http://<computer name>/<URL>?type=environment&server=<servername>&auth=integrated&environment=<Repository>&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=panatara%20holding&security=Kerberos&targetspn=HOST%2fMyServer%2eMyDomain%2enet

Windows Login

Syntax:

http://<computer name>/<URL>?type=environment&server=<servername>&environment=<Repository>&auth=forms&user=<name>&pwd=<pwd>&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=environment&server=localhost&environment=pantara%20holding&auth=forms&user=Admin&pwd=Admin

Default User

Syntax:

http://<computer name>/<URL>?type=environment&server=<servername>&environment=<Repository>&auth=normal&user=<name>&pwd=<pwd>&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=environment&server=localhost&environment=pantara%20holding&auth=normal&user=Admin&pwd=Admin

Optional Parameters

Example:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&report=Home&fullscreen=lock&filter=Makes,Year,Customer&filtervalue=Mercedes,2008;2009,Germany

Explanation:

An integrated login to CSP Server "localhost" is programmed. The repository "Pantara Holding" is called. The report "Home" is opened in fullscreen mode. The "Vehicles" filter is preset to the value "Mercedes", the "Year" filter is preset to the values "2008" and "2009" and the "Customer" filter is preset to "Germany".

Usage of Special Characters in URLs

Special characters in the name of a repository or in the name of a report have to be transformed to UTF-8 coding.

For example: The name of the report to be opened is "Deviation in %". In this case, the URL call has to look like this:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&report=Deviation%20in%20%25

The most important special characters in UTF-8 coding:

For further notes on UTF-8 see also UTF-8 - Wikipedia.

Logging in to a Predefined CSP Server

A connection can be established to a specific CSP Server. The user can then choose the required environment from those available on this server.

The parameters security and target are optional, see: cockweb.cfg: Predefined logins (Microsoft IIS).

Integrated Windows User

Syntax:

http://<computer name>/<URL>?type=server&server=<servername>&auth=integrated&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=server&server=localhost&auth=integrated

Windows Login

Syntax:

http://<computer name>/<URL>?type=server&server=<servername>&auth=forms&user=<name>&pwd=<pwd>&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=server&server=localhost&auth=forms&user=Admin&pwd=Admin

Default User

Syntax:

http://<computer name>/<URL>?type=server&server=<servername>&auth=normal&user=<name>&pwd=<pwd>&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=server&server=localhost&auth=normal&user=Admin&pwd=Admin

Optional Parameters

Example:

http://localhost/Cockpit10?type=server&server=localhost&auth=integrated&fullscreen=on

Explanation:

An integrated login to CSP Server "localhost" is programmed. The repository must be selected manually. If a report has been stored in the global starting view or in the user's personal starting view (see the online help system for Cockpit 10 and the section on Opening a repository automatically) this report is opened in fullscreen mode. The fullscreen mode can be closed.

Usage of Special Characters in URLs

Special characters in the name of a repository or in the name of a report have to be transformed to UTF-8 coding.

For example: The name of the report to be opened is "Deviation in %". In this case, the URL call has to look like this:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&report=Deviation%20in%20%25

The most important special characters in UTF-8 coding:

For further notes on UTF-8 see also UTF-8 - Wikipedia.

Predefined Login Type

This makes the fully open login available. The user must enter all the necessary settings.

Specification of security and targetspn is optional, see: cockweb.cfg: Predefined logins (Microsoft IIS).

Integrated Windows User

Syntax:

http://<HostName>/<URL>?type=free&auth=integrated&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=freea&auth=integrated

Windows Login

Syntax:

http://<HostName>/<URL>?type=free&auth=forms&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=free&auth=forms

Default User

Syntax:

http://<HostName>/<URL>?type=free&auth=normal&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=free&auth=normal

Selectable Login

Syntax:

http://<HostName>/<URL>?type=free&auth=any&security=<security>&targetspn=<spn>

Example:

http://localhost/Cockpit10?type=free&auth=any

Optional parameters

Example:

http://localhost/Cockpit10?type=free&auth=normal&fullscreen=on

Explanation:

Login is performed using a default user. The CSP Server and the repository must be selected manually. If a report has been stored in the global starting view or in the user's personal starting view (see the online help system for Cockpit 10 and the section on Opening a repository automatically) this report is opened in fullscreen mode. The fullscreen mode can be closed.

Example:

http://localhost/Cockpit10?type=free&auth=integrated&fullscreen=lock&report=Sales

Explanation:

An integrated login is performed. The CSP Server and the repository must be selected manually. The report "Sales" is opened in fullscreen mode. The fullscreen mode cannot be closed.

Handling of Diacritics and Special Characters

Diacritics and special characters in report names must be UTF8 encoded. Example: The name of a report to be opened is: "Monatsübersicht Öffentlich".

In this case, the URL call must be as follows:

http://localhost/Cockpit10?type=free&auth=integrated&fullscreen=on&report=Monats%c3%bcbersicht%20%c3%96ffentlich

The most important special characters and German diacritics as UTF8:

You will find further notes on UTF-8 and a complete character table under UTF-8 - Wikipedia.

Executing a Local Export

You can execute a local export from a predefined repository on a specified CSP Server. Three different ways of logging into CSP Server are available.

The parameters security and target are optional, see: cockweb.cfg: Predefined logins (Microsoft IIS).

Integrated Windows User

Syntax:

http://computername>/<URL>?type=environment&server=<servername>&auth=integrated&environment=<repository>&security=<security>&targetspn=<spn>&report=<local export>

Example:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&security=Kerberos&targetspn=HOST%2fMyServer%2eMyDomain%2enet&report=MonthlyExport

Windows Login

Syntax:

http://<computername>/<URL>?type=environment&server=<servername>&environment=<repository>&auth=forms&user=<name>&pwd=<pwd>&security=<security>&targetspn=<spn>&report=<local export>

Example:

http://localhost/Cockpit10?type=environment&server=localhost&environment=pantara%20holding&auth=forms&user=Admin&pwd=Admin&report=MonthlyExport

Default User

Syntax:

http://<computer name>/<URL>?type=environment&server=<servername>&environment=<repository>&auth=normal&user=<name>&pwd=<pwd>&security=<security>&targetspn=<spn>&report=<localexport>

Example:

http://localhost/Cockpit10?type=environment&server=localhost&environment=pantara%20holding&auth=normal&user=Admin&pwd=Admin&report=MonthlyExport&mail=W.Smith@company.de

Optional Parameters

Example:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&language=DE&report=MonthlyExport&filter=Time&filtervalue=2008;2009

Explanation:

An integrated login to CSP Server "localhost" is programmed. The repository "Pantara Holding" is called. The local export "MonthlyExport" is executed. Iteration is performed across the elements "2008" and "2009" of the filter "Time.Time". The export result can be downloaded.

Example:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&report=MonthlyExport&mail=W.Smith@company.de&filter=Time&filtervalue=2008;2009

Explanation:

An integrated login to CSP Server "localhost" is programmed. The repository "Pantara Holding" is called. The local export "MonthlyExport" is executed. Iteration is performed across the elements "2008" and "2009" of the filter "Time.Time". The export result will be sent via mail to "W.Smith@company.de".

Usage of Special Characters in URLs

Special characters in the name of a repository or in the name of a report have to be transformed to UTF-8 coding.

For example: The name of the report to be opened is "Deviation in %". In this case, the URL call has to look like this:

http://localhost/Cockpit10?type=environment&server=localhost&auth=integrated&environment=pantara%20holding&report=Deviation%20in%20%25

The most important special characters in UTF-8 coding:

For further notes on UTF-8 see also UTF-8 - Wikipedia.