# Class FTPServiceDefinition

- [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - [dw.svc.ServiceDefinition](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md)
    - [dw.svc.FTPServiceDefinition](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.FTPServiceDefinition.md)

Represents an FTP or SFTP Service Definition.

There are two basic styles of configuration for this service.

In the first style, `createRequest` is implemented to call the setOperation method on the Service. This
will cause the single operation to be performed and returned as the data object in the `parseResponse`
method. Any error status is set automatically based on the returned value of the operation.

In the second style, `execute` is implemented to perform one or more operations using the serviceClient
available on the Service object. This serviceClient will be either an [FTPClient](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.net.FTPClient.md) or an
[SFTPClient](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.net.SFTPClient.md). The return value of execute will be passed as the data object in the
`parseResponse` method.

**Deprecated:**

:::warning
This class is only used with the deprecated [ServiceRegistry](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceRegistry.md). Use the [LocalServiceRegistry](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.LocalServiceRegistry.md)
instead, which allows configuration on the [FTPService](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.FTPService.md) directly.
:::

**API Version:**

:::note
No longer available as of version 19.10.
:::

## Property Summary

| Property                                                                                                                | Description                                                                                              |
| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [autoDisconnect](#autodisconnect): [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md) | Returns the status of whether the underlying FTP connection will be disconnected after the service call. |

## Constructor Summary

This class does not have a constructor, so you cannot create it directly.

## Method Summary

| Method                                                                                                                                                                                                                   | Description                                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
| [isAutoDisconnect](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.FTPServiceDefinition.md#isautodisconnect)()                                                                                              | Returns the status of whether the underlying FTP connection will be disconnected after the service call. |
| [setAutoDisconnect](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.FTPServiceDefinition.md#setautodisconnectboolean)([Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)) | Sets the auto-disconnect flag.                                                                           |

### Methods inherited from class ServiceDefinition

[configure](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#configureobject), [getConfiguration](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#getconfiguration), [getServiceName](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#getservicename), [isMock](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#ismock), [isThrowOnError](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#isthrowonerror), [setMock](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#setmock), [setThrowOnError](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.ServiceDefinition.md#setthrowonerror)

### Methods inherited from class Object

[assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject)

## Property Details

### autoDisconnect

- autoDisconnect: [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)
  - : Returns the status of whether the underlying FTP connection will be disconnected after the service call.

***

## Method Details

### isAutoDisconnect()

- isAutoDisconnect(): [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)
  - : Returns the status of whether the underlying FTP connection will be disconnected after the service call.

    **Returns:**

    - The auto-disconnect flag.

***

### setAutoDisconnect(Boolean)

- setAutoDisconnect(b: [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)): [FTPServiceDefinition](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.svc.FTPServiceDefinition.md)
  - : Sets the auto-disconnect flag.

    If true, the underlying FTP connection will be disconnected after the service call. If false then it will remain
    open. The default value is true.

    **Parameters:**

    - b - true to enable auto-disconnect, false otherwise.

    **Returns:**

    - this FTP or SFTP Service Definition.

***