Release 1.49

SetDueDateIfInvoicedBillingGroupHasRechargeTicket

com.cdrator.billing.invoicebatch.action.SetDueDateIfInvoicedBillingGroupHasRechargeTicket

8.7

Updates invoice due date for invoices where the related billing group has a recharge ticket

void: No return value

1. InvoiceBatch: invoiceBatch
2. Date: dueDate

GetBillingGroupsByUserID

com.cdrator.billing.main.action.GetBillingGroupsByUserID

8.7

This action will return an arraylist of billing groups that a given userID is the owner of.

ArrayList: An array list of billing groups.

1. String: userID

SetSubscriptionTerminationRequestExpectedDate

com.cdrator.billing.main.action.SetSubscriptionTerminationRequestExpectedDate

8.7

This action sets the expected termination date on a SubscriptionTerminationRequest.

SubscriptionTerminationRequest: Returns the updated SubscriptionTerminationRequest object.

1. SubscriptionTerminationRequest: subscriptionTerminationRequest
2. Date: expectedTerminationDate

TerminateSharedServiceIfNoTeleservices

com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices

8.7

This action iterates through all services and subscriptions for the billing group, and if all teleservices are terminated, it attempts to terminate all shared services attached.

Boolean: Returns true if a shared Service was attempted terminated.

1. BillingGroup: billingGroup
2. Date: terminationDate
3. String: hookpointKey
4. String: reason

SetBillingGroupCurrencyCode

com.cdrator.billing.main.action.SetBillingGroupCurrencyCode

8.7

This action sets the currency code on the billing group. The billing group is saved.

void: No return value.

1. currencyCode: The currency code which is set on the billing group.

1. BillingGroup: billingGroup

GetPlanElementForRatePlan

com.cdrator.billing.rating.action.GetPlanElementForRatePlan

8.7

This action returns a planElement based on a fee code

PlanElements: Return the planElement

1. planElement: The plan elements.

1. RatePlan: ratePlan

GetPlanElement

com.cdrator.billing.rating.action.GetPlanElement

8.7

This action returns a planElement based on a fee code

PlanElements: Return the planElement

1. planElement: The plan elements.

GetActiveRatePlanForSubscription

com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription

8.7

Retrieves the currently active rate plan for a subscription.

RatePlan: Returns a rate plan that is currently active for the subscription.

1. Subscription: subscription

GetPlanElementForRatePlanByDynamicFeeCode

com.cdrator.billing.rating.action.GetPlanElementForRatePlanByDynamicFeeCode

8.7

This action returns a planElement based on a fee code

PlanElements: Return the planElement

1. RatePlan: ratePlan
2. String: planElementCode

GetRatePlansByProduct

com.cdrator.billing.rating.action.GetRatePlansByProduct

8.7

This action retrieves rate plans for a product.

List: Returns a list of rate plans related to this product.

1. Product: product

RatePlanAdvancedReader

com.cdrator.billing.rating.action.RatePlanAdvancedReader

8.7

Retrieves rate plans 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

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

RatePlanReader

com.cdrator.billing.rating.action.RatePlanReader

8.7

Retrieves a RatePlan 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

CalculateInvoiceDetailLinesTotalChargeSum

com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum

8.7

Calculates the Sum to the total charge for a list of Invoice Detail Lines Wrappers. The action will throw an ActionParameterException if the parameter throwExceptionIfAllLinesIgnored is set to true, and all lines passed in is ignored.

Amount: The sum to the total charges of the Invoice Detail Lines Wrappers

1. ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
2. throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum

1. List: idlList

RatingSimulator

com.cdrator.billing.rating.simulate.action.RatingSimulator

8.7

Simulates the rating of a Billing Record. The Billing Record could be of type BillingRecordSimulated. After rating all changes are rolled back. The result is list of Invoice Detail Lines

ArrayList: ArrayList of the Invoice Detail Lines

1. Service: service
2. BillingRecords: billingRecord

BillingRecordBuilder

com.cdrator.billing.rating.simulate.action.BillingRecordBuilder

8.7

Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.

BillingRecordSimulated: A new unrated billing record. Not persisted.

1. BNumber: B-Number of the billing record.
2. ratingCode: Rating code to be set on the Billing Record.
3. ratingDuration: Rating duration to be set on the Billing Record.
4. ratingKey: Rating key to be set on the Billing Record.
5. ratingVolumne: Rating volume to be set on the Billing Record.

1. Service: service

CreateTodoTask

com.cdrator.billing.todoTask.action.CreateTodoTask

8.7

This class is deprecated. Use CreateTodoTaskDynamic instead. Old description: Creates a TodoTask based on configurable properties

void: No return values

1. assignedToOperator: The operator the todo task is assigned to
2. category: Task category
3. contactPhoneNumber: Contact phone number
4. description: Task Description
5. reminderTimeInMinutes: Reminder time in minutes
6. subject: Subject
7. typeOfFollowUp: The type of follow up: email,letter,phone call,sms

1. Service: service

This action is deprecated and therefore should not be used.

CreateTodoTaskAdvanced

