# Query Subscription Administration Console Online Help

> # Parameters

> Buttons Column Display Configuration Options Related Tasks Related Topics

> Each query subscription has a set of query parameters associated with it.

> Use this page to add, modify, or delete the query parameters associated with a subscription.

> On this page you select query parameters to add to a subscription. You add one parameter at a time. When you select a parameter from the Add Parameter drop-down list, the console displays a page where you configure the value for that parameter. After you configure the value for that parameter you return to this page. Repeat this select-and-configure loop until you have added all the query parameters you want associated with this subscription.

> When you select a parameter that requires you to enter a value, the value will generally be one of the following types:

> - URI (Uniform Resource Identifier): A URI is a superset of identifiers that includes URLs (Uniform Resource Locators) and URNs (Uniform Resource Names). A URN identifies a resource in a persistent, location-independent way. Note that although a URN begins with `urn:`, fields that require a URN will accept whatever you enter because the value is treated as `anyURI`. The Related Topics at the bottom of this help page provide a link to the definition of `anyURI`.
> - EPC (Electronic Product Code): A globally unique (64- or 96-bit) identifier assigned to an object, and generally communicated and stored as a URN that begins with `urn:epc:idpat`. The Related Topics at the bottom of this help page provide a link to the EPC Tag Data Standard Version 1.1 rev 1.27.
> - Date and time: Represented in a 12-hour format ("mm/dd/yyyy hh:mm:ss AM|PM").
> - Integer number: An integer in the range 0 to 2147483647, or a positive integer in the range 1 to 2147483647.

> The EPCIS Query Parameter table lists the query parameters for the subscription. To edit the value of an existing parameter, click on its name. To delete a parameter, click the check box next to its name and then click Delete.

> #### Configuration Options

