Build 1.127-SNAPSHOT (Maven confluence-reporting plugin)

DeviceAdvancedReader

com.cdrator.device.action.DeviceAdvancedReader

8.7

Retrieves devices based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SetDeviceDescription

com.cdrator.device.action.SetDeviceDescription

8.7

void:

1. Device: device
2. String: description

DeviceReader

com.cdrator.device.action.DeviceReader

8.7

Retrieves a Device based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

DeviceSetter

com.cdrator.device.action.DeviceSetter

8.7

Sets an attribute of Device

void: Sets an attribute of a persistent object

1. attributeName: Attribute that should be set on the persistent object
2. savePersistentObject: Check if the persistent object should be saved after updating it. Default is true.

1. PersistentObject: persistentObject
2. Object: value

CdmaPhoneAdvancedReader

com.cdrator.device.cdmaphone.action.CdmaPhoneAdvancedReader

8.7

Retrieves CDMA phones based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CdmaPhoneReader

com.cdrator.device.cdmaphone.action.CdmaPhoneReader

8.7

Retrieves a CDMA phone based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

FileObjectReader

com.cdrator.misc.action.FileObjectReader

8.7

Retrieves a File Object based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CreateLongDescriptionElementList

com.cdrator.misc.action.CreateLongDescriptionElementList

8.7

Creates a list of LongDescriptionElements based on a mail template. The values are retrieved by using MethodCaller.The mail template must be in text format. It must and contain a key, value and style delimited by some configurable character(s) . The key will be added in LongDescriptionElement.Text The value must be in the format SUBSCRIPTION.getService.getSimCard.getPin1 which will be resolved and put in LongDescriptionElement.Value. The objects used for retrieving the values must be in context.Last a style object must be included - it sets the LongDescriptionElement.HighLight field. (Only 'bold' will set highlight to true)Example: Pin1,SIMCARD.getPin1,normal - delimiter is ',' SIMCARD must be in context and text will be set to Pin1 and value resolved.Of course more lines can be added.An existing list can be passed in and the resolved list will be added to this existing list. If there is no list to add simply pass in 'Collections emptyList()'

List: List of LongDescriptionElements

1. delimiter: Delimiter used for splitting the mail template text into key/value pairs. It must be a regular expression. Example : ',|

1. String: template
2. WfContext: context
3. List: addToExistingList

MailTemplateAdvancedReader

com.cdrator.misc.action.MailTemplateAdvancedReader

8.7

Retrieves mail templates based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

This action is deprecated and therefore should not be used.

CreateLongDescriptionElements

com.cdrator.misc.action.CreateLongDescriptionElements

8.7

Creates a list of LongDescriptionElements based on a mail template. The values are retrieved by using MethodCaller.The mail template must be in text format. It must and contain a key, value and style delimited by some configurable character. The key will be added in LongDescriptionElement.Text The value must be in the format SUBSCRIPTION.getService.getSimCard.getPin1 which will be resolved and put in LongDescriptionElement.Value. The objects used for retrieving the values must be in context.Last a style object must be included - it sets the LongDescriptionElement.HighLight field. (Only 'bold' will set highlight to true)Example: Pin1,SIMCARD.getPin1,normal - delimiter is ',' SIMCARD must be in context and text will be set to Pin1 and value resolved.Of course more lines can be added.

ArrayList: List of LongDescriptionElements

1. delimiter: Delimiter used for splitting the mail template text into key/value pairs.

1. String: template
2. WfContext: context

TranslateByBroker

com.cdrator.misc.action.TranslateByBroker

8.7

Translates the given text using the language of the given broker

String: Returns the translated text.

1. Broker: broker
2. String: text

ZipCodeAdvancedReader

com.cdrator.misc.action.ZipCodeAdvancedReader

8.7

Retrieves zip codes based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

FileObjectAdvancedReader

com.cdrator.misc.action.FileObjectAdvancedReader

8.7

Retrieves file objects based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

MailTemplateReader

com.cdrator.misc.action.MailTemplateReader

8.7

Retrieves a Mail Template based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GenerateQRCodeImage

com.cdrator.misc.barcodes.action.GenerateQRCodeImage

8.7

This action retrieves an Image of a QR code of the specified content having the specified size

Image: Returns the string value of the parameter requested. Or an empty string, if none exists.

1. int: width
2. int: height
3. String: content

BrandReader

com.cdrator.brand.action.BrandReader

8.7

Retrieves a Brand based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BrandAdvancedReader

com.cdrator.brand.action.BrandAdvancedReader

8.7

Retrieves brands based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

This action is deprecated and therefore should not be used.

BlockSimCard

com.cdrator.simcard.action.BlockSimCard

8.7

This action will create a provisioning task to block or soft-block a SIM card. Please use HardBlockSIMCard or SoftBlockSIMCard instead.

String: "Blocked" for blocked, or "Invalid_Block_Type" for an invalid blocking type.

1. hardBlockParameter: Parameter string used to hard-block the SIM card.
2. softBlockParameter: Parameter string used to soft-block the SIM card.

1. String: blockType
2. SimCard: simCard
3. String: blockReason

GetAvailableRandomSimCard

com.cdrator.simcard.action.GetAvailableRandomSimCard

8.7

Fetches a random available SIM card. Available means that the status is 0 (open and active) and it's not reserved. The SIM card type can be specified as a parameter.

SimCard: The available SIM card if found.

1. String: simTypeId

CreateSimcardChangeRequest

com.cdrator.simcard.action.CreateSimcardChangeRequest

8.7

Creates a SimcardChangeRequest object which can be used to start the Simcard Change Process

SimcardChangeRequest: The newly created SimcardChangeRequest object