com.cdrator.billing.todoTask.action.CreateTodoTaskAdvanced

8.7

Creates a TodoTask based on configurable properties. CreationDate, ScheduledEndTime, TimestampAlert are set to current date if passed as null

TodoTask: Return just created todo task.

1. assignedToOperator: The operator the todo task is assigned to
2. category: Task category
3. typeOfFollowUp: The type of follow up: email,letter,phone call,sms

1. Service: service
2. String: subject
3. String: description
4. String: contactPhoneNumber
5. long: reminderTimeInMinutes
6. Date: creationDate
7. Date: scheduledEndTime
8. Date: timestampAlert

CreateTodoTaskDynamic

com.cdrator.billing.todoTask.action.CreateTodoTaskDynamic

8.7

Creates a TodoTask based on configurable properties

TodoTask: Return just created todo task.

1. assignedToOperator: The operator the todo task is assigned to
2. category: Task category
3. typeOfFollowUp: The type of follow up: email,letter,phone call,sms

1. Service: service
2. String: subject
3. String: description
4. String: contactPhoneNumber
5. long: reminderTimeInMinutes

This action is deprecated and therefore should not be used.

ChargeFee

com.cdrator.billing.subscriptionFees.action.ChargeFee

8.7

Adds a subscription fee to a subscription for a given plan element preffix and code, if the property is not set the fee code value from the parameter will be used. By default the start date is not charged. The fee is billed after its creation.

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.
2. feeCode: The fee code for the subscription fee.

1. Subscription: subscription
2. String: feeCode
3. Date: startDate

AddFee

com.cdrator.billing.subscriptionFees.action.AddFee

8.7

Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.
2. feeCode: The fee code for the subscription fee.

1. Subscription: subscription
2. Date: startDate

AddFeeFromServiceCode

com.cdrator.billing.subscriptionFees.action.AddFeeFromServiceCode

8.7

Adds a subscription fee to a subscription for a given plan element preffix defined by a service code and a price code./nBy default the start date is not charged.

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.

1. Subscription: subscription
2. Date: startDate
3. String: serviceCode
4. String: priceCode

SubscriptionFeesAdvancedReader

com.cdrator.billing.subscriptionFees.action.SubscriptionFeesAdvancedReader

8.7

Retrieves subscription fees 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

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

AddSubscriptionFee

com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee

8.7

Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.

SubscriptionFees: Return the added subscription fee.

1. chargeStartDate: Charge the given start date.
2. planElement: The plan element for the subscription fee.

1. Subscription: subscription
2. Date: startDate

This action is deprecated and therefore should not be used.

SetSubscriptionFeesEndDate

com.cdrator.billing.subscriptionFees.action.SetSubscriptionFeesEndDate

8.7

This action sets the subscription fee end date and saves the subscriptionfee.

void: No return value

1. SubscriptionFees: subscriptionFee
2. Date: endDate

IsBalanceGreatherThanFeePrice

com.cdrator.billing.subscriptionFees.action.IsBalanceGreatherThanFeePrice

8.7

Check if the billing group balance is equal or greater than the price of the given fee and rate plan.

boolean: True if the billing group balance is sufficient. False otherwise.

1. BillingGroup: billingGroup
2. String: feeCode
3. RatePlan: ratePlan

CreateSubscriptionFee

com.cdrator.billing.subscriptionFees.action.CreateSubscriptionFee

8.7

Creates a subscription fee to a subscription for a given plan element prefix and code. The subscription fee is not persisted

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.

1. Subscription: subscription
2. String: feeCode
3. Date: startDate

SubscriptionFeesReader

com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader

8.7

Gets a subscription fee.

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

SetDeviceParameterValue

com.cdrator.billing.product.action.SetDeviceParameterValue

8.7

This action updates a device parameter value if it's found, otherwise it will be created.

boolean: True if the parameter was created, false if the parameter was updated.

1. Device: device
2. String: name
3. String: value

DeviceCanUseOn

com.cdrator.billing.product.action.DeviceCanUseOn

8.7

Calls CanUseOn on a given device with a given service.

boolean: Boolean showing if a given device can be used on a given service.

1. Device: device
2. Service: service

GetDeviceParameterValue

com.cdrator.billing.product.action.GetDeviceParameterValue

8.7

This action returns the value of a given device parameter or throws a NullValueException if none is found.

String: Value of the given parameter (as a string).

1. Device: device
2. String: name

GetDeviceFromParameterValue

com.cdrator.billing.product.action.GetDeviceFromParameterValue

8.7

Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.

Device: The located device.

1. String: name
2. String: value

SimcardOrdersReader

com.cdrator.billing.product.action.SimcardOrdersReader

8.7

Retrieves a sim card order 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

CompleteRatePlanChange

com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange

8.7

This action completes the rateplan change by subscribing to the default and mandatory options.

void: No return value.

1. RatePlanChange: rpc
2. boolean: cache

StatusAdvancedReader

com.cdrator.billing.status.action.StatusAdvancedReader

8.7

Retrieves statuses 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

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

StatusReader

