Web Service

If you have some basic programming knowledge, you can use the XFRACAS web service in your own custom application to insert XML files into the import queue or insert time/usage reports for serialized systems.

Download a Sample Application

You can download a sample application that demonstrates the basic process for using the web service.

XfracasImportExample (*.zip)

Using the Service

On the web server, IIS must be configured with HTTP Activation enabled for the .NET Framework. See XFRACAS Implementation Guide (*.pdf).

The following functions are available. For parameters and code examples, see XFRACAS XML Import Business Logic (*.pdf) and the sample application.

ImportXML - Inserts an XML file into the XFRACAS import queue. This is equivalent to clicking Add via the website. Note that:

The web service can insert any of the XML file types that can be uploaded manually via the Data Import page in the XFRACAS website, such as Incident (xml) or Master BOM (xml), etc.
The maximum size for files that can be inserted into the queue by the web service is set via the XFRACAS Admin utility on the web server (on the Settings page of the XFRACAS Configuration File window). By default, this is set to 10485760 bytes (or ~10 MB).
The web service cannot be used to insert XLSX files into the import queue.

ProcessImports - Immediately begins processing of all files in the import queue for all entities. This is equivalent to clicking Process via the website. To view the processing status of the files, check the Processed and Error logs on the website.
ImportMetrics - Inserts up to 3 time/usage values reported on a particular date for a particular serialized system. This is equivalent to clicking Update System Hours in the customer support record for a serialized system. (See Time Metric Calculations.)
GetAllXFRACASEntities - Returns a list of entities that the user belongs to. The entity ID (eid) is a required parameter for some functions.
WriteExceptionToDiagnosticsLog and WriteMessageToDiagnosticLog - Insert entries into the XFRACAS Diagnostics Log.

Tip: Although similar calls have been available in the Synthesis API, the XFRACAS API methods are planned to be deprecated in Version 2019. If you have developed any custom applications using XFRACAS API methods, it is recommended to transition to the web service instead.

E-mail Link