1. SimCard: newSim
2. StatusSimType: simType
3. SimCardOrderType: orderType
4. Address: address
5. boolean: sendSim
6. boolean: addFee

SimCardReader

com.cdrator.simcard.action.SimCardReader

8.7

Retrieves a SIM card based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

ChangeSimTypeStatus

com.cdrator.simcard.action.ChangeSimTypeStatus

8.7

This action sets the SIM type status.

void: No return value.

1. selectedStatus: Status types to choose from.

1. SimCard: simcard

CheckIsSimcardBlockedOrInBlockedPending

com.cdrator.simcard.action.CheckIsSimcardBlockedOrInBlockedPending

8.7

Checks if the given Simcard is in some block/block pending status already (includes SoftBloc, HardBlock and Stolen)

boolean: Returns TRUE if simcard already in some block/block pending status already, FALSE otherwise

1. SimCard: simcard

SimCardAdvancedReader

com.cdrator.simcard.action.SimCardAdvancedReader

8.7

Retrieves SIM cards based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

ReleaseSimCard

com.cdrator.simcard.action.ReleaseSimCard

8.7

Release an SimCard.

void: No Return Value

1. SimCard: simCard

This action is deprecated and therefore should not be used.

GetSimcardByIcc

com.cdrator.simcard.action.GetSimcardByIcc

8.7

Action for retrieving a SIM card from the database by ICC.

SimCard: The SIM card with the specified ICC. If no SIM card is found, null is returned.

1. String: icc

CreateOrGetSimCardWithICC

com.cdrator.simcard.action.CreateOrGetSimCardWithICC

8.7

This action gets SIMCARD with provided ICC or creates a new one.

SimCard: No return value

1. String: icc
2. boolean: saveNewSim

SoftBlockSimCard

com.cdrator.simcard.action.SoftBlockSimCard

8.7

Start up a workflow that will soft-block the SIM card.

void:

1. SimCard: simCard
2. String: blockReason

ReserveSimcard

com.cdrator.simcard.action.ReserveSimcard

8.7

Action for reserving a SIM card to a service.

boolean: The SIM card with the specified ICC. If no SIM card is found, null is returned.

1. SimCard: simcard
2. Service: service

This action is deprecated and therefore should not be used.

IsSimcardHardBlocked

com.cdrator.simcard.action.IsSimcardHardBlocked

8.7

Checks if the Simcard of the given Subscription is already in HardBlocked (9) or HardBlocked_Pending (102) status

boolean: Returns TRUE if simcard already HardBlocked (9) or HardBlocked_Pending (102), FALSE otherwise

1. Subscription: subscription

FindSimcardsByIccAndPUK

com.cdrator.simcard.action.FindSimcardsByIccAndPUK

8.7

Action for retrieving a SIM cards from the database based on ICC and PUK.

ArrayList: The SIM cards with the ICC substring or the complete PUK. If no SIM cards are found, null is returned.

1. onlyAvailableSIM: Only return available simcards?

1. String: icc
2. String: puk

ReserveSimcardToDate

com.cdrator.simcard.action.ReserveSimcardToDate

8.7

Action for reserving a SIM card to a service until a given date.

void: No return value.

1. overrideCheck: Should a check to see if the simcard can be used on the service be performed?

1. SimCard: simcard
2. Service: service
3. Date: reserveToDate
4. String: description

This action is deprecated and therefore should not be used.

IsSimcardBlockedOrInBlockedPending

com.cdrator.simcard.action.IsSimcardBlockedOrInBlockedPending

8.7

Checks if the Simcard of the given Subscription is in some block/block pending status already (includes SoftBloc, HardBlock and Stolen)

boolean: Returns TRUE if simcard already in some block/block pending status already, FALSE otherwise

1. Subscription: subscription

UnblockSimCard

com.cdrator.simcard.action.UnblockSimCard

8.7

Start up a workflow that will unblock the SIM card.

String:

1. SimCard: simCard

ChangeSimStatus

com.cdrator.simcard.action.ChangeSimStatus

8.7

This action sets the SIM card status. If softblocked, barred or stolen is set, the blocked from date is updated. If in use is set, the blocked from date is set null. If the 'update network status' option is selected, the networkStatusId on the simcard will be updated as well.

void: No return value.

1. changeNetworkStatus: Update network status
2. selectedStatus: Status options to choose from.

1. SimCard: simcard

HardBlockSimCard

com.cdrator.simcard.action.HardBlockSimCard

8.7

Start up a workflow that will hard-block the SIM card.

void:

1. SimCard: simCard

AssignSimCardToService

com.cdrator.simcard.action.AssignSimCardToService

8.7

Assign simcard to a service.

void: No return value.

1. makeOrderFor: If checked a simcard order is created.

1. SimCard: simCard
2. Service: service

CheckIsSimcardHardBlocked

com.cdrator.simcard.action.CheckIsSimcardHardBlocked

8.7

Checks if the given Simcard is already in HardBlocked (9) or HardBlocked_Pending (102) status

boolean: Returns TRUE if simcard already HardBlocked (9) or HardBlocked_Pending (102), FALSE otherwise

1. SimCard: simcard

ReserveSimcardFor

com.cdrator.simcard.action.ReserveSimcardFor

8.7

Action for reserving a SIM card to a service.

void: No return value.

1. minutesToReserveFor: Set the reservation time in minutes. If not set, default is 15 minutes.
2. performCheck: Should a check to see if the simcard can be used on the service be performed?

1. SimCard: simcard
2. Service: service
3. String: description

RollbackTransaction

com.cdrator.support.action.RollbackTransaction

8.7

Rolls back the current transaction

void: Void

SaveObjectInNewTransaction