com.cdrator.billing.status.action.StatusReader

8.7

Retrieves a Status 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

PublishInvoice

com.cdrator.billing.invoice.action.PublishInvoice

8.7

Publishes a given invoice.

Invoice: The published invoice

1. Invoice: invoice

GetAccountPaymentsForInvoice

com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice

8.7

Gets a list of account payments related to the invoice.

List: A list of accountPayments.

1. Invoice: invoice

SetInvoiceDueDate

com.cdrator.billing.invoice.action.SetInvoiceDueDate

8.7

Set the given due date to the invoice.

void: No return value.

1. Invoice: invoice
2. Date: dueDate

InvoiceCompareToLastStepId

com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId

8.7

Checks Invoice lastStepId against string with comma-separated list of Id . (IE '50,55,58' may at collector) with true/false as default result for blank value

boolean: true or false

1. Invoice: invoice
2. String: compareString
3. boolean: defaultForBlank

GetOldestUnpaidInvoice

com.cdrator.billing.invoice.action.GetOldestUnpaidInvoice

8.7

Finds and returns the oldest unpaid invoice if there are any

Invoice: The oldest unpaid invoice. If no closed unpaid invoice is found, null is returned

1. BillingGroup: billingGroup

CloseInvoiceWithCurrentDate

com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate

8.7

Calls closeWithDueDate on a given invoice with current date.

void: No return value.

1. Invoice: invoice

PayInvoicesInBatchWithAccountPayments

com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments

8.7

Marks all invoice on batch as paid

void: null

1. InvoiceBatch: invoiceBatch
2. String: reference
3. String: transactionNumber
4. AccountPaymentType: accountPaymentType

InvoiceReader

com.cdrator.billing.invoice.action.InvoiceReader

8.7

Retrieves an invoice 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

InvoiceAdvancedReader

com.cdrator.billing.invoice.action.InvoiceAdvancedReader

8.7

Retrieves invoices 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

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

InvoiceSetInvoiceScheduleId

com.cdrator.billing.invoice.action.InvoiceSetInvoiceScheduleId

8.7

set Invoice ScheduleId on invoice

void: No return value.

1. Invoice: invoice
2. String: id

GetParameterValue

com.cdrator.billing.misc.action.GetParameterValue

8.7

This action retrieves a string representation of a parameter value.

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

1. String: key
2. Brand: brand

ShopOperatorAdvancedReader

com.cdrator.billing.misc.action.ShopOperatorAdvancedReader

8.7

Retrieves services 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

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

SoftBlockAllTeleServicesOnBillingGroup

com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup

8.7

This action attempts to block all teleservices on a billinggroup. First it verifies if they can be blocked. It will then add a history record with the supplied historyLine string if specified. Leave it blank to ommit a history line.

void: null

1. historyTag: Add translation tag for the history line if needed

1. BillingGroup: billingGroup
2. String: historyLine

HardBlockAllTeleServicesOnBillingGroup

com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup

8.7

This action attempts to hard block all teleservices on a billinggroup. First it verifies if they can be blocked. It will then add a history record with the supplied historyLine string if specified. Leave it blank to ommit a history line.

void: null

1. historyTag: Add translation tag for the history line if needed

1. BillingGroup: billingGroup
2. String: historyLine

GetActiveBillingGroupMembers

com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers

8.7

Retrieves the active members of the billing group

List: The active members of the billing group

1. BillingGroup: billingGroup

UnBlockAllTeleServicesOnBillingGroup

com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup

8.7

This action attempts to unblock all teleservices on a billinggroup. First it verifies if they can be unblocked. Unblock type depends on the type of blocking used (hardblocked or softblocked) It will then add a history record with the supplied historyLine string if specified. Leave it blank to ommit a history line.

void: null

1. historyTag: Add translation tag for the history line if needed

1. BillingGroup: billingGroup
2. String: historyLine

GetParentBillingGroup

com.cdrator.billing.billinggroup.action.GetParentBillingGroup

8.7

Returns The parent billing group

BillingGroup: null

1. BillingGroup: billingGroup

BillingGroupSetter

com.cdrator.billing.billinggroup.action.BillingGroupSetter

8.7

Sets an attribute of Billing Group

void: Sets an attribute of a persistent object

1. attributeName: Attribute that should be set on the persistent object

1. PersistentObject: persistentObject
2. Object: value

BillingGroupAdvancedReader

com.cdrator.billing.billinggroup.action.BillingGroupAdvancedReader

8.7

Retrieves billing groups 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

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

SetBillingGroupAlertGroupId

com.cdrator.billing.billinggroup.action.SetBillingGroupAlertGroupId

8.7

Set the alertGroupId on billing group.

void: Returns nothing.

1. BillingGroup: bg
2. String: defaultAlertGroupId

BillingGroupReader

com.cdrator.billing.billinggroup.action.BillingGroupReader

8.7

Retrieves a Billing Group 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

BillingGroupActiveSubscriptionCounter

com.cdrator.billing.billinggroup.action.BillingGroupActiveSubscriptionCounter

8.7

