C.2. Attributes Reference

This section describes the available attributes for the SGD objects.

For each attribute, usage information is given for the Administration Console. The corresponding command line is also described, where applicable.

C.2.1. Address

Usage: Type a Domain Name System (DNS) name, or IP address, in the field.

Application server objects have this attribute.

Description

This attribute specifies the network address of the application server.

It is best to use the DNS name.

When you create a new application server object, the Name setting is automatically entered in the Address field.

You can use the Test button to validate that the DNS name or IP address is a valid network address. To enable the Test button, you must first save any changes you make to the General tab.

Command Line

Command option: --address address

Usage: Replace address with a DNS name, preferably, or an IP address.

The following example specifies the address of the application server as naples.example.com.

--address naples.example.com

C.2.2. Allow SSH Downgrade

Usage: Select or deselect the check box.

X application objects have this attribute.

Description

Defines whether SGD can try to display an X application using a regular X11 connection when SSH is used as the connection method and X11 forwarding is not configured or not working.

Command Line

Command option: --allowsshdowngrade true|false

Usage: Specify true or false.

The following example specifies that SGD can try to use an X11 connection if X11 forwarding is not available or working.

--allowsshdowngrade true

C.2.3. Answerback Message

Usage: Type a text string in the field.

Character application objects have this attribute.

Description

Defines the message to return when an inquiry is sent from the application server to the emulator.

This attribute applies to VT420 and Wyse 60 character applications only.

Command Line

Command option: --answermsg message

Usage: Replace message with the text string to use.

The following example returns the text “My message” in response to an inquiry from the application server.

--answermsg "My message"

C.2.4. Application Command

Usage: Type the full path name of the application in the field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

Description

This attribute specifies the application that runs when users click the link for the application on the webtop.

The path name must be the same on all application servers that might run the application.

For any command-line arguments, use the Section C.2.11, “Arguments for Command” attribute.

With X applications, use the Section C.2.117, “Window Manager” attribute to start a window manager for the application.

With Windows applications, you can use a backslash (\) or a forward slash (/) between subdirectories. On the command line you might need to escape backslashes, for example, \\.

With Windows applications, leave the field blank to start a full Microsoft Windows session rather than a particular application.

Command Line

Command option: --app pathname

Usage: Replace pathname with the full path name of the application. Make sure that you quote any path names containing spaces

The following example specifies a UNIX platform X application.

--app /usr/local/bin/xfinance

The following example specifies a Windows application.

--app "c:/Program Files/Example/cash.exe"

C.2.5. Application Load Balancing

Usage: Select the Override Global Setting check box, and then select an option. To use the global setting defined in the Global Settings tab, deselect the Override Global Setting box.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

Description

When the application is started, this setting determines the algorithm SGD uses to choose the application server to run the application. The server is selected from those defined on the application object's Section C.2.60, “Hosting Application Servers Tab”.

The default setting for this attribute is to use the setting defined on the Global Settings → Performance tab. You can override this by selecting the Override Global Setting check box and selecting an option.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Override Global Setting (deselected)

default

Use the default algorithm defined on the Global Settings → Performance tab.

Most Free Memory

memory

Choose the application server with the most free memory.

Least CPU Usage

cpu

Choose the application server with the most central processing unit (CPU) idle time.

Fewest Applications

sessions

Choose the application server that is running the fewest application sessions through SGD.

Note

To use the Least CPU Usage and Most Free Memory algorithms, you must install the SGD Enhancement Module on the application server.

Command Line

Command option: --loadbal default | cpu | memory | sessions

Usage: Specify a setting.

The following example uses the application server with the most free memory to run the application.

--loadbal memory

C.2.6. Application Resumability

Usage: Select an option.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines for how long a user is able to resume an application.

Administration Console

Command Line

Description

Never

never

The application can never be resumed.

Use for applications that do not provide a mechanism for the user to exit. For example, a clock application.

During the User Session

session

The application keeps running and is resumable until the user logs out of SGD.

If a user does not log out of SGD cleanly, for example, if they close their web browser or terminate the SGD Client without logging out, then applications that are user session resumable keep running for a time. See Section C.2.7, “Application Resumability: Timeout”.

This is the default setting.

General

always

The application keeps running for a time, see Section C.2.7, “Application Resumability: Timeout”, after the user logs out of SGD, and can be resumed when they next log in.

Use for applications that need to exit in a controlled way. For example, an email application that might need to remove lock files before it exits.

An X application configured with a Section C.2.127, “Window Type” setting of Local X Server is not resumable, whatever the value of the Application Resumability attribute.

Users can see if an application is resumable or not by pointing to its link on the webtop and looking at the popup window that is displayed.

The webtop has controls for suspending and resuming individual application sessions.

Command Line

Command option: --resumable never | session | always

Usage: Specify one of the valid resumability settings.

In the following example, the application is never resumable.

--resumable never

In the following example, the application is resumable until the user logs out of SGD.

--resumable session

C.2.7. Application Resumability: Timeout

Usage: Type the number of minutes you want the application to be resumable for in the field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute ensures that resources on the SGD server are used as efficiently as possible. It is used with the Section C.2.6, “Application Resumability” attribute to define when the SGD server ends a suspended application session.

Application Resumability Setting

Resumability Behavior

Never

Ignored.

During the User Session

If the user logs out of SGD, the application session ends.

If the SGD Client connection is lost, a timer starts. Once the timer reaches the value of this timeout, the SGD server ends the application session.

If an application is terminated because the SGD Client exits unexpectedly or the connection is lost, the timeout is the timeout plus 20 minutes. See Table 7.1, “Application Resumability Scenarios”.

General

If the user disconnects from the SGD server in any way, including by logging out, or if the SGD Client connection is lost, a timer starts. Once the timer reaches the value of this timeout, the SGD server ends the application session.

If an application is terminated because the SGD Client exits unexpectedly or the connection is lost, the timeout is the timeout plus 20 minutes. See Table 7.1, “Application Resumability Scenarios”.

If you leave this setting blank, the default timeout for the Application Resumability attribute is used. You can configure the default timeouts on the Global Settings → Communication tab of the Administration Console.

Command Line

Command option: --resumetimeout mins

Usage: Replace mins with the number of minutes you want the application to be resumable for.

The following example configures the application to be resumable for at least 30 minutes. This timeout is appropriate for an application configured to be resumable During the User Session.

--resumetimeout 30

C.2.8. Application Sessions Tab

Usage: Use the buttons in the Application Sessions tab to view and manage application sessions.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

  • User profile

  • Application server

  • Dynamic application

Description

This tab lists the running and suspended application sessions for the selected object. An application session represents an application running on an application server on behalf of a user.

To show more details about an application session, select the check box for the application session in the Application Session List table and click the View Details button.

To end an application session, select the check box for the application session in the Application Session List table and click the End button.

To shadow an application session, select the check box for the application session in the Application Session List table and click the Shadow button. Suspended applications or character applications cannot be shadowed.

Note

In some countries, it is illegal to shadow a user without their knowledge. It is your responsibility to comply with the law.

The Reload button refreshes the Application Session List table.

You can use the Search options to search the Application Session List table. The number of results returned by a search is limited to 150, by default. When searching for a User Identity, User Profile, Secure Global Desktop Server, or Application Server, you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. The Start Time search option enables you to search for application sessions that were started between a range of times that you specify. The format of each time specified is yyyy/mm/dd hh:mm:ss. Use one of the following formats to specify the range:

  • starttime - endtime

    For example, 2010/05/11 08:00:00 - 2010/05/11 17:00:00.

    Searches for application sessions that were started between the specified times.

  • starttime-

    For example, 20010/05/11 08:00:00-.

    Searches for application sessions that were started on or after the specified time.

  • -endtime

    For example, -2010/05/11 08:00:33.

    Searches for application sessions that were started before the specified time.

Command Line

On the command line, use the tarantella emulatorsession commands to list, end, or shadow application sessions. See Section D.18, “tarantella emulatorsession”.

Command option: tarantella emulatorsession list --person pobj

Usage: Replace pobj with the user identity of the user.

The following example lists application sessions for the Indigo Jones user profile object.

tarantella emulatorsession list --person \
"o=Example/ou=IT/cn=Indigo Jones"

C.2.9. Application Start

Usage: Select or deselect the check box.

Application server objects have this attribute.

Description

This attribute specifies whether applications can run on this application server.

Selecting the check box allows applications to run. The check box is selected by default. An application is started on the application server only if both of the following are true:

Deselecting the check box means that no new applications can be started on the application server. Making an application server unavailable does not affect applications that are already running. If a user has a suspended application session on the application server and the application is set up to be always resumable, the user can resume their session.

You can use this attribute, for example, to make an application server temporarily unavailable while you carry out maintenance work. If the application server is the only server configured to run a particular application, then the application is not available to users.

Command Line

Command option: --available true | false

Usage: Specify true or false.

The following example enables the application server object to run applications.

--available true

C.2.10. Arguments

Usage: Type Remote Desktop Client command-line arguments in the field.

Windows application objects have this attribute.

Description

This attribute specifies command-line arguments to use for the SGD Remote Desktop Client (ttatsc).

See Section 4.1.9, “The SGD Remote Desktop Client” for details of the supported command-line arguments.

Command Line

Command option: --protoargs args

Usage: Replace args with the command-line arguments for the RDP protocol.

The following example configures high audio quality for the Windows application.

--protoargs "-audioquality high"

C.2.11. Arguments for Command

Usage: Type the command-line arguments for the application in the field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies the command-line arguments to use when starting the application. The Section C.2.4, “Application Command” attribute specifies the application that runs, without arguments.

For X applications, do not include the -display argument. The display is set automatically for each user.

Command Line

Command option: --args args

Usage: Replace args with the command-line arguments for the application. Make sure you quote the arguments.

The following example runs the application with command-line arguments to set the background color to “plum4”.

--args "-bg plum4"

C.2.12. Assigned Applications Tab

Usage: To assign applications to a user profile, organization, or organizational unit object, click the Add button in the Editable Assignments table.

To delete applications for a user profile, organization, or organizational unit object, use the Delete button in the Editable Assignments table.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

Description

The Assigned Applications tab lists the applications that are assigned to the selected user profile, organizational unit, or organization.

This attribute defines a series of application links available to the user. Each link is stored as a reference to the application object, so the same application object can be assigned to many users. If an object is moved or renamed later, all references to the object are automatically updated.

If a group of applications is added to an Assigned Applications tab, the group's members and not the group are assigned.

User profile objects and organizational unit objects can inherit applications from their parent in the organizational hierarchy. See Section C.2.62, “Inherit Assigned Applications from Parent”. To inherit applications assigned to the parent object, select the Inherit Assigned Applications from Parent check box in the Editable Assignments area.

The following sections of the Assigned Applications tab are used to display, select, and assign applications:

  • Effective Applications table

  • Editable Assignments table

Effective Applications Table

The Effective Applications table shows all the application objects that are assigned to the selected object. The Local Assignments section of the table lists applications that are selected from the local repository.

The Assignment Type column shows one of the following:

  • Direct. The assignment was made using the Editable Assignments table.

  • Indirect. The assignment is the result of another relationship, such as membership of a group, or inheritance from another object.

  • Multiple. The assignment has multiple sources, both Direct and Indirect.

If an assignment type is Indirect or Multiple, clicking the See Details link displays information that enables you to trace the origin of the link.

Editable Assignments Table

You can use the Editable Assignments table to select applications from the local repository.

Click the Add button in the Editable Assignments table. The Add Application Assignment window is shown.

To select applications in the Add Application Assignment window, do either of the following:

  • Browse the Navigation Tree. As you browse the tree, the Content Area is updated with applications.

  • Use the Search Applications field. Use this field to search for applications. Type in the names of applications in the field. Note that you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. Results of the search are displayed in the Search Results table in the Content Area. The number of results returned by a search is limited to 150, by default.

Select the required applications from those listed in the Content Area. When you have finished selecting applications click the Add button.

The selected applications are displayed in the Effective Applications table of the Assigned Applications tab.

To delete applications from the Assigned Applications tab, use the Delete button in the Editable Assignments table.

Command Line

Command option: --links object

Usage: Replace object with the full name of the object. For example, "o=applications/ou=Finance/cn=XClaim". Make sure that you quote any object names containing spaces.

The following example adds Pers-o-dat and Slide-o-win as links on a webtop.

--links "o=applications/cn=Pers-o-dat" \
        "o=applications/cn=Slide-o-win"

C.2.13. Assigned User Profiles Tab

Usage: To assign user profiles to an application, click the Add button in the Editable Assignments table. If you are using SGD with a Lightweight Directory Access Protocol (LDAP) directory, you can also use the LDAP Searches area of the Assigned User Profiles tab to search for users in your LDAP directory server.

The following objects have this attribute:

  • Character application

  • Document

  • Group

  • Organizational Unit

  • Windows application

  • X application

  • 3270 application

  • 5250 application

  • Dynamic application

Description

Use this tab to define the user profile objects that can run an application, or group of applications. The application, or group of applications, is in addition to any applications already defined for the user profile in its Assigned Applications tab.

User profile objects can be selected from the local repository. If you are using an LDAP directory, you can also select the following:

  • Users in the LDAP directory

  • Groups of users in the LDAP directory

  • Users in the LDAP directory that match an LDAP search criteria

The following sections of the Assigned User Profiles tab are used to display, select and assign user profile objects:

  • Effective User Profiles table

  • Editable Assignments table

  • LDAP Searches section

Effective User Profiles Table

The Effective User Profiles table shows all the user profile objects that are assigned to the application.

The Local Assignments section of the table lists user profiles that are selected from the local repository.

The LDAP Assignments section of the table lists users and groups that are selected from an LDAP directory. This section is only shown if the Local + LDAP setting is selected for the Repository field in the User Profiles tab. You can click the Load LDAP Assignments link to refresh this area of the table.