com.cdrator.support.action.SaveObjectInNewTransaction

8.7

Takes a persistent object and saves it in a new transction.

void:

1. PersistentObject: object

CommitTransaction

com.cdrator.support.action.CommitTransaction

8.7

Commits the current transaction

void: Void

BeginTransaction

com.cdrator.support.action.BeginTransaction

8.7

Starts a new transaction

void: Void

CreateContextForPersistentObject

com.cdrator.soap.CreateContextForPersistentObject

8.7

Create a context based on a persistentObject

Context: The persistentObject wrapped into a context

1. PersistentObject: persistentObject

CreateContextList

com.cdrator.soap.CreateContextList

8.7

Create a context list based on a list of persistentObjects

List: The list of persistentObjects wrapped into a list of contexts

1. List: poList

CreateNewContextWithKeyValue

com.cdrator.soap.CreateNewContextWithKeyValue

8.7

create a context with give key value pair

Context: Return a Context object with given key value pair

1. String: key
2. Object: value

DeletePendingAlerts

com.cdrator.alert.action.DeletePendingAlerts

8.7

void:

1. alertMethod: Alert method

1. Subscription: subscription

GetNewSubscriptionBundle

com.cdrator.campaign.action.GetNewSubscriptionBundle

8.7

This action creates and returns a new SubscriptionBundle.

SubscriptionBundle: Returns a new SubscriptionBundle

1. Bundle: bundle
2. Subscription: subscription
3. SubscriptionCampaign: subscriptionCampaign

SetSubscriptionCampaignFromDateToNextMonth

com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth

8.7

Sets the subscriptionCampaign.fromDate to the first day of next month.

void: No return values

1. SubscriptionCampaign: subscriptionCampaign

TerminateCampaignWithFromDate

com.cdrator.campaign.action.TerminateCampaignWithFromDate

8.7

Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate

void: No return values

1. SubscriptionCampaign: subscriptionCampaign

SubscriptionCampaignAdvancedReader

com.cdrator.campaign.action.SubscriptionCampaignAdvancedReader

8.7

Retrieves subscription campaigns based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

This action is deprecated and therefore should not be used.

GetSubscriptionCampaignsByCriteria

com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria

8.7

This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.

List: A list of SubscriptionCampaign matching given criterias.

1. Subscription: subscription
2. String: criterias

AssignCampaign

com.cdrator.campaign.action.AssignCampaign

8.7

Assign a campaign to the provided subscription. If startDate is null the subscription campaign will be activated immediately

SubscriptionCampaign: The new subscription campaign

1. Campaign: campaign
2. Subscription: subscription
3. Date: startDate
4. boolean: autoExtend

SetSubscriptionCampaignToDateRestOfMonth

com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth

8.7

This action sets the toDate on a subscriptionCampaign to the end of the current month.

SubscriptionCampaign: The subscription campaign.

1. SubscriptionCampaign: subscriptionCampaign

SetSubscriptionCampaignParameter

com.cdrator.campaign.action.SetSubscriptionCampaignParameter

8.7

An action to set subscriptionCampaign parameters.

void: No return value.

1. parameterName: The name of the Subscription Campaign parameter that should be set.

1. SubscriptionCampaign: subscriptionCampaign
2. String: value

SetListOfSubscriptionCampaignToDateToSpecificDate

com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate

8.7

Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns

void: No return values

1. List: subscriptionCampaigns
2. Date: date

SetSubscriptionCampaignCollectionFromToDate

com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate

8.7

Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.

boolean: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.

1. calendarField: The calendar field type.
2. dateColumn: The date that should be changed.
3. quantity: Amount +/- that should be added or subtracted to the date.

1. ArrayList: subscriptionCampaignList
2. Date: newDate

SetSubscriptionCampaignInstanceFromToDate

com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate

8.7

Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.

boolean: Returns true if the date is set on a subscription campaigns, otherwise returns false.

1. calendarField: The calendar field type.
2. dateColumn: The date that should be changed.
3. quantity: Amount +/- that should be added or subtracted to the date.

1. SubscriptionCampaign: subscriptionCampaign
2. Date: newDate

GetBundlesFromCampaign

com.cdrator.campaign.action.GetBundlesFromCampaign

8.7

Returns an list of campaign bundles from a campaign.

ArrayList: a list of campaign bundles

1. Campaign: campaign

SubCampaignSetParameter

com.cdrator.campaign.action.SubCampaignSetParameter

8.7

This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.

boolean: True if the parameter is set, false otherwise.

1. paramName: The name of the Subscription Campaign parameter that should be set.

1. Subscription: sub
2. ServiceOptionParameter: sop

GetCurrentSubscriptionCampaign

com.cdrator.campaign.action.GetCurrentSubscriptionCampaign

8.7

This action returns the current SubscriptionCampaign for a subscription and campaign.

SubscriptionCampaign: The current SubscriptionCampaign.

1. Subscription: subscription
2. Campaign: campaign

SetSubBundleVal1FromServiceOption

com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption

8.7

This action updates value1 if an associated serviceOptionParameter with a given key can be found.

boolean: Boolean indicating success of finding and setting the parameter.

1. bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
2. parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.

1. SubscriptionBundle: bundle
2. Broker: broker

SetSubscriptionCampaignFromDateToSpecificDate

com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate

8.7

Sets the subscriptionCampaign.fromDate to a specific date.

void: No return values

1. SubscriptionCampaign: subscriptionCampaign
2. Date: date

SubCampaignSetParameterFromSOP

com.cdrator.campaign.action.SubCampaignSetParameterFromSOP

8.7

This action updates a subscription campaign parameter from a service option parameter with a given key.

boolean: True if the parameter is set, false otherwise.

1. bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
2. paramName: The name of the subscription campaign parameter that should be set.
3. parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.

1. SubscriptionBundle: bundle

GetSubscriptionCampaignsFromMsisdn

com.cdrator.campaign.action.GetSubscriptionCampaignsFromMsisdn

8.7

Get the subscription campaigns for the specified MSISDN.

List: The subscription campaigns for the user of the specified MSISDN.

1. String: msisdn

CampaignReader

com.cdrator.campaign.action.CampaignReader

8.7

Retrieves a Campaign definition based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetCampaignForKey

com.cdrator.campaign.action.GetCampaignForKey

8.7

This action returns a campaign for which the campaign key is provided as a property.

Campaign: The campaign associated with the provided campaign key.

1. campaignKey: The campaign key for the campaign.

CampaignAdvancedReader

com.cdrator.campaign.action.CampaignAdvancedReader

8.7

Retrieves campaigns based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetAllActiveSubscriptionCampaignsForDate

com.cdrator.campaign.action.GetAllActiveSubscriptionCampaignsForDate

8.7

Returns all active subscription campaigns, including shared ones, that are active for the given date.

ArrayList: A list of subscription campaigns. Empty list is returned if none found.

1. Subscription: subscription
2. Date: date

SubscriptionCampaignByDate

com.cdrator.campaign.action.SubscriptionCampaignByDate

8.7

Returns true if the subscriptioncampaign is found for a given charge date.

boolean: Returns true if the subscriptioncampaign is found for a given charge date.

1. List: subCampaigns
2. Date: chargeDate

CampaignMetaDataReader

com.cdrator.campaign.action.CampaignMetaDataReader

8.7

Retrieves a Campaign definition based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SetSubscriptionCampaignToDateToSpecificDate

com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate

8.7

Sets the subscription_campaign's to_date to a specific date retrieved from the context

void: No return values

1. SubscriptionCampaign: subscriptionCampaign
2. Date: date

SubscriptionCampaignReader

com.cdrator.campaign.action.SubscriptionCampaignReader

8.7

Retrieves a subscription campaign based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetCurrentSubscriptionBundlesNotUsedUpForCode

com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode

8.7

Returns the subscription bundles for a given subscription and the given code.

ArrayList: The list of subscription bundles.

1. bundleCode: The code of the subscription bundles.
2. getBundlesWithoutCreatingNew:

1. Subscription: subscription

SetSubscriptionBundleValueFromServiceOptionParameter

com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter

8.7

Set the defined Value field in the subscription bundle for the specified service option parameter.

void: The value of the Bundle parameter.

1. valueMethodNumber: The bundle value that will be updated.

1. ServiceOptionParameter: serviceOptionParameter
2. SubscriptionBundle: subscriptionBundle

This action is deprecated and therefore should not be used.

GetBundleForCampaignAndBundleKey

com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey

8.7

This action returns the bundle associated with the supplied campaign and bundleKey.

Bundle: The bundle associated with the supplied campaign and bundleKey.

1. Campaign: campaign
2. String: bundleKey

SetSubscriptionBundleValues

com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues

8.7

Set the defined Value field in the subscription bundle for the specified bundles.

void: The value of the Bundle parameter.

1. bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
2. bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
3. campaignKey: The key of the campaign
4. value1: Set value 1
5. value2: Set value 2
6. value3: Set value 3
7. value4: Set value 4

1. String: value
2. Subscription: subscription

This action is deprecated and therefore should not be used.

GetSubscriptionBundles

com.cdrator.campaign.bundle.action.GetSubscriptionBundles

8.7

Returns the subscription bundles for a given subscription.

ArrayList: The value of the Bundle parameter.

1. status: The status of the subscription bundles.

1. Subscription: subscription

GetActiveSubscriptionBundlesDefinedByDate

com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate

8.7

Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.

ArrayList: The list of subscription bundles.

1. bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.

1. Subscription: subscription
2. Date: date

SubscriptionBundleReader

com.cdrator.campaign.bundle.action.SubscriptionBundleReader

8.7

Retrieves a Subscription Bundle based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SetSubscriptionBundleValue

com.cdrator.campaign.bundle.action.SetSubscriptionBundleValue

8.7

Set the defined Value field in the give subscription bundle.

SubscriptionBundle: The value of the updated Subscription Bundle.

1. value1: Set value 1
2. value2: Set value 2
3. value3: Set value 3
4. value4: Set value 4

1. int: value
2. SubscriptionBundle: subscriptionBundle

This action is deprecated and therefore should not be used.

ProrateActivationSubscriptionCampaignBundles

com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles

8.7

Create and prorate the bundles of the given subscription campaign for a certain start date.

SubscriptionCampaign: The subscription campaign with the updated bundles

1. roundPrecission: The precission used when rounding the bundles.

1. SubscriptionCampaign: subscriptionCampaign
2. Date: fromDate

BundleReader

com.cdrator.campaign.bundle.action.BundleReader

8.7

Retrieves a Bundle definition based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetSubscriptionBundleParameter

com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter

8.7

Finds a bundle parameter from a SubscriptionBundle.

String: The value of the Bundle parameter.

1. optionKey: The parameter that should be read from the Bundle.

1. SubscriptionBundle: subscriptionBundle

BundleAdvancedReader

com.cdrator.campaign.bundle.action.BundleAdvancedReader

8.7

Retrieves bundles based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SubscriptionBundleSetter

com.cdrator.campaign.bundle.action.SubscriptionBundleSetter

8.7

Sets an attribute of SubscriptionBundle

void: Sets an attribute of a persistent object

