---
title: "openSession"
slug: "api/session/operations/opensession"
sidebar:
  order: 141
---

<a id="ref-b38359a85df9"></a>
<a id="ref-3c3578bbc924"></a>
<a id="ref-f008237718af"></a>

## Synopsis

```text
SessionId openSession(StringPair[] args) throws SessionServiceFault;
```

See also: [SessionId](/pCon/configuratorOnline/specs/api/session/types/sessionid#ref-02e397c8fdb4), [StringPair](/pCon/configuratorOnline/specs/api/session/types/stringpair#ref-1952c029f1cd), [SessionServiceFault](/pCon/configuratorOnline/specs/api/session/faults/sessionservicefault#ref-30a5c7817f4a)

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](/pCon/configuratorOnline/specs/guide/configuration/server-start-up-file/default-locale#ref-7c76b51fbe05) and [setLocale](/pCon/configuratorOnline/specs/api/session/operations/setlocale#ref-92d609e9dd9e).

Unknown options are ignored.

A [`SessionServiceFault`](/pCon/configuratorOnline/specs/api/session/faults/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.
