Configuration Parameters for HTTP Data Services

The following panels and panes may be displayed when configuring an HTTP data service A connection to plain text data or image data that is external to Loftware. A File data service or an HTTP data service drives Alternate data sources used in documents. or an Alternate data source 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..

Ribbon

Ribbon Commands

Icon	Command	Description
	New	Create a new object of a specific type.
	Open	Open an existing object.
	Save	Save the displayed object.
	Delete	Delete the displayed object.
	Undo Edits	Reverse the most recent action on an object.
	Redo	Reapply the previously undone action to an object.

File Menu

Command	Description
Close	Close the current object.
Close All	Close all objects that you have open.
Save	Save the object.
Save As	Save a copy of the object under a different name.
Delete	Delete the displayed object.

Service Management

The Tag Values dialog box is available when viewing an object that supports tags. Click View > Tags to open the dialog box.

You can categorize an application, business rule, data service, device group, facility, field data catalog, form, image, integration, label template, layer object, layout, process, Remote Site, reusable object, user, or workflow template by assigning tags to it. Each tag has a category and a value. For a version-controlled object, tags cannot be changed in a previously checked-in version.

Button	Command	Description
	Assign Tag	Assign a tag to an object. The tag category must already exist.
	Delete Tag	Remove a tag that was assigned to an object.
	Edit Tag	Edit the tag Category and Value.

For more information about using tags, see Categorize a Data Service.

Connection

The following options may be displayed in the Connectionpanel for an HTTP data service or an Alternate data source.

Important! A Data Service Administrator A local administrator who creates and configures data services for use by Designers who configure Database data sources and Alternate data sources. can select the Is Parameter check box for a parameter in a data service to allow a Designer Person who creates and designs label templates, forms, and applications for use by Data Providers. to customize that parameter for each Alternate data source. If the Is Parameter check box is cleared, then the parameter is not displayed in Alternate data sources.

Parameter	Description
URL	The URL pointing to the external file or endpoint from which data can be retrieved or sent. Examples A file name is typically used when retrieving data and a folder name when sending data. https://www.example.com/Folder/File.txt https://www.example.com/post In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers. Note: A Designer who can change this parameter can access any file.
Username	The user name used when establishing a connection to the URL. In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers.
Password	The password associated with the user name used when establishing a connection to the URL. In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers.

Parameter

Description

URL

The URL pointing to the external file or endpoint from which data can be retrieved or sent.

Examples

A file name is typically used when retrieving data and a folder name when sending data.

https://www.example.com/Folder/File.txt

https://www.example.com/post

In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers.

Note: A Designer who can change this parameter can access any file.

Username

The user name used when establishing a connection to the URL.

In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers.

Password

The password associated with the user name used when establishing a connection to the URL.

In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers.

General

Parameter	Description
Request Method	Whether the HTTP data service uses the GET method to retrieve data or the POST method to send data. GET: Request data from a specified URL. Data is passed in the URL. (Default) POST: Send data to create or update a resource at a specified URL. Data is passed in the request body. In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Alternate data sources by Designers.
Result Name	Required. A name (key) by which to refer to the data returned by the data service. To print an external file, such as a PDF, without associating the file with a label template, enter the !INLINE_DOCUMENT! reserved key. When the POST method is used, the result name receives the response code for the HTTP transaction, such as 200 OK or 404 Not Found. This parameter cannot be displayed or customized in Alternate data sources, therefore no Is Parameter check box is provided for it in an HTTP data service.
Data Type	The data type of the data to retrieve via the URL if using the GET method or to send via the URL if using the POST method. Depending on the request method, the following values can be selected. Custom: Data is of a custom data type defined by the Custom Content Type parameter. Available only with POST. Image: Data is an image. You can also use this value if retrieving a PDF file using the GET method. Note: Loftware Enterprise SP supports images that use an RGB color model and one of the following file formats: PNG, GIF, JPG, BMP, SVG, or PCX. JSON: Data is a standard JSON package. Available only with POST. PDF: Data is a PDF file. Available only with POST. To retrieve a PDF file using the GET method, use Image instead. Text: Data is free form plain text. XML: Data is an XML file. Important! If you select XML for the Data Type, the data service must be managed by using a business rule.
Custom Content Type	For a custom data type, the type of data to send using the format type/subtype. This parameter is available only if Custom is selected for Data Type.
Max Size (MB)	The maximum amount of data to retrieve from the external file for use in Loftware Enterprise SP if using the GET method, or to send from Loftware Enterprise SP if using the POST method. Note: A maximum data size of 5MB is recommended and set by default.
Body	The data to send to the URL. For text-based data types, you can enter the data, formatted as appropriate for that data type. Alternatively, you can enter the fully-qualified name (key) of a data map entry A name (key) and value pair in the data map for a job. for which the value is the data to be sent. For Image, PDF, and Custom data types that are not text-based, you must use the latter approach. This parameter is available only if POST is selected for Request Method. The expected format of the data depends on the value selected for Data Type.
HTTP Headers	The names and values that define the operating parameters of the HTTP transaction.

Properties Pane

The Properties pane allows you to describe the data service. It also displays the type of the data service and status information about the data service.

Option	Description
Service Name	The name for this data service.
Description	A description for this data service.
Data Service Type	The type of data service. JDBC Data Service JDBC Update Data Service File Data Service HTTP Data Service Link Data Service SOAP Web Service Data Service Serial Number Data Service
Configured Status	This property is not displayed until the data service has been saved for the first time. Started Stopped
Status	This property is not displayed until the data service has been saved for the first time. Service Up: The service is online. Service Down: The service is unreachable and possibly offline.
Creation Information	Created By: The user name of the creator of the data service. Created On: The date the data service was created. Modified By: The last user to change the data service Modified On: The date the data service was last changed.