Configuring Web Services

To configure Sage CRM Web Services, do the following:

  1. Log on to Sage CRM as a system administrator.
  2. Go to <My Profile> | Administration | System | Web Services.
  3. Click Change and then specify the Web Services configuration options described below.

Option

Description

Maximum number of records to return

Specifies the maximum number of records that Web Services return in a batch in response to a query. When this option is set to 0, all records matching the query are returned in a single batch.

This option is used in conjunction with the query and queryrecord methods. When a batch is returned, you're prompted to call the next batch, until all records matching the query are returned.

Maximum size of request

Specifies the maximum size of request (in characters) that can be sent to Web Services.

Make WSDL available to all

Specifies whether the Sage CRM Web Services WSDL file is accessible.

Possible values:

  • Yes. Anyone can access the WSDL file.
  • No. Users and system administrators cannot access the WSDL file

When configuring and testing Web Services, we recommend that you set this option to Yes. When you're done, set this option to No for better security.

To view the WSDL file, in your web browser, enter the URL in the following format: http://<ComputerName>/<InstallName>/eware.dll/webservices/webservice.wsdl.

Enable Web Services

Specifies whether Web Services are enabled in Sage CRM.

Possible values:

  • Yes(recommended). Enables Web Services.
  • No. Disables Web Services.

To enable or disable Web Services for an individual entity, log on to Sage CRM as a system administrator, go to <My Profile> | Administration | Customization | <Entity> | External Access, and then use the Allow Web Service Access option.

Dropdown fields as strings in WSDL file

Specifies whether to display selection fields and their enumeration values in the WSDL file.

Possible values:

  • Yes (recommended). Hides selection fields and their enumeration values in the WSDL file.
  • No. Displays selection fields and their enumeration values in the WSDL file.

When this option is set to No, a selection field (comm_status in this case) displayed in the WSDL file looks similar to the following:

Copy 
<simpleType name="comm_status">
<restriction base="xsd:string">
<enumeration value="Cancelled"/>
<enumeration value="Complete"/>
<enumeration value="Pending"/>
<enumeration value="In Progress"/>
</restriction>
</simpleType>

When this option is set to Yes, information about selection fields is excluded from the WSDL file.

Enumerated values are returned in the default system language.

Send and return all dates and times in universal time

Specifies the format in which Sage CRM Web Services send and receive times and dates.

Possible values:

  • Yes. Specifies to use Coordinated Universal Time (UTC).
  • No. Specifies to use the format set on the Sage CRM server.

This option is important when migrating users from different time zones.

Accept web request from IP address

Specifies the unique IP address from which Web Services accept requests. You can only specify one IP address in this option.

Leave this option blank to allow requests from all IP addresses.

Force web service logon

Specifies how to handle the client's attempt to log back on to Web Services when the connection is unexpectedly interrupted.

Possible values:

  • Yes (recommended). Specifies that a new instance of the client is allowed to log on to Web Services following an interrupted connection. This automatically logs out the old instance of the client.
  • No. Specifies that a new instance of the client is blocked from logging on to Web Services. The old instance of the client remains logged on.