Counts no. of active subscription on a billing group.

int: This returns the no. of active subscription on a billing group.

1. BillingGroup: bg

CloneBillingGroupToAccount

com.cdrator.billing.billinggroup.action.CloneBillingGroupToAccount

8.7

Clone a Billing Group from one account to another.
The balance if the original Billing Group is NOT cloned.Subscriptions and other connected attributes are not moved.Owner and Billing Address will be the owner of the Account

BillingGroup: This returns the new billing group.

1. save: Save the new Billing Group after creation

1. BillingGroup: originalBillingGroup
2. Account: newAccount

SetBillingGroupAutoPaymentMaxAmount

com.cdrator.billing.billinggroup.action.SetBillingGroupAutoPaymentMaxAmount

8.7

Set the autoPaymentMaxAmount on billing group.

void: Returns nothing.

1. autoPaymentMaxAmount: The maximum auto payment amount.

1. BillingGroup: bg

GetEndOfBillingCycleDate

com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate

8.7

This action returns a date representing the last day of the current billing cycle for the given billing group.

Date: A Date representing the last day of the current billing cycle.

1. Date: date
2. BillingGroup: bg

BillingCycleAdvancedReader

com.cdrator.billing.billingcycle.action.BillingCycleAdvancedReader

8.7

Retrieves billing cycles 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

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

BillingCycleReader

com.cdrator.billing.billingcycle.action.BillingCycleReader

8.7

Retrieves a Billing Cycle 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

GetPaymentTypes

com.cdrator.billing.payment.action.GetPaymentTypes

8.7

Get all payment types.

List: All payment types.

AccountPaymentSetCaptureInfo

com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo

8.7

Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage)

void: No return value

