Alphabetic Connector List > IBM License Metric Tool > Connector Parameters

Header Look Ahead

This parameter defines the number of records fetched beforehand to determine the set of columns. Set to null for all records.

Technical Name	header_look_ahead
Category	Functional
Type	Integer null
Default Value	100000
Example Values	100000, null

Some API endpoints have variable records, but do not describe the columns and respectively the column names beforehand. However, this is necessary to prepare the output CSV. The connector will collect and cache a number of records before writing the first line to CSV. If this number is too small, then not all fields my be determined, and these will be missing in the final data. If the number is large, the memory consumption of the connector will increase.

API Endpoint

This parameter contains the URL of the API endpoint to extract data from.

Technical Name	end_point
Category	Functional
Type	String
Default Value	n/a
Example Values

URL of the API endpoint to query relative to the server URL. The complete URL is constructed by resolving the endpoint to the Server URL, i.e. '{serverURL}/{endPoint}'. This is necessary to allow multiple endpoints with the same server base URL in the future.

Columns

This parameter contains a comma-separated list of the columns to extract.

Technical Name	columns
Category	Functional
Type	String null
Default Value	null
Example Values	null

A comma-separated list of table fields to extract. If omitted, the default columns are fetched. Note that by default not all fields are returned.

Filter Criteria

This parameter contains an expression that is used to filter the records for certain criteria.

Technical Name	criteria
Category	Functional
Type	String null
Default Value	null
Example Values	null

An expression used to filter the records for certain criteria. The exact way how to compose those expressions is described here.

Start Date

This parameter contains the date from which data will be received in a YYYY-MM-DD format.

Technical Name	start_date
Category	Functional
Type	String null
Default Value	null
Example Values	null, 1970-01-01

Date in YYYY-MM-DD format from which data will be received. Currently only supported within the license_usage resource of API v2. If not specified, the default value is the date of the last successful data import to BigFix Inventory minus the number of days for which data in the corresponding computer group is calculated (90 days per default).

End Date

This parameter contains the date until which data will be received in a YYYY-MM-DD format.

Technical Name	end_date
Category	Functional
Type	String null
Default Value	null
Example Values	null, 1970-12-31

Specify the date until which data should be retrieved. Specify it in the YYYY-MM-DD format. If no filter is specified, its default value is the date of the last successful import of data to the License Metric Tool.

Order

This parameter defines the column name used for ordering the result set before extraction. Use null for no specific order.

Technical Name	order
Category	Functional
Type	String null
Default Value	null
Example Values	null, server_name asc, peak_value desc

Column name used for ordering the result set before extraction. Default sort order is ascending. For descending sort order append desc to the column name (include space between column name and desc).

Configuration