1. attributeName: Attribute that should be set on the persistent object
2. savePersistentObject: Check if the persistent object should be saved after updating it. Default is true.

1. PersistentObject: persistentObject
2. Object: value

SubscriptionBundleAdvancedReader

com.cdrator.campaign.bundle.action.SubscriptionBundleAdvancedReader

8.7

Retrieves subscription bundles based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

IsSubscriptionBundleUsedUp

com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp

8.7

Determines if a given subscription bundle is used up by comparing the maximum value with the current value.

boolean: True if the subscription bundle is completely used up, false otherwise.

1. SubscriptionBundle: subscriptionBundle

ProrateSubscriptionBundle

com.cdrator.campaign.bundle.action.ProrateSubscriptionBundle

8.7

Create and prorate the bundles of the given subscription campaign.

void: Nothing is returned.

1. SubscriptionCampaign: subscriptionCampaign

GetSubscriptionBundleType

com.cdrator.campaign.bundle.action.GetSubscriptionBundleType

8.7

Finds the type of a SubscriptionBundle.

String: The code of the SubscriptionBundle.

1. SubscriptionBundle: subscriptionBundle

GetSubscriptionBundlesWithCode

com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode

8.7

Returns the subscription bundles for a given subscription and the given code.

ArrayList: The list of subscription bundles.

1. bundleCode: The code of the subscription bundles.
2. status: The status of the subscription bundles.

1. Subscription: subscription

GetSubscriptionBundleValue

com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue

8.7

Get the defined Value field in the subscription bundle for the specified bundle.

Amount: The value of the Bundle parameter.

1. bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
2. bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
3. campaignKey: The key of the campaign
4. valueMethodNumber: The bundle value that will be updated.

1. Subscription: subscription

DiscardSubscriptionFee

com.cdrator.recurrentFee.action.DiscardSubscriptionFee

8.7

This action discards (ends) the supplied subscription fee by setting fee end date to end date last period.

SubscriptionFees: The discarded subscription fee.

1. SubscriptionFees: fee

BillSubscriptionFeesToInvoiceNowForListOfSubs

com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNowForListOfSubs

8.7

This action bills all subscription fees to the supplied invoice for a list of subscriptions.

List: A list of all the invoice lines produced.

1. List: subscriptions
2. Invoice: invoice

BillSubscriptionFeeToDate

com.cdrator.recurrentFee.action.BillSubscriptionFeeToDate

8.7

This action bills the supplied subscription fees until a given date.

List: A list of all the invoice detail lines produced.

1. oneLineForAllPeriods: Check to aggregate all invoice detail lines in one line for the period.

1. SubscriptionFees: fee
2. Date: toDate

SetFeeEndDateLastPeriodToEndOfMonth

com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodToEndOfMonth

8.7

Sets the fee's end_date_last_period to end of month

void: No return values

1. SubscriptionFees: fee

SetFeeEndDateLastPeriod

com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriod

8.7

Sets the fee's end_date_last_period to the specified date

void: No return values

1. SubscriptionFees: fee
2. Date: date

BillSubscriptionFeeUntilDate

com.cdrator.recurrentFee.action.BillSubscriptionFeeUntilDate

8.7

Bill the supplied subscription fees until a given date.

ArrayList: A list of all the subscription fee lines created after the billing.

1. SubscriptionFees: fee
2. Date: toDate

BillSubscriptionFeeListToInvoiceNow

com.cdrator.recurrentFee.action.BillSubscriptionFeeListToInvoiceNow

8.7

This action bills the supplied subscription fees to the supplied invoice.

List: A list of all the invoice lines produced.

1. endDateLastPeriod: To set end_date_last_period on subscription fees.

1. List: subscriptionFees
2. Invoice: invoice

SetFeeChargeDateToSiblingFeeChargeDate

com.cdrator.recurrentFee.action.SetFeeChargeDateToSiblingFeeChargeDate

8.7

Sets the fee's next_charge_date to sibling fee's next_charge_date

void: No return values

1. SubscriptionFees: fee
2. SubscriptionFees: siblingFee

This action is deprecated and therefore should not be used.

TerminateFeeFromEndDateLastPeriod

com.cdrator.recurrentFee.action.TerminateFeeFromEndDateLastPeriod

8.7

Terminates the fee from its end_date_last_period

void: No return values

1. SubscriptionFees: fee

SetFeeNextChargeDateForFeeList

com.cdrator.recurrentFee.action.SetFeeNextChargeDateForFeeList

8.7

Sets the fees end_date_last_period to the specified date

void: No return values

1. List: fees
2. Date: date

SetFeeNextChargeDateToSpecificDate

com.cdrator.recurrentFee.action.SetFeeNextChargeDateToSpecificDate

8.7

Sets the fee's next_charge_date to a specific date retrieved from the context

void: No return values

1. SubscriptionFees: fee
2. Date: date

This action is deprecated and therefore should not be used.

SetFeeNextChargeDateToEndOfMonth

com.cdrator.recurrentFee.action.SetFeeNextChargeDateToEndOfMonth

8.7

Sets the fee's next_charge_date to end of month

void: No return values

1. SubscriptionFees: fee

BillSubscriptionFeesToInvoiceNow

com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNow

8.7

This action bills all subscription fees to the supplied invoice.

List: A list of all the invoice lines produced.

1. endDateLastPeriod: To set end_date_last_period on subscription fees.

1. Subscription: subscription
2. Invoice: invoice

SetFeeEndDateLastPeriodForFeeList

com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodForFeeList

8.7

Sets the fees end_date_last_period to the specified date

void: No return values

1. List: fees
2. Date: date

GetActiveWorkflowWithSpecifiedContextObjectForSubscription

