Release 1.3

CreateSubscriptionCampaignMember

com.cdrator.campaign.action.CreateSubscriptionCampaignMember

8.18

Retrieves a service based on configurable parameters.

SubscriptionCampaignMember: null

1. SubscriptionCampaign: subscriptionCampaign
2. SubscriptionCampaignSharingGroup: targetObject
3. Date: startDate
4. Date: endDate

ExpireSubscriptionCampaignMember

com.cdrator.campaign.action.ExpireSubscriptionCampaignMember

8.18

null

void: null

1. SubscriptionCampaignMember: subscriptionCampaignMember
2. Date: endDate

GetSubscriptionCampaignMember

com.cdrator.campaign.action.GetSubscriptionCampaignMember

8.18

Retrieves a subscription campaign member

SubscriptionCampaignMember: null

1. SubscriptionCampaign: subscriptionCampaign
2. SubscriptionCampaignSharingGroup: subscriptionCampaignSharingGroup
3. Date: date

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

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

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

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

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

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

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

CreateSingleChargeForBillingGroup

com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup

8.7

Creates and saves a Charge for a Billing Group. Adding the charge directly is optional.

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

CreateSingleChargeForSubscription

com.cdrator.billing.charge.action.CreateSingleChargeForSubscription

8.7

Creates and saves a Charge for a Subscription. Adding the charge directly is optional.

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

PublishInvoice

com.cdrator.billing.invoice.action.PublishInvoice

8.7

Publishes a given invoice.

Invoice: The published invoice

1. Invoice: invoice

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

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

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

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

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

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

AccountPaymentSetCaptureInfo

com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo

8.7

Set capture info on AccountPayment

void: No return value

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

1. AccountPayment: ap

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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.

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

CreateTodoTask

com.cdrator.billing.todoTask.action.CreateTodoTask

8.7

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TerminateCampaignWithFromDate

com.cdrator.campaign.action.TerminateCampaignWithFromDate

8.7

Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate

void: No return values

1. SubscriptionCampaign: subscriptionCampaign

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

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

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.

1. Subscription: subscription

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

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

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

GetSubscriptionBundleType

com.cdrator.campaign.bundle.action.GetSubscriptionBundleType

8.7

Finds the type of a SubscriptionBundle.

String: The code of the SubscriptionBundle.

1. SubscriptionBundle: subscriptionBundle

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

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

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

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

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

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

DocArchiveReader

com.cdrator.correspondence.archive.action.DocArchiveReader

8.7

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

SaveDocArchiveFile

com.cdrator.correspondence.archive.action.SaveDocArchiveFile

8.7

If property FilePath is set, it will override the FilePath parameter. Throws ActionParameterException if neither is specified

void: No value returned

1. filePath: FilePath

1. DocArchive: archive
2. String: filePathParameter

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

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

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

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

AccountReader

com.cdrator.main.account.action.AccountReader

8.7

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

AddAccountWarning

com.cdrator.main.account.action.AddAccountWarning

8.7

This action adds a warning to an account.
You can use the FormatString action to format the warning before calling this activity

void: No return value.

1. category: null

1. Account: account
2. String: key
3. String: description
4. PersistentObject: sourcePO
5. Date: expireDate

AddWorkflowToAccount

com.cdrator.main.account.action.AddWorkflowToAccount

8.7

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

void: No return value.

1. Account: account
2. WfWorkflow: wfWorkflow

CheckIfAccountInState

com.cdrator.main.account.action.CheckIfAccountInState

8.7

This action checks if an account is in one of the given states.

Boolean: Returns TRUE if the account state matches one of the given states.

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

1. Account: account

CheckIfAccountIsClosed

com.cdrator.main.account.action.CheckIfAccountIsClosed

8.7

This action checks if an account is closed.

Boolean: Returns TRUE if the account is closed.

1. Account: account

ProductMakeSubscription

com.cdrator.main.action.ProductMakeSubscription

8.7

This action creates a subscription based on the supplied product configuration, account and billing group.

Subscription: Returns the newly created subscription.

1. ProductConfig: productConfig
2. Account: account
3. BillingGroup: billingGroup

AlertGroupReader

com.cdrator.main.alert.action.AlertGroupReader

8.7

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

OperatorAuthentication

com.cdrator.main.operator.action.OperatorAuthentication

8.7

This action authenticates the operator based on the username and password provided. If username or password are null or empty, null is returned.

Operators: The operator matching the username and password. Otherwise null.

1. String: username
2. String: password

OperatorHookpointBlockRevoke

com.cdrator.main.operator.action.OperatorHookpointBlockRevoke

8.7

This action checks if the block of a hookpoint access has been revoked. As default all hookpoints have been blocked, but the block can be removed via the Operator Access.

OperatorAccessTags: The operator access tag matching the username and hookpoint key. Otherwise null.