1. captureMessage: Capture message to be set.
2. useCaptureDate: Should Capture Date be set (to current time.

1. AccountPayment: ap

AccountPaymentAdvancedReader

com.cdrator.billing.payment.action.AccountPaymentAdvancedReader

8.7

Retrieves an account payment 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

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

RechargeTicketAdvancedReader

com.cdrator.billing.payment.action.RechargeTicketAdvancedReader

8.7

Retrieves RechargeTickets 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

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

AccountPaymentSetDoCapture

com.cdrator.billing.payment.action.AccountPaymentSetDoCapture

8.7

Calls setDoCapture on a given account payment and saves it.

void: No return value.

1. AccountPayment: accountPayment

AccountPaymentTypeReader

com.cdrator.billing.payment.action.AccountPaymentTypeReader

8.7

Retrieves an account payment 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

GetActiveRechargeTicket

com.cdrator.billing.payment.action.GetActiveRechargeTicket

8.7

This action returns an active recharge ticket for a given billing group.

RechargeTicket: The recharge ticket, if it exists.

1. BillingGroup: billingGroup

AccountPaymentReader

com.cdrator.billing.payment.action.AccountPaymentReader

8.7

Retrieves an account payment 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

GetAccountPaymentTypes

com.cdrator.billing.payment.action.GetAccountPaymentTypes

8.7

Get all account payment types.

List: All account payment types.

GetRechargeTicketForBillingGroup

com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup

8.7

This action returns a rechargeTicket for a BillingGroup.

RechargeTicket: The recharge ticket, if it exists.

1. BillingGroup: billingGroup

AccountPaymentSetAuthorized

com.cdrator.billing.payment.action.AccountPaymentSetAuthorized

8.7

Calls setAuthorized on a given account payment and saves it.

void: No return value.

1. AccountPayment: accountPayment

AcountPaymentSetCaptureMessage

com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage

8.7

Set capture message on AccountPayment

void: No return value

1. AccountPayment: ap
2. String: captureMessage

AccountPaymentTypeAdvancedReader

com.cdrator.billing.payment.action.AccountPaymentTypeAdvancedReader

8.7

Retrieves account payment types 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

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

DeleteRechargeTicket

com.cdrator.billing.payment.action.DeleteRechargeTicket

8.7

Use the DeleteRechargeTicketUsingRemover action if available. This action deletes a recharge ticket from the system. A history line is created with information about the deleted recharge ticket.

void: Nothing is returned.

1. RechargeTicket: rechargeTicket

GetRatePlanAvailableOptions

com.cdrator.billing.rateplan.action.GetRatePlanAvailableOptions

8.7

Gets the list of the rate plan's available options optionally filtered by option key prefix

List: The list of the rate plan's available options optionally filtered by option key prefix

1. optionKeyPrefix: The checked option key prefix

1. RatePlan: ratePlan

GetListOfServicesInStatusFromSubscriptions

com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions

8.7

Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.

List: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.

1. List: subscriptions
2. List: statuses

MakeInvoicePaymentOnInvoicesInBatch

com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch

8.7

Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.

boolean: True is always returned.

1. payPostPaidInvoices: Should postpaid invoices be marked as paid.
2. payPrePaidInvoices: Should prepaid invoices be marked as paid.

1. InvoiceBatch: batch
2. String: paymentTypeId
3. String: bObjectId
4. String: reference
5. String: source

DoAccountPaymentWithAmount

com.cdrator.billing.financial.billing.action.DoAccountPaymentWithAmount

8.7

Creates an account payment in status DO_AUTHORIZE, if the amount is null the amount will be taken from the invoice.

AccountPayment: Returns the account payment

1. accountPaymentTypeId: The account payment type of the recharge ticket.
2. saveAccountPayment: Sets if the account payment should be saved.

1. RechargeTicket: rechargeTicket
2. Invoice: invoice
3. BillingGroup: billingGroup
4. String: paymentRequestRef
5. Amount: amount

BuildAccountPaymentsForInvoicesOnBatch

com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch

8.7

Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.

boolean: True is always returned.

1. paymentType: The account payment type that should be used for the payment.

1. InvoiceBatch: batch
2. String: cdrParameterName
3. String: parameterValue

DoAccountPayment

com.cdrator.billing.financial.billing.action.DoAccountPayment

8.7

Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.

AccountPayment: Returns the account payment

1. accountPaymentTypeId: The account payment type of the recharge ticket.
2. skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.

1. RechargeTicket: rechargeTicket
2. Invoice: invoice
3. BillingGroup: billingGroup
4. String: paymentRequestRef
5. HookpointResult: hookpointResult

GetNewInvoice

com.cdrator.billing.financial.billing.action.GetNewInvoice

8.7

This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.

Invoice: The newly created Invoice

1. invoiceType: The available invoice types

1. BillingGroup: billingGroup

SetBillingGroupCreditDays

com.cdrator.billing.financial.billing.action.SetBillingGroupCreditDays

8.7

This action sets the credit days on a billing group.

void: No return value.

1. BillingGroup: billingGroup
2. long: creditDays

ManualDebitOrCredit

com.cdrator.billing.financial.billing.action.ManualDebitOrCredit

8.7

This action calls the function addManualDebitOrCredit on the provided set of parameters.

void: No return value

1. BillingGroup: billingGroup
2. TimeCharge: timeCharge
3. ChargeItem: chargeItem
4. String: description
5. boolean: isDebit
6. Amount: amount
7. Currency: amountCurrency
8. Subscription: subscription
9. Invoice: invoice

BillingGroupRefundRequestReader

com.cdrator.billing.financial.billing.action.BillingGroupRefundRequestReader

8.7

Retrieves a BillingGroupRefundRequest 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

CreateBillingGroupRefundRequest

com.cdrator.billing.financial.billing.action.CreateBillingGroupRefundRequest

8.7

Create a billing group refund request

BillingGroupRefundRequest: The created BillingGroupRefundReqest

1. type: The account payment type that should be used for the payment.

1. BillingGroup: billingGroup
2. boolean: refundTotalBalance
3. float: amount
4. String: comment

BillingGroupRefundRequestAdvancedReader

com.cdrator.billing.financial.billing.action.BillingGroupRefundRequestAdvancedReader

8.7

Retrieves billing group refund 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

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

AddChargeToBillingGroup

com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup

8.7

Adds a charge to a billing group.

Charge: The created charge is returned.

1. BillingGroup: billingGroup
2. ChargeItem: chargeItem
3. String: description
4. Number: amount

This action is deprecated and therefore should not be used.

PayInvoicesOnBatch

com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch

8.7

Adds a charge to a billing group.

boolean: True is always returned.

1. payPostPaidInvoices: Should postpaid invoices be marked as paid.
2. payPrePaidInvoices: Should prepaid invoices be marked as paid.

1. InvoiceBatch: batch
2. String: paymentTypeId
3. String: bObjectId
4. String: reference
5. String: source

RejectBillingGroupRefundRequest

com.cdrator.billing.financial.billing.action.RejectBillingGroupRefundRequest

8.7

Rejects a billing group refund request. Set the status to 9 (REJECTED) and the refund result to the provided string.

BillingGroupRefundRequest: The rejected billing group refund request.

1. BillingGroupRefundRequest: billingGroupRefundRequest
2. String: refundResult

PaymentMethodReader

com.cdrator.billing.financial.PaymentMethodReader

8.7

Retrieves a Payment Method entity 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

GetPaymentReferenceFromBillingGroup

com.cdrator.billing.financial.action.GetPaymentReferenceFromBillingGroup

8.7

This action will return an unique payment reference based on the billing group provided.

String: A payment reference generated from the supplied billing group.

1. BillingGroup: billingGroup

ChargeItemReader

com.cdrator.billing.financial.action.ChargeItemReader

8.7

Retrieves a ChargeItem 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

FilterInvoiceDetailLinesByBillingGroup

com.cdrator.billing.financial.action.FilterInvoiceDetailLinesByBillingGroup

8.7

This action filters an list of invoice detail lines so only the ones related to the billing group are returned.

List: A list of invoice detail lines related to the billing group.

1. List: invoiceDetailLines
2. BillingGroup: billingGroup

ChargeItemAdvancedReader

com.cdrator.billing.financial.action.ChargeItemAdvancedReader

8.7

Retrieves charge items 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

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

GetActiveInvoiceFlows

com.cdrator.billing.financial.collector.flow.GetActiveInvoiceFlows

8.7

Action for extracting InvoiceFlows based on persistent object (Invoice or BillingGroup). If deepSearch parameter is selected and type of PersistentObject is BillingGroup - action returns all open InvoiceFlows from invoices that belong to this BillingGroup.

List: PersistentObject could be Invoice or BillingGroup

1. deepSearch: Search in all invoices with given BillinGroup

1. PersistentObject: po

PaymentLogReader

com.cdrator.billing.financial.payments.action.PaymentLogReader

8.7

Retrieves a Payment Log 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

UpdateInNodeChargeStatus

com.cdrator.billing.financial.payments.action.UpdateInNodeChargeStatus

8.7

This action will update the status on an IN Node Charge.

void: null

1. newStatus: New Status

1. InNodeCharge: inNodeCharge

GetInNodeChargeByAccountPayment

com.cdrator.billing.financial.payments.action.GetInNodeChargeByAccountPayment

8.7

This action will return the In Node Charge associated with a given account payment.

InNodeCharge: The IN Node Charge entity associated with the Account Payment.

1. AccountPayment: accountPayment

RechargeTicketReader

com.cdrator.billing.financial.payments.action.RechargeTicketReader

8.7

Retrieves a Recharge Ticket 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

CreateSingleChargeForBillingGroup

com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup

8.7

Creates and saves a Charge for a Billing Group. Adding the charge directly is optional, and if selected will create invoice detail lines directly.Adding description and amount is also optional, and if not specified, the amount and description will be default to the ones specified on the Charge Item fields.

Charge: The created charge is returned.

1. addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.

1. BillingGroup: billingGroup
2. ChargeItem: chargeItem
3. String: description
4. Amount: amount

RoundAllInvoicesInBatch

com.cdrator.billing.charge.action.RoundAllInvoicesInBatch

8.7

Rounds all invoices on an invoicebatch, to nearest whole number.

void: null

1. InvoiceBatch: batch
2. ChargeItem: chargeItem

CreateSingleChargeForSubscription

com.cdrator.billing.charge.action.CreateSingleChargeForSubscription

8.7

Creates and saves a Charge for a Subscription. Adding the charge directly is optional, and if selected will create invoice detail lines directly.Adding description and amount is also optional, and if not specified, the amount and description will be default to the ones specified on the Charge Item fields.

Charge: The created charge is returned.

1. addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.

1. Subscription: subscription
2. ChargeItem: chargeItem
3. String: description
4. Amount: amount

CreateSingleChargeForSubscriptionWithInvoice

com.cdrator.billing.charge.action.CreateSingleChargeForSubscriptionWithInvoice

8.7

Creates and saves a Charge for a Subscription on a specific invoice. Adding the charge directly is optional, and if selected will create invoice detail lines directly.Adding description and amount is also optional, and if not specified, the amount and description will be default to the ones specified on the Charge Item fields.

Charge: The created charge is returned.

1. addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.

1. Subscription: subscription
2. ChargeItem: chargeItem
3. String: description
4. Amount: amount
5. Invoice: invoice

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

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

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

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

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

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

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

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

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

This action is deprecated and therefore should not be used.

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

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

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

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

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

TerminateWorkflow

com.cdrator.workflow.action.TerminateWorkflow

8.7

Terminates the given workflow.

void: null

1. WfWorkflow: workflow

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

AddMultipleContextObjects

com.cdrator.workflow.context.action.AddMultipleContextObjects

8.7

Adds multiple objects to the workflow context. 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

SetSubscriptionLockinEndDate

com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate

8.7

This action updates subscription lock-in's end date and saves it. It updates only if a lockin exists.

void: No return value.

1. Subscription: subscription
2. Date: lockinEndDate

SubscriptionLockinTypeAdvancedReader

com.cdrator.main.subscription.lockin.action.SubscriptionLockinTypeAdvancedReader

8.7

Retrieves subscription lockin types 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

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

SubscriptionLockinAdvancedReader

com.cdrator.main.subscription.lockin.action.SubscriptionLockinAdvancedReader

8.7

Retrieves subscription lockins 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

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

SubscriptionLockinTypeReader

com.cdrator.main.subscription.lockin.action.SubscriptionLockinTypeReader

8.7

Retrieves a subscription lockin type 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

HasSubscriptionLockin

com.cdrator.main.subscription.lockin.action.HasSubscriptionLockin

8.7

This action checks if a subscription has a lock-in.

String: Returns either NO or YES.

1. Subscription: subscription

CreateNewSubscriptionLockin

com.cdrator.main.subscription.lockin.action.CreateNewSubscriptionLockin

8.7

This action creates a new subscription lock-in and saves it. If the subscription already has a lock-in, start date will be the day after the last binding period. If no existing lock-in, start date is current date.

SubscriptionLockin: Returns the subscription lock-in created.

1. Subscription: subscription
2. SubscriptionLockinType: subscriptionLockinType

SetEndDateOnSubscriptionLockin

com.cdrator.main.subscription.lockin.action.SetEndDateOnSubscriptionLockin

8.7

Set end date on subscription lockin and optionally save it after change. Main difference between this and similar action com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate is that this action takes subscription lockin as a parameter and not a subscription.

void: No return value.

1. saveAfterEndDateSet: Define if subscription lockin should be saved after end date was changed

1. SubscriptionLockin: subscriptionLockin
2. Date: subscriptionLockinEndDate

GetAllSubscriptionLockins

com.cdrator.main.subscription.lockin.action.GetAllSubscriptionLockins

8.7

This action retrieves all subscription lock-ins for a given subscription.

ArrayList: Returns the subscription lock-in created.

1. Subscription: subscription

GetSubscriptionLockinTypes

com.cdrator.main.subscription.lockin.action.GetSubscriptionLockinTypes

8.7

This action retrieves all subscription lock-in types.

List: Returns a list of subscription lock-in types.

SubscriptionLockinReader

com.cdrator.main.subscription.lockin.action.SubscriptionLockinReader

8.7

Retrieves a subscription lockin 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

SetLockinEndDateForLockinWithLeastEndDate

com.cdrator.main.subscription.lockin.action.SetLockinEndDateForLockinWithLeastEndDate

8.7

This action updates lockin_end_date of the subscription_lockin with least lockin_end_date and saves it.

void: No return value.

1. Subscription: subscription
2. Date: lockinEndDate

SetStartDateOnSubscriptionLockin

com.cdrator.main.subscription.lockin.action.SetStartDateOnSubscriptionLockin

8.7

Set start date on subscription lockin and optionally save it after change.

void: No return value.

1. saveAfterEndDateSet: Define if subscription lockin should be saved after start date was changed

1. SubscriptionLockin: subscriptionLockin
2. Date: subscriptionLockinStartDate

CheckIfParentSubscriptionIsInState

com.cdrator.main.subscription.action.CheckIfParentSubscriptionIsInState

8.7

This action checks if a parent subscription is in a given state.

boolean: Returns true if the parent exists and state matches the given state.

1. controlState: The available states.

1. Subscription: subscription

GetSubscriptionBundlesForSubscription

com.cdrator.main.subscription.action.GetSubscriptionBundlesForSubscription

8.7

Get subscription bundles from the specified subscription.

List: The subscription bundles for the user of the specified service.

1. Subscription: subscription

DeepSave

com.cdrator.main.subscription.action.DeepSave

8.7

This action deep-saves a subscription in Rator.

void: No return value.

1. Subscription: subscription

TerminateSubscription

com.cdrator.main.subscription.action.TerminateSubscription

8.7

This action terminates a subscription, and child subscriptions if selected, using either new or old termination logic dependent on the parameter GUI.FEATURES.SUBSCRIPTION.USE_NEW_TERMINATION. - THIS ACTION DO NOT ALWAYS SET SUBSCRIPTION END-DATE AND STATUS - Depending on core version and the parameter above (for core 8.18+ use action TerminateSubscriptionCore)

void: No return value.

1. terminateChildSubscriptions: Terminate the child subscriptions (if any) with same termination details as the parent subscription.

1. Subscription: subscription
2. SubscriptionTerminationRequest: subscriptionTerminationRequest

GetSubscriptionFromService

com.cdrator.main.subscription.action.GetSubscriptionFromService

8.7

Get subscription from the specified service.

Subscription: The subscription from the specified service.

1. Service: service

CheckSubscriptionStatus

com.cdrator.main.subscription.action.CheckSubscriptionStatus

8.7

Checks if the subscription is in a specific status

boolean: true if the subscription is in the specified status

1. checkedStatus: The checked status

1. Subscription: subscription

AddWorkflow

com.cdrator.main.subscription.action.AddWorkflow

8.7

This action associates a subscription with a workflow by setting the subscription ID on the workflow.

void: No return value.

1. Subscription: subscription
2. WfWorkflow: workflow

SubscriptionHasServiceCode

com.cdrator.main.subscription.action.SubscriptionHasServiceCode

8.7

Determines whether or not the transfer of a subscription to another account is approved.

Boolean: Boolean result indicating whether or not this subscription transfer is approved.

1. serviceCode: The service code to check for.

1. Subscription: subscription

CreateSubscriptionTerminationRequest

com.cdrator.main.subscription.action.CreateSubscriptionTerminationRequest

8.7

This action assembles subscription termination details in a termination request.

SubscriptionTerminationRequest: The constructed termination request object.

1. addTerminationFee: If termination fee should be added. Default is false.
2. terminationReason: Set the terminate reason text.
3. terminationReasonID: Set the terminate reason id.

1. String: comment
2. Date: expectedTerminationDate
3. Date: terminationOrderDate
4. Date: endBillingDate
5. Date: chargeUntilDate
6. boolean: canContactCustomer

IsSubscriptionActive

com.cdrator.main.subscription.action.IsSubscriptionActive

8.7

Checks if the subscription is active

boolean: Returns true if the subscription is active

1. Subscription: subscription

GetSubscriptionUsageForPeriod

com.cdrator.main.subscription.action.GetSubscriptionUsageForPeriod

8.7

This action returns all usage for the supplied subscription in a given period.

Usage: A Usage object with all usage for the given subscription and period.

1. Subscription: subscription
2. Date: fromDate
3. Date: toDate

CheckIfSubscriptionInState

com.cdrator.main.subscription.action.CheckIfSubscriptionInState

8.7

This action checks if a subscription is in given states.

boolean: Returns YES if the subscription state matches one of the given states.

1. possibleState: The possible states separated by ';'

1. Subscription: subscription

SetAlertGroup

com.cdrator.main.subscription.action.SetAlertGroup

8.7

An action to set the alert group on a subscription.

void: No return value.

1. Subscription: subscription
2. AlertGroup: alertGroup

ChangeRatePlan

com.cdrator.main.subscription.action.ChangeRatePlan

8.7

This action schedules a rateplan change.

RatePlanChange: Sets up, saves and returns a rate plan change.

1. Subscription: subscription
2. RatePlan: newRatePlan
3. Product: newProduct
4. Date: changeDate
5. ArrayList: options

SubscriptionSalesDetails

com.cdrator.main.subscription.action.SubscriptionSalesDetails

8.7

This action sets a sales rep and a sales store on a subscription.

void: No return value.

1. Subscription: subscription
2. String: salesRep
3. String: salesStore

TerminateAllChildSubscriptions

com.cdrator.main.subscription.action.TerminateAllChildSubscriptions

8.7

This action terminates child subscriptions with same details as the parent subscription.

void: No return value.

1. Subscription: subscription

ActivateSubscription

com.cdrator.main.subscription.action.ActivateSubscription

8.7

This action activates a subscription in Rator.

Subscription: Returns the subscription.

1. Subscription: subscription

ReactivateSubscription

com.cdrator.main.subscription.action.ReactivateSubscription

8.7

This action reactivates a subscription by setting the end date to null and the status to active.

void: No return value.

1. Subscription: subscription

GetAllChildSubscriptions

com.cdrator.main.subscription.action.GetAllChildSubscriptions

8.7

This action returns all child subscriptions of a given subscription.

List: A list of child subscriptions.

1. Subscription: subscription
2. Broker: broker

ReactivateAllChildSubscriptionsInList

com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList

8.7

This action reactivates all child subscriptions.

void: No return value.

1. List: subscriptions

SubscriptionTransferToWithParent

com.cdrator.main.subscription.action.SubscriptionTransferToWithParent

8.7

This action calls the function transferTo with the provided parameters.

boolean: Boolean result indicating success or failure.

1. Subscription: subscription
2. Account: newAccount
3. BillingGroup: newBillingGroup
4. Subscription: newParentSubscription

TerminateAllChildSubscriptionsInList

com.cdrator.main.subscription.action.TerminateAllChildSubscriptionsInList

8.7

This action terminates child subscriptions with same details as the parent subscription.

void: No return value.

1. consolidateFinalFees: Set consolidate final fees. Default is false.
2. disregardBindingPeriod: Set disregard binding period. Default is false.
3. endBillingDate: Set end billing date. Default is null.
4. finalizeFees: Set finalize fees. Default is false.

1. List: subscriptions
2. Subscription: parentSubscription

SubscriptionReader

com.cdrator.main.subscription.action.SubscriptionReader

8.7

Retrieves a Subscription 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

SetOwner

com.cdrator.main.subscription.action.SetOwner

8.7

This action sets the owner of a subscription.

void: No return value.

1. Subscription: subscription
2. Users: owner

TransferSubscriptionToAccount

com.cdrator.main.subscription.action.TransferSubscriptionToAccount

8.7

Transfer the instance of the Subscription to another Account on a specific Billing Group.
Start Date is assumed to current date if left empty (null)
Destination Parent Subscription can also be left empty (null)

boolean: Returns true if the transfer was a success, otherwise false

1. Subscription: subscription
2. Subscription: destinationParentSubscription
3. BillingGroup: destinationBillingGroup
4. Account: destinationAccount
5. Date: startDate

ReactivateAllChildSubscriptions

com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions

8.7

This action reactivates all child subscriptions.

void: No return value.

1. Subscription: subscription

GetAllActiveWorkflowsForSubscription

com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscription

8.7

This action returns all active workflows for a subscription.

ArrayList: An arrayList of workflows.

1. Subscription: subscription

GetActiveBillingGroupOfSubscription

com.cdrator.main.subscription.action.GetActiveBillingGroupOfSubscription

8.7

Retrieves the active billing group of the subscription

BillingGroup: The active billing group of the subscription

1. Subscription: subscription

SetSubscriptionEndDate

com.cdrator.main.subscription.action.SetSubscriptionEndDate

8.7

This action sets the subscription end date and saves the subscription.

void: No return value.

1. Subscription: subscription
2. Date: endDate

SubscriptionAdvancedReader

com.cdrator.main.subscription.action.SubscriptionAdvancedReader

8.7

Retrieves subscriptions 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