com.cdrator.workflow.action.GetActiveWorkflowWithSpecifiedContextObjectForSubscription

8.7

Get active workflow with specified context object, specified hookpoint static key, optional hookpoint dynamic key,subscription id.

WfWorkflow: The active workflow instance of given hookpoint static key, context object, and optional hookpoint dynamic key

1. contextObjectKey: The context object key.
2. workflowHookpointStaticKey: The hookpoint static key.

1. String: subscriptionId
2. String: contextObjectId
3. String: wfHookpointDynamicKey

StartNewWorkflowList

com.cdrator.workflow.action.StartNewWorkflowList

8.7

Action to start a workflow for each object on the given list. The context object keys of the context objects to be used in the context of the new workflow should be passed as a comma separated string.

boolean: Returns the hookpointResult from the new workflow.

1. String: hookpointKey
2. String: contextKeys
3. Context: existingContext
4. List: objectList
5. String: objectContextKey

StartNewWorkflow

com.cdrator.workflow.action.StartNewWorkflow

8.7

Action to start a new workflow. The context object keys of the context objects to be used in the context of the new workflow should be passed as a comma separated string.

HookpointResult: Returns the hookpointResult from the new workflow.

1. String: hookpointKey
2. String: contextKeys
3. Context: existingContext

WorkflowActivityAdvancedReader

com.cdrator.workflow.action.WorkflowActivityAdvancedReader

8.7

Retrieves workflow activities based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetActiveWorkflowInstanceByContextObject

com.cdrator.workflow.action.GetActiveWorkflowInstanceByContextObject

8.7

Return, if any, newest or oldest active workflow instance belonging to a workflow definition with key equal to or starting with the provided key value.The action searches first for workflows by exact workflow definition key. If no workflow found it does a like search on workflow definition using the provided suffix pattern. The suffix pattern is % by default if it is not provided.If the property newestWfIfCheckedOtherwiseOldest is checked the newest workflow is retrieved, otherwise the oldest one is retrieved.If the property skipWorkflowDefinitionKeyExactSearch is checked the workflow search by exact workflow definition key is skipped.

WfWorkflow: The newest or oldest active workflow instance belonging to a workflow definition that has the key equal to or starting with the provided key value

1. newestWfIfCheckedOtherwiseOldest: If checked newest workflow is retrieved, otherwise oldest
2. skipWorkflowDefinitionKeyExactSearch: If checked the workflow search by exact workflow definition key is skipped

1. String: workflowDefinitionKey
2. String: suffixPattern
3. PersistentObject: contextObject

AddObjectsToResult

com.cdrator.workflow.action.AddObjectsToResult

8.7

Adds key/value to RESULT context object. If RESULT doesn't exist a new HashMap is created.

void: No return value

1. key1: Key 1
2. key2: Key 2
3. key3: Key 3
4. key4: Key 4
5. key5: Key 5

1. Map: context
2. Object: value1
3. Object: value2
4. Object: value3
5. Object: value4
6. Object: value5

WorkflowActivityReader

com.cdrator.workflow.action.WorkflowActivityReader

8.7

Retrieves a workflow activity based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

WfWorkflowReader

com.cdrator.workflow.action.WfWorkflowReader

8.7

Retrieves a workflow activity based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

WfDefAdvancedReader

com.cdrator.workflow.action.WfDefAdvancedReader

8.7

Retrieves workflows based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

PushWorkflow

com.cdrator.workflow.action.PushWorkflow

8.7

Pushes a workflow, a given activity key and a given outcome. The action throws exceptions if the workflow is not waiting the the expected activities. These exception can be mapped to outcomes
Throws a WorkflowNotActive if the workflow is not active
Throws a WorkflowNotInActivityException if workflow in not waiting in the specified activity

WfActivity: The activity the workflow was waiting in.

1. activityKey: The name of the activity to push.
2. outcome: The outcome of the activity.

1. WfWorkflow: workflow

WfWorkflowAdvancedReader

com.cdrator.workflow.action.WfWorkflowAdvancedReader

8.7

Retrieves workflows based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

WfDefReader

com.cdrator.workflow.action.WfDefReader

8.7

Retrieves a workflow definition based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

This action is deprecated and therefore should not be used.

PushWorkflowById

com.cdrator.workflow.action.PushWorkflowById

8.7

Pushes a workflow based on its ID, a given activity key and a given outcome. Throws a nullpoint exception if there is no workflow with this id.

WfWorkflow: The pushed workflow.

1. activityKey: The name of the activity to push.
2. outcome: The outcome of the activity.

1. String: workflowId
2. Broker: broker

TerminateWorkflow

com.cdrator.workflow.action.TerminateWorkflow

8.7

Terminates the given workflow.

void:

1. WfWorkflow: workflow

This action is deprecated and therefore should not be used.

GetNewestActiveWorkflowInstanceForSubscription

com.cdrator.workflow.action.GetNewestActiveWorkflowInstanceForSubscription

8.7

Return, if any, the newest active workflow instance that belongs to a workflow definition with a key similar to the provided pattern key.

WfWorkflow: The newest active workflow instance that belongs to a workflow definition with a key similar to the provided pattern key

1. workflowDefinitionKey: The pattern key of the workflow definition for the workflow instance to be searched. All workflow definition keys that match the pattern will be used to search for the workflow instance.

1. Subscription: subscription

IsOptionalStringContextObjectEqualToValue

com.cdrator.workflow.context.action.IsOptionalStringContextObjectEqualToValue

8.7

Checks if an optional String context object is equal to a specific String value.If the property ignoreCase is set to true the String comparison is done by ignoring the case.By default the property ignoreCase is set to false.

boolean: true if the object is found in the context, it is of String type and it is equal to the specific String value

