Register

Examples


The Register procedure of the Dummy_Presence_Form form registers the presence indicator for a field so the indicator can be updated.

Syntax

Register of form Dummy_Presence_Form, form_name, window_name, index, SIP_address, master_ID, master_type, address_code, product_ID

Parameters

form_name – A string specifying the name of the form that contains the presence indicator field.

window_name – A string specifying the name of the window that contains the presence indicator field.

index – An integer specifying the presence field instance that is being registered. The value 1 indicates the first presence field for the window, the value 2 indicates the second, and so on.

SIP_address – A string specifying the SIP address for the entity. Typically, this value is retrieved from the corresponding Label_Presence field for the presence indicator.

master_ID – A string that contains the ID of the entity. For instance, when retrieving the SIP address for a salesperson, this is the Salesperson ID.

master_type – A string that specifies the type of entity. The following table lists the possible values:

[spacer]

Value

Constant

Description

CUS

CO_INETADDRS_CUSTOMER

Customer

EMP

CO_INETADDRS_EMPLOYEE

Employee

SLP

CO_INETADDRS_SALESPERSON

Salesperson

VEN

CO_INETADDRS_VENDOR

Vendor


address_code – If multiple addresses can be defined for the entity, specifies the ID of the set of address information from which the SIP address will be retrieved. If the entity does not support multiple addresses, use the empty string ("").

product_ID – An integer specifying the product ID for the product that contains the presence fields.


Documentation Feedback