Network - Connect

 

Declaration

<AMNETWORK CONNECTION="manual" NUMBER="number" USERNAME="text" PASSWORD="text (encrypted)" REDIAL="number" REDIALTIME="number" WAITTYPE="text (options)" />

Related Topics   

Description

Establishes a connection to another network using a Virtual Private Network (VPN) or Dial-Up Network (DUN) connection.

Practical Usage

Used to connect to the Internet with a modem or other network device if needed before executing Internet actions.

Parameters

connection

Property

Type

Required

Default

Markup

Description

Connection

Text (options)

Yes

Predefined

CONNECTION="manual"

Specifies whether the connection derives from an existing phone book entry created during Dial-Up Networking (DUN) or Virtual Private Network (VPN) configuration or that it will be manually entered in the properties of this activity. The available options are:

  • Predefined - Connection derives from an entry created during Dial-Up Networking (DUN) or Virtual Private Network (VPN) configuration.

  • Manual - Allows manual entry of a dial-up number, user name and password in which to establish a connection with, bypassing the Windows phone book. The connection will be established based on the information entered in the Phone number, Username and Password parameters.

Connections

Text

Yes if connection is predefined

(Empty)

ENTRY="myConnection"

The name of an existing Dial-Up Networking (DUN) or Virtual Private Network (VPN) connection. To select an existing entry, click the Down arrow and select from the drop-down list of available named connections or manually enter the name of the connection in the provided text box. This parameter is active only if the Connection parameter is set to Predefined.

Phone number

Number

Yes if connection is manual

(Empty)

  1. NUMBER="555-867-5309"

  2. NUMBER="7145551212"

The phone number that should be used to establish a DUN or VPN connection. This parameter is active only if the Connection parameter is set to Manual.

Username

Text

Yes if connection is manual

(Empty)

USERNAME="joe"

The username to authenticate with when establishing a remote connection. This parameter is active only if the Connection parameter is set to Manual.

Password

Text

Yes if connection is manual

(Empty)

PASSWORD="encrypted"

The password to authenticate with when establishing a remote connection. This parameter is active only if the Connection parameter is set to Manual.

advanced

Property

Type

Required

Default

Markup

Description

Attempt redial

       

If enabled, allows redial settings to take place as specified by way of the Redial Attempts and Time Between Attempts parameters. This is a visual mode parameter used only during design-time, therefore, contains no markup.

Redial attempts

Number

No

(Empty)

REDIAL="3"

Specifies the amount of times that the connection should be re-dialed before an error is generated. This option is valid only if the Action parameter is set to Establish a connection.

Time between attempts

Text

No

0

REDIALTIME="30"

Specifies the amount of time to wait before attempting to redial the connection. The Wait Type parameter specifies whether this value is referring to seconds or minutes. This option is valid only if the Action parameter is set to Establish a connection.

Wait measure

Text (options)

No

minutes WAITTYPE="minutes"

Specifies whether the number entered in the Time between attempts parameter is in seconds or minutes. The available options are:

  • Second (default) - The wait time specified is in seconds.

  • Minutes - The wait time specified is in minutes.

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

Establish a connection to "555-867-3734". User name "theUserName". Attempt redial 3 times. Pause 10 Seconds between attempts.

Copy
<AMNETWORK CONNECTION="manual" NUMBER="555-867-3734" USERNAME="theUserName" PASSWORD="AM3V7hFgOHqLgo=aME" REDIAL="3" REDIALTIME="10" />