1. ignoreCase: If the ignoreCase property is set to true the String comparison is done by ignoring the case

1. String: optionalStringContextObjectKey
2. String: value
3. WfContext: wfContext

IsObjectInContext

com.cdrator.workflow.context.action.IsObjectInContext

8.7

Checks if the object is in the context

boolean: true if the object is in the context

1. objectKey: The key of the object to check in the context

1. Map: context

IsOptionalStringContextObjectNotBlank

com.cdrator.workflow.context.action.IsOptionalStringContextObjectNotBlank

8.7

Checks if an optional String context object is not blank

boolean: true if the object is found in the context, it is of String type and it is not blank

1. String: optionalStringContextObjectKey
2. WfContext: wfContext

AddMultipleContextObjects

com.cdrator.workflow.context.action.AddMultipleContextObjects

8.7

Adds multiple objects to the workflow context. It overrides if an object already exists in a wokflow context with the same key.The context keys are configured on the properties and the objects are passed as arguments. The index on the property key name matches to the index on the argument name: e.q. object1 is added into context with key1

void: No return value

1. key1: Key 1
2. key10: Key 10
3. key2: Key 2
4. key3: Key 3
5. key4: Key 4
6. key5: Key 5
7. key6: Key 6
8. key7: Key 7
9. key8: Key 8
10. key9: Key 9

1. WfContext: wfContext
2. Object: value1
3. Object: value2
4. Object: value3
5. Object: value4
6. Object: value5
7. Object: value6
8. Object: value7
9. Object: value8
10. Object: value9
11. Object: value10

WaitUntilDate

com.cdrator.workflow.activity.action.WaitUntilDate

8.7

Waits until specific date

boolean: true if the activity should continue, false if it should wait

1. Date: dateToWaitUntil
2. WfActivity: wfActivity

PushWorkflowActivity

com.cdrator.workflow.activity.action.PushWorkflowActivity

8.7

Pushes a workkflow activity to a specific outcome

void: No return value

1. WfActivity: workflowActivity
2. String: outcome

CheckHookpointResult

com.cdrator.workflow.hookpointresult.action.CheckHookpointResult

8.7

If the hookpoint result is SUCCESS then true is returned, otherwise (FAILURE or other) false is returned instead. If the error code is in the list provided, true is returned.

boolean: True if result is success, False otherwise.

