Page tree
Skip to end of metadata
Go to start of metadata

The primary function of the Attaché Service API is to facilitate server-side processing of Attaché data.

If necessary, you can access the configuration file and log file for the Attaché Service API if you need to adjust the configuration settings or review the log for troubleshooting purposes. You can find these files in the Attaché Service folder within the Attaché Database Server program folder:

  • Log file: AttachéServiceAPI.txt
  • Configuration file: AttService.exe.config

Attaché Service API log file

The Attaché Service API log file allows you to check if certain processing tasks were completed successfully on the server. For example, general ledger transactions are validated on the workstations first and then posted to the database on the server. If any problems occur, such as a workstation crashing during processing, review the log file. If the process is not listed in the log file, this indicates that the task is not processed server-side. In this case you must restore to a backup. 

Note: We recommend that you print the relevant reports and check the data if the log confirms that the task was completed successfully. If you identify any issues, you must restore to a backup.

To view the log file:

  1. Browse to the Attaché Database Server program folder.
  2. Open the Attaché BI Service folder.
  3. Locate the AttacheServiceAPI.txt text file.
  4. Right-click and choose to open with Notepad.
  5. View the records to confirm if the process was successful or not.
    • If failed: Restore to a backup if the log shows the processing failed.
    • If successful: Print and review the necessary reports to confirm the processing was successful. If not, restore to a backup.

Changing the SQL port number

The Attaché Database Server (c-TreeACE) defaults to port 6597 for the SQL port number and the Service API defaults to port 6587 (this is always 10 less than the database port number). 

You can change the port numbers if the defaults are being used by another application but you must make this change to both the AttService.exe.config file and the Attaché Database Host Settings tool.

To change the SQL port number in the AttService configuration file:

  1. Browse to the Attaché Database Server program folder.
  2. Open the Attaché BI Service folder.
  3. Locate the AttService.exe.config file.
  4. Right-click and choose to open with Notepad.
  5. Modify the Database Server port number in <add key ="AppDatabasePort" value="6597" />
    Note: The Attaché Service API will automatically minus ten from that number for its port number.
  6. Browse to MS Services to stop and then restart the AttServiceAPI.

To change the number in the SQL port field in the Attaché Database Host Settings tool, see Manual entry of data connection string (Attaché workstation).

Changing the connection timeout 

The report engine previewer uses the Attaché Service API to obtain and filter the data. When a report is submitted to run, the request will timeout after a certain period (default is set to 15 seconds). This can be increased if required, which may be useful for larger databases.

To increase the timeout period:

  1. Browse to the Attaché Database Server program folder.
  2. Locate the AttService.exe.config file.
  3. Right-click and choose to open with Notepad.
  4. Modify the value of "15" in the line <add key ="AppConnectTimeout" value="15" />.
  5. Browse to MS Services to stop and restart the AttServiceAPI.

Unable to connect to the Attaché Service API

You may receive the following message when signing on to Attaché:

Attaché API service could not be connected. Please ensure that the AttService is running on the server and your server name is in the correct format.

If so, you will need to confirm that the Attaché Service API is running in MS Services. Also ensure that the server name has been set up correctly in the format attache@server.domain.com and not as localhost or an IP Address.

See Manual entry of data connection string (Attaché workstation) for information on how to change the server name.

REF: A001291.15    271118   372