The Assignment Type column shows one of the following:

  • Direct. The assignment was made using the Editable Assignments table.

  • Indirect. The assignment is the result of another relationship, such as an LDAP search, membership of a group, or inheritance from another object.

  • Multiple. The assignment has multiple sources, both Direct and Indirect.

If an assignment type is Indirect or Multiple, clicking the See Details link displays information that enables you to trace the origin of the link.

Editable Assignments Table

You can use the Editable Assignments table to select user profile objects from the local repository, and, if you are using LDAP authentication, users, or groups in an LDAP directory.

Click the Add button in the Editable Assignments table. The Add User Assignment window is shown.

The Add User Assignment window can be used to select the following:

  • User profiles from the local repository

  • Users in an LDAP directory

  • Groups in an LDAP directory

To use the local repository, select the Local option in the Repository list.

To use the local repository and your LDAP directory server, select the Local + LDAP option in the Repository list.

To select user profiles in the Add User Assignment window, do either of the following:

  • Browse the Navigation Tree. As you browse the tree, the Content Area is updated with user profiles.

  • Use the Search User Profiles field. Use this field to search the user profiles within the selected repositories. You can type in names of users and groups in your LDAP directory. Note that you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. Results of the search are displayed in the Search Results table in the Content Area. The number of results returned by a search is limited to 150, by default. The Matched Attribute field of the Search Results table indicates the LDAP attribute that the search matched on.

Select the required user profiles from those listed in the Content Area. When you have finished selecting user profiles, click the Add button.

The selected user profiles are displayed in the Effective User Profiles table of the Assigned User Profiles tab.

To delete applications you have added to the Assigned User Profiles tab, use the Delete button in the Editable Assignments table.

LDAP Searches Section

The LDAP Searches section is used to define search criteria for locating users in an LDAP directory. You can use this feature to assign an application or group of applications to all users in an LDAP directory that match the search criteria.

The search criteria can be either of the following:

  • An RFC2254-compliant LDAP search filter

  • An RFC1959-compliant LDAP URL

For an RFC2254 search filter, enclose each search criteria in double quotes and brackets.

For an LDAP URL, use the format ldap:///search-criteria. If you include the host, port and return attribute specification in the URL they are ignored. This is because the LDAP directory server configured as part of SGD authentication is used.

The LDAP Search area includes two options:

  • Simple Search. This option enables an area where you can “build” a simple LDAP search filter using the window controls. In the Filter Components table, select the attributes you want to match and define search criteria for them.

  • Advanced Search. This option displays a field where you can type in an LDAP URL or search filter.

The Simple Search option is designed for creating LDAP search filters that are based on attributes such as cn and uid. The Advanced Search option enables you to create more complex LDAP search filters.

As you build a simple search, the LDAP filter string is shown in gray text in the Advanced Search area. If you then select the Advanced Search option, the LDAP filter string can be edited. This enables you to start with a simple search and then edit the search string manually to specify an advanced search.

You cannot revert to a simple search after specifying an advanced search that is incompatible with the capabilities of the simple search. You must delete the advanced search and re-enter the simple search.

To specify where in the LDAP directory to start searching from, click the Browse button next to the Search Root field. You can then use the Select Root for LDAP Search window to browse or search for a location in the LDAP directory. Selecting a new Search Root loads a new LDAP URL. The new URL is indicated next to the Browse button and in the Advanced Search box.

Select the Search Filter options to specify the attributes you want to match in your search. You can choose to match all of the attributes (Match All), any of the attributes (Match Any), or none of the attributes (Match None).

Note

The Administration Console does not automatically escape the special characters specified in RFC2254. To use a special character in the Administration Console, you must manually type the escape sequence. For example, to search for a user with the common name “John Doe (123456)”, type the following cn=John Doe\0x28123456\0x29 in the search field. The command line does escape the special characters.

SGD supports the use of extensible matching search filters as specified in RFC2254. This enables you to look up information from components that make up an object's distinguished name (DN). For example, to assign an application to a user that is contained within any OU called managers (ou=managers), you can use a (&(ou:dn:=managers)) search filter.

As you configure LDAP searches, use the Preview button to check that the search returns the expected results.

To save the LDAP search definition, click the Save button.

Click the Load LDAP Assignments link in the Effective User Profiles tab. The user profiles from the LDAP search are displayed in the LDAP Assignments section of the Effective User Profiles table.

Command Line

On the command line, make sure that you quote any object names containing spaces.

C.2.13.1. LDAP Users

Command option: --ldapusers user_dn

Usage: Enter one or more DNs of users in an LDAP directory.

The following example assigns the application or groups of applications to users with the UID “violet” in the Sales department and the UID “emmarald” in the Marketing department.

--ldapusers uid=violet,ou=Sales,dc=example,dc=com \
uid=emmarald,ou=Marketing,dc=example,dc=com

C.2.13.2. LDAP Groups

Command option: --ldapgroups group_dn

Usage: Enter one or more DNs of groups in an LDAP directory.

If your organization uses nested groups (sub-groups), you might need to change the depth of the group search.

The following example assigns the application or groups of applications to users in the managers group in the Sales and Marketing departments.

--ldapgroups cn=managers,ou=Sales,dc=example,dc=com \
cn=managers,ou=Marketing,dc=example,dc=com

C.2.13.3. LDAP Search

Command option: --ldapsearch search_string

Usage: Enter one or more LDAP search strings.

The following example assigns the application or groups of applications to any manager in the Sales department and anyone who has Violet Carson as their manager.

--ldapsearch "(&(job=manager)(dept=Sales))" \
"(manager=Violet Carson)"

The following example assigns the application or groups of applications to any manager in the Sales department of example.com.

--ldapsearch "ldap:///ou=Sales,dc=example,dc=com??sub?job=manager"

C.2.14. Attribute Map

Usage: Type the full path name of the attribute map in the field.

Character application objects have this attribute.

Description

This attribute specifies the attribute map to use for the application. This maps attributes such as bold and underline to colors.

To use the default attribute map, leave the setting blank.

An example attribute map is installed in /opt/tarantella/etc/data/attrmap.txt.

Command Line

Command option: --attributemap attrmap

Usage: Replace attrmap with the full path name of the attribute map to use.

The following example uses the named attribute map.

--attributemap /opt/tarantella/etc/data/myattrmap.txt

C.2.15. Audio Redirection Library

Usage: Select or deselect the check box.

X application objects have this attribute.

Description

This attribute specifies whether the application enables the SGD audio redirection library.

Some X applications are hard-coded to use the /dev/audio or /dev/dsp devices for audio output. Enabling the audio redirection library causes the application to use the device specified by the SGDAUDIODEV environment variable instead.

Command Line

Command option: --unixaudiopreload true | false

Usage: Specify true or false.

The following example enables the audio redirection library for the application.

--unixaudiopreload true

C.2.16. Background Color

Usage: Type a valid color resource, such as yellow, in the field.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies the background color of the application's text window.

X11 color names are supported.

Command Line

Command option: --3270bg color

Command option: --bg color

Usage: Replace color with a valid color resource, such as yellow.

In the following example, the background color of the 3270 application text window is set to the color plum4.

--3270bg plum4

In the following example, the background color of the 5250 application text window is set to the color plum4.

--bg plum4

C.2.17. Bandwidth Limit

Usage: Select the maximum bandwidth from the list.

User profile objects have this attribute.

Description

This attribute specifies the maximum bandwidth a user can use between the client device and the SGD server for X and Windows applications.

Select None to specify no limit. The user can then use as much of the available bandwidth as possible. This gives the best application usability for the speed of the network connection.

You do not need to change this unless you have particular bandwidth restrictions. For normal use, use None.

The table below shows the bandwidth settings in the Administration Console and the equivalent values to use on the command line.

Administration Console

Command Line

2400 bps

2400

4800 bps

4800

9600 bps

9600

14.4 Kbps

14400

19.2 Kbps

19200

28.8 Kbps

28800

33.6 Kbps

33600

38.8 Kbps

38800

57.6 Kbps

57600

64 Kbps

64000

128 Kbps

128000

256 Kbps

256000

512 Kbps

512000

768 Kbps

768000

1 Mbps

1000000

1.5 Mbps

1500000

10 Mbps

10000000

None

0

Command Line

Command option: --bandwidth bandwidth

Usage: Replace bandwidth with the maximum bandwidth, in bits per second.

The following example limits the user to a maximum bandwidth of 512 kilobits per second.

--bandwidth 512000

The following example enables the user to use as much of the available bandwidth as possible.

--bandwidth 0

C.2.18. Border Style

Usage: Select an option.

Character application objects have this attribute.

Description

This attribute determines whether the terminal window has a raised, indented, or “flat” (normal) appearance.

Command Line

Command option: --border normal | indented | raised

Usage: Specify the border style you want.

In the following example, the terminal window has a raised appearance.

--border raised

C.2.19. Client Drive Mapping

Usage: Use the Client Drive Mapping table to create client drive mapping (CDM) specifications. Use the Add, Edit and Delete buttons to create, edit and remove CDM specifications. Order the specifications using the Move Up and Move Down buttons. Any CDM specifications you create are listed in the Mappings Defined Directly section of the Client Drive Mapping table.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

This attribute defines the drives on their client device that a user can access from applications running on Microsoft Windows, UNIX, and Linux platform application servers.

Using this attribute, you configure the client drives you want users to access for user profiles, organizational unit, and organization objects. CDM uses inheritance. You define access to client drives at an organization level, which you can override at an organizational unit level or user profile level. By default, users have read and write access to all drives.

For Windows applications, you can configure application-specific client drive access with this attribute.

For Windows application objects, this setting overrides the CDM configuration for organization, organizational unit, or user profile objects. The order of precedence for CDM configuration is: Windows application → user profile → organizational unit → organization.

The Client Drive Mapping attribute is an ordered list of drive mapping specifications. Each specification includes the following:

  • The client drive letter or type

  • The access rights to grant to the client drive

Note

The first matching entry in the list is used, so make sure that the most specific settings, for example A or B, appear before more general settings, for example All Drives.

The following tables show the available options for each part of a drive mapping specification, and the corresponding value to use on the command line.

The following Client Device Drive options are available.

Administration Console

Command Line

All Drives

alldrives

Fixed Drives

fixeddrives

R/W Removable

rw

R/O Removable

ro

Network Drives

networkdrives

Removable Devices

removable

A:, B: ... Z:

a, b ... z

Note

Client Device Drive options that specify a drive letter, such as A:, are only supported for Microsoft Windows client devices.

The following Access Rights options are available.

Administration Console

Command Line

Read Only

ro

Read/Write

rw

None

none

Command Line

Command option: --cdm drive_spec

Usage: Replace drive_spec with a drive mapping specification of the form clientdrive:access. For example, a:rw. Separate each drive_spec with the pipe character, (|).

For a user profile object, the following example means the user is given read-write access to drive A on their client device, and also has read-write access to all network drives defined on their client device. The same drive letter is used on the client device.

--cdm 'a:rw|networkdrives:rw'

The user might have access to other drives, for example a fixed drive C, depending on the Client Drive Mapping attributes for the user profile object's ancestors in the organizational hierarchy, or any Client Drive Mapping attributes configured for a specific Windows application object.

C.2.20. Client Printing

Usage: Select an option.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

Controls the client printers that users can print to when printing from Windows applications.

This attribute can only be edited using the Administration Console if Section C.2.21, “Client Printing: Override” is enabled for the object.

The setting for this attribute overrides the following:

  • The setting for a parent object in the organizational hierarchy.

  • The default setting configured on the Global Settings → Printing tab of the Administration Console, if no parent object configuration exists.

  • For Windows application objects, this setting overrides the printing configuration for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

If you select No Printer, you can still use an SGD PDF printer.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

All Printers

2

Let users print to all client printers

Default Printer

1

Let users print to client's default printer

No Printer

0

No client printers are available

If users can only print to their default printer and they want to print to a different printer, they have to log out of SGD, change the default printer and then log in again.

Command Line

Command option: --mapprinters 2|1|0

Usage: Specify a valid setting.

The following example enables users to print only to their default client printer.

--mapprinters 1

C.2.21. Client Printing: Override

Usage: For user profile objects or organizational unit objects, select the Override Parent's Settings check box. To use the setting defined for the parent object, deselect the Override Parent's Settings check box.

For organization or Windows application objects, select the Override Global Settings check box. To use the default setting defined in the Global Settings → Client Device tab, deselect the Override Global Settings check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

Enables user-specific or application-specific printing configuration. This configuration is used when printing from Windows applications.

For user-specific printing configuration, client printing override is enabled for a user profile, organizational unit, or organization object. In this case, the printing settings for the object override the following:

  • The printing settings for a parent object in the organizational hierarchy.

  • The default printing settings configured on the Global Settings → Printing tab of the Administration Console, if no parent object printing configuration exists.

For application-specific printing configuration, client printing override is enabled for a Windows application object. In this case, the printing settings for the object override the following:

  • The printing settings for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

  • The default printing settings configured on the Global Settings → Printing tab of the Administration Console.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

Command Line

Command option: --userprintingconfig 1|0

Command option: --appprintingconfig 1|0

Usage: Specify 1 (true) or 0 (false).

The following example enables user-specific printing configuration.

--userprintingconfig 1

The following example enables application-specific printing configuration for a Windows application object.

--appprintingconfig 1

C.2.22. Client Profile Editing

Usage: For user profile objects or organizational unit objects, select the Override Parent's Setting check box and then select or deselect the Enabled option. To use the setting defined for the parent object, deselect the Override Parent's Setting check box.

For organization objects, select the Override Global Setting check box and then select or deselect the Enabled option. To use the default setting defined in the Global Settings tab, deselect the Override Global Setting check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

