Bulletin Transactions

The API Bulletin Board transactions can be used to create, update, delete and retrieve bulletin board entries.

Limited Support/End of Life Capabilities

The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact Alemba Support

Transactions are also provided for sending bulletin board entries to Users, groups and analysts.

BulletinCreate Transaction

The BulletinCreate transaction can be used to create a bulletin board entry.

Input Parameters: BulletinCreateRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Ignored

-

Ignored on Create transaction

sTitle

String

No

“”

Title of the Bulletin Board entry

dDateActive

Date/Time

Yes

Today

Date from which the Bulletin Board entry is active

dDateExpire

Date/Time

Yes

Today + 1 month

Date to which the Bulletin Board entry is active

bIsHTML

Boolean

No

False

Format in which the Bulletin Board entry will display. Values:

  • True = Create Bulletin Board entry in HTML format.

  • False = Create Bulletin Board entry in Plain Text format.

sBody

String

No

“”

Body of the Bulletin Board entry

lPriority

Lookup Field

No

0

Bulletin Board Priority

nCallNo

Integer

No

0

Number of the call linked to the Bulletin Board entry

nRequestNo

Integer

No

0

Number of the request linked to the Bulletin Board entry

nTaskNo

Integer

No

0

Number of the task linked to the Bulletin Board entry

yExtPortalVisible

Yes/No

No

N

Is this Bulletin Board entry visible to External Suppliers on the Self Service Portal?

yPortalVisible

Yes/No

No

N

Is this Bulletin Board entry visible to Users on the Self Service Portal?

yAlertInd

Yes/No

No

N

Send a pop-up message alert to analysts that the Bulletin Board has been updated?

yInternalInd

Yes/No

No

N

Send an internal message to specified recipients?

yMailInd

Yes/No

No

N

Send an email to specified recipients?

yPagerInd

Yes/No

No

N

Send a pager message to specified recipients?

lCMGroup

Lookup Field

No

-

Workflow Management group(s) to receive notification about the Bulletin Board entry.

Ignored if yFilterRecipientsByGroup is N.

lIPKGroup

Lookup Field

No

-

IPK group(s) to receive notification about the Bulletin Board entry

Ignored if yFilterRecipientsByGroup is N.

yFilterRecipientsByGroup

Yes/No

No

N

Filter Recipients by Group? Values:

  • Y = will check both CM and IPK groups

  • N = ignores CMGroup and IPKGroup

lPartition

Lookup Field

No

Analyst’s default partition

Partition in which the Bulletin Board entry will be created

lSecurityProfile

Lookup Field

No

0

Security Profile in which to apply to the Bulletin Board entry

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values:BulletinResponse

Argument

Type

Description

nEntityRef

Integer

New bulletin ref

sMessage

String

Error/Warning Message

Ret

APIReturn

Error/Warning Number

BulletinUpdate Transaction

The BulletinUpdate transaction can be used to modify an existing Bulletin Board entry.

Input Parameters: BulletinUpdateRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Bulletin Entry

sTitle

String

No

“”

Title of the Bulletin Board entry

dDateActive

Date/Time

Yes

Today

Date from which the Bulletin Board entry is active

dDateExpire

Date/Time

Yes

Today + 1 month

Date to which the Bulletin Board entry is active

bIsHTML

Boolean

No

False

Format in which the Bulletin Board entry will display. Values:

  • True = Create Bulletin Board entry in HTML format.

  • False = Create Bulletin Board entry in Plain Text format.

sBody

String

No

“”

Body of the Bulletin Board entry

lPriority

Lookup Field

No

0

Bulletin Board Priority

nCallNo

Integer

No

0

Number of the call linked to the Bulletin Board entry

nRequestNo

Integer

No

0

Number of the request linked to the Bulletin Board entry

nTaskNo

Integer

No

0

Number of the task linked to the Bulletin Board entry

yExtPortalVisible

Yes/No

No

N

Is this Bulletin Board entry visible to External Suppliers on the Self Service Portal?

yPortalVisible

Yes/No

No

N

Is this Bulletin Board entry visible to Users on the Self Service Portal?

yAlertInd

Yes/No

No

N

Send a pop-up message alert to analysts that the Bulletin Board has been updated?

yInternalInd

Yes/No

No

N

Send an internal message to specified recipients?

yMailInd

Yes/No

No

N

Send an email to specified recipients?

yPagerInd

Yes/No

No

N

Send a pager message to specified recipients?

lCMGroup

Lookup Field

No

-

Workflow Management group(s) to receive notification about the Bulletin Board entry.

Ignored if yFilterRecipientsByGroup is N.

lIPKGroup

Lookup Field

No

-

IPK group(s) to receive notification about the Bulletin Board entry

Ignored if yFilterRecipientsByGroup is N.

yFilterRecipientsByGroup

Yes/No

No

N

Filter Recipients by Group? Values:

  • Y = will check both CM and IPK groups

  • N = ignores CMGroup and IPKGroup

lPartition

Lookup Field

No

Analyst’s default partition

Partition in which the Bulletin Board entry will be created

lSecurityProfile

Lookup Field

No

0

Security Profile in which to apply to the Bulletin Board entry

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: BulletinResponse

See BulletinResponse for more information.

BulletinRetrieve Transaction

The BulletinRetrieve transaction can be used to retrieve a Bulletin Board entry.

Input Parameters: BulletinEntityRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Bulletin Board entry to retrieve

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: BulletinRetrieveResponse

Argument

Type

Description

Ret

APIReturn

Error/Warning Number

sMessage

String

Error/Warning Message

ResultSet

DataSet

ResultSet containing attribute details

BulletinDelete Transaction

The BulletinDelete transaction can be used to delete a Bulletin Board entry.

Input Parameters: BulletinDeleteRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Bulletin board entry to delete

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: BulletinResponse

See BulletinResponse for more information.