Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

openSession

Synopsis

SessionId openSession(StringPair[] args) throws SessionServiceFault;

See also: SessionId, StringPair, SessionServiceFault

The openSession operation is used to create a new session. As virtually all other web service operations of the Online Configurator require an open session, this operation is usually the first operation called by a client of the Online Configurator.

It is not an error if a single client simultaneously opens and works with multiple sessions.

The following options are defined for openSession:

-startup <startup-file-name>

The -startup option specifies the base name of the session start-up file. The full path name of the session start-up file is $EAIWS/etc/startup/<startup-file-name>.cfg.

-locale <locale-name>

The -locale option may be used to specify the locale used by the session. It overrides the locale specified in the session or server start-up files. For more information see sections Default Locale and setLocale.

Unknown options are ignored.

A SessionServiceFault is returned if any of the following conditions occurs:

  • The maximum number of configured or licensed sessions has been reached.

  • The <startup-file-name> does not name an existing session start-up file.

  • Numerous other errors, usually caused by incorrect configuration of the Online Configurator.