Description

This attribute controls whether or not users can create and edit profiles for use with the SGD Client.

Note

Profile editing must also be enabled on the Global Settings → Client Device tab of the Administration Console.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Override Parent's Setting (deselected)

2

User profile objects or organizational unit objects. Use the setting inherited from the parent object.

This is the default setting.

Override Global Setting (deselected)

2

Organization objects. Use the global setting.

This is the default setting.

Enabled (selected)

1

Enable client profile editing.

Enabled (deselected)

0

Disable client profile editing.

For user profile objects or organizational unit objects, deselect the Override Parent's Setting check box to inherit the setting of a parent object in the organizational hierarchy. This is used to enable or disable profile editing for many users without having to edit each user profile object.

For organization objects, deselect the Override Global Setting check box to use the default setting configured on the Global Settings → Client Device tab of the Administration Console.

SGD checks the user profile object for the user and then any parent object further up the organizational hierarchy to see whether profile editing is enabled or disabled. If all the objects selected are configured to use the parent's setting, then the default setting is used.

If profile editing is disabled for a user profile object in the System Objects organization, for example o=Tarantella System Objects/cn=UNIX User Profile, this affects all users who are assigned that profile.

By default, profile editing is enabled.

Command Line

Command option: --editprofile 2|1|0

Usage: Specify a valid setting.

The following example disables profile editing.

--editprofile 0

C.2.23. Code Page

Usage: Select an option.

Character application objects have this attribute.

Description

This attribute specifies the code page you want to use for the emulator. Different code pages are available for different types of character application.

Application Type

Code Pages Available

SCO Console

  • 437 - International

  • 850 - Multilingual

  • 852 - Central Europe

  • 860 - Portuguese

  • 863 - Canadian-French

  • 865 - Danish-Norwegian

VT420

  • 8859-1 - ISO Latin 1

  • 8859-2 - ISO Latin 2

Wyse 60

  • Multinational

  • Mazovia

  • CP852

Command Line

Command option: --codepage 437 | 850 | 852 | 860 | 863 | 865 | 8859-1 | 8859-2 | Multinational | Mazovia | CP852

Usage: Specify a valid setting for the type of character application.

The following example uses the ISO 8859-1 code page, appropriate for a VT420 application.

--codepage 8859-1

C.2.24. Color Depth

Usage: Select a setting from the list.

The following objects have this attribute:

  • X application

  • Windows application

Description

The color depth for the application. As the number of colors increases, more memory is required on the SGD server and on the client device, and more network bandwidth is used between them.

X Applications

The 16/8-bit, 24/8-bit, 8/16-bit, and 8/24-bit settings enable you to support X applications with multiple color depths. For example, if you need to run an 8-bit application in a 16-bit or 24-bit high color X application session, such as a Common Desktop Environment (CDE) desktop, use either the 16/8-bit or the 24/8-bit setting.

Changing these settings can affect system performance as follows:

  • Increases the amount of memory used on the SGD server compared to an application using a single color depth.

    The amount of extra memory used for each setting is as follows:

    • The 8/16 setting uses 200% more memory

    • The 8/24 setting uses 400% more memory

    • The 16/8 setting uses 50% more memory

    • The 24/8 setting uses 25% more memory

  • Increases the amount of bandwidth used.

  • Degrades performance over low bandwidth connections.

To reduce network bandwidth at greater color depths for X applications, change the Section C.2.26, “Color Quality” setting.

Windows Applications

SGD supports 8-bit, 16-bit, 24-bit, and 32-bit color depths in a Windows Remote Desktop Services session. 32-bit color depths are supported for Windows Server 2008 and later versions.

If the application server is configured to use a lower color depth than the color depth configured for the application object, SGD automatically adjusts the color depth to match the server setting.

The 24/32-bit setting means that the color depth is 32-bit on platforms that support 32-bit color. For other platforms, the application is displayed using 24-bit color.

Command Line

Command option: --depth 8 | 16 | 24 | 16/8 | 24/8 | 8/16 | 8/24 | 24/32

Usage: Specify a valid setting.

The 16/8-bit, 24/8-bit, 8/16-bit, and 8/24-bit settings apply only to X applications.

The 24/32-bit setting applies only to Windows applications.

The following example sets the color depth for the application to 16-bit color (thousands of colors).

--depth 16

C.2.25. Color Map

Usage: Type the full path name of the color map in the field.

Character application objects have this attribute.

Description

This attribute specifies the color map to use for the application. A color map maps logical colors such as Color_1, Color_2 and so on, to displayed colors.

To use the default color map, /opt/tarantella/etc/data/colormap.txt, leave the setting blank.

Command Line

Command option: --colormap colormap

Usage: Replace colormap with the full path name of the color map to use.

The following example uses the named color map.

--colormap /usr/local/maps/mycolormap.txt

C.2.26. Color Quality

Usage: Select a setting from the list.

X application objects have this attribute.

Description

The effective color depth displayed on client devices. Reducing color quality reduces bandwidth usage, but also reduces the number of colors that can be displayed.

Note

If the Section C.2.24, “Color Depth” is set to 8-bit, this attribute is not available. If the Color Depth is set to 16-bit, only the 16-bit, 15-bit, 12-bit, 9-bit, and 6-bit settings are available.

The default setting Best at Application Start fixes the color depth at the most appropriate setting according to network conditions at the time the user starts the application. The color depth does not change while the session is running.

Specify Adjust Dynamically to enable the quality level to change at any time during the session, depending on network conditions. This setting works within the following ranges:

  • 24 bit images – 12 to 24-bit color

  • 16 bit images – 12 to 16-bit color

The following table shows the effect on color quality of using a numeric quality setting.

Color Quality Setting

Approximate Color Quality for 16-bit Applications

Approximate Color Quality for 24-bit Applications

24

-

100%

21

-

88%

18

-

75%

16

100%

67%

15

94%

63%

12

75%

50%

9

56%

38%

6

38%

25%

The physical color quality of the client device is not forced to match that of the X session. If a 24-bit color session is being displayed on an 8-bit client device, the client dithers the image locally so that the session can be displayed reasonably.

Command Line

Command option: --quality automatic|best|24|21|18|16|15|12|9|6

Usage: Specify a valid setting.

The following example sets the color quality to 12-bit color. If the Section C.2.24, “Color Depth” is set to 24-bit, this reduces color quality to approximately 50% on client devices.

--quality 12

C.2.27. Command Compression

Usage: Select an option.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

  • Character application

Description

This attribute determines whether the Adaptive Internet Protocol (AIP) compresses commands for transmission.

Select Adjust Dynamically to allow compression to be turned on or off at any stage, according to the network conditions.

With some applications, compression incurs a greater overhead than transmitting commands uncompressed. Turn off compression for these applications.

Command Line

Command option: --compression automatic|on|off

Usage: Specify a valid option.

The following example disables AIP command compression.

--compression off

C.2.28. Command Execution

Usage: Select an option.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.

Select Adjust Dynamically to allow the network conditions to determine the setting.

For some applications, for example those that use animation, the order that commands are executed is critical.

Command Line

Command option: --execution automatic|inorder|optimized

Usage: Specify a valid option. When listing object attributes on the command line, the following applies:

  • The inorder attribute value is displayed as on

  • The optimized attribute value is displayed as off

The following example executes commands in the order they occur.

--execution inorder

C.2.29. Comment

Usage: Type a description of the object in the field.

The following objects have this attribute:

  • Character application

  • Document

  • Group

  • Application server

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

  • X application

  • 3270 application

  • 5250 application

  • Dynamic application

  • Dynamic application server

Description

This attribute describes the object. Use this as an optional comment field for administrator notes

Descriptions can include any characters you want.

Command Line

Command option: --description text

Usage: Replace text with a description of the object. Ensure that you quote any descriptions containing spaces.

The following example describes the object. You might use this description with a document object, for example.

--description "The intranet for Example"

C.2.30. Connection Closed Action

Usage: Select a telnet close option.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies the course of action to be taken by the TeemTalk for Unix emulator when the telnet connection to the application server is closed.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Prompt User for Action

0

Prompt the user to choose to either reconnect, close the connection or exit the emulator.

Reconnect

2

Attempt to reconnect to the 3270 application server.

Close Connection

3

Close the connection.

Exit Emulator

1

Exit the TeemTalk for Unix emulator. The SGD application session is terminated.

Command Line

Command option: --3270tn 0|1|2|3

Command option: --tn 0|1|2|3

Usage: Specify one of the valid telnet close options.

The following example exits the emulator when the telnet connection to the 3270 application server is closed.

--3270tn 1

The following example exits the emulator when the telnet connection to the 5250 application server is closed.

--tn 1

C.2.31. Connection Method

Usage: Select a connection method option.

The following objects have this attribute:

  • Character application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies the mechanism used by the SGD server to access the application server and start the application.

The default connection method is ssh.

Command Line

Command option: --method ssh | telnet

Usage: Specify one of the valid connection methods.

The following example uses the telnet connection method to log in to an application server.

--method telnet

C.2.32. Connections

Usage: Create as many connection type specifications as you need, using the Connection Definitions table. Use the Add, Edit, and Delete buttons to create, modify, and delete connections. Order the connections using the Move Up and Move Down buttons.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

Description

This attribute defines, for ranges of DNS names or IP addresses, the connections that are allowed between the client device and the SGD server.

Once a user is logged in to an SGD server, the DNS names and IP addresses of the client device and the SGD server are used to determine the type of connection. First, the Connections attribute for the user profile object is selected. If no matching entry exists, the parent organizational unit's Connections attribute is selected, and so on up the organizational hierarchy to the organization object.

If no matching entry for the organization object is found, the user is given the best available connection.

Processing of connection types is turned off by default, enabling users to log in more quickly. You can turn on processing of connection types on the Security tab in the Global Settings → Security tab of the Administration Console.

The Connections attribute is an ordered list of connection type specifications. Each specification names the following:

  • The DNS name or IP address of a client device. Use the wildcards ? and * to match more than one client device.

  • The DNS name or IP address of an SGD server. Use the wildcards ? and * to match more than one SGD server.

  • The connection type.

In all cases, DNS names or IP addresses are considered from the perspective of the SGD server. They are peer DNS names and IP addresses. If your network is configured to use different names on each side of a firewall, you must use the names on the side of the SGD servers for this attribute.

The following connection types are available.

Administration Console

Command Line

Notes

Standard

STD

Always available.

Secure

SSL

Gives users a secure connection between their client device and the SGD server. The connection uses Secure Sockets Layer (SSL).

Only available if SGD security services are enabled. If not, users configured to receive secure connections are given standard connections instead.

Note

If security services have been enabled on the SGD server, all connections are secure until the user logs in. Once the user is known, the connection can be downgraded.

Command Line

Command option: --conntype type_spec

Usage: Replace type_spec with a connection type specification of the form: client:server:type. For example, 192.168.5.*:*:STD.

Separate each type_spec with the "pipe" character, |.

The following example, for a user profile object, means the user is given a secure connection to all SGD servers if the client device has an IP address that starts 192.168.5, and a standard connection for all other client devices.

--conntype '192.168.5.*:*:SSL|*:*:STD'

For an organizational unit or an organization object, these connection type specifications are used only if no match is found for the client device and SGD server in the user profile object's Section C.2.32, “Connections” attribute.

C.2.33. Connection Method: SSH Arguments

Usage: Select the ssh Connection Method option and type the ssh command-line arguments in the field.

The following objects have this attribute:

  • Character application

  • X application

  • 3270 application

  • 5250 application

Description

The attribute enables you to specify the command-line arguments for the ssh client when the Section C.2.31, “Connection Method” for an application is ssh.

See Section 4.6, “Using SSH” for information on using ssh with SGD.

Command Line

Command option: --ssharguments args

Usage: Replace args with the ssh command-line arguments.

The following example configures the ssh client to use the -X command-line option when using the application. This enables X11 forwarding.

--ssharguments "-X"

C.2.34. Console Mode

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

Enabling this attribute starts the Windows application in console mode.

For Windows 2003 versions, the application connects to a user console session on the Windows application server. This is equivalent to using the /console option of the mtsc.exe (Microsoft Terminal Services Client) program.

For Windows 2008 and later versions, the application connects to an administrator mode console session on the Windows application server. This is equivalent to using the /admin option of the mtsc.exe program.

Command Line

Command option: --console 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example enables console mode.

--console 1

C.2.35. Copy and Paste

Usage: For user profile objects or organizational unit objects, select the Override Parent's Setting check box and then select or deselect the Enabled option. To use the setting defined for the parent object, deselect the Override Parent's Setting check box.

For organization objects, select the Override Global Setting check box and then select or deselect the Enabled option. To use the default setting defined in the Global Settings → Client Device tab, deselect the Override Global Setting check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

Description

This attribute controls whether users can use copy and paste in Windows or X application sessions.

For user profile objects or organizational unit objects, deselect the Override Parent's Setting check box to inherit the setting of a parent object in the organizational hierarchy. This is used to enable or disable copy and paste for many users without having to edit each user profile object.

For organization objects, deselect the Overrride Global Setting check box to use the default setting configured on the Global Settings → Client Device tab of the Administration Console.

When a user starts an application, SGD checks the user profile object for the user and then any parent object further up the organizational hierarchy to see whether copy and paste is enabled or disabled. If all the objects selected are configured to use the parent's setting, then the default setting is used.

By default, copy and paste is enabled.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Override Parent's Setting (deselected)

2

User profile objects or organizational unit objects. Use the setting inherited from the parent object.

This is the default setting.

Override Global Setting (deselected)

2

Organization objects. Use the global setting.

This is the default setting.

Enabled (selected)

1

Enable copy and paste.

Enabled (deselected)