1. accessTagPostfix: Alternative access tag postfix. Default is _BLOCK_REVOKED

1. String: username
2. String: hookpointKey

OperatorReader

com.cdrator.main.operator.action.OperatorReader

8.7

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

OperatorTypeReader

com.cdrator.main.operator.action.OperatorTypeReader

8.7

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

ChangeDevice

com.cdrator.main.service.action.ChangeDevice

8.7

This action assigns a device to a given service.

Hashtable: Assign a new device to the given service. If the auto assign device property is set to true, the newDevice parameter will be disregarded and a nullvalue will be passed to the underlying workflow supporting auto assigning devices.

1. autoAssignDevice: Auto assign device? If true, then newDevice parameter will be disregarded and the underlying workflow will assign a device automatically.

1. Service: service
2. Device: newDevice
3. boolean: addFee
4. String: sendType
5. Status: reason
6. String: comment

CompleteCachedOptions

com.cdrator.main.service.action.CompleteCachedOptions

8.7

Complete cached options on service

void: Void

1. Service: service

GetServiceCode

com.cdrator.main.service.action.GetServiceCode

8.7

Return the code of the service.

String: The code of the service.

1. Service: service

GetServiceFromPhoneNumber

com.cdrator.main.service.action.GetServiceFromPhoneNumber

8.7

This action gets an active service from the phone number and optionally the brand.

Service: The active service matching the phone number and brand.

1. String: phoneNumber
2. Brand: brand

GetServiceOptionParameter

com.cdrator.main.service.action.GetServiceOptionParameter

8.7

This action gets a service option parameter given an option key and a parameter key.

ServiceOptionParameter: The service option parameter. If the service does not have the service option or the service option parameter, null is returned.

1. optionKey: The option key to look for on service.

1. Service: service
2. String: parameterKey

GetServicesForAccountAndProduct

com.cdrator.main.service.action.GetServicesForAccountAndProduct

8.7

Return a list of services belonging to the account, with the a specific product code and with the status selected.

ArrayList: The list of recovered services, based on the input parameters.

1. productIdDescription: The product for the service. If empty all services will be returned.
2. serviceStatus: The service status. If empty all services will be returned.

1. Account: account

ActivateSubscription

com.cdrator.main.subscription.action.ActivateSubscription

8.7

This action activates a subscription in Rator.

Subscription: Returns the subscription.

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

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

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

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

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

DeepSave

com.cdrator.main.subscription.action.DeepSave

8.7

This action deep-saves a subscription in Rator.

void: No return value.

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

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

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

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

ReactivateAllChildSubscriptions

com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions

8.7

This action reactivates all child subscriptions.

void: No return value.

1. Subscription: subscription

ReactivateAllChildSubscriptionsInList

com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList

8.7

This action reactivates all child subscriptions.

void: No return value.

1. List: subscriptions

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

ReactivateSubscriptionCore

com.cdrator.main.subscription.action.ReactivateSubscriptionCore

8.7

This action reactivates a subscription by setting the end date to null and the status to active. The Subscription Termination is also deactivated.
The solution uses the core implementation

SubscriptionTermination: The Subscription Termination connected to the termination

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

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

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

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

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

SubscriptionTransferTo

com.cdrator.main.subscription.action.SubscriptionTransferTo

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

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

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

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

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.

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

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

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.

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

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

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

DeactivateSubscriptionTermination

com.cdrator.main.subscriptiontermination.action.DeactivateSubscriptionTermination

8.7

This action deactivates a subscription termination.

void: No return value.

1. SubscriptionTermination: subscriptionTermination

CheckUsernameAvailability

com.cdrator.main.user.action.CheckUsernameAvailability

8.7

This action checks if a given username is available.

boolean: boolean true if the username is available (no user exists with the usename), else false

1. caseSensitive: Is the username case sensitive?

1. String: username
2. Brand: brand

GetAddress

com.cdrator.main.user.action.GetAddress

8.7

Action to create and save a new Address object based on the address information of the user passed as argument.

Address: Returns the newly created Address object.

1. doSetCoFromAddress2: Specify whether or not the Address field CO should be set from user.address2.

1. Users: user

GetUserAccessLevel

com.cdrator.main.user.action.GetUserAccessLevel

8.7

This action returns an integer value representing the access level of the user. 40= Account owner, 30=CostCenter owner, 20=BillingGroup owner, 10= SubscriptionOwner, 0=Not owner of anything. This action will return only the highest single value.

int: An integer value representing the access level of the user. 40= Account owner, 30=CostCenter owner, 20=BillingGroup owner, 10= SubscriptionOwner, 0=Not owner of anything

1. Users: user

GetUserByEmailAddress

com.cdrator.main.user.action.GetUserByEmailAddress

8.7

This action returns the user with a given email address if one exists. SysException is thrown if more than one user object exists with the email address.

Users: The user object if a user with the email address exists. The value null is returned if none exists.