1. errorCodesToIgnore: List of error codes to ignore. Use semicolon ( to separate the values of the list.

1. HookpointResult: hookpointResult

AddSuccessToHookpointResult

com.cdrator.workflow.hookpointresult.action.AddSuccessToHookpointResult

8.7

Add the RESULT = SUCESS to the HOOKPOINT_RESULT

HookpointResult: The hookpoint result

1. HookpointResult: result

AddHookpointResultObjects

com.cdrator.workflow.hookpointresult.action.AddHookpointResultObjects

8.7

Adds key/value to hookpoint result. Allows having objects in HOOKPOINT_RESULT

void: No return value

1. key1: Key 1
2. key2: Key 2
3. key3: Key 3
4. key4: Key 4
5. key5: Key 5

1. HookpointResult: result
2. Object: value1
3. Object: value2
4. Object: value3
5. Object: value4
6. Object: value5

AddFailedToHookpointResult

com.cdrator.workflow.hookpointresult.action.AddFailedToHookpointResult

8.7

Add the RESULT = FAILED to the HOOKPOINT_RESULT along with error code and description

HookpointResult: The hookpoint result

1. HookpointResult: result
2. String: code
3. String: description

ResetStartDateWithDelayOnProvisioningTask

com.cdrator.provisioning.action.ResetStartDateWithDelayOnProvisioningTask

8.7

Adds the delayInMinutes property to start date on Provisioning Task. If no start date on task, adds delay from current date.

void: No return values

1. delayInMinutes:

1. ProvisioningTask: task

CancelProvisioningTask

com.cdrator.provisioning.action.CancelProvisioningTask

8.7

Cancel the provisioning task.

boolean: Returns true if the provisioningTask is cancelled.

1. ProvisioningTask: task

GetProvisioningRequestsByReference

com.cdrator.provisioning.action.GetProvisioningRequestsByReference

8.7

Retrieves a List of ProvisioningRequest linked to a ProvisioningTask by reference field.

List: Returns the ProvisioningRequest linked from the task reference.

1. linkedFieldOnRequest: Optional to choose the database field from which to retrieve the reference linking the request to the task. Required to be varchar2 field.

1. ProvisioningTask: task

GetResponseCodeFromProvisioningRequest

com.cdrator.provisioning.action.GetResponseCodeFromProvisioningRequest

8.7

Retrieves the Response Code from a ProvisioningRequest.

String: Return response code from ProvisioningRequest object.

1. responseCodeField: Optional to choose the database field from which to retrieve the response code.

1. ProvisioningRequest: request

NetworkOperatorReader

com.cdrator.provisioning.action.NetworkOperatorReader

8.7

Retrieves a Network Operator based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

ProvisioningTaskAdvancedReader

com.cdrator.provisioning.action.ProvisioningTaskAdvancedReader

8.7

Retrieves provisioning tasks based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CreateProvisioningTask

com.cdrator.provisioning.action.CreateProvisioningTask

8.7

Create a provisioning task of a specific type (CODE). The status of the new task will be "New". (the workflow instance can be added using "_activity.getWorkflow()")

ProvisioningTask: Return response code from ProvisioningRequest object.

1. priority: Optional priority of the provisioning task. Default is 5
2. taskComments: Optional comments to add to the provisioning task
3. taskDescription: Optional description to add to the provisioning task
4. taskType: The type of task that should be provisioned

1. Service: service
2. WfWorkflow: workflow

GetProvisioningTaskList

com.cdrator.provisioning.action.GetProvisioningTaskList

8.7

This action will return a list of provisioning tasks based on the specified criteria. If any parameters are blank or null, they are skipped when generating the query to find the provisioning tasks.

List: A list of provisioning tasks.

1. baseQuery: Base query to find provisioning tasks.

1. String: msisdn
2. Date: fromDate
3. Date: toDate
4. String: network
5. String: icc
6. Service: service

SetStatusOnProvisioningTask

com.cdrator.provisioning.action.SetStatusOnProvisioningTask

8.7

Set Status for Processing on Provisioning Task.

void: No return values

1. completeDate: Update complete_date for completed provisioning task
2. statusToSet: The status that the provisioning task will be set to.

1. ProvisioningTask: task

ProvisioningTaskReader

com.cdrator.provisioning.action.ProvisioningTaskReader

8.7

Retrieves a Provisioning Task based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

ProvisioningRequestAdvancedReader

com.cdrator.provisioning.action.ProvisioningRequestAdvancedReader

8.7

Retrieves provisioning requests based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3
8. orderBy: Order by
9. orderByDesc: If a list is returned and ordered, set if it should be ordered descending instead of ascending

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

UpdateProvisioningRequestStatus

com.cdrator.provisioning.action.UpdateProvisioningRequestStatus

8.7

Set Status for Provisioning Request.

void: No return values

1. statusToSet: The status that the provisioning task will be set to.

1. ProvisioningRequest: request

SetProvisioningTaskICC

com.cdrator.provisioning.action.SetProvisioningTaskICC

8.7

Sets the ICC on a provisioning task

void:

1. save:

1. ProvisioningTask: provisioningTask
2. String: icc

PerformCreditCheck

com.cdrator.fraud.creditcheck.action.PerformCreditCheck

8.7

This action performs a credit check on a user.

CreditCheckResult: The CreditCheckResult will be returned.

1. Users: user
2. CreditCheck: cc

PerformCreditCheckOnUser

com.cdrator.fraud.creditcheck.action.PerformCreditCheckOnUser

8.7

This action performs a credit check on a user.

CreditCheckResult: The CreditCheckResult will be returned.

1. Users: user

GetBlacklistEntriesForSearchCriteria

com.cdrator.fraud.action.GetBlacklistEntriesForSearchCriteria

8.7

Returns the blacklist entries. Use these optional context parameters:FIRST_NAME, LAST_NAME, STREET, STREET_NUMBER, STREET_UNIT, FLOOR, FLOOR_UNIT, CITY, ZIP, COUNTY, PERSONAL_ID, DATE_OF_BIRTH. If context object matching name of optional context parameters is found then it is used to build query criterionExtra lookup constraints can be added using the Extra Parameters. The extra parameters is a list of comma separated values.Standalone custom attributes column name can also be used.

ArrayList: Returns an ArrayList<Blacklist> containing the blacklist entries matching search criteria.

1. includeOnlyEnabledEntries: Specify if only enabled blacklist entries should be included in search results.

1. Map: context
2. String: extraParameters

CreateInternalBlackList

com.cdrator.fraud.action.CreateInternalBlackList

8.7

Create an internal blacklist.

InternalBlacklist: Return response code from ProvisioningRequest object.

1. active: Optional to set blacklist to enabled/disabled, by default is enabled
2. reasonStatusId: The type of blacklist that should be created
3. taskComments: Optional comments to add to the blacklist

1. Users: user
2. BillingGroup: bg
3. Service: service
4. Date: fromDate
5. Date: toDate

GetBlacklistReasons

com.cdrator.fraud.action.GetBlacklistReasons

8.7

Returns the blacklist reasons
The array is empty if the user is not matched or if it is not blacklisted. Use these optional context parameters: FIRST_NAME, LAST_NAME, STREET, STREET_NUMBER, STREET_UNIT, FLOOR, FLOOR_UNIT, CITY, ZIP, COUNTY, PERSONAL_ID, DATE_OF_BIRTH Extra lookup constraints can be added using the Extra Parameters. The extra parameters is a list of comma separated values

ArrayList: Returns an ArrayList<String> containing the reasons from the blacklist table.

1. Map: context
2. String: extraParameters

PerformAddressCheck

com.cdrator.fraud.addresscheck.action.PerformAddressCheck

8.7

This action performs an address check on a user.

AddressCheckResult: The AddressCheckResult is returned.

1. Users: user
2. AddressCheck: ac

GetANumbersForNumberSearchLastDigits

com.cdrator.number.action.GetANumbersForNumberSearchLastDigits

8.7

This action will retrieve the list of random anumbers ending with the pattern.

ArrayList: List of anumbers.

1. Anumber_Group: group
2. String: searchPattern
3. int: maxCount

ReleaseAnumber

com.cdrator.number.action.ReleaseAnumber

8.7

Release an Anumber.

void: No Return Value

1. Anumber: anumber

IsAnumberFree

com.cdrator.number.action.IsAnumberFree

8.7

Given a phone number, checks if the related anumber is free. NOTE: Uses old logic by checking the network operator and the product. Action GetAnumberForBrand should be used instead.

boolean: True, if the anumber for the phone number is free, else False

1. String: phoneNumber
2. Brand: brand

GetANumbersForNumberSearchRandom

com.cdrator.number.action.GetANumbersForNumberSearchRandom

8.7

This action will retrieve the list of random phone numbers according to the group_id.

ArrayList: List of phone numbers.

1. batchLimit: Batch limit to fetch anumbers.

1. Anumber_Group: group
2. int: maxRows

BookRessourceToService