0

Disable copy and paste.

Changes to this attribute only take effect for new application sessions.

Command Line

Command option: --clipboard 2|1|0

Usage: Specify a valid setting.

The following example disables copy and paste for a user's Windows or X application sessions.

--clipboard 0

C.2.36. Copy and Paste: Application's Clipboard Security Level

Usage: Select the Enabled check box and type a number in the field.

The following objects have this attribute:

  • Windows application

  • X application

Description

This attribute is used to control user copy and paste operations in Windows or X application sessions.

Use this attribute to specify a security level. The security level can be any positive integer. The higher the number, the higher the security level.

You can only copy and paste data to an application if the application has the same security level or higher as the source application. The source application is the application the data was copied from.

SGD Clients also have a security level. You can only copy and paste data to applications running on the client device if the client has the same security level or higher as the source application. See Section A.6.12, “Client's Clipboard Security Level”.

The default security level is 3.

Changes to this attribute only take effect for new application sessions.

Command Line

Command option: --clipboardlevel level

Usage: Replace level with the security level. Specify -1 to disable copy and paste operations for the application object.

The following example sets the security level for an application to 5. You can only copy and paste data to this application if the source application or SGD Client has a security level of 5 or less.

--clipboardlevel 5

C.2.37. Cursor

Usage: Select a cursor style option.

Character application objects have this attribute.

Description

This attribute specifies how you want the cursor to appear within the application.

Command Line

Command option: --cursor off | block | underline

Usage: Specify the cursor style you want.

The following example uses an underline for the cursor.

--cursor underline

C.2.38. Cursor Key Codes Modification

Usage: Select or deselect the check box.

Character application objects have this attribute.

Description

This attribute specifies the behavior of the cursor keys. It determines whether they always generate cursor movement codes, or whether the application changes the codes generated by the cursor keys.

This attribute applies to VT420 character applications only.

Command Line

Command option: --cursorkeys application | cursor

Usage: Specify the cursor key behavior you want.

In the following example, the cursor keys always generate cursor movement codes.

--cursorkeys cursor

C.2.39. Cursor Settings

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to enable mouse pointer schemes and customizations for the Windows application. Disabling these features can improve performance.

Command Line

Command option: --disablecursorsettings 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables mouse pointer schemes and customizations.

--disablecursorsettings 1

C.2.40. Cursor Shadow

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to show the mouse pointer shadow for the Windows application. Disabling the mouse pointer shadow can improve performance.

Command Line

Command option: --disablecursorshadow 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables the mouse pointer shadow.

--disablecursorshadow 1

C.2.41. Delayed Updates

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies whether delayed updates of the display are enabled. This accumulates changes and can improve performance.

If your application's display must always be exact, deselect the check box. To improve performance, turn off delayed updates for animation.

Command Line

Command option: --delayed true|false

Usage: Specify true or false.

The following example enables delayed updates of the application's display.

--delayed true

C.2.42. Desktop Wallpaper

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to enable or disable the wallpaper for a Windows application, such as a Windows desktop session. Disabling the wallpaper can improve performance, by reducing the amount of data that is updated when users move items around the screen.

Command Line

Command option: --disablewallpaper 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables the wallpaper.

--disablewallpaper 1

C.2.43. Displayed Soft Buttons

Usage: Select an option.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies how many levels of “soft buttons” are displayed.

Command Line

Command option: --3270bl 0|1|2|3|4

Command option: --bl 0|1|2|3|4

Usage: Specify a level between 0 and 4.

The following example sets the number of levels of “soft buttons” for a 3270 application to 2.

--3270bl 2

The following example sets the number of levels of “soft buttons” for a 5250 application to 2.

--bl 2

C.2.44. Domain Name

Usage: Type the domain to use for application server authentication in the field.

The following objects have this attribute:

  • Application server

  • User profile

  • Windows application

Description

This attribute specifies the domain to use for the application server authentication process.

Note

This attribute plays no part in the SGD login.

Command Line

Command option: --ntdomain dom

Usage: Replace dom with the domain to use for application server authentication.

The following example authenticates using the domain indigo.

--ntdomain indigo

C.2.45. Email Address

Usage: Type the user's email address in the field.

User profile objects have this attribute.

Description

This attribute specifies a user's email address, in the form: name@domain

When authenticating users, SGD might use this attribute for identifying the user.

Command Line

Command option: --email email

Usage: Replace email with the user's email address.

The following example defines the email address of the user as indigo@example.com.

--email indigo@example.com

C.2.46. Emulation Type

Usage: Select an emulation type option.

Character application objects have this attribute.

Description

This attribute identifies the type of emulation required for the application: SCO Console, VT420, or Wyse 60. Set the correct Section C.2.104, “Terminal Type” for the selected Emulation Type.

Not all character application attributes apply to all emulation types. In the Administration Console, selecting an emulation type option enables and disables other attributes for the object.

Command Line

Command option: --emulator scoconsole | vt420 | wyse60

Usage: Specify the correct emulation type.

The following example uses Wyse 60 terminal emulation for the application.

--emulator wyse60

C.2.47. Enhanced Network Security

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

Whether to enable enhanced network security for the application.

Enabling enhanced network security means that an enhanced security mechanism such as Transport Layer Security (TLS) or Network Level Authentication (NLA) using CredSSP can be used when authenticating to the Windows application server.

TLS can be used with Windows 2003 or later application servers.

NLA can be used with Windows 2008 R2, Windows 7, and Windows 2008 application servers.

Enhanced Network Security is enabled by default for Windows applications. If this attribute is disabled, RDP security is used when authenticating to the application server.

The following table shows which security mechanism is used when the security layer on the Windows application server is set to Negotiate.

Application Server PlatformSecurity Mechanism
Windows XPRDP
Windows 2003TLS
Windows 2008NLA
Windows 7NLA
Windows 2008 R2NLA

Command Line

Command option: --enhancednetworksecurity 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example enables enhanced network security for the application.

--enhancednetworksecurity 1

C.2.48. Environment Variables

Usage: Type the environment variables in the field, one on each line. Press Return to add new entries.

The following objects have this attribute:

  • Character application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies any environment variable settings needed to run the application. For example, you might need to set LD_LIBRARY_PATH to access shared libraries.

Quote any environment variable setting with a value containing spaces.

Do not set the DISPLAY variable. SGD sets the display automatically for each user.

Command Line

Command option: --env setting

Usage: Replace setting with an environment variable setting, of the form VARIABLE=value. To set more than one variable, use multiple --env arguments.

The following example runs the application with two environment variables set.

--env LD_LIBRARY_PATH=/usr/lib "MY_VARIABLE=603 1769"

C.2.49. Escape Sequences

Usage: Select an option.

Character application objects have this attribute.

Description

This attribute specifies how escape sequences are sent from the emulator to the application server. Escape sequences can be sent as 7-bit or 8-bit control codes.

This attribute applies to VT420 character applications only.

Command Line

Command option: --escape 7-bit | 8-bit

Usage: Specify a valid setting.

The following example sends escape sequences using 8-bit control codes.

--escape 8-bit

C.2.50. 'File' and 'Settings' Menus

Usage: Select or deselect the check box.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies whether or not the File and Settings menu items are enabled. When disabled, only the window resize buttons are displayed in the menu bar.

Command Line

Command option: --3270si true|false

Command option: --si true|false

Usage: Specify true or false.

The following example enables the File and Settings menu items for a 3270 application.

--3270si true

The following example enables the File and Settings menu items for a 5250 application.

--si true

C.2.51. Font Family

Usage: Select a font family from the list.

Character application objects have this attribute.

Description

This attribute determines the font family used within the terminal window for the application.

Only Courier, Helvetica, or Times Roman can be used. It is not possible to use any other font family.

Command Line

Command option: --font courier | helvetica | timesroman

Usage: Specify a valid font family.

The following example uses the Times Roman font in the application's terminal window.

--font timesroman

C.2.52. Font Size

Usage: Type a font size, in points, in the field.

Character application objects have this attribute.

Description

This attribute defines the font size in the terminal window, in the range 2-20 points.

Command Line

Command option: --fontsize points

Usage: Replace points with the font size in points.

The following example uses a 16-point font in the terminal window.

--fontsize 16

C.2.53. Font Size: Fixed Font Size

Usage: Select or deselect the Fixed Font Size check box.

Character application objects have this attribute.

Description

If this attribute is not selected, the emulator chooses a font size that fits the defined number of Section C.2.119, “Window Size: Columns” and Section C.2.121, “Window Size: Lines” into the Section C.2.126, “Window Size: Width” and Section C.2.120, “Window Size: Height” defined for the application. The application's Section C.2.52, “Font Size” setting is used as a minimum value.

If this attribute is selected, the Section C.2.52, “Font Size” defined is used, and scroll bars appear if necessary.

Note

If this attribute is selected, the Section C.2.118, “Window Size: Client's Maximum Size” attribute is ignored.

Command Line

Command option: --fixedfont true|false

Usage: Specify true or false.

The following example uses the font size specified by Section C.2.52, “Font Size” for the terminal window.

--fixedfont true

C.2.54. Font Smoothing

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to enable font smoothing for text in the Windows application. Enabling font smoothing improves text readability, but can affect performance.

Command Line

Command option: --enablefontsmoothing 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example enables font smoothing for the Windows application.

--enablefontsmoothing 1

C.2.55. Foreground Color

Usage: Type a valid color resource, such as yellow, in the field.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies the color of the text in the application's text window.

X11 color names are supported.

Command Line

Command option: --3270fg color

Command option: --fg color

Usage: Replace color with a valid color resource, such as yellow.

In the following example, the text in the 3270 application's text window is set to the color plum4.

--3270fg plum4

In the following example, the text in the 5250 application's text window is set to the color plum4.

--fg plum4

C.2.56. Full Window Drag

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to show the contents of a window while it is moved in a Windows application. Disabling this feature can improve performance.

Command Line

Command option: --disablefullwindowdrag 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables the option to show the contents of a window while it is moved.

--disablefullwindowdrag 1

C.2.57. Graphics Acceleration

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies whether acceleration is enabled. Acceleration optimizes how graphics are rendered and improves performance at the expense of smoothness and exactness. For example, colors might not always be exact.

If your application's display must always be exact, deselect the check box.

Command Line

Command option: --accel true | false

Usage: Specify true or false.

The following example enables graphics acceleration for the application's display.

--accel true

C.2.58. Hints

Usage: Type the hints in the field. Separate each hint with a semi-colon.

The following objects have this attribute:

  • Character application

  • Document

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute enables you to define one or more strings that can be used to control the publishing and display of objects on the webtop.

You can use any number of strings and the strings can be anything. Separate each hint with a semi-colon. Use a name=value naming convention for webtop hints.

This attribute is blank by default.

This attribute is for developers who are using the SGD web services to develop custom webtops.

Command Line

Command option: --hints hint...

Usage: Replace hint with the webtop hint. Separate each hint with a semi-colon.

The following example sets a hint that might be used to specify the size of the webtop icon for the application.

--hints "preferredsize=16;"

C.2.59. Hosted Applications Tab

Usage: To assign applications to an application server object, click the Add button in the Editable Assignments table.

To delete applications for an application server object, use the Delete button in the Editable Assignments table.

The following objects have this attribute:

  • Application server

  • Dynamic application server

Description

The Hosted Applications tab lists the applications that are hosted by the application server.

The following sections of the Hosted Applications tab are used to display, select and assign applications:

  • Effective Applications table

  • Editable Assignments table

Effective Applications Table

The Effective Applications table shows all the application objects that are assigned to the selected object. The Local Assignments section of the table lists applications that are selected from the local repository.

The Assignment Type column shows one of the following:

  • Direct. The assignment was made using the Editable Assignments table.

  • Indirect. The assignment is the result of another relationship, such as membership of a group, or inheritance from another object.

  • Multiple. The assignment has multiple sources, both Direct and Indirect.

If an assignment type is Indirect or Multiple, clicking the See Details link displays information that enables you to trace the origin of the link.

Editable Assignments Table

You can use the Editable Assignments table to select applications from the local repository.

Click the Add button in the Editable Assignments table. The Add Application Assignment window is shown.

To select applications in the Add Application Assignment window, do either of the following:

  • Browse the Navigation Tree. As you browse the tree, the Content Area is updated with applications.

  • Use the Search Applications field. Use this field to search for applications. Type in the names of applications in the field. Note that you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. Results of the search are displayed in the Search Results table in the Content Area. The number of results returned by a search is limited to 150, by default.

Select the required applications from those listed in the Content Area. When you have finished selecting applications click the Add button.

The selected applications are displayed in the Effective Applications table of the Hosted Applications tab.

To delete applications from the Hosted Applications tab, use the Delete button in the Editable Assignments table.

Command Line

There is no command-line equivalent for this attribute.

C.2.60. Hosting Application Servers Tab

Usage: To assign application servers to a character, Windows, or X application object, click the Add button in the Editable Assignments table. To delete application servers for a character, Windows, or X application object, use the Delete button in the Editable Assignments table.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

Description

This attribute defines the application servers that can run the application. The SGD server uses application server load balancing to determine the application server to use. Each application server is stored as a reference to the object, so a particular object can appear on many Hosting Application Server tabs. If an object is moved or renamed later, all references to the object are automatically updated.

If a group is added to a Hosting Application Servers tab, the group's members and not the group are used for application server load balancing.

If you do not specify any application servers to run the application, the application can run on any SGD server in the array that supports that type of application.

The following sections of the Hosting Application Servers tab are used to display, select and assign applications:

  • Effective Application Servers table

  • Editable Assignments table

Effective Application Servers Table

The Effective Application Servers table shows all the application server objects that are assigned to the selected object. The Local Assignments section of the table lists applications that are selected from the local repository.

