Subscribe (tlbct5220m000)

Use this session to create or modify event subscriptions.

You start this session from the menu bar of the Event Subscriptions (tlbct5500m000) session.

For information on the filter that can be used in the subscription, see the Infor LN Studio Integration Development Guide.

Caution: 
You must not overwrite subscriptions that are managed from outside LN.

Subscriptions on BDE Business Interfaces can be managed from outside LN, using the SubscribeEvent method of the BDE interface. Using the Subscribe (tlbct5220m000) session, you can overwrite these external subscriptions. You are advised not to maintain subscriptions through both the SubscribeEvent method and the Subscribe session.

Buttons

These buttons are available:

Subscribe
Creates a subscription in the specified LN company, as indicated by the settings you specified in the current session.

After you clicked Subscribe , LN reports whether the subscription succeeded or failed.

Subscriptions only take effect after you restart the bshell. This is necessary to activate the subscription's auditing profile. To restart the bshell, you must log out from the LN application and log on again. When you use Web UI, for example, you simply restart the Web UI service.

Field Information

Company

The number of the LN company containing the business object that provides the event publishing service.

Allowed values

The company number is mandatory and must be a whole number in the range from 0 to 999.

Business Object

The name of the business object that provides the event publishing service, for example SalesOrder. The subscription is created for this business object.

Allowed values

This field is mandatory. To specify a value, zoom to the Business Objects (ttadv7501m000) session and select in this session a business object. This session only shows the public business objects of the current VRC. To specify a private business object, enter the name of the business object directly in the field.

The Business Objects (ttadv7501m000) session can contain business objects that are not suited for event publishing, because they do not have a SubscribeEvent and a PublishEvent method.

Select Standard Event Actions

If this check box is selected, the subscription uses all standard event actions of the selected business object.

These standard or default event actions are the standard events according to the BDE specification (that is, create, change and delete) (see Event Actions).

Default value

By default, the check box is selected.

Event Actions

The actions that can be performed on the selected business object and that trigger an event. These actions can include standard event actions or custom event actions.

The standard event actions consist of the invocation of standard methods Create, Change and Delete, as explained in the following paragraphs.

For the BDE Business Interfaces changes in the state of a business object instance produce events by default. These changes are referred to as standard event actions and correspond to the standard business object methods create, change and delete.

Allowed values

A list of one or more event actions for the selected business object. The event action names must be separated by spaces. You must select at least one event action.

The default event actions are:

  • create
  • change
  • delete

Note that these event action values are case-sensitive.

Select All Attributes

If this check box is selected, the published event messages will contain data from all components and attributes of the selected business object.

Which business data is published will depend on the selected business object.

Default value

By default, the check box is selected.

Component/Attribute Selection

The business data (components and attributes) that are included in the published event messages.

Allowed values

A list of one or more attributes or components of the selected business object. The attribute or component names must be separated by spaces or new line characters. You must select at least one attribute.

The selections are the same as the ‘selectionAttribute’ contents in the BDE List and Show methods. Therefore, you can use <Component>.<Attribute> or <Component>.<Group>.<Attribute>, or you can use a ‘*’ to select multiple attributes from the same component or attribute group. The following values illustrate how you can specify a selection:

  • Order.date (only the order date)
  • Order.Line.PriceData.* (the complete contents of the PriceData group in the Line component)
  • Order.* (all attributes from the Order component, but the Line subcomponent will not be included)
Note: If at least one attribute is selected, then the identifiers from the component and its parent components are also selected. For example, if you select Order.Line.Item, then also Order.Line.LineNumber and Order.OrderNumber are selected.
Select All Instances

If this check box is selected, no filter is applied and the specified business object publishes event messages for all its instances.

Default value

By default, the check box is selected.

Instance Filter (XML)

The filter that determines for which instances event messages are published. The filter is in an XML format that is specific to LN and that conforms to the BDE standards of LN. Only the object or component instances that pass through this filter are includes in the event messages.

Allowed values

An XML document that complies to the BDE filter specifications.

Destination

The address of the event consumer to which the event message must be sent.

The destination consists of a Bus Component that represents an Infor Integration back end. On this back end, the enterprise application runs that consumes the event messages. The name of this application is specified in the Event Consumer field.

Event Consumer

The name of the event consumer application, as specified in the event messages published by BDE Business Interfaces.

Allowed values

An ASCII text.

This field is mandatory.