> Name | Description
> --- | ---
> Subscription ID | The ID that identifies a query subscription.
> Add Parameter | Add a query parameter to the current subscription. When you select a parameter from the drop-down list, the Console displays the configuration page for that parameter. Set the parameter value as desired. Click OK to save the parameter value(s) and return to the previous screen. Click Cancel to return to the previous screen without saving any changes. If the query can contain only one instance of a parameter, the parameter is removed from the pull-down list when the first instance is created.
> Action | Action values are ADD, DELETE, and OBSERVE. Configure the action parameter by selecting the specific event action or actions you want to include in the query.
> ADD | Include events whose action is ADD. For an event, the meaning of an ADD action depends on the event type with which the action is associated: Object Event: The EPCs in `epcList` are commissioned. Aggregation Event: The EPCs in `childEPCs` are aggregated to parent. Transaction Event: The EPCs in `epcList` are associated with a transaction, either with a new transaction, or additional EPCs are added to an existing transaction.
> DELETE | Include events whose action is DELETE. For an event, the meaning of a DELETE action depends on the event type with which the action is associated: Object Event: The EPCs in `epcList` are decommissioned. Aggregation Event: The EPCs in `childEPCs` are disaggregated. If `childEPCs` is omitted, all children are disaggregated. Transaction Event: The EPCs in `epcList` are disassociated from the transaction. If `epcList` is omitted, all children are disassociated.
> OBSERVE | Include events whose action is OBSERVE. For an event, the meaning of an OBSERVE action depends on the event type with which the action is associated: Object Event: Simple observation: neither a commission nor a decommission event. Aggregation Event: Simple observation: there is no guarantee that all children are observed, or that the parent is either observed or known. Transaction Event: The EPCs are confirmed as continuing to be associated with the transaction.
> After Event Time | Include only events that occurred after this time. Each event has an `eventTime`, which is a timestamp indicating when the event occurred. Use this parameter to include only those events that occurred after the time you enter. For example, entering the following value will result in including only those events whose `eventTime` is after August 15, 2006 at 11 A.M.: `08/15/2006 11:00:00 AM`
> After Record Time | Include only events that were recorded after this time. Each event has an `recordTime`, which is a timestamp indicating when the event was recorded by an event repository. Use this parameter to include only those events that were recorded after the time you enter. For example, entering the following value will result in including only those events whose `recordTime` is after August 15, 2006 at 11 A.M.: `08/15/2006 11:00:00 AM`
> Before Event Time | Include only events that occurred before this time. Each event has an `eventTime`, which is a timestamp indicating when the event occurred. Use this parameter to include only those events that occurred before the time you enter. For example, entering the following value will result in including only those events whose `eventTime` is before August 15, 2006 at 11 A.M.: `08/15/2006 11:00:00 AM`
> Before Record Time | Include only events that were recorded before this time. Each event has an `recordTime`, which is a timestamp indicating when the event was recorded by an event repository. Use this parameter to include only those events that were recorded before the time you enter. For example, entering the following value will result in including only those events whose `recordTime` is before August 15, 2006 at 11 A.M.: `08/15/2006 11:00:00 AM`
> Business Location | Query results will include only events for this business location (specified as a URI). Examples of business locations specified as URIs are: `urn:epcglobal:fmcg:loc:0614141003624:203,412.Shelf123` `urn:epc:id:sgln:0614141.12345.0` You can specify more than one business location; use newline characters as separators.
> Include Descendants | Include descendants (children). The Business Location and Read Point parameters support this option, which provides additional querying based on master data information. If Include Descendants is not selected, event data is searched only for the specified Business Location or Read Point URI. If Include Descendants is selected, the query is broadened to include any children of the specified location or read point. The query determines whether there is a master data entry for the business location or read point. If there is a master data entry, and if that entry has children, those URIs are also included in the query. This lets you search event data not only for a specific business location or read point, but also for additional items that have been associated with that URI through master data. Explanation: Master data allows the arbitrary establishment of a hierarchical parent-child relationship among master data entries. For example, a building which is a business location could have its second floor as a child entry. In addition, that second floor entry could have a stock room and a sales room as child entries. Therefore, if you specify the URI for the building as the Business Location and select Include Descendants, the resulting query searches event data looking not only for the building but also for any event whose business location is the second floor, stock room, or sales room.
> Business Step | Query results will include only events for this business step (specified as a URI). Examples of business steps specified as URIs are: `urn:epcglobal:epcis:bizstep:fmcg:shipped` `urn:epcglobal:epcis:bizstep:fmcg:arrived` You can specify more than one business step; use newline characters as separators.
> Business Transaction | Query results will include only events for this business transaction. For each business transaction parameter you specify one business transaction type and one or more business transaction values. Note that you can add more than one business transaction parameter to a query. After you add one business transaction parameter, you will see that Business Transaction is still available from the drop-down list of parameters.
> Business Transaction Type | Business transaction type (specified as a URI). Examples of business transaction types specified as URIs are: `urn:epcglobal:fmcg:btt:po` You can specify only one business transaction type for each business transaction parameter.
> Business Transaction Values | One or more business transaction values (specified as URIs). When you create a business transaction parameter, it can contain only one business transaction type, but the parameter can have more than one value associated with that type. Examples of business transaction values specified as URIs are: `http://transaction.acme.com/po/12345678` `http://transaction.acme.com/po/1152` When specifying multiple values, use newline characters as separators.
> Disposition | Query results will include only events for this disposition (specified as a URI). Examples of dispositions specified as URIs are: `urn:epcglobal:epcis:disp:fmcg:sellable_available` `urn:epcglobal:epcis:disp:fmcg:processing` You can specify more than one disposition; use newline characters as separators.
> Event Count Limit | The number of events to include in the results. Enter a positive integer in the range 1 to 2147483647. Results will include only the first N events that match the other criteria, where N is the value of this parameter. The ordering specified by the Order By and Order Direction parameters determine the meaning of "first" for this purpose. If a value for Event Count Limit is not specified, all events matching the specified criteria will be included in the results. Event Count Limit and Max Event Count are mutually exclusive parameters. You can use one or the other of these parameters in a query; you cannot use both. If you select one of these parameters, the other one is no longer available from the drop-down list. If you remove either of these parameters from a query, both parameters are again available from the drop-down list.
> Event Type | The event types for the query. The query result will include events whose type matches one of the selected types: Object Event Aggregation Event Quantity Event Transaction Event
> Object Event | Include Object Events in the query. An Object Event pertains to one EPC, or to more than one EPC as long as the set of EPCs (epcList) share the same event attributes. In an Object Event, no relationship among the EPCs is implied by their appearing in the same Object Event, other than the coincidence of them all being captured with identical information.
> Aggregation Event | Include Aggregation Events in the query. An Aggregation Event describes events related to objects that have been physically aggregated. In such an event, there is a set of contained objects that have been aggregated within a containing entity which identifies the physical aggregation itself. An example of an aggregation is where cases are loaded onto a pallet and carried as a unit; the pallet may well have a tag, but the containing entity is not the physical pallet, it is the aggregate of the pallet and all the cases. Because an Aggregation Event indicates aggregations among physical objects, the children are identified by EPCs. However, the parent entity is identified by an arbitrary URI (which may or may not be an EPC) because the parent is not necessarily a physical object that is separate from the aggregation itself.
> Quantity Event | Include Quantity Events in the query. A Quantity Event captures an event that pertains to a specified quantity of an object class; for example, to report inventory levels of a product.
> Transaction Event | Include Transaction Events in the query. A Transaction Event describes the association or disassociation of physical objects to one or more business transactions. While other event types have an optional bizTransactionList field that can be used to provide context for an event, the Transaction Event is used to declare in an unequivocal way that certain EPCs have been associated or disassociated with one or more business transactions as part of the event.
> Field with Attribute | Include events that are associated with the specified master data type field, attribute ID, and values. The Field with Attribute parameter lets you filter query results based on master data information. You can create more than one Field with Attribute parameter. To create a Field with Attribute parameter, first select a field name from the drop-down list of supported master data types. Then enter one (and only one) master data type attribute ID and one or more master data entry attribute values. For example, if you select a field name of Business Location, enter the attribute ID for one Business Location attribute type, and then enter the value or values for that attribute ID that you want the query to find. For instance, to limit query results to events that reference a Business Location in Canada: Field Name: Business Location Attribute ID: urn:epcglobal:epcis:mda:country Attribute Values: Canada
> Field Name | Field name. The drop-down list contains supported field names (master data types): Business Location, Business Step, Disposition, and Read Point.
> Attribute ID | One master data type attribute ID (specified as a URI). Each master data type has a defined set of attributes. Each attribute has an attribute ID. Examples of attribute IDs for Business Location or Read Point are: `urn:epcglobal:epcis:mda:name` `urn:epcglobal:epcis:mda:description` `urn:epcglobal:epcis:mda:address1` `urn:epcglobal:epcis:mda:address2` `urn:epcglobal:epcis:mda:address3` `urn:epcglobal:epcis:mda:city` `urn:epcglobal:epcis:mda:stateProvince` `urn:epcglobal:epcis:mda:country` `urn:epcglobal:epcis:mda:postalCode` `urn:epcglobal:fmcg:gln` (global location number) `urn:epcglobal:fmcg:sslt` (site sublocation type) `urn:epcglobal:fmcg:sslta` (site sublocation type attributes) `urn:epcglobal:fmcg:sle` (site location extension) Examples of attribute IDs for Business Step or Disposition are: `urn:epcglobal:epcis:mda:name` `urn:epcglobal:epcis:mda:description` These example attribute IDs are the default attribute IDs supplied with Enterprise Server. Use the Master Data Administration Console to determine which attribute IDs are in use at your site.
> Attribute Values | One or more master data entry attribute values. A master data entry is a concrete instance of a master data type. Each master data entry has the attributes associated with its type. In addition, a master data entry has values associated with its attributes. For the attribute ID that you entered in the Attribute ID box, enter actual values for that ID. For example, if you select Business Location as the Field, and then enter `urn:epcglobal:epcis:mda:city` as the Attribute ID, you would now enter the name of one or more cities as Attribute Values. For example: `Boston Paris` You can specify more than one value; use newline characters as separators.
> Child EPC Matches One of the Patterns | One or more Child EPC patterns. The result will only include events that have a `childEPC` field (Aggregation Event) where the `childEPC` field matches one of the EPC patterns specified here as a pure identity pattern. An example of a pure identity pattern is: `urn:epc:idpat:sgtin:0652642.*.*` Note that when specifying an `idpat` you cannot include a range. For example, the following pattern is not valid: `urn:epc:idpat:sgtin:000000000000.0.[0-9]` There is no EPC validation performed on the string you enter. However, if the string is not recognized as an EPC pattern, the Console displays a warning message. If you choose to keep the string as the parameter value, the query will search for an exact match of the string (which is assumed to be a valid URI) instead of performing a search based on pattern matching. To edit the string, click on the parameter name in the EPCIS Query Parameters table.
> EPC Matches One of the Patterns | One or more EPC patterns. The result will only include events that have an `epc` field (that is, Object Events or extension event type that extends `ObjectEvent`) where the `epc` field matches one of the EPC patterns specified here as a pure identity pattern. An example of a pure identity pattern is: `urn:epc:idpat:sgtin:0652642.*.*` Note that when specifying an `idpat` you cannot include a range. For example, the following pattern is not valid: `urn:epc:idpat:sgtin:000000000000.0.[0-9]` There is no EPC validation performed on the string you enter. However, if the string is not recognized as an EPC pattern, the Console displays a warning message. If you choose to keep the string as the parameter value, the query will search for an exact match of the string (which is assumed to be a valid URI) instead of performing a search based on pattern matching. To edit the string, click on the parameter name in the EPCIS Query Parameters table.
> EPC Class Matches One of the Patterns | One or more EPC Class patterns. The result will only include events that have an `epcClass` field (Quantity Events) where the `epcClass` field matches one of the EPC patterns specified here as a pure identity pattern. An example of a pure identity pattern is: `urn:epc:idpat:sgtin:0652642.*.*` Note that when specifying an `idpat` you cannot include a range. For example, the following pattern is not valid: `urn:epc:idpat:sgtin:000000000000.0.[0-9]` There is no EPC validation performed on the string you enter. However, if the string is not recognized as an EPC pattern, the Console displays a warning message. If you choose to keep the string as the parameter value, the query will search for an exact match of the string (which is assumed to be a valid URI) instead of performing a search based on pattern matching. To edit the string, click on the parameter name in the EPCIS Query Parameters table.
> Parent ID Matches One of the Patterns | One or more Parent IDs. The result will only include events that have a `parentID` field (Aggregation Event and Transaction Event) where the `parentID` field matches the entered value. In general, a parent ID is one of the EPC patterns specified here as a pure identity pattern. An example of a pure identity pattern is: `urn:epc:idpat:sgtin:0652642.*.*` Note that when specifying an `idpat` you should not include a range. For example, the following pattern is not valid: `urn:epc:idpat:sgtin:000000000000.0.[0-9]` A parent ID can be an arbitrary URI that is not a URN. If the entered string is not recognized as an EPC pattern, the search is performed against database entries stored in the EPC.URI field.
> Max Event Count | The maximum number of events to return in the query results. Enter a positive integer in the range 1 to 2147483647. At most, this many events will be included in the query results. If a value for Max Event Count is not specified, all events matching the specified criteria will be included in the results. Max Event Count and Event Count Limit are mutually exclusive parameters. You can use one or the other of these parameters in a query; you cannot use both. If you select one of these parameters, the other one is no longer available from the drop-down list. If you remove either of these parameters from a query, both parameters are again available from the drop-down list.
> Order By | The parameter that determines how results are ordered. You can order results by event time, record time, or quantity. Note: Because only a Quantity Event has a `quantity` field, selecting Quantity as the Order By parameter means that events of type `QuantityEvent` will be ordered but other types of events will have no sort order applied to them.
> Event Time | See Order By.
> Record Time | See Order By.
> Order Direction | The order direction: ascending (ASC) or descending (DESC).
> ASC | Order the results selected by Order By in ascending order. If Order By is event time, events are ordered from oldest event time to most recent event time. If Order By is quantity, events are ordered from fewest quantity to greatest quantity. If Order By is record time, events are ordered from oldest record time to most recent record time.
> DESC | Order the results selected by Order By in descending order. If Order By is event time, events are ordered from most recent event time to oldest event time. If Order By is quantity, events are ordered from greatest quantity to fewest quantity. If Order By is record time, events are ordered from most recent record time to oldest record time.
> Quantity | A number of objects. Enter an integer in the range 0 to 2147483647. The Quantity parameter (quantity value plus operator value) determines whether the query result includes or excludes a Quantity Event based on the value of the event's quantity field. For information about Quantity as a selectable option for the Order By parameter, see Order By.
> Operator | The comparison operator used with the quantity parameter. Operator values are greater than, less than, equal to, equal to or greater than, and equal to or less than.
> Read Point | Query results will include only events for this read point (specified as a URIs). The read point is the location that identifies the most specific place at which an event took place. The read point for an event is determined by the capturing application. Read point URIs use the same format as business locations. Examples of read points specified as URIs are: `urn:epcglobal:fmcg:loc:0614141003624:203,412.Door123` `urn:epc:id:sgln:0614141.12345.0` You can specify more than one read point; use newline characters as separators.

> #### Column Display

> Name | Description
> --- | ---
> Parameter Name | The names of the query parameters associated with this subscription.
> Parameter Value | The values for the query parameters associated with this subscription.

> #### Buttons

> Name | Description
> --- | ---
> Back | Return to the previous screen.
> Next | Proceed to the next screen.
> Finish | Finish and subscribe the current query.
> Test Query | Test (execute) the current query and view the results.
> Cancel | Cancel the current operation.

> Related Tasks

> - Create query subscriptions
> - Copy query subscriptions
> - Delete query subscriptions
> - Modify query subscriptions
> - Test query parameters

> Related Topics

> - Event Service
> - Data Exchange Service
> - EPC Tag Data Standard Version 1.1 rev 1.27
> - XML Schema Part 2: Datatypes Second Edition