The Assignment Type column shows one of the following:

  • Direct. The assignment was made using the Editable Assignments table.

  • Indirect. The assignment is the result of another relationship, such as membership of a group, or inheritance from another object.

  • Multiple. The assignment has multiple sources, both Direct and Indirect.

If an assignment type is Indirect or Multiple, clicking the See Details link displays information that enables you to trace the origin of the link.

Editable Assignments Table

You can use the Editable Assignments table to select application servers from the local repository.

Click the Add button in the Editable Assignments table. The Add Application Server Assignment window is shown.

To select application servers in the Add Application Server Assignment window, do either of the following:

  • Browse the Navigation Tree. As you browse the tree, the Content Area is updated with application servers.

  • Use the Search Application Servers field. Use this field to search for application servers. Type in the names of application servers in the field. Note that you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. Results of the search are displayed in the Search Results table in the Content Area. The number of results returned by a search is limited to 150, by default.

Select the required application servers from those listed in the Content Area. When you have finished selecting application servers click the Add button.

The selected application servers are displayed in the Effective Application Servers table of the Hosting Application Servers tab.

To delete application servers from the Hosting Application Servers tab, use the Delete button in the Editable Assignments table.

Command Line

Command option: --appserv object

Usage: Replace object with the full name of an object, for example, "o=appservers/ou=IT/cn=london". Make sure that you quote any object names containing spaces.

The following example adds geneva and prague as application servers for an application.

--appserv "o=appservers/ou=IT/cn=geneva" \
          "o=appservers/cn=prague"

C.2.61. Icon

Usage: Click the Edit button and select an icon option from the Select Application Icon list. Click OK to save the setting.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • Document

  • 3270 application

  • 5250 application

  • Dynamic application

Description

This attribute specifies the icon that users see on their webtop.

Command Line

Command option: --icon icon_name

Usage: Replace icon_name with a file name, including the extension. For example, spreadsheet.gif.

The following example uses the clock.gif icon.

--icon clock.gif

C.2.62. Inherit Assigned Applications from Parent

Usage: Select or deselect the check box and click the Save button.

The following objects have this attribute:

  • Organizational Unit

  • User profile

Description

This attribute determines whether the assigned applications for the object also includes the assigned applications for the object's parent in the organizational hierarchy.

Depending on this attribute's setting in the parent object, the aggregation of assigned applications can continue up the hierarchy to the organization object.

Command Line

Command option: --inherit true | false

Usage: Specify true or false.

In the following example, the object inherits assigned applications from the parent object.

--inherit true

C.2.63. Interlaced Images

Usage: Select an option.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines whether images are transmitted and displayed in a series of interlaced passes or in one pass from top to bottom.

Select Adjust Dynamically to allow interlacing to be turned on or off at any stage, according to the network conditions.

Use interlacing for graphics-intensive applications, particularly over low-bandwidth connections.

Command Line

Command option: --interlaced automatic|on|off

Usage: Specify a valid setting.

The following example enables interlaced image transmission.

--interlaced on

C.2.64. Keep Launch Connection Open

Usage: Select or deselect the check box.

The following objects have this attribute:

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies whether to keep open the connection used to start the application, or to close the connection.

Usually, you deselect the check box.

Select the check box if users experience either of these symptoms:

Command Line

Command option: --keepopen true | false

Usage: Specify true or false.

The following example closes the connection used to start the application.

--keepopen false

C.2.65. Keyboard Codes Modification

Usage: Select or deselect the check box.

Character application objects have this attribute.

Description

This attribute determines whether the application can change the codes generated by keys on the keyboard.

This attribute applies to Wyse 60 character applications only.

Command Line

Command option: --appkeymode true|false

Usage: Specify true or false.

The following example disables key code changes for the application.

--appkeymode false

C.2.66. Keyboard Type

Usage: Select a keyboard type option.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies the layout to use for mapping the keyboard to the terminal being emulated.

Command Line

Command option: --3270kt pc|sun4|sun5|hp

Command option: --kt pc|sun4|sun5|hp

Usage: Specify one of the valid keyboard types.

In the following example, the keyboard type for a 3270 application is set to pc.

--3270kt pc

In the following example, the keyboard type for a 5250 application is set to pc.

--kt pc

C.2.67. Kiosk Mode Escape

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Windows application

  • X application

Description

Enables a pull-down header for the application. The header includes icons for minimizing and closing the application window. This attribute is only effective for applications having a Section C.2.127, “Window Type” setting of Kiosk mode.

To display the pull-down header when this attribute is enabled, move the mouse to the top of the application window.

Command Line

Command option: --allowkioskescape true | false

Usage: Specify true or false. The default setting is true.

The following example disables the pull-down header.

--allowkioskescape false

C.2.68. Line Wrapping

Usage: Select or deselect the check box.

Character application objects have this attribute.

Description

This attribute determines the behavior when a user types characters extending beyond the right edge of the terminal window.

Select the check box to wrap the characters onto the next line.

Deselect the check box to not display the characters. The characters are placed in the keyboard buffer.

Command Line

Command option: --autowrap true|false

Usage: Specify true or false.

The following example wraps characters onto the next line in the terminal window.

--autowrap true

C.2.69. Load Balancing Groups

Usage: Type one or more load balancing groups for the application server in the field. Press the Return key after each load balancing group.

Application server objects have this attribute.

Description

This attribute specifies the load balancing group used for application load balancing.

You can use any string, for example “Scandinavia” or “US-East”. Application load balancing tries to choose an application server and SGD server with the same location, to minimize the “network distance” between them and maximize performance. The connection between the user's client device and the SGD server uses the AIP protocol, which adapts to the network conditions.

Leave this attribute blank unless you use an array spanning a wide area network (WAN), or one that includes slow links, and you use the intelligent array routing load balancing groups feature. More than one string is allowed, but this slows application startup.

If used, set this attribute on all appropriate application server objects, and for all SGD servers in the array. Use the Server Settings → General tab of the Administration Console.

Command Line

Command option: --location location

Usage: Replace location with the location of the application server.

The following example locates the application server in Paris.

--location Paris

C.2.70. Login

Usage: Select or deselect the check box.

User profile objects have this attribute.

Description

This attribute specifies whether someone can log in using this user profile object.

Deselect the check box to deny a user access to SGD.

This attribute is always selected for profile objects in the System Objects organization. Users can always log in using the profile object, as long as the appropriate authentication mechanism is available. The authentication mechanism is configured on the Global Settings → Secure Global Desktop Authentication tab of the Administration Console.

To deny access to all users who use a particular authentication mechanism, deselect the appropriate authentication repository using the Authentication Wizard on the Global Settings → Secure Global Desktop Authentication tab of the Administration Console.

To stop all users from logging in to a particular SGD server, deselect Section B.2.2, “User Login” for the server on the Server Settings → General tab of the Administration Console.

Command Line

Command option: --enabled true|false

Usage: Specify true or false.

The following example enables the user profile object to log in to SGD.

--enabled true

C.2.71. Login: Multiple

Usage: Select or deselect the check box.

User profile objects have this attribute.

Description

This attribute specifies whether the user profile is used by a single user, or can be shared by multiple users in the form of a “guest” account.

The following table shows the similarities and differences between user profile objects with the attribute deselected and with the attribute selected.

Account is Not Shared

Account is Shared

Must be used by one user.

Can be used by more than one user.

Each user has their own application sessions.

Each user has their own application sessions.

Application sessions can continue between user sessions.

Application sessions end when a user logs out.

One set of password cache entries.

One set of password cache entries, which is shared between all users.

The user can save entries in the password cache.

Users cannot save entries in the password cache.

If the user is already logged in, logging in again from a different client device relocates the user session. The old user session ends.

Logging in again creates a new user session. No existing user sessions are affected.

Command Line

Command option: --shared true | false

Usage: Specify true or false.

The following example enables the user profile object to be shared by multiple users in the form of a “guest” account.

--shared true

C.2.72. Login Name

Usage: Type the user's login name in the field.

User profile objects have this attribute.

Description

This attribute specifies the login name of a user. This is typically their UNIX system user name.

An authentication repository might use this attribute for identifying and authenticating users.

Command Line

Command option: --user username

Usage: Replace username with the user's login name.

The following example defines the login name as indigo.

--user indigo

C.2.73. Login Script

Usage: Type the login script file name in the field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies the login script that runs to start this application. Only change this attribute if you are having problems starting an application.

To configure SGD to choose a login script automatically, leave the setting blank.

You can use a full path name or a relative path name. Relative path names are considered relative to the value of the Execution Protocol Engine's Section B.8.3, “Login Script Directory” attribute.

The current working directory of the login script is the directory containing the script. If the script sources another script using a relative path name, the path name is considered relative to this directory.

Command Line

Command option: --login script

Usage: Replace script with the file name of the login script to use.

The following example uses the custom login script my_login.exp to start the application.

--login my_login.exp

C.2.74. Make Universal PDF Printer the Default

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

Sets the SGD Universal PDF printer as the client's default printer when printing from Windows applications.

This attribute is only available if the Section C.2.106, “Universal PDF Printer” is enabled.

This attribute can only be edited using the Administration Console if Section C.2.21, “Client Printing: Override” is enabled for the object.

By default, the Universal PDF printer is not the default printer. The setting is false on the command line.

The setting for this attribute overrides the following:

  • The setting for a parent object in the organizational hierarchy.

  • The default setting configured on Global Settings → Printing tab of the Administration Console, if no parent object configuration exists.

  • For Windows application objects, this setting overrides the printing configuration for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

Command Line

Command option: --pdfisdefault 1|0

Usage: Specify 1 (true) or 0 (false).

The following example makes the Universal PDF printer the default printer when printing from a Windows application.

--pdfisdefault true

C.2.75. Make Universal PDF Viewer the Default

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

Sets the SGD Universal PDF Viewer printer as the client's default printer when printing from Windows applications.

By default, the Universal PDF Viewer printer is not the default printer. The setting is false on the command line.

This attribute is only available if the Section C.2.107, “Universal PDF Viewer” is enabled.

This attribute can only be edited using the Administration Console if Section C.2.21, “Client Printing: Override” is enabled for the object.

The setting for this attribute overrides the following:

  • The setting for a parent object in the organizational hierarchy

  • The default setting configured on the Global Settings → Printing tab of the Administration Console, if no parent object configuration exists

  • For Windows application objects, this setting overrides the printing configuration for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

Command Line

Command option: --pdfviewerisdefault 1|0

Usage: Specify 1 (true) or 0 (false).

The following example makes the Universal PDF Viewer printer the default printer when printing from Windows applications.

--pdfviewerisdefault true

C.2.76. Mappings Tab

Usage: To create a new mapping for a dynamic application, click the Add button in the Editable Mappings table.

To delete mappings for a dynamic application, click the Delete button in the Editable Mappings table.

Dynamic application objects have this attribute.

Description

The Mappings tab lists the mappings for a dynamic application.

Use this tab to create and manage mappings between a type string and the name of an application object. The type string is displayed to users when they select which application to run.

Command Line

Command option: --mapping mappings

Usage: Replace mappings with one or more type-application mappings.

The following example specifies a mapping between type linux and the gnome_desktop application.

--mapping linux="o=applications/cn=gnome_desktop"

C.2.77. Maximum Count

Usage: Type a number in the field.

Application server objects have this attribute.

Description

This attribute specifies the maximum number of application sessions that can be run concurrently on the application server using SGD.

When the maximum number of application sessions is reached, SGD does not allow users to start any further applications hosted on the application server.

Command Line

Command option: --maxcount count

Usage: Replace count with the maximum number of application sessions.

The following example sets the maximum number of application sessions for the application server to 64.

--maxcount 64

C.2.78. Members Tab

Usage: To add group members to a group object, click the Add button in the Editable Assignments table.

To delete group members from a group object, use the Delete button in the Editable Assignments table.

Group objects have this attribute.

Description

The Members tab shows the members of the selected group object. You can only create groups of applications or groups of application servers.

A group can have many members, including other groups. Each member is stored as a reference to the object, so a particular object can be a member of many groups. If an object is moved or renamed later, all references to the object are automatically updated.

The following sections of the Members tab are used to display, select, and assign group members:

  • Effective Members table

  • Editable Members table

Effective Members Table

The Effective Members table shows all the objects that are assigned to the selected group object.

The Assignment Type column shows one of the following:

  • Direct. The assignment was made using the Editable Assignments table.

  • Indirect. The assignment is the result of another relationship, such as membership of a group, or inheritance from another object.

  • Multiple. The assignment has multiple sources, both Direct and Indirect.

If an assignment type is Indirect or Multiple, clicking the See Details link displays information that enables you to trace the origin of the link.

Editable Members Table

You can use the Editable Members table to select group members from the local repository.

Click the Add button in the Editable Assignments table. The Add Application Member window, or Add Application Server Member window, is shown, depending on the whether you are editing a group of applications or a group of application servers.

To select group members in the Add Application Assignment or Add Application Server Member window, do either of the following:

  • Browse the Navigation Tree. As you browse the tree, the Content Area is updated with applications.

  • Use the Search Applications or Search Application Servers field. The name of this field varies, depending on whether you are editing a group of applications or a group of application servers. Use this field to search for group members. Type in the names of applications or application servers in the field. Note that you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. Results of the search are displayed in the Search Results table in the Content Area. The number of results returned by a search is limited to 150, by default.

Select the required group members from those listed in the Content Area. When you have finished selecting members click the Add button.

The selected group members are displayed in the Effective Members table of the Members tab.

To delete members from the Members tab, use the Delete button in the Editable Members table.

Command Line

Command option: --member object

Usage: Replace object with the full name of the object. For example,"o=Example/ou=Finance/cn=XClaim". Make sure that you quote any object names containing spaces.

