Data ServicesConfigure a File Data Service

To configure a File data service so that Designers can retrieve data from a text file or an image file that is on the Loftware Application Server or that is accessible via a UNC path that does not require credentials, a Data Service AdministratorClosed A local administrator who creates and configures data services for use by Designers who configure Database data sources and Alternate data sources. should use this procedure.

You can also configure a File data service to receive XML data. However, the XML data received must be managed by using a business rule rather than by using a label data source.

To retrieve data from a file accessible via HTTP, see Configure an HTTP Data Service. To retrieve data from a spreadsheet file, see Configure a JDBC Data Service.

To configure a File data service, use the following procedure.

Note: You do not have to stop a data service to make changes to its configuration or for those changes to take effect, but you must save your changes.

  1. In Data Services Data Services, in the ribbon click > File Data Service
  2. In the Connection panel, enter the URL for the text file, image file, or XML file using the following format.

    Note: The computer hosting the target file and the Loftware Application Server must be operating in a domain environment. Connections among workgroups are not supported.

    TargetURL Format Examples
    File available via public UNC path such as \\Server\SharedFolder\File.txt

    file://Server/SharedFolder/File.txt

    Credentials must not be required to access this file.

    File on the Loftware Application Server with a path such as C:\Folder\File.txt

    file:///C:/Folder/File.txt

    The file must be hosted on the Loftware Application Server.

  3. For the Result Name, enter a name by which to refer to the data returned by the data service.

    Important! If you are configuring an Alternate Data Source in Label Design, record the name you enter to enter as the Data Ref for the data source.

  4. For each parameter, decide whether you will manage the parameter or whether you will allow the Designer to manage the parameter for each Alternate data source. For more about each parameter, see Configuration Parameters for File Data Services.

    Important! If you select XML for the Data Type, the data service must be managed by using a business rule.

    • To allow Designers to configure a parameter, select the Is Parameter check box. You can either specify an initial value or data ref for the parameter or leave it blank. Changes made to the parameter in the data service are not propagated to existing Alternate data sources.
    • To configure a parameter as part of the data service, clear the Is Parameter check box and configure the parameter, entering a value or a data ref. Changes made to the parameter in the data service are propagated to Alternate data sources. The parameter is not displayed to Designers in Alternate data sources.
    • The Result Name must be configured as part of the data service.
  5. In the Properties pane, optionally enter a Description.
  6. In the ribbon, click SaveSave .

    Important! Provide a Display Name that is easily recognizable to Designers. When a DesignerClosed Person who creates and designs label templates, forms, and applications for use by Data Providers. creates an Alternate data sourceClosed A connection to a file external to Loftware that acts as a data source and can serve as the data ref for a document field. An Alternate data source is associated with either a File data service or an HTTP data service., the Display Name (but not the Description) is displayed. Data service names are case sensitive.


    7. The following characters are permitted in the name: letters, numbers, parentheses, square brackets, ampersands, plus signs, commas, semi-colons, and tildes. Additionally, the following characters are permitted but cannot begin or end the name: spaces, double quotation marks, single quotation marks, hyphens, underscores, periods, and grave accents. For letters, the case that you specify is displayed, but case is ignored when Loftware Enterprise SP interprets a name. If you will be installing the Loftware Enterprise SP application on a computer running Windows Server, and transferring data between Loftware Enterprise SP instances, see the "Transferring Data in a Compressed File" section of the Loftware Enterprise SP Data Transfer Guide.

  7. If the data service has not been started, click Start Data Service.
  8. In the ribbon, click SaveSave .

The data service is updated with the connection information. You can view the status of the data service in the Properties pane. If the data service is stopped, you must start it to make the results available when printing labels.

Important! Whenever you add a new device, data service, integration, or facility, you must ensure that the service is activated on all Loftware Application Servers on which it should be available to run and started on at least one. In an environment with only one Loftware Application Server, these types of services are automatically activated and started when they are created. For more information, see High Availability with Distributed Services.

Note: If you want to delete a data service, you must stop it before you can delete it.