abn.Add

This job creates a subscription for the specified object.

The request for request subscriptions (AboRequest) must consist of lowercase letters and begin with select count(distinct d.id) or select distinct d.id, otherwise it will be rejected. Depending on the main type of the requested object, o.id must be used for folders, r.id for registers or d.id for documents as identifier.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Currently not supported — pass 0.

ObjectID

INT

Yes

ID of the object to be notified about

ObjectType

INT

Yes

Type of the object

ActionFlags

INT

Yes

Action performed on the document that triggers notification:
2 = Notification when a document is created (for subscribed requests only)
3 = Notification when index data is changed (for subscribed documents only)
4 = Notification when the document is changed
27 = Notification when the document is deleted
39 = Notification when a location is added

Channel

INT

Yes

Notification channel (type of notification):
0 = Notification via internal channel (oxmljsc)
1 = Notification via email

AboGrpID

STRING

Yes

This ID combines all actions of a subscription.

[User]

STRING

No

Name of the user to be notified

[Alias]

STRING

No

Info text for the subscription (max. 255 characters)

[Product]

STRING

No

String describing the program instance, e.g. ax.exe

[Confirm]

INT

No

1 = user/group was notified, must be marked as read before deleting the message
2 = system password of the user is queried before marking as read
0 = no confirmation required (default)

[Station]

STRING

No

Name of the station that should exclusively receive the notification

[Mail]

STRING

No

Email address for notification (max. 255 characters); multiple addresses separated by semicolon

[AboType]

INT

No

0 = Document subscription (default); 1 = Request subscription

[RequestFormat]

STRING

No

Format of the request. Default ABN (native SQL format; request is evaluated in parameter AboRequest). XML = DMSQuery request expected in parameter XmlRequest.

[AboRequest]

STRING

No

SQL statement for request subscriptions

[XmlRequest]

STRING/BASE64

No

Subscription request in DMSQuery XML format

[GroupID]

STRING

No

GUID of the group to be notified

[UserID]

STRING

No

User GUID of the Abo admin when creating system subscriptions

2. Return Value

(INT): 0 = Job successful, otherwise error code.

See also: abn.Remove