The following example names Indigo Jones and Emma Rald as members.

--member "o=Example/cn=Indigo Jones" \
         "o=Example/ou=Marketing/cn=Emma Rald"

C.2.79. Menu Animations

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to show transition effects for menus and tooltips in the Windows application. Disabling these menu animation effects can improve performance.

Command Line

Command option: --disablemenuanimations 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables menu animation effects.

--disablemenuanimations 1

C.2.80. Menu Bar

Usage: Select or deselect the check box.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies whether the application's menu bar is displayed or not.

Command Line

Command option: --3270mb true|false

Command option: --mb true|false

Usage: Specify true or false.

In the following example, the 3270 application's menu bar is enabled.

--3270mb true

In the following example, the 5250 application's menu bar is enabled.

--mb true

C.2.81. Middle Mouse Timeout

Usage: Type a timeout, in milliseconds, in the field.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute enables you to emulate the middle mouse button on a two-button mouse by clicking the left and right mouse buttons at the same time.

This attribute is the maximum time that can elapse between pressing the left and the right mouse buttons for the action to be treated as a middle mouse button operation.

Command Line

Command option: --middlemouse ms

Usage: Replace ms with a timeout in milliseconds.

In the following example, the left and right buttons must be pressed within 0.3 seconds for the operation to be considered as a middle mouse button operation.

--middlemouse 300

C.2.82. Monitor Resolution

Usage: Type a resolution, in dots per inch, in the field.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies the monitor resolution, in dots per inch, that SGD reports to X applications asking for this information. Some X applications need this value to determine what font size to use.

If you leave this attribute blank, the value specified in the X Protocol Engine's Section B.7.1, “Monitor Resolution” attribute is reported.

The default resolution might cause the X application to choose a font size larger than it normally uses. This can cause clipping problems, as the X application needs more screen space. If this happens, try reducing the resolution by typing a smaller value, for example, 75.

The X application might also use too large a font if the X Protocol Engine's Section B.7.2, “Font Path” attribute uses a different order than the console or X terminal.

Command Line

Command option: --dpi dpi

Usage: Replace dpi with a resolution in dots per inch.

The following example reports a resolution of 75 dpi to X applications that need this information.

--dpi 75

C.2.83. Mouse

Usage: Select or deselect the Only 3-Button Mouse Supported check box.

X application objects have this attribute.

Description

This attribute enables you to specify whether the X application only supports a 3-button mouse.

Select the check box if the application only supports a 3-button mouse. The check box is cleared by default.

Command Line

Command option: --force3button true|false

Usage: Specify true or false.

In the following example, the application only supports a 3-button mouse.

--force3button true

C.2.84. Name

Usage: Type the name used for the object, for example, Indigo Jones.

The following objects have this attribute:

  • Active Directory container

  • Character application

  • Document

  • Domain component

  • Group

  • Application server

  • User profile

  • Windows application

  • X application

  • 3270 application

  • 5250 application

  • Organization

  • Organizational Unit

  • Dynamic application

  • Dynamic application server

Description

This attribute specifies the name of the object in the local repository.

The following naming conventions are used for SGD objects.

  • 3270 application objects have a cn= naming attribute.

  • 5250 application objects have a cn= naming attribute.

  • Active Directory container objects have a cn= naming attribute.

  • Application server objects have a cn= naming attribute.

  • Dynamic application server objects have a cn= naming attribute.

  • Character application objects have a cn= naming attribute.

  • Document objects have a cn= naming attribute.

  • Domain Component objects have a dc= naming attribute.

  • Group objects have a cn= naming attribute.

  • Organization objects have an o= naming attribute.

  • Organizational Unit objects have an ou= naming attribute.

  • User profile objects can have a cn= (common name), a uid= (user identification), or a mail= (mail address) naming attribute.

  • Windows application objects have a cn= naming attribute.

  • X application objects have an cn= naming attribute.

  • Dynamic application objects have an cn= naming attribute.

In the Administration Console, names can include any characters, except the backslash (\) or plus (+) characters.

When you create a new application server object, the Name setting is automatically entered in the Address field.

Command Line

Command option: --name name

Usage: Replace name with the full name of the object, for example, "o=applications/ou=Finance/cn=XClaim".

Make sure that you quote any names containing spaces.

If you use a forward slash (/) in an object name, you must backslash protect (escape) it. For example, to create an object with the relative name cn=a/b beneath o=organisation, type cn=a\/b.

This creates an object o=organisation/"cn=a/b".

The following example defines the name of the organization object as Example.

--name "o=Example"

The following example defines the name of the organizational unit object as Finance. The object belongs to the directory object, Example, which must already exist.

--name "o=Example/ou=Finance"

The following example defines the common name of a user profile object as Indigo Jones. The object belongs to the organization object, Example.

--name "o=Example/cn=Indigo Jones"

The following example defines the names of a domain component object as example.

--name "dc=com/dc=example"

C.2.85. Number of Sessions

Usage: Select or deselect the Limited check box. If the Limited check box is selected, type a number in the Max per User field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute enables you to set the maximum number of instances of an application a user can run simultaneously. The default is 3.

The application's link on the webtop indicates how many instances of the application the user can run. The webtop also provides tools for suspending, resuming or ending each application instance.

Command Line

Command option: --maxinstances 0| instances

Usage: Specify 0 or replace instances with the number of instances.

The following example sets the maximum number of instances of the application to unlimited.

--maxinstances 0

C.2.86. Numpad Codes Modification

Usage: Select a keypad behavior option from the list.

Character application objects have this attribute.

Description

This attribute specifies the behavior of the numeric keypad, whether it always generates numbers or whether you want the application to change the codes generated by the keypad.

This attribute applies to VT420 character applications only.

Command Line

Command option: --keypad numeric | application

Usage: Specify the keypad behavior you want.

In the following example, the keypad always generates numbers.

--keypad numeric

C.2.87. Passwords Tab

Usage: Use the Password Cache table to manage entries in the password cache.

The following objects have this attribute:

  • Application server

  • Dynamic application server

  • User profile

Description

The Passwords tab lists the password cache entries for the selected user profile or application server object.

Use the New button to add a password cache entry, using the Create New Password Cache Entry page.

Use the Edit button to edit an entry in the password cache, or the Delete button to remove an entry from the password cache.

Use the Reload button to refresh the Password Cache table.

Use the Search field to search for entries in the Password Cache table. You can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string. The number of results returned by a search is limited to 150, by default.

Command Line

On the command line, use the tarantella passcache commands to delete and examine entries in the password cache. See Section D.54, “tarantella passcache”.

C.2.88. Password Cache Usage

Usage: Select the Override Global Setting check box and then select or deselect the Secure Global Desktop Password Tried option. To use the default setting defined in the Global Settings → Application Authentication tab, deselect the Override Global Setting check box.

The following objects have this attribute:

  • Application server

  • Dynamic application server

Description

This attribute specifies the policy for authenticating users on the application server, if no password is already cached for that server.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Secure Global Desktop Password Tried (selected)

--auth trytta

If the user's password for logging in to SGD is cached, the same password is used to try to log in to the application server. If the attempt fails, the user is prompted for a password.

When listing object attributes on the command line, this attribute value is displayed as true.

Secure Global Desktop Password Tried (deselected)

--auth nevertrytta

The user's password for logging in to SGD is not used. The user is prompted to enter a user name and password for the application server.

When listing object attributes on the command line, this attribute value is displayed as false.

Override Global Setting (deselected)

--auth default

The Section A.3.1, “Password Cache Usage” attribute determines whether to try the user's password or not.

When listing object attributes on the command line, this attribute value is displayed by default.

A user's password for logging in to SGD can be stored in the password cache if an SGD server is also used as an application server, or if Section A.1.2, “Password Cache” is selected in the Section A.1, “Secure Global Desktop Authentication Tab”.

Command Line

Command option: --auth trytta|nevertrytta|default

Usage: Specify one of the valid settings.

The following example tries the password the user typed to log in to SGD, if the password is cached.

--auth trytta

C.2.89. Postscript Printer Driver

Usage: Type the name of the printer driver to use for PDF printing in the field.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

The name of the printer driver to use for PDF printing when printing from Windows applications.

This printer driver must be installed on every Windows application server used with SGD.

The printer driver must be a PostScript™ printer driver. The default is HP Color LaserJet 2800 Series PS.

The name you type must match the name of the printer driver installed on your Windows application servers exactly. Pay particular attention to the use of capitals and spaces. The /opt/tarantella/etc/data/default.printerinfo.txt file contains all the common printer driver names ordered by manufacturer. To avoid errors, copy and paste the driver name from this file.

This attribute is only available if Section C.2.106, “Universal PDF Printer” is enabled.

This attribute can only be edited using the Administration Console if Section C.2.21, “Client Printing: Override” is enabled for the object.

The setting for this attribute overrides the following:

  • The setting for a parent object in the organizational hierarchy.

  • The default setting configured on the Global Settings → Printing tab of the Administration Console, if no parent object configuration exists.

  • For Windows application objects, this setting overrides the printing configuration for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

Command Line

Command option: --pdfdriver driver_name

Usage: Replace driver_name with the name of the printer driver to use for PDF printing. Use quotes on the command line if the name includes spaces.

The following example configures the HP LaserJet 8000 Series PS printer driver as the driver to use for PDF printing.

--pdfdriver "HP LaserJet 8000 Series PS"

C.2.90. Printer Preference Caching

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute disables the caching of printer preferences, such as page orientation and paper size, for a Windows application.

Command Line

Command option: --noprintprefs 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables the caching of printer preferences.

--noprintprefs 1

C.2.91. Prompt Locale

Usage: Type a locale in the field.

Application server objects have this attribute.

Description

This attribute controls the language used in the login scripts when pattern matching the login data from an application server.

When using the login scripts supplied with SGD, the vars.exp script defines variables for matching system prompts. By default, English system prompts are supported. This script can be customized to support users in other locales.

A locale has two parts, a language and an optional territory, separated by an underscore.

The language part of a locale is specified using ISO 639 language codes, for example en for English or ja for Japanese.

The territory part of a locale is specified using ISO 3166 territory codes, for example us for the United States or jp for Japan.

By default, the locale is en_us.

Command Line

Command option: --hostlocale ll_tt

Usage: Replace ll_tt with a locale.

The following example sets the default language of the application server object to French. French prompts must be configured in the login scripts used with this application server.

--locale fr

C.2.92. RandR Extension

Usage: For user profile objects or organizational unit objects, select the Override Parent's Setting check box and then select or deselect the Enabled option. To use the setting defined for the parent object, deselect the Override Parent's Setting check box.

For organization objects, select the Override Global Setting check box and then select or deselect the Enabled option. To use the default setting defined in the Global Settings tab, deselect the Override Global Setting check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

Description

This attribute controls whether users can use the RANDR X extension during application sessions. RANDR is used to provide enhanced support for displaying applications using multiple monitors. See Section C.2.124, “Window Size: RandR Extension”.

Changes to this attribute only take effect for new user sessions.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Override Parent's Setting (deselected)

2

User profile objects or organizational unit objects. Use the setting inherited from the parent object.

This is the default setting.

Override Global Setting (deselected)

2

Organization objects. Use the global setting.

This is the default setting.

Enabled (selected)

1

Enable use of the RANDR Extension.

Enabled (deselected)

0

Disable use of the RANDR Extension.

For user profile objects or organizational unit objects, deselect the Override Parent's Setting check box to inherit the setting of a parent object in the organizational hierarchy. This is used to enable or disable RANDR for many users without having to edit each user profile object.

For organization objects, deselect the Overrride Global Setting check box to use the default setting configured on the Global Settings → Client Device tab of the Administration Console.

When a user starts an application, SGD checks the user profile object for the user and then any parent object further up the organizational hierarchy to see whether RANDR is enabled or disabled. If all the objects selected are configured to use the parent's setting, then the default setting is used.

If RANDR is disabled for a user profile object in the System Objects organization, for example o=Tarantella System Objects/cn=UNIX User Profile, this affects all users who are assigned that profile.

By default, use of RANDR is disabled.

Command Line

Command option: --orgxrandr 2|1|0

Usage: Specify a valid setting.

The following example enables use of the RANDR X extension.

--orgxrandr 0

C.2.93. Remote Audio

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute configures whether audio is sent from the Windows application server to the client device. If Remote Audio is enabled, audio is played on the Windows application server.

Enabling this attribute has the same effect as the “Leave at remote computer” sound setting for a Microsoft Windows Remote Desktop connection.

By default, this attribute is disabled.

Command Line

Command option: --remoteaudio 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example keeps remote audio at the Windows application server.

--remoteaudio 1

C.2.94. Scroll Style

Usage: Select a scroll style option.

Character application objects have this attribute.

Description

This attribute specifies how the terminal window scrolls. The available options are line-by-line, several lines at once, or smoothly.

When listing object attributes on the command line, the following applies:

  • The line attribute value is displayed as normal

  • The multiple attribute value is displayed as jump

Command Line

Command option: --scrollstyle line | multiple | smooth

Usage: Specify the scroll style you want.

The following example scrolls the terminal window smoothly.

--scrollstyle smooth

C.2.95. Serial Port Mapping

Usage: For user profile objects or organizational unit objects, select the Override Parent's Setting check box and then select or deselect the Enabled option. To use the setting defined for the parent object, deselect the Override Parent's Setting check box.

For organization objects, select the Override Global Setting check box and then select or deselect the Enabled option. To use the setting defined in the Global Settings tab, deselect the Override Global Setting check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

Description

This attribute controls whether users can access the serial ports on a client device from a Windows Remote Desktop Services session.

By default, a user profile object or organizational unit object inherits the setting of its parent object in the organizational hierarchy. This is used to enable or disable access to serial ports for many users without having to edit each user profile object. To override this, select the Override Parent's Setting check box and change the setting.

