Parameters for the Bulk Data Form URL

The URL for the Bulk Data Form, http:/<WebServer>/MeridiumWeb/apm/Registry/Bulk Data Form.aspx, accepts the parameters described in the following table. Note that a link created from the path with no parameters will generate an error. To open the Bulk Data Form, if you are not using the QueryPath parameter, you must define at least the EntityKeys parameter. If you are using the QueryPath parameter, you do not need to define the EntityKey parameter.

Parameter Name

Description

Accepted Value(s)

Notes

EntityKeys

Specifies the Entity Key of the record that you want to open in the Bulk Data Form.

numeric Entity Key(s)

To open more than one record in the Bulk Data Form, you can specify multiple values for this parameter, each separated by a comma. Note that the entities you specify must belong to the same family.

To be able to modify records via the Bulk Data Form in the Meridium APM Web Framework, you must use the EntityKeys parameter.

QueryPath

Specifies the query whose results you want to view in the Bulk Data Form.

The Catalog path and file name of the query you want to open.

You must include the query path within parenthesis and single quotation marks. Additionally, within the parenthesis, before the first single quotation mark, you must insert an exclamation mark.

DatasheetID

Specifies the datasheet that you want to display in the Bulk Data Form.

The Datasheet ID of the desired datasheet.

The Datasheet ID must correspond to a datasheet that has been defined for the specified family in the Configuration Manager. If you do not specify this parameter, the default datasheet will be used.

You must use this parameter in conjunction with the QueryPath or EntityKeys parameters.

FilterField

Specifies the field name to which you want to apply a filter that will be applied to the records in the Bulk Data Form by default.

Field ID(s)

To apply a filter to more than one field in the Bulk Data Form, you can specify multiple values for this parameter, each separated by a comma an numbered, starting with 0.

To use the FilterField parameter, you must also use the FilterType and FilterValue parameters.

Note that you can define only one default filter per field per URL.

FilterType

Specifies the type of filter that you want to apply to the specified field.

EQUAL

GREATER

LESS

NOTEQUAL

To apply more than one filter type to a field in the Bulk Data Form, you can specify multiple values for this parameter, each separated by a comma and numbered, starting with 0. The number that you specify should correspond to the number in the FilterField parameter to represent the field to which the filter should be applied.

This parameter should be used in conjunction with the FilterField parameter and the FitlerValue parameter.

FilterValue

Specifies the value that the specified filter type will use to filter the specified field.

numeric and character strings

To apply more than one filter value to a field in the Bulk Data Form, you can specify multiple values for this parameter, each separated by a comma and numbered, starting with 0. The number that you specify should correspond to the number in the FilterField and FilterType parameters that represent the field and field type to which the FilterValue parameter corresponds.

SortType

Specifies the order in which to sort records in the Bulk Data Form.  

A

D

You can specify the following values for this parameter:

·         A - Sorts records in ascending order on the field specified for the SortField parameter.

·         D - Sorts records in descending order on the field specified for the SortField parameter.

This parameter should be used inconjunction with the SortField parameter but is not required when you specify the SortField parameter. If you omit the SortType parameter, records will be sorted in ascending order on the field specified for the SortField parameter.

SortField

Specifies the field on which to sort records in the Bulk Data Form.

The field ID of the field that you want to use for sorting.

When you use this parameter, you can also include the SortType parameter to indicate the order in which records should be sorted.

Copyright © 1993-2016 Meridium, Inc. All rights reserved.