1. String: emailAddress
2. Brand: brand

GetUserByPhoneNumber

com.cdrator.main.user.action.GetUserByPhoneNumber

8.7

This action returns the user with a given phone number if one exists. SysException is thrown if more than one user object exists with the phone number.

Users: The user object if a user with the phone number exists. The value null is returned if none exists.

1. cancelationPending: Include subscriptions in cancelation pending status.

1. String: phoneNumber
2. Brand: brand

GetUserByUsername

com.cdrator.main.user.action.GetUserByUsername

8.7

This action returns the user with a given username if one exists. SysException is thrown if more than one user object exists with the username.

Users: The user object if a user with the username exists. The value null is returned if none exists.

1. String: username
2. Brand: brand

GetUsersByPersonalIDHash

com.cdrator.main.user.action.GetUsersByPersonalIDHash

8.7

This action returns the user with a given PersonalID if one exists.This activity REQUIRES database access to SYS.DBMS_CRYPTO and the function get_hash_val. Both of these can be obtained by importing the scripts located at

ArrayList: An ArrayList of users matching the given personalID. If none exists, an empty ArrayList is returned.

1. selectedHashAlgorithm: Chosen hashing algorithm. only SHA-1, SHA-256, SHA-384, SHA-512, MD2, MD5 is supported. If none is specified or no match, then SHA-1 is assumed.

1. String: personalIDInput

SetNewPassword

com.cdrator.main.user.action.SetNewPassword

8.7

This action changes the password of a user. If password is blank, a password will be generated.

String: The new password.

1. Users: user
2. String: password

SetPersonalIDHash

com.cdrator.main.user.action.SetPersonalIDHash

8.7

This action adds a PersonalID entry for a User. The input parameter must already be hashed/encrypted if so desired.

void: No return value.

1. endDateLastPeriod: To set expiry date on personal id.
2. personalIDType: The personal ID type

1. Users: user
2. String: hashedPersonalID

SetUserAsAccountOwner

com.cdrator.main.user.action.SetUserAsAccountOwner

8.7

This action sets the user as account owner. Both user and account is saved.

void: No return value.

1. Users: user
2. Account: account

UserReader

com.cdrator.main.user.action.UserReader

8.7

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

LoginUserWithAttemptsCount

com.cdrator.main.user.login.action.LoginUserWithAttemptsCount

8.7

Attempts to login the user based on a password and the Users object.
The user can be blocked after a specific number of incorrect login attempts (Parameter Value: SOAP.SERVICES.SELFCARE_SERVICE.GET_USER_PROFILE.MAX_TRIES)
The timeout value for the block also configurable (Parameter Value: SOAP.SERVICES.SELFCARE_SERVICE.GET_USER_PROFILE.BLOCK_TIMEOUT)

boolean: The user object if a user with the username exists. The value null is returned if none exists.Throws exception MaxTriesReachedException when the maximum number login attempts have been reached

1. Users: user
2. String: password

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

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

This action is deprecated and therefore should not be used.

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

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

LookupActiveNpFlow

com.cdrator.np.action.LookupActiveNpFlow

8.7

Looks for an active NP Flow of a given phone number and (optionally) brand (via the subscription).

NpFlow: The NP Flow matching the phone number and the brand.

1. ignoreBrand: Ignore the brand connected to the NP Flow.

1. String: phoneNumber
2. Brand: brand

LookupActiveNpFlowBySubscription

com.cdrator.np.action.LookupActiveNpFlowBySubscription

8.7

Looks for an active NP Flow for a given subscription.

NpFlow: The active NP Flow from the subscription.

1. Subscription: subscription

NpFlowReader

com.cdrator.np.action.NpFlowReader

8.7

Retrieves an NP flow 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

SaveNpFlow

com.cdrator.np.action.SaveNpFlow

8.7

Sets some initial values on np flow.

void: No Return Value

1. NpFlow: npFlow

SetRejectCodeOnExportFlow

com.cdrator.np.action.SetRejectCodeOnExportFlow

8.7

Set Reject Code and Comment On an Np Export Flow object.

void: No return value.

1. comment: Used for adding a static comment.
2. rejectCode: Used for adding reject code.

1. NpExportFlow: npFlow
2. String: dynamicComment

TeleOperatorReader

com.cdrator.np.action.TeleOperatorReader

8.7

Retrievse a tele 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

CheckOverlappingRange

com.cdrator.np.range.action.CheckOverlappingRange

8.7

Check if the ranges are overlapping

boolean: A boolean indicating whether the two ranges overlap each other, fully or partially

1. String: newRange
2. String: existingRange

AnumberReader

com.cdrator.number.action.AnumberReader

8.7

Retrieves an A-number 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

AssignAnumberToService

com.cdrator.number.action.AssignAnumberToService

8.7

Sets Anumber on Service (Only relevant for Service types with phone numbers.)

void: No Return Value