By default, organization objects use the global setting configured on the Global Settings → Client Device tab of the Administration Console. To override this, select the Override Global Setting check box and change the setting.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Override Parent's Setting (deselected)

2

User profile objects or organizational unit objects. Use the setting inherited from the parent object.

This is the default setting.

Override Global Setting (deselected)

2

Organization objects. Use the global setting.

This is the default setting.

Enabled (selected)

1

Enable access to serial ports.

Enabled (deselected)

0

Disable access to serial ports.

When a user starts a Windows application, SGD checks the user profile object for the user and then any parent object further up the organizational hierarchy to see whether access to serial ports is enabled or disabled. If all the objects selected are configured to use the parent's setting, then the default setting is used.

By default, access to serial ports is enabled.

Command Line

Command option: --serialport 2|1|0

Usage: Specify a valid setting.

The following example disables access to serial ports.

--serialport 0

C.2.96. Server Address

Usage: Type DNS name or IP address of the application server in the field.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

This attribute names the 3270 (mainframe) or AS/400 application server that runs the application.

Use a DNS name rather than an IP address, if you know the DNS name.

Command Line

Command option: --hostname host

Usage: Replace host with the DNS name or IP address of the 3270 (mainframe) or AS/400 application server.

The following example runs the application on the application server warsaw.example.com.

--hostname warsaw.example.com

C.2.97. Server Port

Usage: Type the TCP port number used to connect to the application server in the field.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

This attribute specifies the TCP port used by the emulator to exchange data with the 3270 (mainframe) application server or AS/400 application server.

By default, TCP port 23 is used.

Command Line

Command option: --portnumber tcp

Usage: Replace tcp with the TCP port number used to connect to the application server.

The following example connects on TCP port 4567 to the application server.

--portnumber 4567

C.2.98. Session Termination

Usage: Select a setting from the list.

The following objects have this attribute:

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines when an application session ends.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Last Client Exit

lastclient

The SGD server keeps track of the number of X clients running within the session, and ends the session when this reaches zero. Use this setting with Section C.2.64, “Keep Launch Connection Open” if a forked application, such as OpenOffice, has problems shutting down.

Window Manager Exit

windowmanager

The SGD server ends the session when the Window Manager exits, no matter how many X clients are running.

Only Window Manager Remaining

windowmanageralone

The SGD server ends the session when the only remaining X client is the Window Manager. Some Window Managers, such as OpenLook, run X clients in the background, which means that this condition is never met. If you encounter this problem, use the No Visible Windows setting.

Login Script Exit

loginscript

The SGD server ends the session when the login script completes. Use this setting with Section C.2.64, “Keep Launch Connection Open” if an application has problems shutting down.

No Visible Windows

nowindows

The SGD server ends the session when no windows are visible. This is useful for window managers, such as OpenLook, that run X clients in the background.

Login Script Exit or No Visible Windows

loginscriptnowindows

The SGD server ends the session when either the login script completes or no windows are visible. Use this setting for applications that have a General Section C.2.6, “Application Resumability” setting and that use X clients, as this forces a session to close if an application server is rebooted or disconnected from the network. Use this setting with Section C.2.64, “Keep Launch Connection Open” if an application has problems shutting down.

Command Line

Command option: --endswhen lastclient | windowmanager | windowmanageralone | loginscript | nowindows | loginscriptnowindows

Usage: Specify a valid setting.

The following example ends the application session when no windows are visible.

--endswhen nowindows

C.2.99. SGD Remote Desktop Client

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to use the SGD Remote Desktop Client (ttatsc) to run an application from a Microsoft Windows application server, using the Microsoft RDP protocol.

Use the Section C.2.10, “Arguments” attribute to specify command-line options for the Remote Desktop Client.

Command Line

Command option: --winproto wts | none

Usage: Specify a valid setting.

The following example connects to a Microsoft Windows server using the Microsoft RDP protocol.

--winproto wts

C.2.100. Share Resources Between Similar Sessions

Usage: Select or deselect the check box.

The following objects have this attribute:

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies whether application sessions for applications try to share resources. Sharing resources reduces the memory overhead on both the SGD server and the client device.

This attribute is available for applications configured with the following Section C.2.127, “Window Type” settings:

  • Client Window Management

  • Kiosk

  • Independent Window

Resources are shared between applications with the same settings for the following attributes:

If you have problems when launching applications, try disabling this attribute.

Command Line

Command option: --share true | false

Usage: Specify true or false.

The following example enables resource sharing for similar sessions.

--share true

C.2.101. Status Line

Usage: Select a type of status line from the list.

Character application objects have this attribute.

Description

This attribute specifies the type of status line to show for the application.

Application Type

Types of Status Line Available

VT420

  • None

  • Cursor Position and Print Mode

  • Messages from the Host

Wyse 60

  • None

  • Standard

  • Extended

SCO Console

  • Not Applicable

When listing object attributes on the command line, the attribute value hostmessages is displayed as host writable.

Command Line

Command option: --statusline none | indicator | hostmessages | standard | extended

Usage: Specify the type of status line you want. Not all settings are valid for all types of character application.

The following example does not display a status line.

--statusline none

C.2.102. Surname

Usage: Type the user's surname in the field.

User profile objects have this attribute.

Description

This attribute specifies the surname, or family name, of the user.

Names can include any characters you want.

Command Line

Command option: --surname name

Usage: Replace name with the surname of the user. Make sure that you quote any names containing spaces.

The following example defines the surname of the user as Jones.

--surname Jones

C.2.103. SWM Local Window Hierarchy

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute is only effective for applications having a Section C.2.127, “Window Type” setting of Seamless Window.

The attribute is needed for compatibility with some Borland applications. Enable the attribute if you are having trouble with minimizing and maximizing the application window from the task bar.

Command Line

Command option: --swmopts 1|0

Usage: Specify 1 (true) or 0 (false). The default setting is 0.

The following example enables SWM local window hierarchy for the application.

--swmopts 1

C.2.104. Terminal Type

Usage: Select a terminal type option, or select the Custom option and type in the field.

Character application objects have this attribute.

Description

This attribute specifies the terminal type required for the application. You must set this appropriately for the Section C.2.46, “Emulation Type”.

Command Line

Command option: --termtype type

Usage: Replace type with a terminal type, for example, ansi.

The following example uses the ansi terminal type.

--termtype ansi

The following example uses the wyse60 terminal type.

--termtype wyse60

C.2.105. Theming

Usage: Select or deselect the check box.

Windows application objects have this attribute.

Description

This attribute specifies whether to enable themes for a Windows application, such as a Windows desktop session. Disabling themes can improve performance.

Command Line

Command option: --disabletheming 1 | 0

Usage: Specify 1 (true) or 0 (false).

The following example disables themes.

--disabletheming 1

C.2.106. Universal PDF Printer

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

This attribute enables users to print using the SGD Universal PDF printer when printing from Windows applications.

This attribute can only be edited using the Administration Console if Section C.2.21, “Client Printing: Override” is enabled for the object.

The setting for this attribute overrides the following:

  • The setting for a parent object in the organizational hierarchy.

  • The default setting configured on the Global Settings → Printing tab of the Administration Console, if no parent object configuration exists.

  • For Windows application objects, this setting overrides the printing configuration for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

Command Line

Command option: --pdfenabled 1|0

Usage: Specify 1 (true) or 0 (false).

The following example enables users to print using the Universal PDF printer.

--pdfenabled 1

C.2.107. Universal PDF Viewer

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Organization

  • Organizational Unit

  • User profile

  • Windows application

Description

This attribute enables users to print using the SGD Universal PDF Viewer printer when printing from Windows applications.

This attribute can only be edited using the Administration Console if Section C.2.21, “Client Printing: Override” is enabled for the object.

The setting for this attribute overrides the following:

  • The setting for a parent object in the organizational hierarchy.

  • The default setting configured on the Global Settings → Printing tab of the Administration Console, if no parent object configuration exists.

  • For Windows application objects, this setting overrides the printing configuration for organization, organizational unit, or user profile objects. The order of precedence for printing configuration is: Windows application → user profile → organizational unit → organization.

For organization, organizational unit, and user profile objects, changes to this attribute only take effect for new user sessions.

Command Line

Command option: --pdfviewerenabled 1|0

Usage: Specify 1 (true) or 0 (false).

The following example enables users to print using the Universal PDF Viewer printer.

--pdfviewerenabled true

C.2.108. URL

Usage: Type a URL in the field.

Document objects have this attribute.

Description

The URL associated with the object. This is displayed when users click the link on their webtop.

You can use absolute or relative URLs. Relative URLs are considered relative to the SGD document root. This is usually /opt/tarantella/var/docroot.

Command Line

Command option: --url url

Usage: Replace url with a URL. Make sure that you quote any values containing spaces or other characters that might be interpreted by your shell.

The following example makes the object display the example.com home page when clicked.

--url http://www.example.com

The following example displays the specified URL, considered relative to the SGD document root.

--url ../my_docs/index.html

C.2.109. User Assignment

Usage: Type one or more search specifications in the field.

Application server objects have this attribute.

Description

Use this attribute to specify the users that can run applications on the application server.

The search specification filters application servers based on the user identity (the fully-qualified user name) of the user. The search filter can be any of the following:

  • An RFC2254-compliant LDAP search filter

  • An RFC1959-compliant LDAP URL

  • A scottasessionowner= filter

Note

LDAP-based search filters are applied even if the user identity is not an LDAP identity.

For an RFC2254 search filter, enclose each filter in double quotes and brackets.

For an LDAP URL, use the format ldap:///search-criteria. If you include the host, port and return attribute specification in the URL they are ignored. This is because the LDAP directory server configured as part of SGD authentication is used.

Note

The Administration Console does not automatically escape the special characters specified in RFC2254. To use a special character in the Administration Console, you must manually type the escape sequence. For example, to search for a user with the common name “John Doe (123456)”, type the following cn=John Doe\0x28123456\0x29 in the search field. The command line does escape the special characters.

SGD supports the use of extensible matching search filters as specified in RFC2254. This enables you to look up information from components that make up an object's distinguished name (DN). For example, to assign an application server to a user that is contained within any OU called managers (ou=managers), you can use a (&(ou:dn:=managers)) search filter.

The scottasessionowner= filter is a simple search that takes only the asterisk (*) wildcard.

Command Line

Command option: --userassign spec

Usage: Replace spec with a search specification.

The following example assigns the application server to any manager in the Sales department and anyone who has Violet Carson as their manager.

--userassign "(&(job=manager)(dept=Sales))" \
"(manager=Violet Carson)"

The following example assigns the application server to any manager in the Sales department of example.com.

--userassign "ldap:///ou=Sales,dc=example,dc=com??sub?job=manager"

The following example assigns the application server to users with the UID “violet” in the Sales department and the UID “emmarald” in the Marketing department.

--userassign uid=violet,ou=Sales,dc=example,dc=com \
uid=emmarald,ou=Marketing,dc=example,dc=com

The following example assigns the application server to all users in the Sales OU in the local repository.

--userassign "scottasessionowner=dc=com/dc=example/ou=Sales/*"

The following example assigns the application server to Elizabeth Blue in the Sales OU in the local repository.

--userassign "scottasessionowner=dc=com/dc=example/ou=Sales/cn=Elizabeth Blue"

C.2.110. User Sessions Tab

Usage: Use the buttons in the User Sessions tab to view and manage user sessions.

User profile objects have this attribute.

Description

This tab lists the active user sessions for the selected user profile object. A user session represents a user who is connected to an SGD server.

Use the View Details button in the User Session List table to show more details for the selected user session. Use the End button to end the selected user session. The Reload button refreshes the User Session List table.

Use the Search options to search the User Session List table. When searching for a User Identity or Secure Global Desktop Server, you can use the * wildcard in your search string. Typing a search string of name is equivalent to searching for *name* and returns any match of the search string.

To search for a Login Time, use a search string format of yyyy/mm/dd hh:mm:ss.

The number of results returned by a search is limited to 150, by default.

Command Line

On the command line, use the tarantella webtopsession commands to list and end user sessions. See Section D.118, “tarantella webtopsession”.

Use the Section D.119, “tarantella webtopsession list” command to show user session details for a specified user profile object.

Command option: tarantella webtopsession list --person pobj

Usage: Replace pobj with the full name of the user profile object.

The following example lists user sessions for the Indigo Jones user profile object.

tarantella webtopsession list \
"o=Example/ou=IT/cn=Indigo Jones"

C.2.111. Virtual Server Broker Class

Usage: Select a broker from the list, or select Other from the list and type a fully-qualified class name in the field.

Dynamic application server objects have this attribute.

Description

The virtual server broker (VSB) interface class to use for the dynamic application server.

The following table shows the VSBs supplied with SGD.

Broker

Fully-Qualified Class Name

SGD

com.tarantella.tta.webservices.vsbim.SGD

User-defined SGD

com.tarantella.tta.webservices.vsbim.UserDefinedSGD

Legacy VDI

com.sun.sgd.vsbim.SunVDIVirtualServerBroker

VDI

com.oracle.sgd.vsbim.OracleVDIVirtualServerBroker

This attribute can be used by developers who are using SGD web services to develop applications.

Command Line

Command option: --vsbclass class-name

Usage: Replace class-name with the fully-qualified class name for the VSB.

The following example uses the VDI broker.

--vsbclass com.oracle.sgd.vsbim.OracleVDIVirtualServerBroker

C.2.112. Virtual Server Broker Parameters

Usage: Type parameters for the virtual server broker (VSB) in the field.

Dynamic application server objects have this attribute.

Description

This attribute specifies a parameter string to pass to the VSB.

This attribute is blank by default.

This attribute can be used by developers who are using SGD web services to develop applications.

Command Line

Command option: --vsbparams string

Usage: Replace string with a string of parameters to pass to the VSB.

The following example passes a string of host names to the VDI broker. A backslash (\) character is used to escape double quotation marks (") within the string.

--vsbparams "preferredhosts=\"https://vdihost1.com:1802/client,https://vdihost2.com:1802/client,
  https://vdihost3.com:1802/client\""

C.2.113. Window Close Action

Usage: Select a setting from the list.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines what happens if the user closes the main application window using the Window Manager decoration. This attribute only applies for applications that are configured with a Section C.2.127, “Window Type” setting of Client Window Management or Independent Window.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Description

Notify Application

notifyapp

The application is notified of a close action in the normal way. If the application ignores the request, SGD kills the application.

When listing object attributes on the command line, this attribute value is displayed as notifyclient.

This setting only applies to X applications that are configured with a Section C.2.127, “Window Type” setting of Client Window Management.

Kill Application

killapp

SGD kills the application. This is similar to using the program xkill to exit the application. Use this setting only if your users are having difficulty closing an application.

When listing object attributes on the command line, this attribute value is displayed as killclient.

This setting only applies to X applications that are configured with a Section C.2.127, “Window Type” setting of Client Window Management.

Suspend Application Session

suspendsession

If the application object is resumable, the application's application session is suspended. If the application object is not resumable, the application session ends. Use this setting only if the application provides its own mechanism for the user to exit. See also Section C.2.6, “Application Resumability”.

For applications that are configured with a Section C.2.127, “Window Type” setting of Client Window Management, a confirmation prompt is displayed when the user closes the application using the window decoration.

End Application Session

endsession

SGD ends the application session.

This is the default setting for Windows and character applications configured with a Section C.2.127, “Window Type” setting of Independent Window.

For applications that are configured with a Section C.2.127, “Window Type” setting of Client Window Management, a confirmation prompt is displayed when the user closes the application using the window decoration.

Note

An application session can contain several main application windows, for example, a CDE session with several applications running. If this attribute is set to either Suspend Application Session or End Application Session, then closing any of the applications results in the entire session being suspended or ended.

Command Line

Command option: --windowclose notifyapp | killapp | suspendsession | endsession

Usage: Specify a valid setting.

In the following example, closing the application's main window suspends the application session, as long as the application object is resumable.

--windowclose suspendsession

C.2.114. Window Color

Usage: Select an option. For the Custom Color option, type a color in the field.

The following objects have this attribute:

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines the appearance of the root window.

Select Default Colors to show the standard black window. To use your own color, select Custom Color and specify a Section C.2.115, “Window Color: Custom Color” attribute.

When listing object attributes on the command line, the custom attribute value is displayed as color.

Command Line

Command option: --roottype default|custom

Usage: Specify a valid setting.

The following example uses a custom color, which is specified using --rootcolor, for the root window.

--roottype custom

C.2.115. Window Color: Custom Color

Usage: Used when the Custom Color option is selected for the Section C.2.114, “Window Color” attribute. Type a valid color resource, such as yellow, in the field.

The following objects have this attribute:

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines the color of the root window.

X11 color names are supported.

Command Line

Command option: --rootcolor color

Usage: Replace color with a valid color resource, such as yellow.

In the following example, the root window uses the color plum4.

--rootcolor plum4

C.2.116. Window Management Keys

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Windows application

  • X application

Description

Keyboard shortcuts that deal with window management can either be sent to the remote session or acted on locally. This attribute is only effective for applications having a Section C.2.127, “Window Type” setting of Kiosk mode.

To exit kiosk mode when this attribute is enabled, use the key sequence Alt+Ctrl+Shift+Space. This minimizes the kiosk session on the local desktop.

Command Line

Command option: --remotewindowkeys 1 | 0

Usage: Specify 1 (true) or 0 (false). The default setting is 0.

The following example sends window management keys to the remote session.

--remotewindowkeys 1

C.2.117. Window Manager

Usage: Type the full path name of the Window Manager in the field. Press Return to add new entries.

The following objects have this attribute:

  • X application

  • 3270 application

  • 5250 application

Description

This attribute specifies the Window Manager to use for the application. You can also use this to name any other applications to run alongside the main application.

You can name as many Window Manager applications as you want.

A Window Manager is not needed for X applications configured with a Section C.2.127, “Window Type” setting of Client Window Management.

Command Line

Command option: --winmgr command

Usage: Replace command with a full path name. Separate each path name with a space.

The following example runs the application using the twm Window Manager.

--winmgr /usr/local/bin/twm

C.2.118. Window Size: Client's Maximum Size

Usage: Select or deselect the check box.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute affects the initial size of the application.

Select the check box to ensure that the application fills the user's screen when it starts.

The application appears with window decoration. To cause an application to fill the screen completely, without window decoration, set the application object's Section C.2.127, “Window Type” attribute to Kiosk.

Deselect the check box to size the application according to the object's Section C.2.126, “Window Size: Width” and Section C.2.120, “Window Size: Height” attributes.

Unless Section C.2.125, “Window Size: Scale to Fit Window” is selected, the application size does not change during the lifetime of the application session. If the user starts an application on one client device, then resumes the same application on a client device with a different screen resolution, the application does not resize to fit the screen. If you need this feature, use the RANDR X extension as described in Section 4.3, “Using the RANDR X Extension”.

Note

If this attribute is selected and the application is a character application, the Section C.2.53, “Font Size: Fixed Font Size” attribute must be deselected.

Command Line

Command option: --maximize true | false

Usage: Specify true or false.

The following example displays the application at maximum size on the client device.

--maximize true

C.2.119. Window Size: Columns

Usage: Type the number of columns for the application's terminal window in the field.

Character application objects have this attribute:

Description

This attribute defines the number of columns in the terminal window, in the range 5–132.

Command Line

Command option: --cols cols

Usage: Replace cols with the number of columns in the terminal window.

The following example uses an 80-column window for the application.

--cols 80

C.2.120. Window Size: Height

Usage: Type the height of the application, in pixels, in the field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute defines the height of the application, in pixels. The minimum height is 10 pixels, the maximum 65535 pixels.

Command Line

Command option: --height pixels

Usage: Replace pixels with the height of the application, in pixels. You must specify the height, even if this attribute is not required, for example because the application is configured with a Section C.2.127, “Window Type” setting of Client Window Management, or to display at the Section C.2.118, “Window Size: Client's Maximum Size”.

The following example uses a 600-pixel high window to display the application.

--height 600

C.2.121. Window Size: Lines

Usage: Type the number of lines for the application's terminal window in the field.

Character application objects have this attribute:

Description

This attribute defines the number of lines in the terminal window, in the range 5-100.

Command Line

Command option: --lines lines

Usage: Replace lines with the number of lines in the terminal window.

The following example uses a 25-line window for the application.

--lines 25

C.2.122. Window Size: Maximized

Usage: Select or deselect the Maximized check box.

The following objects have this attribute:

  • 3270 application

  • 5250 application

Description

Specifies whether the emulator window is maximized.

These commands cause the window to be displayed at the maximum size possible when the TeemTalk for Unix emulator is loaded. The window retains the default number of lines and columns and includes all window elements, such as the title bar and soft buttons, if enabled.

Command Line

Command option: --3270ma true|false

Command option: --ma true|false

Usage: Specify true or false.

In the following example, the emulator window for a 3270 application is maximized.

--3270ma true

In the following example, the emulator window for a 5250 application is maximized.

--ma true

C.2.123. Window Size: Variable Root Window Size

Usage: Select or deselect the Variable Root Window Size check box.

X application objects have this attribute.

Description

Specifies whether the X root window is resized to match the user's screen.

If this attribute is disabled, the root window is a fixed size.

This attribute is only available for application objects configured with a Section C.2.127, “Window Type” setting of Client Window Management.

This attribute is only available if the Section C.2.124, “Window Size: RandR Extension” attribute is disabled. This is because root window resizing is supported automatically by the RANDR X extension.

Command Line

Command option: --variablerootsize true|false

Usage: Specify true or false.

The following example enables resizing of the root window.

--variablerootsize true

C.2.124. Window Size: RandR Extension

Usage: Select or deselect the RandR Extension check box.

The following objects have this attribute:

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

Specifies whether the RANDR X extension is enabled.

The RANDR extension enables the remote session window to be resized dynamically, and provides enhanced support for multiple monitors.

Command Line

Command option: --xrandr true|false

Usage: Specify true or false.

The following example enables the RANDR X extension.

--xrandr true

C.2.125. Window Size: Scale to Fit Window

Usage: Select or deselect the Scale to Fit Window check box.

The following objects have this attribute:

  • 3270 application

  • 5250 application

  • Windows application

  • X application

Description

This attribute specifies that the application is scaled to fit the window in which it is displayed.

This attribute is only available if the application has a Section C.2.127, “Window Type” setting of Independent Window or Kiosk.

This attribute is not available if Section C.2.124, “Window Size: RandR Extension” is enabled for the application.

If this attribute is selected, the application is always scaled to fit the window in which it is displayed. If you resize the window, SGD rescales the application to fit the new window size and scroll bars never display.

You can toggle between a scaled and an unscaled application by pressing the Scroll Lock key.

Command Line

Command option: --scalable true | false

Usage: Specify true or false.

The following example scales the application to fit the window.

--scalable true

C.2.126. Window Size: Width

Usage: Type the width of the application, in pixels, in the field.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute defines the width of the application, in pixels. The minimum width is 10 pixels, the maximum 65535 pixels.

Command Line

Command option: --width pixels

Usage: Replace pixels with the width of the application, in pixels. You must specify the width, even if this attribute is not required, for example because the application is configured with a Section C.2.127, “Window Type” setting of Client Window Management or to display at the Section C.2.118, “Window Size: Client's Maximum Size”.

The following example uses a 300-pixel wide window to display the application.

--width 300

C.2.127. Window Type

Usage: Select a setting from the list.

The following objects have this attribute:

  • Character application

  • Windows application

  • X application

  • 3270 application

  • 5250 application

Description

This attribute determines how the application is displayed to the user.

Some settings affect other attributes. For example, in the Administration Console, choosing Client Window Management disables the attributes for configuring the application's size. You can specify these attributes on the command line, but they have no effect.

The Administration Console options and their command line equivalents are shown in the following table.

Administration Console

Command Line

Applies To

Description

Client Window Management

clientwm

X applications

The application's windows behave in the same way as those of applications running on the client device. For example, the windows can be resized, moved, minimized and maximized using the client's normal window management controls.

The object's Section C.2.113, “Window Close Action” attribute determines what happens when the user closes the application's last or main window.

When listing object attributes on the command line, this attribute value is displayed as multiplewindows.

Use for applications with many top-level resizable windows.

Independent Window

independent

All application types

The application appears in a new window, without any web browser toolbars or menus.

This window can be resized, but this does not resize the application: the window includes scrollbars. The object's Section C.2.126, “Window Size: Width” and Section C.2.120, “Window Size: Height” attributes determine the size of the application.

Closing the window ends or suspends the application session, depending on the object's Section C.2.113, “Window Close Action” attribute. A dialog is shown when the window is closed, asking you to confirm closure of the application.

When listing object attributes on the command line, this attribute value is displayed as awtwindow.

Kiosk

kiosk

All application types

The application appears full-screen, with no window decoration.

Users cannot resize or move the window.

A pull-down header enables users to minimize or close the window.

Use for full-screen desktop sessions.

Seamless Window

seamless

Windows applications

The application's windows behave like an application running on a Windows application server.

If an application is started in a seamless window, you can toggle between a seamless and independent window by pressing the Scroll Lock key.

When listing object attributes on the command line, this attribute value is displayed as seamlesswindows.

Do not use for full-screen desktop sessions. Use a kiosk or independent window instead.

Command Line

Command option: --displayusing clientwm | independent | kiosk | seamless

Usage: Specify one of the valid settings. Not all settings are available for all types of application.

The following example displays the application as a full-screen desktop session.

--displayusing kiosk

The following example displays the application in an independent window.

--displayusing independent

C.2.128. Window Type: New Browser Window

Usage: Select or deselect the check box.

Document objects have this attribute.

Description

For users logged in to SGD using a browser, if this attribute is selected the URL specified for the object is displayed in a new browser window. If this attribute is not selected, the URL is displayed on the webtop.

Command Line

Command option: --newbrowser true | false

Usage: Specify true or false.

The following example displays the document in a new browser window.

--newbrowser true

C.2.129. Working Directory

Usage: Type the full path name of the directory in the field.

Windows application objects have this attribute.

Description

This attribute specifies the working directory to be used by the application.

You can use a backslash (\) or a forward slash (/) between subdirectories. On the command line, you might need to escape backslashes. For example, \\.

Command Line

Command option: --workingdir dirname

Usage: Replace dirname with the full path name of the working directory.

The following example specifies a working directory.

--workingdir "C:/Program Files/Example/data"

C.2.130. X Security Extension

Usage: Select or deselect the check box.

X application objects have this attribute.

Description

Whether to enable the X Security Extension for the application.

The X Security Extension divides X clients, also known as hosts, into trusted and untrusted clients. Untrusted clients cannot interact with windows and resources owned by trusted clients.

If you need to run an X application from an application server that might not be secure, enable the X Security Extension and run the application in untrusted mode. This restricts the operations that the X application can perform in the X server and protects the display.

To run an application in untrusted mode, do the following:

  1. Configure the X application to use ssh as the Section C.2.31, “Connection Method”.

  2. Configure ssh to allow X11 forwarding.

The X Security Extension only works with versions of ssh that support the -Y option.

Command Line

Command option: --securityextension true | false

Usage: Specify true or false.

The following example enables the X Security Extension for the application.

--securityextension true