Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

{noprint}
{float:right|width=350px|background=lightgrey|border=solid blue 2px|margin=10px|padding=8px}
*Contents*
{toc:all=true|depth=4|excerpt=true|indent=14px}
{float}
{noprint}
h2. Action list
h3.CustomAttribute
h4.GetCustomAttribute
||Action name|GetCustomAttribute|
||Class name|{{com.cdrator.customAttribute.action.GetCustomAttribute}}|
||Available from core version|8.19|
||Description|Gets a custom attribute from the database, it is returned as the kind of object that the property definition is set to. (string, date, amount, boolean or persisten object.|
||Return value|{{Object}}: null|
||Properties| |
||Parameters|# {{PersistentObject}}: object
# {{String}}: columnName
|
h4.SetCustomAttribute
||Action name|SetCustomAttribute|
||Class name|{{com.cdrator.customAttribute.action.SetCustomAttribute}}|
||Available from core version|8.19|
||Description|Set the value of a custom attribute|
||Return value|{{void}}: null|
||Properties|# saveObject: Sets if the object should be saved.
|
||Parameters|# {{PersistentObject}}: object
# {{String}}: columnName
# {{Object}}: value
|
h3.Campaign
h4.CreateSubscriptionCampaignMember
||Action name|CreateSubscriptionCampaignMember|
||Class name|{{com.cdrator.campaign.action.CreateSubscriptionCampaignMember}}|
||Available from core version|8.18|
||Description|Retrieves a service based on configurable parameters.|
||Return value|{{SubscriptionCampaignMember}}: null|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{SubscriptionCampaignSharingGroup}}: targetObject
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.ExpireSubscriptionCampaignMember
||Action name|ExpireSubscriptionCampaignMember|
||Class name|{{com.cdrator.campaign.action.ExpireSubscriptionCampaignMember}}|
||Available from core version|8.18|
||Description|null|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{SubscriptionCampaignMember}}: subscriptionCampaignMember
# {{Date}}: endDate
|
h4.GetSubscriptionCampaignMember
||Action name|GetSubscriptionCampaignMember|
||Class name|{{com.cdrator.campaign.action.GetSubscriptionCampaignMember}}|
||Available from core version|8.18|
||Description|Retrieves a subscription campaign member|
||Return value|{{SubscriptionCampaignMember}}: null|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{SubscriptionCampaignSharingGroup}}: subscriptionCampaignSharingGroup
# {{Date}}: date
|
h4.ActivateSubscriptionCampaigns
||Action name|ActivateSubscriptionCampaigns|
||Class name|{{com.cdrator.campaign.action.ActivateSubscriptionCampaigns}}|
||Available from core version|8.15|
||Description|Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now. |
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: campaigns
# {{Date}}: activationDate
|
h4.ActivateSubscriptionCampaigns
||Action name|ActivateSubscriptionCampaigns|
||Class name|{{com.cdrator.campaign.action.ActivateSubscriptionCampaigns}}|
||Available from core version|8.15|
||Description|Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now. |
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: campaigns
# {{Date}}: activationDate
|
h4.ActivateSubscriptionCampaigns
||Action name|ActivateSubscriptionCampaigns|
||Class name|{{com.cdrator.campaign.action.ActivateSubscriptionCampaigns}}|
||Available from core version|8.15|
||Description|Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now. |
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: campaigns
# {{Date}}: activationDate
|
h3.Campaign - Bundle
h4.CreateBundleTypeSummary
||Action name|CreateBundleTypeSummary|
||Class name|{{com.cdrator.campaign.bundle.action.CreateBundleTypeSummary}}|
||Available from core version|8.15|
||Description|Returns a list of bundle type summaries of type Context. One bundle type summary is created for each bundle code in the provided subscription bundle list|
||Return value|{{ArrayList}}: A list of Context objects representing summary of bundle types.|
||Properties|# bundleCodes: A semicolon seperated list of bundle codes to create summaries for.
|
||Parameters|# {{ArrayList}}: subscriptionBundles
|
h3.Campaign
h4.ActivateSubscriptionCampaigns
||Action name|ActivateSubscriptionCampaigns|
||Class name|{{com.cdrator.campaign.action.ActivateSubscriptionCampaigns}}|
||Available from core version|8.15|
||Description|Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now. |
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: campaigns
# {{Date}}: activationDate
|
h3.Campaign - Bundle
h4.CreateBundleTypeSummary
||Action name|CreateBundleTypeSummary|
||Class name|{{com.cdrator.campaign.bundle.action.CreateBundleTypeSummary}}|
||Available from core version|8.15|
||Description|Returns a list of bundle type summaries of type Context. One bundle type summary is created for each bundle code in the provided subscription bundle list|
||Return value|{{ArrayList}}: A list of Context objects representing summary of bundle types.|
||Properties|# bundleCodes: A semicolon seperated list of bundle codes to create summaries for.
|
||Parameters|# {{ArrayList}}: subscriptionBundles
|
h3.Campaign
h4.ActivateSubscriptionCampaigns
||Action name|ActivateSubscriptionCampaigns|
||Class name|{{com.cdrator.campaign.action.ActivateSubscriptionCampaigns}}|
||Available from core version|8.15|
||Description|Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now. |
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: campaigns
# {{Date}}: activationDate
|
h3.Campaign - Bundle
h4.CreateBundleTypeSummary
||Action name|CreateBundleTypeSummary|
||Class name|{{com.cdrator.campaign.bundle.action.CreateBundleTypeSummary}}|
||Available from core version|8.15|
||Description|Returns a list of bundle type summaries of type Context. One bundle type summary is created for each bundle code in the provided subscription bundle list|
||Return value|{{ArrayList}}: A list of Context objects representing summary of bundle types.|
||Properties|# bundleCodes: A semicolon seperated list of bundle codes to create summaries for.
|
||Parameters|# {{ArrayList}}: subscriptionBundles
|
h3.Campaign
h4.ActivateSubscriptionCampaigns
||Action name|ActivateSubscriptionCampaigns|
||Class name|{{com.cdrator.campaign.action.ActivateSubscriptionCampaigns}}|
||Available from core version|8.15|
||Description|Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now. |
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: campaigns
# {{Date}}: activationDate
|
h3.Campaign - Bundle
h4.CreateBundleTypeSummary
||Action name|CreateBundleTypeSummary|
||Class name|{{com.cdrator.campaign.bundle.action.CreateBundleTypeSummary}}|
||Available from core version|8.15|
||Description|Returns a list of bundle type summaries of type Context. One bundle type summary is created for each bundle code in the provided subscription bundle list|
||Return value|{{ArrayList}}: A list of Context objects representing summary of bundle types.|
||Properties|# bundleCodes: A semicolon seperated list of bundle codes to create summaries for.
|
||Parameters|# {{ArrayList}}: subscriptionBundles
|
h3.Billing - Billingcycle
h4.BillingCycleReader
||Action name|BillingCycleReader|
||Class name|{{com.cdrator.billing.billingcycle.action.BillingCycleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Cycle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetEndOfBillingCycleDate
||Action name|GetEndOfBillingCycleDate|
||Class name|{{com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate}}|
||Available from core version|8.7|
||Description|This action returns a date representing the last day of the current billing cycle for the given billing group.|
||Return value|{{Date}}: A Date representing the last day of the current billing cycle.|
||Properties| |
||Parameters|# {{Date}}: date
# {{BillingGroup}}: bg
|
h3.Billing - Billinggroup
h4.BillingGroupReader
||Action name|BillingGroupReader|
||Class name|{{com.cdrator.billing.billinggroup.action.BillingGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Group based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveBillingGroupMembers
||Action name|GetActiveBillingGroupMembers|
||Class name|{{com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers}}|
||Available from core version|8.7|
||Description|Retrieves the active members of the billing group|
||Return value|{{List}}: The active members of the billing group|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.HardBlockAllTeleServicesOnBillingGroup
||Action name|HardBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.SoftBlockAllTeleServicesOnBillingGroup
||Action name|SoftBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.UnBlockAllTeleServicesOnBillingGroup
||Action name|UnBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h3.Billing - Charge
h4.CreateSingleChargeForBillingGroup
||Action name|CreateSingleChargeForBillingGroup|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Billing Group. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.CreateSingleChargeForSubscription
||Action name|CreateSingleChargeForSubscription|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForSubscription}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Subscription. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{Subscription}}: subscription
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.RoundAllInvoicesInBatch
||Action name|RoundAllInvoicesInBatch|
||Class name|{{com.cdrator.billing.charge.action.RoundAllInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Rounds all invoices on an invoicebatch, to nearest whole number.|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: batch
# {{ChargeItem}}: chargeItem
|
h3.Billing - Financial - Billing
h4.AddChargeToBillingGroup
||Action name|AddChargeToBillingGroup|
||Class name|{{com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Number}}: amount
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.BuildAccountPaymentsForInvoicesOnBatch
||Action name|BuildAccountPaymentsForInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# paymentType: The account payment type that should be used for the payment.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: cdrParameterName
# {{String}}: parameterValue
|
h4.DoAccountPayment
||Action name|DoAccountPayment|
||Class name|{{com.cdrator.billing.financial.billing.action.DoAccountPayment}}|
||Available from core version|8.7|
||Description|Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.|
||Return value|{{AccountPayment}}: Returns the account payment|
||Properties|# accountPaymentTypeId: The account payment type of the recharge ticket.
# skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.
|
||Parameters|# {{RechargeTicket}}: rechargeTicket
# {{Invoice}}: invoice
# {{BillingGroup}}: billingGroup
# {{String}}: paymentRequestRef
# {{HookpointResult}}: hookpointResult
|
h4.GetListOfServicesInStatusFromSubscriptions
||Action name|GetListOfServicesInStatusFromSubscriptions|
||Class name|{{com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions}}|
||Available from core version|8.7|
||Description|Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.|
||Return value|{{List}}: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{List}}: statuses
|
h4.GetNewInvoice
||Action name|GetNewInvoice|
||Class name|{{com.cdrator.billing.financial.billing.action.GetNewInvoice}}|
||Available from core version|8.7|
||Description|This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.|
||Return value|{{Invoice}}: The newly created Invoice|
||Properties|# invoiceType: The available invoice types
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.MakeInvoicePaymentOnInvoicesInBatch
||Action name|MakeInvoicePaymentOnInvoicesInBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h4.ManualDebitOrCredit
||Action name|ManualDebitOrCredit|
||Class name|{{com.cdrator.billing.financial.billing.action.ManualDebitOrCredit}}|
||Available from core version|8.7|
||Description|This action calls the function addManualDebitOrCredit on the provided set of parameters.|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{TimeCharge}}: timeCharge
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{boolean}}: isDebit
# {{Amount}}: amount
# {{Currency}}: amountCurrency
# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.PayInvoicesOnBatch
||Action name|PayInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h3.Unknown package
h4.PaymentMethodReader
||Action name|PaymentMethodReader|
||Class name|{{com.cdrator.billing.financial.PaymentMethodReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Method entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Financial - Payments
h4.PaymentLogReader
||Action name|PaymentLogReader|
||Class name|{{com.cdrator.billing.financial.payments.action.PaymentLogReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Log based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Invoice
h4.CloseInvoiceWithCurrentDate
||Action name|CloseInvoiceWithCurrentDate|
||Class name|{{com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate}}|
||Available from core version|8.7|
||Description|Calls closeWithDueDate on a given invoice with current date.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.GetAccountPaymentsForInvoice
||Action name|GetAccountPaymentsForInvoice|
||Class name|{{com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice}}|
||Available from core version|8.7|
||Description|Gets a list of account payments related to the invoice.|
||Return value|{{List}}: A list of accountPayments.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.InvoiceCompareToLastStepId
||Action name|InvoiceCompareToLastStepId|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId}}|
||Available from core version|8.7|
||Description|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 |
||Return value|{{boolean}}: true or false|
||Properties| |
||Parameters|# {{Invoice}}: invoice
# {{String}}: compareString
# {{boolean}}: defaultForBlank
|
h4.InvoiceReader
||Action name|InvoiceReader|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceReader}}|
||Available from core version|8.7|
||Description|Retrieves an invoice based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.PayInvoicesInBatchWithAccountPayments
||Action name|PayInvoicesInBatchWithAccountPayments|
||Class name|{{com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments}}|
||Available from core version|8.7|
||Description|Marks all invoice on batch as paid|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: invoiceBatch
# {{String}}: reference
# {{String}}: transactionNumber
# {{AccountPaymentType}}: accountPaymentType
|
h4.PublishInvoice
||Action name|PublishInvoice|
||Class name|{{com.cdrator.billing.invoice.action.PublishInvoice}}|
||Available from core version|8.7|
||Description|Publishes a given invoice.|
||Return value|{{Invoice}}: The published invoice|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h3.Billing - Main
h4.GetBillingGroupsByUserID
||Action name|GetBillingGroupsByUserID|
||Class name|{{com.cdrator.billing.main.action.GetBillingGroupsByUserID}}|
||Available from core version|8.7|
||Description|This action will return an arraylist of billing groups that a given userID is the owner of.|
||Return value|{{ArrayList}}: An array list of billing groups.|
||Properties| |
||Parameters|# {{String}}: userID
|
h4.SetBillingGroupCurrencyCode
||Action name|SetBillingGroupCurrencyCode|
||Class name|{{com.cdrator.billing.main.action.SetBillingGroupCurrencyCode}}|
||Available from core version|8.7|
||Description|This action sets the currency code on the billing group. The billing group is saved.|
||Return value|{{void}}: No return value.|
||Properties|# currencyCode: The currency code which is set on the billing group.
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.TerminateSharedServiceIfNoTeleservices
||Action name|TerminateSharedServiceIfNoTeleservices|
||Class name|{{com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Boolean}}: Returns true if a shared Service was attempted terminated.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{Date}}: terminationDate
# {{String}}: hookpointKey
# {{String}}: reason
|
h3.Billing - Misc
h4.GetParameterValue
||Action name|GetParameterValue|
||Class name|{{com.cdrator.billing.misc.action.GetParameterValue}}|
||Available from core version|8.7|
||Description|This action retrieves a string representation of a parameter value.|
||Return value|{{String}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{String}}: key
# {{Brand}}: brand
|
h3.Billing - Payment
h4.AccountPaymentReader
||Action name|AccountPaymentReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AccountPaymentSetAuthorized
||Action name|AccountPaymentSetAuthorized|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetAuthorized}}|
||Available from core version|8.7|
||Description|Calls setAuthorized on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentSetCaptureInfo
||Action name|AccountPaymentSetCaptureInfo|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo}}|
||Available from core version|8.7|
||Description|Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage) |
||Return value|{{void}}: No return value|
||Properties|# captureMessage: Capture message to be set.
# useCaptureDate: Should Capture Date be set (to current time.
|
||Parameters|# {{AccountPayment}}: ap
|
h4.AccountPaymentSetDoCapture
||Action name|AccountPaymentSetDoCapture|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetDoCapture}}|
||Available from core version|8.7|
||Description|Calls setDoCapture on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentTypeReader
||Action name|AccountPaymentTypeReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AcountPaymentSetCaptureMessage
||Action name|AcountPaymentSetCaptureMessage|
||Class name|{{com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage}}|
||Available from core version|8.7|
||Description|Set capture message on AccountPayment|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{AccountPayment}}: ap
# {{String}}: captureMessage
|
h4.GetRechargeTicketForBillingGroup
||Action name|GetRechargeTicketForBillingGroup|
||Class name|{{com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup}}|
||Available from core version|8.7|
||Description|This action returns a rechargeTicket for a BillingGroup.|
||Return value|{{RechargeTicket}}: The recharge ticket, if it exists.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h3.Billing - Product
h4.DeviceCanUseOn
||Action name|DeviceCanUseOn|
||Class name|{{com.cdrator.billing.product.action.DeviceCanUseOn}}|
||Available from core version|8.7|
||Description|Calls CanUseOn on a given device with a given service.|
||Return value|{{boolean}}: Boolean showing if a given device can be used on a given service.|
||Properties| |
||Parameters|# {{Device}}: device
# {{Service}}: service
|
h4.GetDeviceFromParameterValue
||Action name|GetDeviceFromParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceFromParameterValue}}|
||Available from core version|8.7|
||Description|Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.|
||Return value|{{Device}}: The located device.|
||Properties| |
||Parameters|# {{String}}: name
# {{String}}: value
|
h4.GetDeviceParameterValue
||Action name|GetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action returns the value of a given device parameter or throws a NullValueException if none is found.|
||Return value|{{String}}: Value of the given parameter (as a string).|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
|
h4.SetDeviceParameterValue
||Action name|SetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.SetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action updates a device parameter value if it's found, otherwise it will be created.|
||Return value|{{boolean}}: True if the parameter was created, false if the parameter was updated.|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
# {{String}}: value
|
h3.Billing - Product - RatePlanChange
h4.CompleteRatePlanChange
||Action name|CompleteRatePlanChange|
||Class name|{{com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange}}|
||Available from core version|8.7|
||Description|This action completes the rateplan change by subscribing to the default and mandatory options.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{RatePlanChange}}: rpc
# {{boolean}}: cache
|
h3.Billing - Rating
h4.GetActiveRatePlanForSubscription
||Action name|GetActiveRatePlanForSubscription|
||Class name|{{com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the currently active rate plan for a subscription.|
||Return value|{{RatePlan}}: Returns a rate plan that is currently active for the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetPlanElement
||Action name|GetPlanElement|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElement}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters| |
h4.GetPlanElementForRatePlan
||Action name|GetPlanElementForRatePlan|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElementForRatePlan}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters|# {{RatePlan}}: ratePlan
|
h4.GetRatePlansByProduct
||Action name|GetRatePlansByProduct|
||Class name|{{com.cdrator.billing.rating.action.GetRatePlansByProduct}}|
||Available from core version|8.7|
||Description|This action retrieves rate plans for a product.|
||Return value|{{List}}: Returns a list of rate plans related to this product.|
||Properties| |
||Parameters|# {{Product}}: product
|
h3.Billing - Rating - Simulate
h4.BillingRecordBuilder
||Action name|BillingRecordBuilder|
||Class name|{{com.cdrator.billing.rating.simulate.action.BillingRecordBuilder}}|
||Available from core version|8.7|
||Description|Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.|
||Return value|{{BillingRecordSimulated}}: A new unrated billing record. Not persisted.|
||Properties|# BNumber: B-Number of the billing record.
# ratingCode: Rating code to be set on the Billing Record.
# ratingDuration: Rating duration to be set on the Billing Record.
# ratingKey: Rating key to be set on the Billing Record.
# ratingVolumne: Rating volume to be set on the Billing Record.
|
||Parameters|# {{Service}}: service
|
h4.CalculateInvoiceDetailLinesTotalChargeSum
||Action name|CalculateInvoiceDetailLinesTotalChargeSum|
||Class name|{{com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Amount}}: The sum to the total charges of the Invoice Detail Lines Wrappers|
||Properties|# ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
# throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
|
||Parameters|# {{List}}: idlList
|
h4.RatingSimulator
||Action name|RatingSimulator|
||Class name|{{com.cdrator.billing.rating.simulate.action.RatingSimulator}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{ArrayList}}: ArrayList of the Invoice Detail Lines|
||Properties| |
||Parameters|# {{Service}}: service
# {{BillingRecords}}: billingRecord
|
h3.Billing - Status
h4.StatusReader
||Action name|StatusReader|
||Class name|{{com.cdrator.billing.status.action.StatusReader}}|
||Available from core version|8.7|
||Description|Retrieves a Status object based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - SubscriptionFees
h4.AddFee
||Action name|AddFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddFee}}|
||Available from core version|8.7|
||Description|Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Returns the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# feeCode: The fee code for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
h4.AddSubscriptionFee
||Action name|AddSubscriptionFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee}}|
||Available from core version|8.7|
||Description|Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Return the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# planElement: The plan element for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SubscriptionFeesReader
||Action name|SubscriptionFeesReader|
||Class name|{{com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader}}|
||Available from core version|8.7|
||Description|Gets a subscription fee.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - TodoTask
h4.CreateTodoTask
||Action name|CreateTodoTask|
||Class name|{{com.cdrator.billing.todoTask.action.CreateTodoTask}}|
||Available from core version|8.7|
||Description|Creates a TodoTask based on configurable properties|
||Return value|{{void}}: No return values|
||Properties|# assignedToOperator: The operator the todo task is assigned to
# category: Task category
# contactPhoneNumber: Contact phone number
# description: Task Description
# reminderTimeInMinutes: Reminder time in minutes
# subject: Subject
# typeOfFollowUp: The type of follow up: email,letter,phone call,sms
|
||Parameters|# {{Service}}: service
|
h3.Brand
h4.BrandReader
||Action name|BrandReader|
||Class name|{{com.cdrator.brand.action.BrandReader}}|
||Available from core version|8.7|
||Description|Retrieves a Brand based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Campaign
h4.CampaignReader
||Action name|CampaignReader|
||Class name|{{com.cdrator.campaign.action.CampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a Campaign definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetBundlesFromCampaign
||Action name|GetBundlesFromCampaign|
||Class name|{{com.cdrator.campaign.action.GetBundlesFromCampaign}}|
||Available from core version|8.7|
||Description|Returns an list of campaign bundles from a campaign.|
||Return value|{{ArrayList}}: a list of campaign bundles|
||Properties| |
||Parameters|# {{Campaign}}: campaign
|
h4.GetCampaignForKey
||Action name|GetCampaignForKey|
||Class name|{{com.cdrator.campaign.action.GetCampaignForKey}}|
||Available from core version|8.7|
||Description|This action returns a campaign for which the campaign key is provided as a property.|
||Return value|{{Campaign}}: The campaign associated with the provided campaign key.|
||Properties|# campaignKey: The campaign key for the campaign.
|
||Parameters| |
h4.GetCurrentSubscriptionCampaign
||Action name|GetCurrentSubscriptionCampaign|
||Class name|{{com.cdrator.campaign.action.GetCurrentSubscriptionCampaign}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a subscription and campaign.|
||Return value|{{SubscriptionCampaign}}: The current SubscriptionCampaign.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Campaign}}: campaign
|
h4.GetNewSubscriptionBundle
||Action name|GetNewSubscriptionBundle|
||Class name|{{com.cdrator.campaign.action.GetNewSubscriptionBundle}}|
||Available from core version|8.7|
||Description|This action creates and returns a new SubscriptionBundle.|
||Return value|{{SubscriptionBundle}}: Returns a new SubscriptionBundle|
||Properties| |
||Parameters|# {{Bundle}}: bundle
# {{Subscription}}: subscription
# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.GetSubscriptionCampaignsByCriteria
||Action name|GetSubscriptionCampaignsByCriteria|
||Class name|{{com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.|
||Return value|{{List}}: A list of SubscriptionCampaign matching given criterias.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: criterias
|
h4.SetListOfSubscriptionCampaignToDateToSpecificDate
||Action name|SetListOfSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: subscriptionCampaigns
# {{Date}}: date
|
h4.SetSubBundleVal1FromServiceOption
||Action name|SetSubBundleVal1FromServiceOption|
||Class name|{{com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption}}|
||Available from core version|8.7|
||Description|This action updates value1 if an associated serviceOptionParameter with a given key can be found.|
||Return value|{{boolean}}: Boolean indicating success of finding and setting the parameter.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
# parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.
|
||Parameters|# {{SubscriptionBundle}}: bundle
# {{Broker}}: broker
|
h4.SetSubscriptionCampaignCollectionFromToDate
||Action name|SetSubscriptionCampaignCollectionFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.|
||Return value|{{boolean}}: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{ArrayList}}: subscriptionCampaignList
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignFromDateToNextMonth
||Action name|SetSubscriptionCampaignFromDateToNextMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to the first day of next month.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignFromDateToSpecificDate
||Action name|SetSubscriptionCampaignFromDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to a specific date.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SetSubscriptionCampaignInstanceFromToDate
||Action name|SetSubscriptionCampaignInstanceFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.|
||Return value|{{boolean}}: Returns true if the date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignParameter
||Action name|SetSubscriptionCampaignParameter|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignParameter}}|
||Available from core version|8.7|
||Description|An action to set subscriptionCampaign parameters.|
||Return value|{{void}}: No return value.|
||Properties|# parameterName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{String}}: value
|
h4.SetSubscriptionCampaignToDateRestOfMonth
||Action name|SetSubscriptionCampaignToDateRestOfMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth}}|
||Available from core version|8.7|
||Description|This action sets the toDate on a subscriptionCampaign to the end of the current month.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign.|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignToDateToSpecificDate
||Action name|SetSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SubCampaignSetParameter
||Action name|SubCampaignSetParameter|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameter}}|
||Available from core version|8.7|
||Description|This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# paramName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{Subscription}}: sub
# {{ServiceOptionParameter}}: sop
|
h4.SubCampaignSetParameterFromSOP
||Action name|SubCampaignSetParameterFromSOP|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameterFromSOP}}|
||Available from core version|8.7|
||Description|This action updates a subscription campaign parameter from a service option parameter with a given key.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
# paramName: The name of the subscription campaign parameter that should be set.
# parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.
|
||Parameters|# {{SubscriptionBundle}}: bundle
|
h4.SubscriptionCampaignReader
||Action name|SubscriptionCampaignReader|
||Class name|{{com.cdrator.campaign.action.SubscriptionCampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a subscription campaign based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.TerminateCampaignWithFromDate
||Action name|TerminateCampaignWithFromDate|
||Class name|{{com.cdrator.campaign.action.TerminateCampaignWithFromDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h3.Campaign - Bundle
h4.BundleReader
||Action name|BundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.BundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Bundle definition based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveSubscriptionBundlesDefinedByDate
||Action name|GetActiveSubscriptionBundlesDefinedByDate|
||Class name|{{com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate}}|
||Available from core version|8.7|
||Description|Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: date
|
h4.GetBundleForCampaignAndBundleKey
||Action name|GetBundleForCampaignAndBundleKey|
||Class name|{{com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey}}|
||Available from core version|8.7|
||Description|This action returns the bundle associated with the supplied campaign and bundleKey.|
||Return value|{{Bundle}}: The bundle associated with the supplied campaign and bundleKey.|
||Properties| |
||Parameters|# {{Campaign}}: campaign
# {{String}}: bundleKey
|
h4.GetCurrentSubscriptionBundlesNotUsedUpForCode
||Action name|GetCurrentSubscriptionBundlesNotUsedUpForCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleParameter
||Action name|GetSubscriptionBundleParameter|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter}}|
||Available from core version|8.7|
||Description|Finds a bundle parameter from a SubscriptionBundle.|
||Return value|{{String}}: The value of the Bundle parameter.|
||Properties|# optionKey: The parameter that should be read from the Bundle.
|
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundles
||Action name|GetSubscriptionBundles|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundles}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription.|
||Return value|{{ArrayList}}: The value of the Bundle parameter.|
||Properties|# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundlesWithCode
||Action name|GetSubscriptionBundlesWithCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleType
||Action name|GetSubscriptionBundleType|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleType}}|
||Available from core version|8.7|
||Description|Finds the type of a SubscriptionBundle.|
||Return value|{{String}}: The code of the SubscriptionBundle.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundleValue
||Action name|GetSubscriptionBundleValue|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue}}|
||Available from core version|8.7|
||Description|Get the defined Value field in the subscription bundle for the specified bundle.|
||Return value|{{Amount}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{Subscription}}: subscription
|
h4.IsSubscriptionBundleUsedUp
||Action name|IsSubscriptionBundleUsedUp|
||Class name|{{com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp}}|
||Available from core version|8.7|
||Description|Determines if a given subscription bundle is used up by comparing the maximum value with the current value.|
||Return value|{{boolean}}: True if the subscription bundle is completely used up, false otherwise.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.ProrateActivationSubscriptionCampaignBundles
||Action name|ProrateActivationSubscriptionCampaignBundles|
||Class name|{{com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles}}|
||Available from core version|8.7|
||Description|Create and prorate the bundles of the given subscription campaign for a certain start date.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign with the updated bundles|
||Properties|# roundPrecission: The precission used when rounding the bundles.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: fromDate
|
h4.SetSubscriptionBundleValueFromServiceOptionParameter
||Action name|SetSubscriptionBundleValueFromServiceOptionParameter|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified service option parameter.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{SubscriptionBundle}}: subscriptionBundle
|
h4.SetSubscriptionBundleValues
||Action name|SetSubscriptionBundleValues|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified bundles.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# value1: Set value 1
# value2: Set value 2
# value3: Set value 3
# value4: Set value 4
|
||Parameters|# {{String}}: value
# {{Subscription}}: subscription
|
h4.SubscriptionBundleReader
||Action name|SubscriptionBundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.SubscriptionBundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription Bundle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Correspondence - Archive
h4.DocArchiveReader
||Action name|DocArchiveReader|
||Class name|{{com.cdrator.correspondence.archive.action.DocArchiveReader}}|
||Available from core version|8.7|
||Description|Retrieves a DocArchive entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveDocArchiveFile
||Action name|SaveDocArchiveFile|
||Class name|{{com.cdrator.correspondence.archive.action.SaveDocArchiveFile}}|
||Available from core version|8.7|
||Description|If property FilePath is set, it will override the FilePath parameter. Throws ActionParameterException if neither is specified|
||Return value|{{void}}: No value returned|
||Properties|# filePath: FilePath
|
||Parameters|# {{DocArchive}}: archive
# {{String}}: filePathParameter
|
h3.Device
h4.DeviceReader
||Action name|DeviceReader|
||Class name|{{com.cdrator.device.action.DeviceReader}}|
||Available from core version|8.7|
||Description|Retrieves a Device based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Device - Cdmaphone
h4.CdmaPhoneReader
||Action name|CdmaPhoneReader|
||Class name|{{com.cdrator.device.cdmaphone.action.CdmaPhoneReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDMA phone based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Fraud - Addresscheck
h4.PerformAddressCheck
||Action name|PerformAddressCheck|
||Class name|{{com.cdrator.fraud.addresscheck.action.PerformAddressCheck}}|
||Available from core version|8.7|
||Description|This action performs an address check on a user.|
||Return value|{{AddressCheckResult}}: The AddressCheckResult is returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{AddressCheck}}: ac
|
h3.Fraud - Creditcheck
h4.PerformCreditCheck
||Action name|PerformCreditCheck|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheck}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{CreditCheck}}: cc
|
h4.PerformCreditCheckOnUser
||Action name|PerformCreditCheckOnUser|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheckOnUser}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
|
h3.Main - Account
h4.AccountIsNewSignupAllowed
||Action name|AccountIsNewSignupAllowed|
||Class name|{{com.cdrator.main.account.action.AccountIsNewSignupAllowed}}|
||Available from core version|8.7|
||Description|This action check if it is allowed to add a new subscription to an account |
||Return value|{{boolean}}: true(default) or false based on workflow with hook_point SUB_SIGNUP_ALLOWED.|
||Properties| |
||Parameters|# {{Account}}: account
|
h4.AccountReader
||Action name|AccountReader|
||Class name|{{com.cdrator.main.account.action.AccountReader}}|
||Available from core version|8.7|
||Description|Retrieves an Account based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AddAccountWarning
||Action name|AddAccountWarning|
||Class name|{{com.cdrator.main.account.action.AddAccountWarning}}|
||Available from core version|8.7|
||Description|This action adds a warning to an account.
You can use the FormatString action to format the warning before calling this activity|
||Return value|{{void}}: No return value.|
||Properties|# category: null
|
||Parameters|# {{Account}}: account
# {{String}}: key
# {{String}}: description
# {{PersistentObject}}: sourcePO
# {{Date}}: expireDate
|
h4.AddWorkflowToAccount
||Action name|AddWorkflowToAccount|
||Class name|{{com.cdrator.main.account.action.AddWorkflowToAccount}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the WfWorkflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Account}}: account
# {{WfWorkflow}}: wfWorkflow
|
h4.CheckIfAccountInState
||Action name|CheckIfAccountInState|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountInState}}|
||Available from core version|8.7|
||Description|This action checks if an account is in one of the given states.|
||Return value|{{Boolean}}: Returns TRUE if the account state matches one of the given states.|
||Properties|# possibleStates: The possible states separated by ';'
|
||Parameters|# {{Account}}: account
|
h4.CheckIfAccountIsClosed
||Action name|CheckIfAccountIsClosed|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountIsClosed}}|
||Available from core version|8.7|
||Description|This action checks if an account is closed.|
||Return value|{{Boolean}}: Returns TRUE if the account is closed.|
||Properties| |
||Parameters|# {{Account}}: account
|
h3.Main
h4.ProductMakeSubscription
||Action name|ProductMakeSubscription|
||Class name|{{com.cdrator.main.action.ProductMakeSubscription}}|
||Available from core version|8.7|
||Description|This action creates a subscription based on the supplied product configuration, account and billing group.|
||Return value|{{Subscription}}: Returns the newly created subscription.|
||Properties| |
||Parameters|# {{ProductConfig}}: productConfig
# {{Account}}: account
# {{BillingGroup}}: billingGroup
|
h3.Main - Alert
h4.AlertGroupReader
||Action name|AlertGroupReader|
||Class name|{{com.cdrator.main.alert.action.AlertGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves an AlertGroup based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Operator
h4.OperatorAuthentication
||Action name|OperatorAuthentication|
||Class name|{{com.cdrator.main.operator.action.OperatorAuthentication}}|
||Available from core version|8.7|
||Description|This action authenticates the operator based on the username and password provided. If username or password are null or empty, null is returned.|
||Return value|{{Operators}}: The operator matching the username and password. Otherwise null.|
||Properties| |
||Parameters|# {{String}}: username
# {{String}}: password
|
h4.OperatorHookpointBlockRevoke
||Action name|OperatorHookpointBlockRevoke|
||Class name|{{com.cdrator.main.operator.action.OperatorHookpointBlockRevoke}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{OperatorAccessTags}}: The operator access tag matching the username and hookpoint key. Otherwise null.|
||Properties|# accessTagPostfix: Alternative access tag postfix. Default is _BLOCK_REVOKED
|
||Parameters|# {{String}}: username
# {{String}}: hookpointKey
|
h4.OperatorReader
||Action name|OperatorReader|
||Class name|{{com.cdrator.main.operator.action.OperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves an Operator based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OperatorTypeReader
||Action name|OperatorTypeReader|
||Class name|{{com.cdrator.main.operator.action.OperatorTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an operator type based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Service
h4.ChangeDevice
||Action name|ChangeDevice|
||Class name|{{com.cdrator.main.service.action.ChangeDevice}}|
||Available from core version|8.7|
||Description|This action assigns a device to a given service.|
||Return value|{{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.|
||Properties|# autoAssignDevice: Auto assign device? If true, then newDevice parameter will be disregarded and the underlying workflow will assign a device automatically.
|
||Parameters|# {{Service}}: service
# {{Device}}: newDevice
# {{boolean}}: addFee
# {{String}}: sendType
# {{Status}}: reason
# {{String}}: comment
|
h4.ChangeServiceStatus
||Action name|ChangeServiceStatus|
||Class name|{{com.cdrator.main.service.action.ChangeServiceStatus}}|
||Available from core version|8.7|
||Description|This action sets and saves the Service status. |
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{Service}}: service
|
h4.CompleteCachedOptions
||Action name|CompleteCachedOptions|
||Class name|{{com.cdrator.main.service.action.CompleteCachedOptions}}|
||Available from core version|8.7|
||Description|Complete cached options on service|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceCode
||Action name|GetServiceCode|
||Class name|{{com.cdrator.main.service.action.GetServiceCode}}|
||Available from core version|8.7|
||Description|Return the code of the service.|
||Return value|{{String}}: The code of the service.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceFromPhoneNumber
||Action name|GetServiceFromPhoneNumber|
||Class name|{{com.cdrator.main.service.action.GetServiceFromPhoneNumber}}|
||Available from core version|8.7|
||Description|This action gets an active service from the phone number and optionally the brand.|
||Return value|{{Service}}: The active service matching the phone number and brand.|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.main.service.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|This action gets a service option parameter given an option key and a parameter key.|
||Return value|{{ServiceOptionParameter}}: The service option parameter. If the service does not have the service option or the service option parameter, null is returned.|
||Properties|# optionKey: The option key to look for on service.
|
||Parameters|# {{Service}}: service
# {{String}}: parameterKey
|
h4.GetServicesForAccountAndProduct
||Action name|GetServicesForAccountAndProduct|
||Class name|{{com.cdrator.main.service.action.GetServicesForAccountAndProduct}}|
||Available from core version|8.7|
||Description|Return a list of services belonging to the account, with the a specific product code and with the status selected.|
||Return value|{{ArrayList}}: The list of recovered services, based on the input parameters.|
||Properties|# productIdDescription: The product for the service. If empty all services will be returned.
# serviceStatus: The service status. If empty all services will be returned.
|
||Parameters|# {{Account}}: account
|
h3.Main - Subscription
h4.ActivateSubscription
||Action name|ActivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ActivateSubscription}}|
||Available from core version|8.7|
||Description|This action activates a subscription in Rator.|
||Return value|{{Subscription}}: Returns the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.AddWorkflow
||Action name|AddWorkflow|
||Class name|{{com.cdrator.main.subscription.action.AddWorkflow}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the workflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{WfWorkflow}}: workflow
|
h4.ChangeRatePlan
||Action name|ChangeRatePlan|
||Class name|{{com.cdrator.main.subscription.action.ChangeRatePlan}}|
||Available from core version|8.7|
||Description|This action schedules a rateplan change.|
||Return value|{{RatePlanChange}}: Sets up, saves and returns a rate plan change.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{RatePlan}}: newRatePlan
# {{Product}}: newProduct
# {{Date}}: changeDate
# {{ArrayList}}: options
|
h4.CheckIfParentSubscriptionIsInState
||Action name|CheckIfParentSubscriptionIsInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfParentSubscriptionIsInState}}|
||Available from core version|8.7|
||Description|This action checks if a parent subscription is in a given state.|
||Return value|{{boolean}}: Returns true if the parent exists and state matches the given state.|
||Properties|# controlState: The available states.
|
||Parameters|# {{Subscription}}: subscription
|
h4.CheckIfSubscriptionInState
||Action name|CheckIfSubscriptionInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfSubscriptionInState}}|
||Available from core version|8.7|
||Description|This action checks if a subscription is in given states.|
||Return value|{{boolean}}: Returns YES if the subscription state matches one of the given states.|
||Properties|# possibleState: The possible states separated by ';'
|
||Parameters|# {{Subscription}}: subscription
|
h4.CreateSubscriptionTerminationRequest
||Action name|CreateSubscriptionTerminationRequest|
||Class name|{{com.cdrator.main.subscription.action.CreateSubscriptionTerminationRequest}}|
||Available from core version|8.7|
||Description|This action assembles subscription termination details in a termination request.|
||Return value|{{SubscriptionTerminationRequest}}: The constructed termination request object.|
||Properties|# addTerminationFee: If termination fee should be added. Default is false.
# terminationReason: Set the terminate reason text.
# terminationReasonID: Set the terminate reason id.
|
||Parameters|# {{String}}: comment
# {{Date}}: expectedTerminationDate
# {{Date}}: terminationOrderDate
# {{Date}}: endBillingDate
# {{Date}}: chargeUntilDate
# {{boolean}}: canContactCustomer
|
h4.DeepSave
||Action name|DeepSave|
||Class name|{{com.cdrator.main.subscription.action.DeepSave}}|
||Available from core version|8.7|
||Description|This action deep-saves a subscription in Rator.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetActiveBillingGroupOfSubscription
||Action name|GetActiveBillingGroupOfSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetActiveBillingGroupOfSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the active billing group of the subscription|
||Return value|{{BillingGroup}}: The active billing group of the subscription|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllActiveWorkflowsForSubscription
||Action name|GetAllActiveWorkflowsForSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscription}}|
||Available from core version|8.7|
||Description|This action returns all active workflows for a subscription.|
||Return value|{{ArrayList}}: An arrayList of workflows.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllChildSubscriptions
||Action name|GetAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.GetAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action returns all child subscriptions of a given subscription.|
||Return value|{{List}}: A list of child subscriptions.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Broker}}: broker
|
h4.IsSubscriptionActive
||Action name|IsSubscriptionActive|
||Class name|{{com.cdrator.main.subscription.action.IsSubscriptionActive}}|
||Available from core version|8.7|
||Description|Checks if the subscription is active|
||Return value|{{boolean}}: Returns true if the subscription is active|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptions
||Action name|ReactivateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptionsInList
||Action name|ReactivateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{List}}: subscriptions
|
h4.ReactivateSubscription
||Action name|ReactivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscription}}|
||Available from core version|8.7|
||Description|This action reactivates a subscription by setting the end date to null and the status to active.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateSubscriptionCore
||Action name|ReactivateSubscriptionCore|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscriptionCore}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{SubscriptionTermination}}: The Subscription Termination connected to the termination|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetAlertGroup
||Action name|SetAlertGroup|
||Class name|{{com.cdrator.main.subscription.action.SetAlertGroup}}|
||Available from core version|8.7|
||Description|An action to set the alert group on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{AlertGroup}}: alertGroup
|
h4.SetOwner
||Action name|SetOwner|
||Class name|{{com.cdrator.main.subscription.action.SetOwner}}|
||Available from core version|8.7|
||Description|This action sets the owner of a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Users}}: owner
|
h4.SetSubscriptionEndDate
||Action name|SetSubscriptionEndDate|
||Class name|{{com.cdrator.main.subscription.action.SetSubscriptionEndDate}}|
||Available from core version|8.7|
||Description|This action sets the subscription end date and saves the subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: endDate
|
h4.SubscriptionHasServiceCode
||Action name|SubscriptionHasServiceCode|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionHasServiceCode}}|
||Available from core version|8.7|
||Description|Determines whether or not the transfer of a subscription to another account is approved.|
||Return value|{{Boolean}}: Boolean result indicating whether or not this subscription transfer is approved.|
||Properties|# serviceCode: The service code to check for.
|
||Parameters|# {{Subscription}}: subscription
|
h4.SubscriptionReader
||Action name|SubscriptionReader|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SubscriptionSalesDetails
||Action name|SubscriptionSalesDetails|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionSalesDetails}}|
||Available from core version|8.7|
||Description|This action sets a sales rep and a sales store on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: salesRep
# {{String}}: salesStore
|
h4.SubscriptionTransferTo
||Action name|SubscriptionTransferTo|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferTo}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
|
h4.SubscriptionTransferToWithParent
||Action name|SubscriptionTransferToWithParent|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferToWithParent}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
# {{Subscription}}: newParentSubscription
|
h4.TerminateAllChildSubscriptions
||Action name|TerminateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.TerminateAllChildSubscriptionsInList
||Action name|TerminateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties|# consolidateFinalFees: Set consolidate final fees. Default is false.
# disregardBindingPeriod: Set disregard binding period. Default is false.
# endBillingDate: Set end billing date. Default is null.
# finalizeFees: Set finalize fees. Default is false.
|
||Parameters|# {{List}}: subscriptions
# {{Subscription}}: parentSubscription
|
h4.TerminateSubscription
||Action name|TerminateSubscription|
||Class name|{{com.cdrator.main.subscription.action.TerminateSubscription}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: No return value.|
||Properties|# terminateChildSubscriptions: Terminate the child subscriptions (if any) with same termination details as the parent subscription.
|
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionTerminationRequest}}: subscriptionTerminationRequest
|
h3.Main - Subscription - Lockin
h4.CreateNewSubscriptionLockin
||Action name|CreateNewSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.CreateNewSubscriptionLockin}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{SubscriptionLockin}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionLockinType}}: subscriptionLockinType
|
h4.GetAllSubscriptionLockins
||Action name|GetAllSubscriptionLockins|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetAllSubscriptionLockins}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-ins for a given subscription.|
||Return value|{{ArrayList}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionLockinTypes
||Action name|GetSubscriptionLockinTypes|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetSubscriptionLockinTypes}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-in types.|
||Return value|{{List}}: Returns a list of subscription lock-in types.|
||Properties| |
||Parameters| |
h4.HasSubscriptionLockin
||Action name|HasSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.HasSubscriptionLockin}}|
||Available from core version|8.7|
||Description|This action checks if a subscription has a lock-in.|
||Return value|{{String}}: Returns either NO or YES.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetLockinEndDateForLockinWithLeastEndDate
||Action name|SetLockinEndDateForLockinWithLeastEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetLockinEndDateForLockinWithLeastEndDate}}|
||Available from core version|8.7|
||Description|This action updates lockin_end_date of the subscription_lockin with least lockin_end_date and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h4.SetSubscriptionLockinEndDate
||Action name|SetSubscriptionLockinEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate}}|
||Available from core version|8.7|
||Description|This action updates subscription lock-in's end date and saves it. It updates only if a lockin exists.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h3.Main - Subscriptiontermination
h4.DeactivateSubscriptionTermination
||Action name|DeactivateSubscriptionTermination|
||Class name|{{com.cdrator.main.subscriptiontermination.action.DeactivateSubscriptionTermination}}|
||Available from core version|8.7|
||Description|This action deactivates a subscription termination.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SubscriptionTermination}}: subscriptionTermination
|
h3.Main - User
h4.CheckUsernameAvailability
||Action name|CheckUsernameAvailability|
||Class name|{{com.cdrator.main.user.action.CheckUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given username is available.|
||Return value|{{boolean}}: boolean true if the username is available (no user exists with the usename), else false|
||Properties|# caseSensitive: Is the username case sensitive?
|
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetAddress
||Action name|GetAddress|
||Class name|{{com.cdrator.main.user.action.GetAddress}}|
||Available from core version|8.7|
||Description|Action to create and save a new Address object based on the address information of the user passed as argument.|
||Return value|{{Address}}: Returns the newly created Address object.|
||Properties|# doSetCoFromAddress2: Specify whether or not the Address field CO should be set from user.address2.
|
||Parameters|# {{Users}}: user
|
h4.GetUserAccessLevel
||Action name|GetUserAccessLevel|
||Class name|{{com.cdrator.main.user.action.GetUserAccessLevel}}|
||Available from core version|8.7|
||Description|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.|
||Return 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|
||Properties| |
||Parameters|# {{Users}}: user
|
h4.GetUserByEmailAddress
||Action name|GetUserByEmailAddress|
||Class name|{{com.cdrator.main.user.action.GetUserByEmailAddress}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the email address exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: emailAddress
# {{Brand}}: brand
|
h4.GetUserByPhoneNumber
||Action name|GetUserByPhoneNumber|
||Class name|{{com.cdrator.main.user.action.GetUserByPhoneNumber}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the phone number exists. The value null is returned if none exists.|
||Properties|# cancelationPending: Include subscriptions in cancelation pending status.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetUserByUsername
||Action name|GetUserByUsername|
||Class name|{{com.cdrator.main.user.action.GetUserByUsername}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the username exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetUsersByPersonalIDHash
||Action name|GetUsersByPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.GetUsersByPersonalIDHash}}|
||Available from core version|8.7|
||Description|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 http://jira.cdrator.com/browse/CDRP-5401|
||Return value|{{ArrayList}}: An ArrayList of users matching the given personalID. If none exists, an empty ArrayList is returned.|
||Properties|# 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.
|
||Parameters|# {{String}}: personalIDInput
|
h4.SetNewPassword
||Action name|SetNewPassword|
||Class name|{{com.cdrator.main.user.action.SetNewPassword}}|
||Available from core version|8.7|
||Description|This action changes the password of a user. If password is blank, a password will be generated.|
||Return value|{{String}}: The new password.|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h4.SetPersonalIDHash
||Action name|SetPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.SetPersonalIDHash}}|
||Available from core version|8.7|
||Description|This action adds a PersonalID entry for a User. The input parameter must already be hashed/encrypted if so desired.|
||Return value|{{void}}: No return value.|
||Properties|# endDateLastPeriod: To set expiry date on personal id.
# personalIDType: The personal ID type
|
||Parameters|# {{Users}}: user
# {{String}}: hashedPersonalID
|
h4.SetUserAsAccountOwner
||Action name|SetUserAsAccountOwner|
||Class name|{{com.cdrator.main.user.action.SetUserAsAccountOwner}}|
||Available from core version|8.7|
||Description|This action sets the user as account owner. Both user and account is saved.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Users}}: user
# {{Account}}: account
|
h4.UserReader
||Action name|UserReader|
||Class name|{{com.cdrator.main.user.action.UserReader}}|
||Available from core version|8.7|
||Description|Retrieves a User based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - User - Login
h4.LoginUserWithAttemptsCount
||Action name|LoginUserWithAttemptsCount|
||Class name|{{com.cdrator.main.user.login.action.LoginUserWithAttemptsCount}}|
||Available from core version|8.7|
||Description|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)|
||Return value|{{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|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h3.Misc
h4.CreateLongDescriptionElementList
||Action name|CreateLongDescriptionElementList|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElementList}}|
||Available from core version|8.7|
||Description|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()'|
||Return value|{{List}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs. It must be a regular expression. Example : ',|
|
| ' will split at , and newline
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
# {{List}}: addToExistingList
|
h4.CreateLongDescriptionElements
||Action name|CreateLongDescriptionElements|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElements}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{ArrayList}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs.
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FileObjectReader
||Action name|FileObjectReader|
||Class name|{{com.cdrator.misc.action.FileObjectReader}}|
||Available from core version|8.7|
||Description|Retrieves a File Object based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.MailTemplateReader
||Action name|MailTemplateReader|
||Class name|{{com.cdrator.misc.action.MailTemplateReader}}|
||Available from core version|8.7|
||Description|Retrieves a Mail Template based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Misc - Barcodes
h4.GenerateQRCodeImage
||Action name|GenerateQRCodeImage|
||Class name|{{com.cdrator.misc.barcodes.action.GenerateQRCodeImage}}|
||Available from core version|8.7|
||Description|This action retrieves an Image of a QR code of the specified content having the specified size |
||Return value|{{Image}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{int}}: width
# {{int}}: height
# {{String}}: content
|
h3.Np
h4.LookupActiveNpFlow
||Action name|LookupActiveNpFlow|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlow}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow of a given phone number and (optionally) brand (via the subscription).|
||Return value|{{NpFlow}}: The NP Flow matching the phone number and the brand.|
||Properties|# ignoreBrand: Ignore the brand connected to the NP Flow.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.LookupActiveNpFlowBySubscription
||Action name|LookupActiveNpFlowBySubscription|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlowBySubscription}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow for a given subscription.|
||Return value|{{NpFlow}}: The active NP Flow from the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.NpFlowReader
||Action name|NpFlowReader|
||Class name|{{com.cdrator.np.action.NpFlowReader}}|
||Available from core version|8.7|
||Description|Retrieves an NP flow based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveNpFlow
||Action name|SaveNpFlow|
||Class name|{{com.cdrator.np.action.SaveNpFlow}}|
||Available from core version|8.7|
||Description|Sets some initial values on np flow.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{NpFlow}}: npFlow
|
h4.SetRejectCodeOnExportFlow
||Action name|SetRejectCodeOnExportFlow|
||Class name|{{com.cdrator.np.action.SetRejectCodeOnExportFlow}}|
||Available from core version|8.7|
||Description|Set Reject Code and Comment On an Np Export Flow object.|
||Return value|{{void}}: No return value.|
||Properties|# comment: Used for adding a static comment.
# rejectCode: Used for adding reject code.
|
||Parameters|# {{NpExportFlow}}: npFlow
# {{String}}: dynamicComment
|
h4.TeleOperatorReader
||Action name|TeleOperatorReader|
||Class name|{{com.cdrator.np.action.TeleOperatorReader}}|
||Available from core version|8.7|
||Description|Retrievse a tele operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Np - Range
h4.CheckOverlappingRange
||Action name|CheckOverlappingRange|
||Class name|{{com.cdrator.np.range.action.CheckOverlappingRange}}|
||Available from core version|8.7|
||Description|Check if the ranges are overlapping|
||Return value|{{boolean}}: A boolean indicating whether the two ranges overlap each other, fully or partially|
||Properties| |
||Parameters|# {{String}}: newRange
# {{String}}: existingRange
|
h3.Number
h4.AnumberReader
||Action name|AnumberReader|
||Class name|{{com.cdrator.number.action.AnumberReader}}|
||Available from core version|8.7|
||Description|Retrieves an A-number based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AssignAnumberToService
||Action name|AssignAnumberToService|
||Class name|{{com.cdrator.number.action.AssignAnumberToService}}|
||Available from core version|8.7|
||Description|Sets Anumber on Service (Only relevant for Service types with phone numbers.)|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Service}}: service
|
h4.GetANumbersForNumberSearchExact
||Action name|GetANumbersForNumberSearchExact|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchExact}}|
||Available from core version|8.7|
||Description|This action will return the list of anumbers that are exact match of the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchLastDigits
||Action name|GetANumbersForNumberSearchLastDigits|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchLastDigits}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers ending with the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchPattern
||Action name|GetANumbersForNumberSearchPattern|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchPattern}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers that contain the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchRandom
||Action name|GetANumbersForNumberSearchRandom|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchRandom}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random phone numbers according to the group_id.|
||Return value|{{ArrayList}}: List of phone numbers.|
||Properties|# batchLimit: Batch limit to fetch anumbers.
|
||Parameters|# {{Anumber_Group}}: group
# {{int}}: maxRows
|
h4.IsAnumberFree
||Action name|IsAnumberFree|
||Class name|{{com.cdrator.number.action.IsAnumberFree}}|
||Available from core version|8.7|
||Description|Given a phone number, checks if the related anumber is free.|
||Return value|{{boolean}}: True, if the anumber for the phone number is free, else False|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.ReReserveAnumber
||Action name|ReReserveAnumber|
||Class name|{{com.cdrator.number.action.ReReserveAnumber}}|
||Available from core version|8.7|
||Description|Re-reserves an already reserved anumber, if the number is not in use and already reserved with the given id.|
||Return value|{{boolean}}: Returns: boolean true if the number could be re-reserved|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{String}}: reservationId
# {{int}}: reserveTime
|
h4.SetAnumberReservToDate
||Action name|SetAnumberReservToDate|
||Class name|{{com.cdrator.number.action.SetAnumberReservToDate}}|
||Available from core version|8.7|
||Description|Sets the reservToDate on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Date}}: reservToDate
|
h4.SetAnumberStatus
||Action name|SetAnumberStatus|
||Class name|{{com.cdrator.number.action.SetAnumberStatus}}|
||Available from core version|8.7|
||Description|Sets status on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{StatusAnumber}}: status
|
h4.ValidateAnumberReservation
||Action name|ValidateAnumberReservation|
||Class name|{{com.cdrator.number.action.ValidateAnumberReservation}}|
||Available from core version|8.7|
||Description|This action validates that an a-number matches a reservation id, that the a-number has status not used and that the reservation has not expired.|
||Return value|{{boolean}}: boolean true if reservation ID is still valid for the A-number, false otherwise.|
||Properties| |
||Parameters|# {{String}}: anumber
# {{String}}: reservationId
|
h3.Persistence
h4.CheckIfPersisted
||Action name|CheckIfPersisted|
||Class name|{{com.cdrator.persistence.action.CheckIfPersisted}}|
||Available from core version|8.7|
||Description|Check if an object is persisted|
||Return value|{{boolean}}: A boolean indicating whether the object is persisted or not.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Product
h4.ChangeAnumberGroup
||Action name|ChangeAnumberGroup|
||Class name|{{com.cdrator.product.action.ChangeAnumberGroup}}|
||Available from core version|8.7|
||Description|Sets the group on an A-number and saves it.|
||Return value|{{Anumber}}: Returns the updated A-number.|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Anumber_Group}}: group
|
h4.CheckProductServiceClassCode
||Action name|CheckProductServiceClassCode|
||Class name|{{com.cdrator.product.action.CheckProductServiceClassCode}}|
||Available from core version|8.7|
||Description|This action checks the products service class code.|
||Return value|{{boolean}}: Returns true if the product matches the service class configured.|
||Properties|# serviceClassCode: The service class code to check for.
|
||Parameters|# {{Product}}: product
|
h4.CreateCdmaPhoneForMeid
||Action name|CreateCdmaPhoneForMeid|
||Class name|{{com.cdrator.product.action.CreateCdmaPhoneForMeid}}|
||Available from core version|8.7|
||Description|This action creates a CdmaPhone based on the supplied MEID.|
||Return value|{{CdmaPhone}}: The cdmaPhone created is returned.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: meid
|
h4.FilterProductConfigsByShop
||Action name|FilterProductConfigsByShop|
||Class name|{{com.cdrator.product.action.FilterProductConfigsByShop}}|
||Available from core version|8.7|
||Description|This action filters an existing list of product configurations so only the ones set up for the shop is returned.|
||Return value|{{List}}: A list of product configs defined for the shop.|
||Properties| |
||Parameters|# {{List}}: productConfigs
# {{Shop}}: shop
|
h4.MakeSubscription
||Action name|MakeSubscription|
||Class name|{{com.cdrator.product.action.MakeSubscription}}|
||Available from core version|8.7|
||Description|Creates a new subscription, and a service, for a given product on a given account, billing group and user.|
||Return value|{{Subscription}}: Returns the subscription|
||Properties| |
||Parameters|# {{Account}}: account
# {{BillingGroup}}: bg
# {{ProductConfig}}: pc
# {{Users}}: user
|
h4.ProductConfigReader
||Action name|ProductConfigReader|
||Class name|{{com.cdrator.product.action.ProductConfigReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Config based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProductReader
||Action name|ProductReader|
||Class name|{{com.cdrator.product.action.ProductReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.RemoveSharedServiceMemberEndDate
||Action name|RemoveSharedServiceMemberEndDate|
||Class name|{{com.cdrator.product.action.RemoveSharedServiceMemberEndDate}}|
||Available from core version|8.7|
||Description|This action removes the end date of a sharedServiceMember.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SharedServiceMember}}: sharedServiceMember
|
h4.ReserveCdmaPhoneForService
||Action name|ReserveCdmaPhoneForService|
||Class name|{{com.cdrator.product.action.ReserveCdmaPhoneForService}}|
||Available from core version|8.7|
||Description|This action reserves a CdmaPhone for a service.|
||Return value|{{CdmaPhone}}: The CdmaPhone is returned.|
||Properties| |
||Parameters|# {{CdmaPhone}}: cdmaPhone
# {{Service}}: service
|
h3.Product - Option
h4.CompareSubscribedProductOptionParameter
||Action name|CompareSubscribedProductOptionParameter|
||Class name|{{com.cdrator.product.option.action.CompareSubscribedProductOptionParameter}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for.
# parameterKey: The parameter key that we are searching for.
|
||Parameters|# {{Service}}: service
# {{String}}: compareValue
|
h4.ExistsActiveCampaignForEqualOrHigherPackage
||Action name|ExistsActiveCampaignForEqualOrHigherPackage|
||Class name|{{com.cdrator.product.option.action.ExistsActiveCampaignForEqualOrHigherPackage}}|
||Available from core version|8.7|
||Description|Checks if there is campaign for equal or higher package option|
||Return value|{{boolean}}: If there is an active subscriptionCampaign associated to a greater or equal package option returns true|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Subscription}}: subscription
|
h4.GetLowestSubscribedOption
||Action name|GetLowestSubscribedOption|
||Class name|{{com.cdrator.product.option.action.GetLowestSubscribedOption}}|
||Available from core version|8.7|
||Description|Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Return value|{{ProductOption}}: Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
|
h4.GetOptionMetaData
||Action name|GetOptionMetaData|
||Class name|{{com.cdrator.product.option.action.GetOptionMetaData}}|
||Available from core version|8.7|
||Description|This action returns the meta data on an option based on the Option and the Metadata name.|
||Return value|{{ProductOptionMetaData}}: The ProductOptionMetaData for the option and Metadata name. If not found, null is returned.|
||Properties| |
||Parameters|# {{Option}}: option
# {{String}}: metaDataName
|
h4.GetOptionPriceElementsForProductRatePlanAndCategory
||Action name|GetOptionPriceElementsForProductRatePlanAndCategory|
||Class name|{{com.cdrator.product.option.action.GetOptionPriceElementsForProductRatePlanAndCategory}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan, product and category.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time. When category is set cache is always enabled.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
# {{String}}: category
|
h4.GetOptionsForProductAndRatePlan
||Action name|GetOptionsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Product Option available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: An list of product options.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetOptionsPrice
||Action name|GetOptionsPrice|
||Class name|{{com.cdrator.product.option.action.GetOptionsPrice}}|
||Available from core version|8.7|
||Description|Returns a map of product option id and the related price for the given subscription and product options list.|
||Return value|{{Hashtable}}: Returns a map of product option id and the related price.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: optionsList
|
h4.GetOptionsPricesElementsForProductAndRatePlan
||Action name|GetOptionsPricesElementsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsPricesElementsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetProductOptionsFromService
||Action name|GetProductOptionsFromService|
||Class name|{{com.cdrator.product.option.action.GetProductOptionsFromService}}|
||Available from core version|8.7|
||Description|Returns all the product options subscribed to be the given service.|
||Return value|{{ArrayList}}: An array list of product options.|
||Properties|# onlyActive: If this is set, only serviceOptions that are active will be used to get the productOptions.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOption
||Action name|GetServiceOption|
||Class name|{{com.cdrator.product.option.action.GetServiceOption}}|
||Available from core version|8.7|
||Description|Action to retrieve a service option based on the option key.|
||Return value|{{ServiceOption}}: The service option.|
||Properties|# optionKey: The key of the option that will be retrieved.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOptionForParameterWithSpecifiedObjectReference
||Action name|GetServiceOptionForParameterWithSpecifiedObjectReference|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionForParameterWithSpecifiedObjectReference}}|
||Available from core version|8.7|
||Description|Returns a serviceOption for parameter with matching obejct reference.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
# {{String}}: parameterKey
# {{String}}: objectReferenceClass
# {{String}}: objectReferenceId
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Returns a serviceOptionParameter with the specified parameterKey.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: parameterKey
|
h4.GetServiceOptionRecurrentFee
||Action name|GetServiceOptionRecurrentFee|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionRecurrentFee}}|
||Available from core version|8.7|
||Description|Retrieves the recurrent fee of the service option|
||Return value|{{SubscriptionFees}}: Returns the recurrent fee of the service option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetServiceOptionsByCriteria
||Action name|GetServiceOptionsByCriteria|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionsByCriteria}}|
||Available from core version|8.7|
||Description|Returns a list of service option for a service matching the given criteria.|
||Return value|{{List}}: A List of service options matching given criterias.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: criterias
|
h4.GetSiblingServiceOption
||Action name|GetSiblingServiceOption|
||Class name|{{com.cdrator.product.option.action.GetSiblingServiceOption}}|
||Available from core version|8.7|
||Description|Get the sibling service option of a specific service option if that exists|
||Return value|{{ServiceOption}}: Returns the sibling service option of the current service option if that exists. Otherwise returns null|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetTotalPriceForOptionChange
||Action name|GetTotalPriceForOptionChange|
||Class name|{{com.cdrator.product.option.action.GetTotalPriceForOptionChange}}|
||Available from core version|8.7|
||Description|Compares the two list and returns the total price of the change|
||Return value|{{Amount}}: The total price as an amount|
||Properties| |
||Parameters|# {{List}}: oldOptions
# {{List}}: newOptions
|
h4.HasSiblingOptionLowerPackageWeight
||Action name|HasSiblingOptionLowerPackageWeight|
||Class name|{{com.cdrator.product.option.action.HasSiblingOptionLowerPackageWeight}}|
||Available from core version|8.7|
||Description|Checks if the sibling option has lower package_weight than the current option|
||Return value|{{boolean}}: Returns true if the sibling option has lower package_weight than the current option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{ServiceOption}}: siblingServiceOption
|
h4.HasSubscribedProductOption
||Action name|HasSubscribedProductOption|
||Class name|{{com.cdrator.product.option.action.HasSubscribedProductOption}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for
|
||Parameters|# {{Service}}: service
|
h4.IsOptionInExclusiveGroup
||Action name|IsOptionInExclusiveGroup|
||Class name|{{com.cdrator.product.option.action.IsOptionInExclusiveGroup}}|
||Available from core version|8.7|
||Description|Checks if option belongs to an exclusive group|
||Return value|{{boolean}}: Returns true if the option belongs to an exclusive option group|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.OptionReader
||Action name|OptionReader|
||Class name|{{com.cdrator.product.option.action.OptionReader}}|
||Available from core version|8.7|
||Description|Retrieves an option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OptionStatusChangeActionCheck
||Action name|OptionStatusChangeActionCheck|
||Class name|{{com.cdrator.product.option.action.OptionStatusChangeActionCheck}}|
||Available from core version|8.7|
||Description|Compare the action used in option status_change workflow to a predefined action value|
||Return value|{{boolean}}: If the action equals to the predefined action value it returns true. Otherwise it returns false.|
||Properties|# actionValue: The action value that the action should be compared to
|
||Parameters|# {{String}}: action
|
h4.RemoveListOfServiceOptions
||Action name|RemoveListOfServiceOptions|
||Class name|{{com.cdrator.product.option.action.RemoveListOfServiceOptions}}|
||Available from core version|8.7|
||Description|Removes all service options in a list|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
|
h4.RemovePendingTerminationOption
||Action name|RemovePendingTerminationOption|
||Class name|{{com.cdrator.product.option.action.RemovePendingTerminationOption}}|
||Available from core version|8.7|
||Description|Removes a pending termination option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: action
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.RemoveServiceOption
||Action name|RemoveServiceOption|
||Class name|{{com.cdrator.product.option.action.RemoveServiceOption}}|
||Available from core version|8.7|
||Description|Removes the service option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetEndDateOnServiceOptionList
||Action name|SetEndDateOnServiceOptionList|
||Class name|{{com.cdrator.product.option.action.SetEndDateOnServiceOptionList}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date from a list of options retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
# {{Date}}: date
|
h4.SetServiceOptionEndDateRestOfMonth
||Action name|SetServiceOptionEndDateRestOfMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateRestOfMonth}}|
||Available from core version|8.7|
||Description|Sets the end date of the option.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionEndDateToSpecificDate
||Action name|SetServiceOptionEndDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SetServiceOptionEndDateToStartDate
||Action name|SetServiceOptionEndDateToStartDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToStartDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' endDate to the service option's startDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionParameterValue
||Action name|SetServiceOptionParameterValue|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionParameterValue}}|
||Available from core version|8.7|
||Description|Updates a service option parameter value.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{String}}: newValue
|
h4.SetServiceOptionStartDateToNextMonth
||Action name|SetServiceOptionStartDateToNextMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the first day of next month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionStartDateToSpecificDate
||Action name|SetServiceOptionStartDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SubscribeToProductOption
||Action name|SubscribeToProductOption|
||Class name|{{com.cdrator.product.option.action.SubscribeToProductOption}}|
||Available from core version|8.7|
||Description|Subscribes to a product option for a given service and product option.|
||Return value|{{ServiceOption}}: The service option created by subscribing to the option.|
||Properties|# optionKey: The option key that the service will subscribe to.
|
||Parameters|# {{Service}}: service
|
h4.UnsubscribeOptionsWithCampaigns
||Action name|UnsubscribeOptionsWithCampaigns|
||Class name|{{com.cdrator.product.option.action.UnsubscribeOptionsWithCampaigns}}|
||Available from core version|8.7|
||Description|Unsubscribes to options with campaigns (and only options with a campaign) for a given service.|
||Return value|{{List}}: A list of the unsubscribed service options.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.UnsubscribeToOption
||Action name|UnsubscribeToOption|
||Class name|{{com.cdrator.product.option.action.UnsubscribeToOption}}|
||Available from core version|8.7|
||Description|If there is a dynamic optionkey parameter, it will override the optionkey property unless it is null. If neither option key or dynamic option key is set an Action Parameter Exception is thrown.|
||Return value|{{void}}: No value returned|
||Properties|# makeProvisioningTask: Make provisioning task?
# optionKey: The key of the option that will be unsubscribed
|
||Parameters|# {{Service}}: service
# {{String}}: dynamicOptionKey
|
h4.ValidateOptions
||Action name|ValidateOptions|
||Class name|{{com.cdrator.product.option.action.ValidateOptions}}|
||Available from core version|8.7|
||Description|This action validates that options are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config.|
||Properties| |
||Parameters|# {{List}}: options
# {{ProductConfig}}: productConfig
|
h4.ValidateOptionsRateplan
||Action name|ValidateOptionsRateplan|
||Class name|{{com.cdrator.product.option.action.ValidateOptionsRateplan}}|
||Available from core version|8.7|
||Description|This action validates that the list of options passed as a parameter are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config, false otherwise.|
||Properties| |
||Parameters|# {{List}}: options
# {{RatePlan}}: rateplan
|
h3.Product - Service
h4.AssignCdmaPhoneToService
||Action name|AssignCdmaPhoneToService|
||Class name|{{com.cdrator.product.service.action.AssignCdmaPhoneToService}}|
||Available from core version|8.7|
||Description|This action assigns a cdmaPhone to a service.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has been assigned to the service.|
||Properties| |
||Parameters|# {{CdmaService}}: service
# {{CdmaPhone}}: cdmaPhone
|
h4.CanBlockService
||Action name|CanBlockService|
||Class name|{{com.cdrator.product.service.action.CanBlockService}}|
||Available from core version|8.7|
||Description|This action checks if a service can be blocked.|
||Return value|{{boolean}}: A boolean indicating whether the service can be blocked.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.ReleaseCdmaPhone
||Action name|ReleaseCdmaPhone|
||Class name|{{com.cdrator.product.service.action.ReleaseCdmaPhone}}|
||Available from core version|8.7|
||Description|This action releases the CdmaPhone assigned to the service, if a CdmaPhone exists.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has just been released.|
||Properties| |
||Parameters|# {{CdmaService}}: service
|
h4.ServiceReader
||Action name|ServiceReader|
||Class name|{{com.cdrator.product.service.action.ServiceReader}}|
||Available from core version|8.7|
||Description|Retrieves a service based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Product - Service - Fixed
h4.SetPhoneNumberOnFixedLineService
||Action name|SetPhoneNumberOnFixedLineService|
||Class name|{{com.cdrator.product.service.fixed.action.SetPhoneNumberOnFixedLineService}}|
||Available from core version|8.7|
||Description|This action sets the provided phone number on a fixed line service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h3.Product - Service - Option
h4.GetServiceOptionFromOptionMetaData
||Action name|GetServiceOptionFromOptionMetaData|
||Class name|{{com.cdrator.product.service.option.action.GetServiceOptionFromOptionMetaData}}|
||Available from core version|8.7|
||Description|Search in the list of meta data records linked to the Option, if the service provided is subscribed to a product option key that is in the list then the service option is returned.|
||Return value|{{ServiceOption}}: The first service option found if subscribed to the service and in the meta data option list. Null if service not subscribed to any option in the meta data list.|
||Properties|# isAllowed: Check if the option is allowed or not.
|
||Parameters|# {{Option}}: option
# {{Service}}: service
|
h4.ServiceOptionReader
||Action name|ServiceOptionReader|
||Class name|{{com.cdrator.product.service.option.action.ServiceOptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a service option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SwitchServiceOptionsAction
||Action name|SwitchServiceOptionsAction|
||Class name|{{com.cdrator.product.service.option.action.SwitchServiceOptionsAction}}|
||Available from core version|8.7|
||Description|Unsubscribes a current service option and subscribes to a new option.|
||Return value|{{String}}: The id of the newly subscribed service option.|
||Properties|# makeProvisioningTask: If cached options should be completed or not.
|
||Parameters|# {{Subscription}}: subscription
# {{Option}}: optionToUnSubscribe
# {{Option}}: optionToSubscribe
|
h3.Product - Service - Shared
h4.GetAllNonTerminatedSharedServiceMembers
||Action name|GetAllNonTerminatedSharedServiceMembers|
||Class name|{{com.cdrator.product.service.shared.action.GetAllNonTerminatedSharedServiceMembers}}|
||Available from core version|8.7|
||Description|This action returns a list of all non-terminated (active and cancellation pending) members of a shared service.|
||Return value|{{List}}: A list of all non-terminated members of the shared service.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
|
h4.GetNonTerminatedSharedServiceMember
||Action name|GetNonTerminatedSharedServiceMember|
||Class name|{{com.cdrator.product.service.shared.action.GetNonTerminatedSharedServiceMember}}|
||Available from core version|8.7|
||Description|This action returns the direct member to a shared service.|
||Return value|{{SharedServiceMember}}: The SharedServiceMember of the sharedServiceInterface is returned if found.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
# {{SharedServiceInterface}}: sharedServiceInterface
|
h3.Product - Service - Tele
h4.DisconnectOldSimCards
||Action name|DisconnectOldSimCards|
||Class name|{{com.cdrator.product.service.tele.action.DisconnectOldSimCards}}|
||Available from core version|8.7|
||Description|This action disconnect any old SIMcards related to this TeleService (where TeleService.imsi not like SimCard.imsi ).|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h4.TeleServicePhoneNumber
||Action name|TeleServicePhoneNumber|
||Class name|{{com.cdrator.product.service.tele.action.TeleServicePhoneNumber}}|
||Available from core version|8.7|
||Description|This action sets a phone number on a Tele service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h4.UnBlockTeleService
||Action name|UnBlockTeleService|
||Class name|{{com.cdrator.product.service.tele.action.UnBlockTeleService}}|
||Available from core version|8.7|
||Description|This unblocks a service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h3.Product - Voucher
h4.AssignVoucher
||Action name|AssignVoucher|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucher}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{boolean}}: Boolean with the result of the assignment.|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.AssignVoucherToSubscription
||Action name|AssignVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.ChargeVoucherToSubscription
||Action name|ChargeVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.ChargeVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Charge a voucher to a subscription|
||Return value|{{boolean}}: A boolean value indicating whether the voucher was charged successfully|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.CreateNewVoucher
||Action name|CreateNewVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateNewVoucher}}|
||Available from core version|8.7|
||Description|To be used when a new voucher needs to be created. The keyword which is generated is an alphanumeric code.The length of this code is specified by the property numberOfCharacters. A voucherBatch needs to be passed to this action.|
||Return value|{{Voucher}}: The voucher which was created.|
||Properties|# numberOfCharacters: null
|
||Parameters|# {{VoucherBatch}}: voucherBatch
|
h4.CreateVoucher
||Action name|CreateVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateVoucher}}|
||Available from core version|8.7|
||Description|Creates a new voucher with the specified number of alphanumeric characters for the keyword, voucher code, price code and amount.|
||Return value|{{Voucher}}: The created voucher.|
||Properties|# batchVoucherCode: The voucher code.
# currencyCode: The amount currency code.
# numberOfCharacters: The length of the keyword alphanumeric code.
|
||Parameters|# {{Amount}}: amount
# {{String}}: priceCode
|
h4.GetVouchers
||Action name|GetVouchers|
||Class name|{{com.cdrator.product.voucher.action.GetVouchers}}|
||Available from core version|8.7|
||Description|Returns a list of vouchers|
||Return value|{{Collection}}: List of vouchers related to the batchId and the statusId for a given subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: batchId
# {{String}}: statusId
|
h4.VoucherBatchReader
||Action name|VoucherBatchReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherBatchReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.VoucherReader
||Action name|VoucherReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Provisioning
h4.CreateProvisioningTask
||Action name|CreateProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.CreateProvisioningTask}}|
||Available from core version|8.7|
||Description|Create a provisioning task of a specific type (CODE). The status of the new task will be "New". (the workflow instance can be added using "_activity.getWorkflow()")|
||Return value|{{ProvisioningTask}}: Return response code from ProvisioningRequest object.|
||Properties|# priority: Optional priority of the provisioning task. Default is 5
# taskComments: Optional comments to add to the provisioning task
# taskDescription: Optional description to add to the provisioning task
# taskType: The type of task that should be provisioned
|
||Parameters|# {{Service}}: service
# {{WfWorkflow}}: workflow
|
h4.GetProvisioningRequestsByReference
||Action name|GetProvisioningRequestsByReference|
||Class name|{{com.cdrator.provisioning.action.GetProvisioningRequestsByReference}}|
||Available from core version|8.7|
||Description|Retrieves a List of ProvisioningRequest linked to a ProvisioningTask by reference field.|
||Return value|{{List}}: Returns the ProvisioningRequest linked from the task reference.|
||Properties|# linkedFieldOnRequest: Optional to choose the database field from which to retrieve the reference linking the request to the task. Required to be varchar2 field.
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.GetResponseCodeFromProvisioningRequest
||Action name|GetResponseCodeFromProvisioningRequest|
||Class name|{{com.cdrator.provisioning.action.GetResponseCodeFromProvisioningRequest}}|
||Available from core version|8.7|
||Description|Retrieves the Response Code from a ProvisioningRequest.|
||Return value|{{String}}: Return response code from ProvisioningRequest object.|
||Properties|# responseCodeField: Optional to choose the database field from which to retrieve the response code.
|
||Parameters|# {{ProvisioningRequest}}: request
|
h4.NetworkOperatorReader
||Action name|NetworkOperatorReader|
||Class name|{{com.cdrator.provisioning.action.NetworkOperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves a Network Operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProvisioningTaskReader
||Action name|ProvisioningTaskReader|
||Class name|{{com.cdrator.provisioning.action.ProvisioningTaskReader}}|
||Available from core version|8.7|
||Description|Retrieves a Provisioning Task based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ResetStartDateWithDelayOnProvisioningTask
||Action name|ResetStartDateWithDelayOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.ResetStartDateWithDelayOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Adds the delayInMinutes property to start date on Provisioning Task. If no start date on task, adds delay from current date.|
||Return value|{{void}}: No return values|
||Properties|# delayInMinutes: null
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.SetStatusOnProvisioningTask
||Action name|SetStatusOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.SetStatusOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Set Status for Processing on Provisioning Task.|
||Return value|{{void}}: No return values|
||Properties|# statusToSet: The status that the provisioning task will be set to.
|
||Parameters|# {{ProvisioningTask}}: task
|
h3.RecurrentFee
h4.BillSubscriptionFeeListToInvoiceNow
||Action name|BillSubscriptionFeeListToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeeListToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills the supplied subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{List}}: subscriptionFees
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNow
||Action name|BillSubscriptionFeesToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNowForListOfSubs
||Action name|BillSubscriptionFeesToInvoiceNowForListOfSubs|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNowForListOfSubs}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice for a list of subscriptions.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{Invoice}}: invoice
|
h4.SetFeeChargeDateToSiblingFeeChargeDate
||Action name|SetFeeChargeDateToSiblingFeeChargeDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeChargeDateToSiblingFeeChargeDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to sibling fee's next_charge_date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{SubscriptionFees}}: siblingFee
|
h4.SetFeeEndDateLastPeriod
||Action name|SetFeeEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodForFeeList
||Action name|SetFeeEndDateLastPeriodForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodToEndOfMonth
||Action name|SetFeeEndDateLastPeriodToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
h4.SetFeeNextChargeDateForFeeList
||Action name|SetFeeNextChargeDateForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeNextChargeDateToEndOfMonth
||Action name|SetFeeNextChargeDateToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SetFeeNextChargeDateToSpecificDate
||Action name|SetFeeNextChargeDateToSpecificDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.TerminateFeeFromEndDateLastPeriod
||Action name|TerminateFeeFromEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.TerminateFeeFromEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Terminates the fee from its end_date_last_period|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h3.Shop
h4.CheckShopUsernameAvailability
||Action name|CheckShopUsernameAvailability|
||Class name|{{com.cdrator.shop.action.CheckShopUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given shop user name is available.|
||Return value|{{boolean}}: boolean true if the user name is available (no shop exists with the user name), else false.|
||Properties|# caseSensitive: Is the shop user name case sensitive?
|
||Parameters|# {{String}}: username
|
h4.GetSubscriptionsForSalesStoreEstablishedBetween
||Action name|GetSubscriptionsForSalesStoreEstablishedBetween|
||Class name|{{com.cdrator.shop.action.GetSubscriptionsForSalesStoreEstablishedBetween}}|
||Available from core version|8.7|
||Description|Finds subscriptions with a specific sales store established between two dates|
||Return value|{{ArrayList}}: Subscriptions|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.SetShopParentId
||Action name|SetShopParentId|
||Class name|{{com.cdrator.shop.action.SetShopParentId}}|
||Available from core version|8.7|
||Description|This action sets the parent id of a shop and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Shop}}: parentShop
|
h4.ShopReader
||Action name|ShopReader|
||Class name|{{com.cdrator.shop.action.ShopReader}}|
||Available from core version|8.7|
||Description|Retrieves a shop based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Simcard
h4.ChangeSimStatus
||Action name|ChangeSimStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM card status. If softblocked, barred or stolen is set, the blocked from date is updated. If in use is set, the blocked from date is set null.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.ChangeSimTypeStatus
||Action name|ChangeSimTypeStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimTypeStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM type status.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status types to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.FindSimcardsByIccAndPUK
||Action name|FindSimcardsByIccAndPUK|
||Class name|{{com.cdrator.simcard.action.FindSimcardsByIccAndPUK}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM cards from the database based on ICC and PUK.|
||Return value|{{ArrayList}}: The SIM cards with the ICC substring or the complete PUK. If no SIM cards are found, null is returned.|
||Properties|# onlyAvailableSIM: Only return available simcards?
|
||Parameters|# {{String}}: icc
# {{String}}: puk
|
h4.GetAvailableRandomSimCard
||Action name|GetAvailableRandomSimCard|
||Class name|{{com.cdrator.simcard.action.GetAvailableRandomSimCard}}|
||Available from core version|8.7|
||Description|Fetches a random available SIM card. Available means that the status is 0 (open and active) and it's not reserved. The SIM card type can be specified as a parameter.|
||Return value|{{SimCard}}: The available SIM card if found.|
||Properties| |
||Parameters|# {{String}}: simTypeId
|
h4.GetSimcardByIcc
||Action name|GetSimcardByIcc|
||Class name|{{com.cdrator.simcard.action.GetSimcardByIcc}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM card from the database by ICC.|
||Return value|{{SimCard}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{String}}: icc
|
h4.ReserveSimcard
||Action name|ReserveSimcard|
||Class name|{{com.cdrator.simcard.action.ReserveSimcard}}|
||Available from core version|8.7|
||Description|Action for reserving a SIM card to a service.|
||Return value|{{boolean}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{SimCard}}: simcard
# {{Service}}: service
|
h4.SimCardReader
||Action name|SimCardReader|
||Class name|{{com.cdrator.simcard.action.SimCardReader}}|
||Available from core version|8.7|
||Description|Retrieves a SIM card based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Util
h4.AddHookpointResult
||Action name|AddHookpointResult|
||Class name|{{com.cdrator.util.action.AddHookpointResult}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result.|
||Return value|{{void}}: No return value|
||Properties|# clearHookpointResult: Clear hookpoint result except for keys starting with LAST_OUTCOME_
# key1: Key 1
# key2: Key 2
# key3: Key 3
|
||Parameters|# {{HookpointResult}}: result
# {{String}}: value1
# {{String}}: value2
# {{String}}: value3
|
h4.CreateCdrParameter
||Action name|CreateCdrParameter|
||Class name|{{com.cdrator.util.action.CreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action creates a new cdrparameter based on the given code. The description, value and object, will be set based on the given information.|
||Return value|{{CdrParameter}}: The created cdrparameter.|
||Properties|# code: The code to create the cdrparameter from.
# description: The description of the cdrparameter.
|
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FormatString
||Action name|FormatString|
||Class name|{{com.cdrator.util.action.FormatString}}|
||Available from core version|8.7|
||Description|Format a string. Uses standard String.format|
||Return value|{{String}}: The formatted string.|
||Properties|# format: The format string.
|
||Parameters|# {{Object}}: param1
# {{Object}}: param2
# {{Object}}: param3
# {{Object}}: param4
# {{Object}}: param5
|
h4.GeneratePDFAction
||Action name|GeneratePDFAction|
||Class name|{{com.cdrator.util.action.GeneratePDFAction}}|
||Available from core version|8.7|
||Description|Generates a PDF specification based on the specified type.|
||Return value|{{String}}: The generated PDF string - Base64 encoded.|
||Properties|# PDFType: Specify the type of PDF generation.
|
||Parameters|# {{PersistentObject}}: object
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.GenerateXMLFromPO
||Action name|GenerateXMLFromPO|
||Class name|{{com.cdrator.util.action.GenerateXMLFromPO}}|
||Available from core version|8.7|
||Description|This action generates a XML document based on the given XMLDocumentDefinition and Persistant object. The resulting XML is placed in the provided dirName with the provided name+timestamp|
||Return value|{{boolean}}: Returns a persistentObject from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: documentDefKey
# {{String}}: dirName
# {{String}}: fileName
# {{PersistentObject}}: persistantObject
# {{String}}: persistentObjectKey
|
h4.GetCdrParameter
||Action name|GetCdrParameter|
||Class name|{{com.cdrator.util.action.GetCdrParameter}}|
||Available from core version|8.7|
||Description|This action adds a new cdrparameter based on the given objects and text string. Throws NullPointerException if both the cdrParameter and the parameter definition does not exist in the database.|
||Return value|{{CdrParameter}}: Returns cdr parameter based on the given objecs.|
||Properties| |
||Parameters|# {{CdrParameterIf}}: object
# {{String}}: varname
# {{CdrParameterIf}}: alternativeObject
|
h4.GetHashedValueFromString
||Action name|GetHashedValueFromString|
||Class name|{{com.cdrator.util.action.GetHashedValueFromString}}|
||Available from core version|8.7|
||Description|This action returns a hashed string based on the input given and the chosen hash type.|
||Return value|{{String}}: Returns a string hash of the suppplied input.|
||Properties|# selectedHashAlgorithm: Chosen hashing algorithm. Only SHA-1, SHA-256, SHA-384, SHA-512, MD2, MD5 are supported. If none is specified or no match, then SHA-1 is assumed.
|
||Parameters|# {{String}}: input
|
h4.GetInstanceFromDB
||Action name|GetInstanceFromDB|
||Class name|{{com.cdrator.util.action.GetInstanceFromDB}}|
||Available from core version|8.7|
||Description|This action retrieves a persistentObject from the database.|
||Return value|{{PersistentObject}}: Returns a persistent object from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{String}}: className
# {{Broker}}: broker
# {{String}}: clause
|
h4.GetParameterTreeValues
||Action name|GetParameterTreeValues|
||Class name|{{com.cdrator.util.action.GetParameterTreeValues}}|
||Available from core version|8.7|
||Description|This action retrieves all parameter values for a given node path and brand.|
||Return value|{{List}}: Returns the list of parameter values for the given node path.|
||Properties|# nodePath: Path to parameter tree node. Example: ALERTS.ALERT_GROUPS.
|
||Parameters|# {{Brand}}: brand
|
h4.GetStatusTypesFor
||Action name|GetStatusTypesFor|
||Class name|{{com.cdrator.util.action.GetStatusTypesFor}}|
||Available from core version|8.7|
||Description|This action retrieves the statuses for a given status type code.|
||Return value|{{List}}: Returns statuses for the given code.|
||Properties| |
||Parameters|# {{String}}: code
|
h4.IsStringInDelimitedString
||Action name|IsStringInDelimitedString|
||Class name|{{com.cdrator.util.action.IsStringInDelimitedString}}|
||Available from core version|8.7|
||Description|This action returns true if a given string val is in the comma separated string values. Remark: Both strings are trimmed before comparison to avoid unintended results.|
||Return value|{{boolean}}: Returns true if the given val is in the values string, false in all other cases.|
||Properties| |
||Parameters|# {{String}}: val
# {{String}}: values
|
h4.SimpleReturn
||Action name|SimpleReturn|
||Class name|{{com.cdrator.util.action.SimpleReturn}}|
||Available from core version|8.7|
||Description|Returns the argument object|
||Return value|{{Object}}: The argument object|
||Properties| |
||Parameters|# {{Object}}: executionArg
|
h4.Throttle
||Action name|Throttle|
||Class name|{{com.cdrator.util.action.Throttle}}|
||Available from core version|8.7|
||Description|Throttles a process
Requires 2 parameters:
WORKFLOW.THROTTLING.<name>.CAP number of times the throttled process may be performed in each interval
WORKFLOW.THROTTLING.<name>.INTERVAL number of seconds each interval lasts|
||Return value|{{boolean}}: Returns true if the process can continue.|
||Properties|# name: Used to generate the keys for the properties and parameters.
|
||Parameters| |
h4.ThrowNewUserMessageSysExceptionAction
||Action name|ThrowNewUserMessageSysExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewUserMessageSysExceptionAction}}|
||Available from core version|8.7|
||Description|Will throw an exception with a user defined message. Use this action to manually throw an exception to force a rollback while also specifying an error message to the end user, e.g. in the SOAP response instead of displaying BUSINESS_ERROR.|
||Return value|{{void}}: No return value.|
||Properties|# userMessage: The user message to pass along the exception. Specify labels, max 5 labels, in the message using <LABEL(X)>, e.g. This is <LABEL1> example label one.
|
||Parameters|# {{String}}: label1
# {{String}}: label2
# {{String}}: label3
# {{String}}: label4
# {{String}}: label5
|
h4.ThrowNewWorkflowExceptionAction
||Action name|ThrowNewWorkflowExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewWorkflowExceptionAction}}|
||Available from core version|8.7|
||Description|Finalizes logistics file.|
||Return value|{{void}}: No return value.|
||Properties|# recordNo: Error message to log throw with exception.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h4.UpdatePersistentObject
||Action name|UpdatePersistentObject|
||Class name|{{com.cdrator.util.action.UpdatePersistentObject}}|
||Available from core version|8.7|
||Description|This action updates a persistent object by calling a method on it with one or more parameters. The persistent object is saved afterwards. Example: PersistentObject=USERS, method="setAccount", params=ACCOUNT result: USERS.setAccount(ACCOUNT); USERS.save();|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
# {{String}}: method
# {{Object[]}}: params
|
h3.Util - Date
h4.DateChanger
||Action name|DateChanger|
||Class name|{{com.cdrator.util.date.action.DateChanger}}|
||Available from core version|8.7|
||Description|Changes values on a given date, al values are given as numbers where e.g. Month=1 sets the date to January.|
||Return value|{{Date}}: The modified date.|
||Properties| |
||Parameters|# {{Date}}: date
# {{String}}: milliSecond
# {{String}}: second
# {{String}}: minute
# {{String}}: hour
# {{String}}: day
# {{String}}: month
# {{String}}: year
|
h4.DateComparator
||Action name|DateComparator|
||Class name|{{com.cdrator.util.date.action.DateComparator}}|
||Available from core version|8.7|
||Description|Compares two given dates for one of these actions: AFTER, BEFORE, or EQUALS. Date1 is compared against date2 with the action (e.g. date1 after date2).|
||Return value|{{boolean}}: A boolean representing the outcome of the specified operation.|
||Properties|# action: Specify the operation between dates.
|
||Parameters|# {{Date}}: date1
# {{Date}}: date2
|
h4.DateStaticAdder
||Action name|DateStaticAdder|
||Class name|{{com.cdrator.util.date.action.DateStaticAdder}}|
||Available from core version|8.7|
||Description|Adds day, hours, minutes, and second to the given date|
||Return value|{{Date}}: The modified date.|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters|# {{Date}}: date
|
h4.FormatDate
||Action name|FormatDate|
||Class name|{{com.cdrator.util.date.action.FormatDate}}|
||Available from core version|8.7|
||Description|Turns a given date into a string using a specified format.|
||Return value|{{String}}: The formatted date.|
||Properties|# format: The format to format the date by.
|
||Parameters|# {{Date}}: date
|
h4.GetDate
||Action name|GetDate|
||Class name|{{com.cdrator.util.date.action.GetDate}}|
||Available from core version|8.7|
||Description|An action to retrieve the current or a future date|
||Return value|{{Date}}: A date representing the sysdate + eventual added minutes, hours, days or months|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters| |
h4.GetEndOfMonthDate
||Action name|GetEndOfMonthDate|
||Class name|{{com.cdrator.util.date.action.GetEndOfMonthDate}}|
||Available from core version|8.7|
||Description|This action returns a calendar representing the last day of the current month.|
||Return value|{{Calendar}}: A calendar representing the last day of the current month.|
||Properties| |
||Parameters| |
h4.GetFirstDayOfMonth
||Action name|GetFirstDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetFirstDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the first day of the month of the supplied date|
||Return value|{{Date}}: A date representing the first day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetFormattedCalendarField
||Action name|GetFormattedCalendarField|
||Class name|{{com.cdrator.util.date.action.GetFormattedCalendarField}}|
||Available from core version|8.7|
||Description|Returns the string representation of the calendar field value in the given style and locale. Parameters requrired: dateField - the calendar field for which the string representation is returned (Calendar.MONTH ...); date - The source date; locale - The locale used for formatting. (no ...); dateStyle - The locale used for formatting.(Calendar.SHORT, Calendar.LONG).|
||Return value|{{String}}: Returns the string representation of the calendar field value in the given style and locale.|
||Properties| |
||Parameters|# {{int}}: dateField
# {{Date}}: date
# {{String}}: locale
# {{int}}: dateStyle
|
h4.GetLastDayOfMonth
||Action name|GetLastDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetLastDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the last day of the month of the supplied date|
||Return value|{{Date}}: A date representing the last day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetNextWorkingDay
||Action name|GetNextWorkingDay|
||Class name|{{com.cdrator.util.date.action.GetNextWorkingDay}}|
||Available from core version|8.7|
||Description|Get the next working day if the supplied date is a holiday|
||Return value|{{Date}}: The next working day|
||Properties| |
||Parameters|# {{Date}}: fromDate
|
h3.Util - Image
h4.GetImage
||Action name|GetImage|
||Class name|{{com.cdrator.util.image.action.GetImage}}|
||Available from core version|8.7|
||Description|Loads an image from a specific path given as parameter or context object|
||Return value|{{Image}}: Returns the Image object loaded from the given path.|
||Properties| |
||Parameters|# {{String}}: imagePath
|
h3.Util - Parameter
h4.CdrParameterReader
||Action name|CdrParameterReader|
||Class name|{{com.cdrator.util.parameter.action.CdrParameterReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDR Parameter based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.UpdateCreateCdrParameter
||Action name|UpdateCreateCdrParameter|
||Class name|{{com.cdrator.util.parameter.action.UpdateCreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action updates a cdr parameter, if the cdr parameter doesn't exist it will create a new one. The value, name and object will be set based on the given information.|
||Return value|{{CdrParameter}}: The updated/created cdr parameter.|
||Properties| |
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
h3.Unknown package
h4.SingleValueReader
||Action name|SingleValueReader|
||Class name|{{com.cdrator.util.SingleValueReader}}|
||Available from core version|8.7|
||Description|Reads a single value from a persistent object. Column name must be specified.|
||Return value|{{String}}: The string value of the specified column name of the persistent object|
||Properties|# columnName: The column name of the persistent object, from where to read the value from
|
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Util - String
h4.CreateListOfStringsFromDelimitedText
||Action name|CreateListOfStringsFromDelimitedText|
||Class name|{{com.cdrator.util.string.action.CreateListOfStringsFromDelimitedText}}|
||Available from core version|8.7|
||Description|Creates a List of strings from a delimited text|
||Return value|{{List}}: The list of strings computed by splitting the delimited text|
||Properties|# delimiter: The delimiter used in the text
|
||Parameters|# {{String}}: delimitedText
|
h3.Workflow
h4.PushWorkflow
||Action name|PushWorkflow|
||Class name|{{com.cdrator.workflow.action.PushWorkflow}}|
||Available from core version|8.7|
||Description|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
|
||Return value|{{WfActivity}}: The activity the workflow was waiting in.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{WfWorkflow}}: workflow
|
h4.PushWorkflowById
||Action name|PushWorkflowById|
||Class name|{{com.cdrator.workflow.action.PushWorkflowById}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{WfWorkflow}}: The pushed workflow.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{String}}: workflowId
# {{Broker}}: broker
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.StartNewWorkflow
||Action name|StartNewWorkflow|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflow}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{HookpointResult}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
|
h4.StartNewWorkflowList
||Action name|StartNewWorkflowList|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflowList}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
# {{List}}: objectList
# {{String}}: objectContextKey
|
h4.WorkflowActivityReader
||Action name|WorkflowActivityReader|
||Class name|{{com.cdrator.workflow.action.WorkflowActivityReader}}|
||Available from core version|8.7|
||Description|Retrieves a workflow activity based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Workflow - Context
h4.IsObjectInContext
||Action name|IsObjectInContext|
||Class name|{{com.cdrator.workflow.context.action.IsObjectInContext}}|
||Available from core version|8.7|
||Description|Checks if the object is in the context|
||Return value|{{boolean}}: true if the object is in the context|
||Properties|# objectKey: The key of the object to check in the context
|
||Parameters|# {{Map}}: context
|
h3.Workflow - Hookpointresult
h4.AddHookpointResultObjects
||Action name|AddHookpointResultObjects|
||Class name|{{com.cdrator.workflow.hookpointresult.action.AddHookpointResultObjects}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result. Allows having objects in HOOKPOINT_RESULT|
||Return value|{{void}}: No return value|
||Properties|# key1: Key 1
# key2: Key 2
# key3: Key 3
# key4: Key 4
# key5: Key 5
|
||Parameters|# {{HookpointResult}}: result
# {{Object}}: value1
# {{Object}}: value2
# {{Object}}: value3
# {{Object}}: value4
# {{Object}}: value5
|
h4.CheckHookpointResult
||Action name|CheckHookpointResult|
||Class name|{{com.cdrator.workflow.hookpointresult.action.CheckHookpointResult}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: True if result is success, False otherwise.|
||Properties|# errorCodesToIgnore: List of error codes to ignore. Use semicolon (;) to separate the values of the list.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h3.Billing - Billingcycle
h4.BillingCycleReader
||Action name|BillingCycleReader|
||Class name|{{com.cdrator.billing.billingcycle.action.BillingCycleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Cycle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetEndOfBillingCycleDate
||Action name|GetEndOfBillingCycleDate|
||Class name|{{com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate}}|
||Available from core version|8.7|
||Description|This action returns a date representing the last day of the current billing cycle for the given billing group.|
||Return value|{{Date}}: A Date representing the last day of the current billing cycle.|
||Properties| |
||Parameters|# {{Date}}: date
# {{BillingGroup}}: bg
|
h3.Billing - Billinggroup
h4.BillingGroupReader
||Action name|BillingGroupReader|
||Class name|{{com.cdrator.billing.billinggroup.action.BillingGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Group based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveBillingGroupMembers
||Action name|GetActiveBillingGroupMembers|
||Class name|{{com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers}}|
||Available from core version|8.7|
||Description|Retrieves the active members of the billing group|
||Return value|{{List}}: The active members of the billing group|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.HardBlockAllTeleServicesOnBillingGroup
||Action name|HardBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.SoftBlockAllTeleServicesOnBillingGroup
||Action name|SoftBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.UnBlockAllTeleServicesOnBillingGroup
||Action name|UnBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h3.Billing - Charge
h4.CreateSingleChargeForBillingGroup
||Action name|CreateSingleChargeForBillingGroup|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Billing Group. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.CreateSingleChargeForSubscription
||Action name|CreateSingleChargeForSubscription|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForSubscription}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Subscription. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{Subscription}}: subscription
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.RoundAllInvoicesInBatch
||Action name|RoundAllInvoicesInBatch|
||Class name|{{com.cdrator.billing.charge.action.RoundAllInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Rounds all invoices on an invoicebatch, to nearest whole number.|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: batch
# {{ChargeItem}}: chargeItem
|
h3.Billing - Financial - Billing
h4.AddChargeToBillingGroup
||Action name|AddChargeToBillingGroup|
||Class name|{{com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Number}}: amount
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.BuildAccountPaymentsForInvoicesOnBatch
||Action name|BuildAccountPaymentsForInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# paymentType: The account payment type that should be used for the payment.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: cdrParameterName
# {{String}}: parameterValue
|
h4.DoAccountPayment
||Action name|DoAccountPayment|
||Class name|{{com.cdrator.billing.financial.billing.action.DoAccountPayment}}|
||Available from core version|8.7|
||Description|Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.|
||Return value|{{AccountPayment}}: Returns the account payment|
||Properties|# accountPaymentTypeId: The account payment type of the recharge ticket.
# skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.
|
||Parameters|# {{RechargeTicket}}: rechargeTicket
# {{Invoice}}: invoice
# {{BillingGroup}}: billingGroup
# {{String}}: paymentRequestRef
# {{HookpointResult}}: hookpointResult
|
h4.GetListOfServicesInStatusFromSubscriptions
||Action name|GetListOfServicesInStatusFromSubscriptions|
||Class name|{{com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions}}|
||Available from core version|8.7|
||Description|Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.|
||Return value|{{List}}: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{List}}: statuses
|
h4.GetNewInvoice
||Action name|GetNewInvoice|
||Class name|{{com.cdrator.billing.financial.billing.action.GetNewInvoice}}|
||Available from core version|8.7|
||Description|This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.|
||Return value|{{Invoice}}: The newly created Invoice|
||Properties|# invoiceType: The available invoice types
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.MakeInvoicePaymentOnInvoicesInBatch
||Action name|MakeInvoicePaymentOnInvoicesInBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h4.ManualDebitOrCredit
||Action name|ManualDebitOrCredit|
||Class name|{{com.cdrator.billing.financial.billing.action.ManualDebitOrCredit}}|
||Available from core version|8.7|
||Description|This action calls the function addManualDebitOrCredit on the provided set of parameters.|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{TimeCharge}}: timeCharge
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{boolean}}: isDebit
# {{Amount}}: amount
# {{Currency}}: amountCurrency
# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.PayInvoicesOnBatch
||Action name|PayInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h3.Unknown package
h4.PaymentMethodReader
||Action name|PaymentMethodReader|
||Class name|{{com.cdrator.billing.financial.PaymentMethodReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Method entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Financial - Payments
h4.PaymentLogReader
||Action name|PaymentLogReader|
||Class name|{{com.cdrator.billing.financial.payments.action.PaymentLogReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Log based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Invoice
h4.CloseInvoiceWithCurrentDate
||Action name|CloseInvoiceWithCurrentDate|
||Class name|{{com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate}}|
||Available from core version|8.7|
||Description|Calls closeWithDueDate on a given invoice with current date.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.GetAccountPaymentsForInvoice
||Action name|GetAccountPaymentsForInvoice|
||Class name|{{com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice}}|
||Available from core version|8.7|
||Description|Gets a list of account payments related to the invoice.|
||Return value|{{List}}: A list of accountPayments.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.InvoiceCompareToLastStepId
||Action name|InvoiceCompareToLastStepId|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId}}|
||Available from core version|8.7|
||Description|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 |
||Return value|{{boolean}}: true or false|
||Properties| |
||Parameters|# {{Invoice}}: invoice
# {{String}}: compareString
# {{boolean}}: defaultForBlank
|
h4.InvoiceReader
||Action name|InvoiceReader|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceReader}}|
||Available from core version|8.7|
||Description|Retrieves an invoice based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.PayInvoicesInBatchWithAccountPayments
||Action name|PayInvoicesInBatchWithAccountPayments|
||Class name|{{com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments}}|
||Available from core version|8.7|
||Description|Marks all invoice on batch as paid|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: invoiceBatch
# {{String}}: reference
# {{String}}: transactionNumber
# {{AccountPaymentType}}: accountPaymentType
|
h4.PublishInvoice
||Action name|PublishInvoice|
||Class name|{{com.cdrator.billing.invoice.action.PublishInvoice}}|
||Available from core version|8.7|
||Description|Publishes a given invoice.|
||Return value|{{Invoice}}: The published invoice|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h3.Billing - Main
h4.GetBillingGroupsByUserID
||Action name|GetBillingGroupsByUserID|
||Class name|{{com.cdrator.billing.main.action.GetBillingGroupsByUserID}}|
||Available from core version|8.7|
||Description|This action will return an arraylist of billing groups that a given userID is the owner of.|
||Return value|{{ArrayList}}: An array list of billing groups.|
||Properties| |
||Parameters|# {{String}}: userID
|
h4.SetBillingGroupCurrencyCode
||Action name|SetBillingGroupCurrencyCode|
||Class name|{{com.cdrator.billing.main.action.SetBillingGroupCurrencyCode}}|
||Available from core version|8.7|
||Description|This action sets the currency code on the billing group. The billing group is saved.|
||Return value|{{void}}: No return value.|
||Properties|# currencyCode: The currency code which is set on the billing group.
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.TerminateSharedServiceIfNoTeleservices
||Action name|TerminateSharedServiceIfNoTeleservices|
||Class name|{{com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Boolean}}: Returns true if a shared Service was attempted terminated.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{Date}}: terminationDate
# {{String}}: hookpointKey
# {{String}}: reason
|
h3.Billing - Misc
h4.GetParameterValue
||Action name|GetParameterValue|
||Class name|{{com.cdrator.billing.misc.action.GetParameterValue}}|
||Available from core version|8.7|
||Description|This action retrieves a string representation of a parameter value.|
||Return value|{{String}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{String}}: key
# {{Brand}}: brand
|
h3.Billing - Payment
h4.AccountPaymentReader
||Action name|AccountPaymentReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AccountPaymentSetAuthorized
||Action name|AccountPaymentSetAuthorized|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetAuthorized}}|
||Available from core version|8.7|
||Description|Calls setAuthorized on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentSetCaptureInfo
||Action name|AccountPaymentSetCaptureInfo|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo}}|
||Available from core version|8.7|
||Description|Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage) |
||Return value|{{void}}: No return value|
||Properties|# captureMessage: Capture message to be set.
# useCaptureDate: Should Capture Date be set (to current time.
|
||Parameters|# {{AccountPayment}}: ap
|
h4.AccountPaymentSetDoCapture
||Action name|AccountPaymentSetDoCapture|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetDoCapture}}|
||Available from core version|8.7|
||Description|Calls setDoCapture on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentTypeReader
||Action name|AccountPaymentTypeReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AcountPaymentSetCaptureMessage
||Action name|AcountPaymentSetCaptureMessage|
||Class name|{{com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage}}|
||Available from core version|8.7|
||Description|Set capture message on AccountPayment|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{AccountPayment}}: ap
# {{String}}: captureMessage
|
h4.GetRechargeTicketForBillingGroup
||Action name|GetRechargeTicketForBillingGroup|
||Class name|{{com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup}}|
||Available from core version|8.7|
||Description|This action returns a rechargeTicket for a BillingGroup.|
||Return value|{{RechargeTicket}}: The recharge ticket, if it exists.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h3.Billing - Product
h4.DeviceCanUseOn
||Action name|DeviceCanUseOn|
||Class name|{{com.cdrator.billing.product.action.DeviceCanUseOn}}|
||Available from core version|8.7|
||Description|Calls CanUseOn on a given device with a given service.|
||Return value|{{boolean}}: Boolean showing if a given device can be used on a given service.|
||Properties| |
||Parameters|# {{Device}}: device
# {{Service}}: service
|
h4.GetDeviceFromParameterValue
||Action name|GetDeviceFromParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceFromParameterValue}}|
||Available from core version|8.7|
||Description|Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.|
||Return value|{{Device}}: The located device.|
||Properties| |
||Parameters|# {{String}}: name
# {{String}}: value
|
h4.GetDeviceParameterValue
||Action name|GetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action returns the value of a given device parameter or throws a NullValueException if none is found.|
||Return value|{{String}}: Value of the given parameter (as a string).|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
|
h4.SetDeviceParameterValue
||Action name|SetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.SetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action updates a device parameter value if it's found, otherwise it will be created.|
||Return value|{{boolean}}: True if the parameter was created, false if the parameter was updated.|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
# {{String}}: value
|
h3.Billing - Product - RatePlanChange
h4.CompleteRatePlanChange
||Action name|CompleteRatePlanChange|
||Class name|{{com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange}}|
||Available from core version|8.7|
||Description|This action completes the rateplan change by subscribing to the default and mandatory options.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{RatePlanChange}}: rpc
# {{boolean}}: cache
|
h3.Billing - Rating
h4.GetActiveRatePlanForSubscription
||Action name|GetActiveRatePlanForSubscription|
||Class name|{{com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the currently active rate plan for a subscription.|
||Return value|{{RatePlan}}: Returns a rate plan that is currently active for the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetPlanElement
||Action name|GetPlanElement|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElement}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters| |
h4.GetPlanElementForRatePlan
||Action name|GetPlanElementForRatePlan|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElementForRatePlan}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters|# {{RatePlan}}: ratePlan
|
h4.GetRatePlansByProduct
||Action name|GetRatePlansByProduct|
||Class name|{{com.cdrator.billing.rating.action.GetRatePlansByProduct}}|
||Available from core version|8.7|
||Description|This action retrieves rate plans for a product.|
||Return value|{{List}}: Returns a list of rate plans related to this product.|
||Properties| |
||Parameters|# {{Product}}: product
|
h3.Billing - Rating - Simulate
h4.BillingRecordBuilder
||Action name|BillingRecordBuilder|
||Class name|{{com.cdrator.billing.rating.simulate.action.BillingRecordBuilder}}|
||Available from core version|8.7|
||Description|Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.|
||Return value|{{BillingRecordSimulated}}: A new unrated billing record. Not persisted.|
||Properties|# BNumber: B-Number of the billing record.
# ratingCode: Rating code to be set on the Billing Record.
# ratingDuration: Rating duration to be set on the Billing Record.
# ratingKey: Rating key to be set on the Billing Record.
# ratingVolumne: Rating volume to be set on the Billing Record.
|
||Parameters|# {{Service}}: service
|
h4.CalculateInvoiceDetailLinesTotalChargeSum
||Action name|CalculateInvoiceDetailLinesTotalChargeSum|
||Class name|{{com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Amount}}: The sum to the total charges of the Invoice Detail Lines Wrappers|
||Properties|# ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
# throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
|
||Parameters|# {{List}}: idlList
|
h4.RatingSimulator
||Action name|RatingSimulator|
||Class name|{{com.cdrator.billing.rating.simulate.action.RatingSimulator}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{ArrayList}}: ArrayList of the Invoice Detail Lines|
||Properties| |
||Parameters|# {{Service}}: service
# {{BillingRecords}}: billingRecord
|
h3.Billing - Status
h4.StatusReader
||Action name|StatusReader|
||Class name|{{com.cdrator.billing.status.action.StatusReader}}|
||Available from core version|8.7|
||Description|Retrieves a Status object based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - SubscriptionFees
h4.AddFee
||Action name|AddFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddFee}}|
||Available from core version|8.7|
||Description|Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Returns the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# feeCode: The fee code for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
h4.AddSubscriptionFee
||Action name|AddSubscriptionFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee}}|
||Available from core version|8.7|
||Description|Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Return the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# planElement: The plan element for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SubscriptionFeesReader
||Action name|SubscriptionFeesReader|
||Class name|{{com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader}}|
||Available from core version|8.7|
||Description|Gets a subscription fee.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - TodoTask
h4.CreateTodoTask
||Action name|CreateTodoTask|
||Class name|{{com.cdrator.billing.todoTask.action.CreateTodoTask}}|
||Available from core version|8.7|
||Description|Creates a TodoTask based on configurable properties|
||Return value|{{void}}: No return values|
||Properties|# assignedToOperator: The operator the todo task is assigned to
# category: Task category
# contactPhoneNumber: Contact phone number
# description: Task Description
# reminderTimeInMinutes: Reminder time in minutes
# subject: Subject
# typeOfFollowUp: The type of follow up: email,letter,phone call,sms
|
||Parameters|# {{Service}}: service
|
h3.Brand
h4.BrandReader
||Action name|BrandReader|
||Class name|{{com.cdrator.brand.action.BrandReader}}|
||Available from core version|8.7|
||Description|Retrieves a Brand based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Campaign
h4.CampaignReader
||Action name|CampaignReader|
||Class name|{{com.cdrator.campaign.action.CampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a Campaign definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetBundlesFromCampaign
||Action name|GetBundlesFromCampaign|
||Class name|{{com.cdrator.campaign.action.GetBundlesFromCampaign}}|
||Available from core version|8.7|
||Description|Returns an list of campaign bundles from a campaign.|
||Return value|{{ArrayList}}: a list of campaign bundles|
||Properties| |
||Parameters|# {{Campaign}}: campaign
|
h4.GetCampaignForKey
||Action name|GetCampaignForKey|
||Class name|{{com.cdrator.campaign.action.GetCampaignForKey}}|
||Available from core version|8.7|
||Description|This action returns a campaign for which the campaign key is provided as a property.|
||Return value|{{Campaign}}: The campaign associated with the provided campaign key.|
||Properties|# campaignKey: The campaign key for the campaign.
|
||Parameters| |
h4.GetCurrentSubscriptionCampaign
||Action name|GetCurrentSubscriptionCampaign|
||Class name|{{com.cdrator.campaign.action.GetCurrentSubscriptionCampaign}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a subscription and campaign.|
||Return value|{{SubscriptionCampaign}}: The current SubscriptionCampaign.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Campaign}}: campaign
|
h4.GetNewSubscriptionBundle
||Action name|GetNewSubscriptionBundle|
||Class name|{{com.cdrator.campaign.action.GetNewSubscriptionBundle}}|
||Available from core version|8.7|
||Description|This action creates and returns a new SubscriptionBundle.|
||Return value|{{SubscriptionBundle}}: Returns a new SubscriptionBundle|
||Properties| |
||Parameters|# {{Bundle}}: bundle
# {{Subscription}}: subscription
# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.GetSubscriptionCampaignsByCriteria
||Action name|GetSubscriptionCampaignsByCriteria|
||Class name|{{com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.|
||Return value|{{List}}: A list of SubscriptionCampaign matching given criterias.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: criterias
|
h4.SetListOfSubscriptionCampaignToDateToSpecificDate
||Action name|SetListOfSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: subscriptionCampaigns
# {{Date}}: date
|
h4.SetSubBundleVal1FromServiceOption
||Action name|SetSubBundleVal1FromServiceOption|
||Class name|{{com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption}}|
||Available from core version|8.7|
||Description|This action updates value1 if an associated serviceOptionParameter with a given key can be found.|
||Return value|{{boolean}}: Boolean indicating success of finding and setting the parameter.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
# parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.
|
||Parameters|# {{SubscriptionBundle}}: bundle
# {{Broker}}: broker
|
h4.SetSubscriptionCampaignCollectionFromToDate
||Action name|SetSubscriptionCampaignCollectionFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.|
||Return value|{{boolean}}: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{ArrayList}}: subscriptionCampaignList
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignFromDateToNextMonth
||Action name|SetSubscriptionCampaignFromDateToNextMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to the first day of next month.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignFromDateToSpecificDate
||Action name|SetSubscriptionCampaignFromDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to a specific date.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SetSubscriptionCampaignInstanceFromToDate
||Action name|SetSubscriptionCampaignInstanceFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.|
||Return value|{{boolean}}: Returns true if the date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignParameter
||Action name|SetSubscriptionCampaignParameter|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignParameter}}|
||Available from core version|8.7|
||Description|An action to set subscriptionCampaign parameters.|
||Return value|{{void}}: No return value.|
||Properties|# parameterName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{String}}: value
|
h4.SetSubscriptionCampaignToDateRestOfMonth
||Action name|SetSubscriptionCampaignToDateRestOfMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth}}|
||Available from core version|8.7|
||Description|This action sets the toDate on a subscriptionCampaign to the end of the current month.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign.|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignToDateToSpecificDate
||Action name|SetSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SubCampaignSetParameter
||Action name|SubCampaignSetParameter|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameter}}|
||Available from core version|8.7|
||Description|This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# paramName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{Subscription}}: sub
# {{ServiceOptionParameter}}: sop
|
h4.SubCampaignSetParameterFromSOP
||Action name|SubCampaignSetParameterFromSOP|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameterFromSOP}}|
||Available from core version|8.7|
||Description|This action updates a subscription campaign parameter from a service option parameter with a given key.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
# paramName: The name of the subscription campaign parameter that should be set.
# parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.
|
||Parameters|# {{SubscriptionBundle}}: bundle
|
h4.SubscriptionCampaignReader
||Action name|SubscriptionCampaignReader|
||Class name|{{com.cdrator.campaign.action.SubscriptionCampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a subscription campaign based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.TerminateCampaignWithFromDate
||Action name|TerminateCampaignWithFromDate|
||Class name|{{com.cdrator.campaign.action.TerminateCampaignWithFromDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h3.Campaign - Bundle
h4.BundleReader
||Action name|BundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.BundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Bundle definition based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveSubscriptionBundlesDefinedByDate
||Action name|GetActiveSubscriptionBundlesDefinedByDate|
||Class name|{{com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate}}|
||Available from core version|8.7|
||Description|Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: date
|
h4.GetBundleForCampaignAndBundleKey
||Action name|GetBundleForCampaignAndBundleKey|
||Class name|{{com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey}}|
||Available from core version|8.7|
||Description|This action returns the bundle associated with the supplied campaign and bundleKey.|
||Return value|{{Bundle}}: The bundle associated with the supplied campaign and bundleKey.|
||Properties| |
||Parameters|# {{Campaign}}: campaign
# {{String}}: bundleKey
|
h4.GetCurrentSubscriptionBundlesNotUsedUpForCode
||Action name|GetCurrentSubscriptionBundlesNotUsedUpForCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleParameter
||Action name|GetSubscriptionBundleParameter|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter}}|
||Available from core version|8.7|
||Description|Finds a bundle parameter from a SubscriptionBundle.|
||Return value|{{String}}: The value of the Bundle parameter.|
||Properties|# optionKey: The parameter that should be read from the Bundle.
|
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundles
||Action name|GetSubscriptionBundles|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundles}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription.|
||Return value|{{ArrayList}}: The value of the Bundle parameter.|
||Properties|# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundlesWithCode
||Action name|GetSubscriptionBundlesWithCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleType
||Action name|GetSubscriptionBundleType|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleType}}|
||Available from core version|8.7|
||Description|Finds the type of a SubscriptionBundle.|
||Return value|{{String}}: The code of the SubscriptionBundle.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundleValue
||Action name|GetSubscriptionBundleValue|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue}}|
||Available from core version|8.7|
||Description|Get the defined Value field in the subscription bundle for the specified bundle.|
||Return value|{{Amount}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{Subscription}}: subscription
|
h4.IsSubscriptionBundleUsedUp
||Action name|IsSubscriptionBundleUsedUp|
||Class name|{{com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp}}|
||Available from core version|8.7|
||Description|Determines if a given subscription bundle is used up by comparing the maximum value with the current value.|
||Return value|{{boolean}}: True if the subscription bundle is completely used up, false otherwise.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.ProrateActivationSubscriptionCampaignBundles
||Action name|ProrateActivationSubscriptionCampaignBundles|
||Class name|{{com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles}}|
||Available from core version|8.7|
||Description|Create and prorate the bundles of the given subscription campaign for a certain start date.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign with the updated bundles|
||Properties|# roundPrecission: The precission used when rounding the bundles.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: fromDate
|
h4.SetSubscriptionBundleValueFromServiceOptionParameter
||Action name|SetSubscriptionBundleValueFromServiceOptionParameter|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified service option parameter.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{SubscriptionBundle}}: subscriptionBundle
|
h4.SetSubscriptionBundleValues
||Action name|SetSubscriptionBundleValues|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified bundles.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# value1: Set value 1
# value2: Set value 2
# value3: Set value 3
# value4: Set value 4
|
||Parameters|# {{String}}: value
# {{Subscription}}: subscription
|
h4.SubscriptionBundleReader
||Action name|SubscriptionBundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.SubscriptionBundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription Bundle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Correspondence - Archive
h4.DocArchiveReader
||Action name|DocArchiveReader|
||Class name|{{com.cdrator.correspondence.archive.action.DocArchiveReader}}|
||Available from core version|8.7|
||Description|Retrieves a DocArchive entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveDocArchiveFile
||Action name|SaveDocArchiveFile|
||Class name|{{com.cdrator.correspondence.archive.action.SaveDocArchiveFile}}|
||Available from core version|8.7|
||Description|If property FilePath is set, it will override the FilePath parameter. Throws ActionParameterException if neither is specified|
||Return value|{{void}}: No value returned|
||Properties|# filePath: FilePath
|
||Parameters|# {{DocArchive}}: archive
# {{String}}: filePathParameter
|
h3.Device
h4.DeviceReader
||Action name|DeviceReader|
||Class name|{{com.cdrator.device.action.DeviceReader}}|
||Available from core version|8.7|
||Description|Retrieves a Device based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Device - Cdmaphone
h4.CdmaPhoneReader
||Action name|CdmaPhoneReader|
||Class name|{{com.cdrator.device.cdmaphone.action.CdmaPhoneReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDMA phone based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Fraud - Addresscheck
h4.PerformAddressCheck
||Action name|PerformAddressCheck|
||Class name|{{com.cdrator.fraud.addresscheck.action.PerformAddressCheck}}|
||Available from core version|8.7|
||Description|This action performs an address check on a user.|
||Return value|{{AddressCheckResult}}: The AddressCheckResult is returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{AddressCheck}}: ac
|
h3.Fraud - Creditcheck
h4.PerformCreditCheck
||Action name|PerformCreditCheck|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheck}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{CreditCheck}}: cc
|
h4.PerformCreditCheckOnUser
||Action name|PerformCreditCheckOnUser|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheckOnUser}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
|
h3.Main - Account
h4.AccountIsNewSignupAllowed
||Action name|AccountIsNewSignupAllowed|
||Class name|{{com.cdrator.main.account.action.AccountIsNewSignupAllowed}}|
||Available from core version|8.7|
||Description|This action check if it is allowed to add a new subscription to an account |
||Return value|{{boolean}}: true(default) or false based on workflow with hook_point SUB_SIGNUP_ALLOWED.|
||Properties| |
||Parameters|# {{Account}}: account
|
h4.AccountReader
||Action name|AccountReader|
||Class name|{{com.cdrator.main.account.action.AccountReader}}|
||Available from core version|8.7|
||Description|Retrieves an Account based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AddAccountWarning
||Action name|AddAccountWarning|
||Class name|{{com.cdrator.main.account.action.AddAccountWarning}}|
||Available from core version|8.7|
||Description|This action adds a warning to an account.
You can use the FormatString action to format the warning before calling this activity|
||Return value|{{void}}: No return value.|
||Properties|# category: null
|
||Parameters|# {{Account}}: account
# {{String}}: key
# {{String}}: description
# {{PersistentObject}}: sourcePO
# {{Date}}: expireDate
|
h4.AddWorkflowToAccount
||Action name|AddWorkflowToAccount|
||Class name|{{com.cdrator.main.account.action.AddWorkflowToAccount}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the WfWorkflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Account}}: account
# {{WfWorkflow}}: wfWorkflow
|
h4.CheckIfAccountInState
||Action name|CheckIfAccountInState|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountInState}}|
||Available from core version|8.7|
||Description|This action checks if an account is in one of the given states.|
||Return value|{{Boolean}}: Returns TRUE if the account state matches one of the given states.|
||Properties|# possibleStates: The possible states separated by ';'
|
||Parameters|# {{Account}}: account
|
h4.CheckIfAccountIsClosed
||Action name|CheckIfAccountIsClosed|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountIsClosed}}|
||Available from core version|8.7|
||Description|This action checks if an account is closed.|
||Return value|{{Boolean}}: Returns TRUE if the account is closed.|
||Properties| |
||Parameters|# {{Account}}: account
|
h3.Main
h4.ProductMakeSubscription
||Action name|ProductMakeSubscription|
||Class name|{{com.cdrator.main.action.ProductMakeSubscription}}|
||Available from core version|8.7|
||Description|This action creates a subscription based on the supplied product configuration, account and billing group.|
||Return value|{{Subscription}}: Returns the newly created subscription.|
||Properties| |
||Parameters|# {{ProductConfig}}: productConfig
# {{Account}}: account
# {{BillingGroup}}: billingGroup
|
h3.Main - Alert
h4.AlertGroupReader
||Action name|AlertGroupReader|
||Class name|{{com.cdrator.main.alert.action.AlertGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves an AlertGroup based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Operator
h4.OperatorAuthentication
||Action name|OperatorAuthentication|
||Class name|{{com.cdrator.main.operator.action.OperatorAuthentication}}|
||Available from core version|8.7|
||Description|This action authenticates the operator based on the username and password provided. If username or password are null or empty, null is returned.|
||Return value|{{Operators}}: The operator matching the username and password. Otherwise null.|
||Properties| |
||Parameters|# {{String}}: username
# {{String}}: password
|
h4.OperatorHookpointBlockRevoke
||Action name|OperatorHookpointBlockRevoke|
||Class name|{{com.cdrator.main.operator.action.OperatorHookpointBlockRevoke}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{OperatorAccessTags}}: The operator access tag matching the username and hookpoint key. Otherwise null.|
||Properties|# accessTagPostfix: Alternative access tag postfix. Default is _BLOCK_REVOKED
|
||Parameters|# {{String}}: username
# {{String}}: hookpointKey
|
h4.OperatorReader
||Action name|OperatorReader|
||Class name|{{com.cdrator.main.operator.action.OperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves an Operator based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OperatorTypeReader
||Action name|OperatorTypeReader|
||Class name|{{com.cdrator.main.operator.action.OperatorTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an operator type based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Service
h4.ChangeDevice
||Action name|ChangeDevice|
||Class name|{{com.cdrator.main.service.action.ChangeDevice}}|
||Available from core version|8.7|
||Description|This action assigns a device to a given service.|
||Return value|{{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.|
||Properties|# autoAssignDevice: Auto assign device? If true, then newDevice parameter will be disregarded and the underlying workflow will assign a device automatically.
|
||Parameters|# {{Service}}: service
# {{Device}}: newDevice
# {{boolean}}: addFee
# {{String}}: sendType
# {{Status}}: reason
# {{String}}: comment
|
h4.ChangeServiceStatus
||Action name|ChangeServiceStatus|
||Class name|{{com.cdrator.main.service.action.ChangeServiceStatus}}|
||Available from core version|8.7|
||Description|This action sets and saves the Service status. |
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{Service}}: service
|
h4.CompleteCachedOptions
||Action name|CompleteCachedOptions|
||Class name|{{com.cdrator.main.service.action.CompleteCachedOptions}}|
||Available from core version|8.7|
||Description|Complete cached options on service|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceCode
||Action name|GetServiceCode|
||Class name|{{com.cdrator.main.service.action.GetServiceCode}}|
||Available from core version|8.7|
||Description|Return the code of the service.|
||Return value|{{String}}: The code of the service.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceFromPhoneNumber
||Action name|GetServiceFromPhoneNumber|
||Class name|{{com.cdrator.main.service.action.GetServiceFromPhoneNumber}}|
||Available from core version|8.7|
||Description|This action gets an active service from the phone number and optionally the brand.|
||Return value|{{Service}}: The active service matching the phone number and brand.|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.main.service.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|This action gets a service option parameter given an option key and a parameter key.|
||Return value|{{ServiceOptionParameter}}: The service option parameter. If the service does not have the service option or the service option parameter, null is returned.|
||Properties|# optionKey: The option key to look for on service.
|
||Parameters|# {{Service}}: service
# {{String}}: parameterKey
|
h4.GetServicesForAccountAndProduct
||Action name|GetServicesForAccountAndProduct|
||Class name|{{com.cdrator.main.service.action.GetServicesForAccountAndProduct}}|
||Available from core version|8.7|
||Description|Return a list of services belonging to the account, with the a specific product code and with the status selected.|
||Return value|{{ArrayList}}: The list of recovered services, based on the input parameters.|
||Properties|# productIdDescription: The product for the service. If empty all services will be returned.
# serviceStatus: The service status. If empty all services will be returned.
|
||Parameters|# {{Account}}: account
|
h3.Main - Subscription
h4.ActivateSubscription
||Action name|ActivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ActivateSubscription}}|
||Available from core version|8.7|
||Description|This action activates a subscription in Rator.|
||Return value|{{Subscription}}: Returns the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.AddWorkflow
||Action name|AddWorkflow|
||Class name|{{com.cdrator.main.subscription.action.AddWorkflow}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the workflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{WfWorkflow}}: workflow
|
h4.ChangeRatePlan
||Action name|ChangeRatePlan|
||Class name|{{com.cdrator.main.subscription.action.ChangeRatePlan}}|
||Available from core version|8.7|
||Description|This action schedules a rateplan change.|
||Return value|{{RatePlanChange}}: Sets up, saves and returns a rate plan change.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{RatePlan}}: newRatePlan
# {{Product}}: newProduct
# {{Date}}: changeDate
# {{ArrayList}}: options
|
h4.CheckIfParentSubscriptionIsInState
||Action name|CheckIfParentSubscriptionIsInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfParentSubscriptionIsInState}}|
||Available from core version|8.7|
||Description|This action checks if a parent subscription is in a given state.|
||Return value|{{boolean}}: Returns true if the parent exists and state matches the given state.|
||Properties|# controlState: The available states.
|
||Parameters|# {{Subscription}}: subscription
|
h4.CheckIfSubscriptionInState
||Action name|CheckIfSubscriptionInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfSubscriptionInState}}|
||Available from core version|8.7|
||Description|This action checks if a subscription is in given states.|
||Return value|{{boolean}}: Returns YES if the subscription state matches one of the given states.|
||Properties|# possibleState: The possible states separated by ';'
|
||Parameters|# {{Subscription}}: subscription
|
h4.CreateSubscriptionTerminationRequest
||Action name|CreateSubscriptionTerminationRequest|
||Class name|{{com.cdrator.main.subscription.action.CreateSubscriptionTerminationRequest}}|
||Available from core version|8.7|
||Description|This action assembles subscription termination details in a termination request.|
||Return value|{{SubscriptionTerminationRequest}}: The constructed termination request object.|
||Properties|# addTerminationFee: If termination fee should be added. Default is false.
# terminationReason: Set the terminate reason text.
# terminationReasonID: Set the terminate reason id.
|
||Parameters|# {{String}}: comment
# {{Date}}: expectedTerminationDate
# {{Date}}: terminationOrderDate
# {{Date}}: endBillingDate
# {{Date}}: chargeUntilDate
# {{boolean}}: canContactCustomer
|
h4.DeepSave
||Action name|DeepSave|
||Class name|{{com.cdrator.main.subscription.action.DeepSave}}|
||Available from core version|8.7|
||Description|This action deep-saves a subscription in Rator.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetActiveBillingGroupOfSubscription
||Action name|GetActiveBillingGroupOfSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetActiveBillingGroupOfSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the active billing group of the subscription|
||Return value|{{BillingGroup}}: The active billing group of the subscription|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllActiveWorkflowsForSubscription
||Action name|GetAllActiveWorkflowsForSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscription}}|
||Available from core version|8.7|
||Description|This action returns all active workflows for a subscription.|
||Return value|{{ArrayList}}: An arrayList of workflows.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllChildSubscriptions
||Action name|GetAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.GetAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action returns all child subscriptions of a given subscription.|
||Return value|{{List}}: A list of child subscriptions.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Broker}}: broker
|
h4.IsSubscriptionActive
||Action name|IsSubscriptionActive|
||Class name|{{com.cdrator.main.subscription.action.IsSubscriptionActive}}|
||Available from core version|8.7|
||Description|Checks if the subscription is active|
||Return value|{{boolean}}: Returns true if the subscription is active|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptions
||Action name|ReactivateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptionsInList
||Action name|ReactivateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{List}}: subscriptions
|
h4.ReactivateSubscription
||Action name|ReactivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscription}}|
||Available from core version|8.7|
||Description|This action reactivates a subscription by setting the end date to null and the status to active.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateSubscriptionCore
||Action name|ReactivateSubscriptionCore|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscriptionCore}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{SubscriptionTermination}}: The Subscription Termination connected to the termination|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetAlertGroup
||Action name|SetAlertGroup|
||Class name|{{com.cdrator.main.subscription.action.SetAlertGroup}}|
||Available from core version|8.7|
||Description|An action to set the alert group on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{AlertGroup}}: alertGroup
|
h4.SetOwner
||Action name|SetOwner|
||Class name|{{com.cdrator.main.subscription.action.SetOwner}}|
||Available from core version|8.7|
||Description|This action sets the owner of a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Users}}: owner
|
h4.SetSubscriptionEndDate
||Action name|SetSubscriptionEndDate|
||Class name|{{com.cdrator.main.subscription.action.SetSubscriptionEndDate}}|
||Available from core version|8.7|
||Description|This action sets the subscription end date and saves the subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: endDate
|
h4.SubscriptionHasServiceCode
||Action name|SubscriptionHasServiceCode|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionHasServiceCode}}|
||Available from core version|8.7|
||Description|Determines whether or not the transfer of a subscription to another account is approved.|
||Return value|{{Boolean}}: Boolean result indicating whether or not this subscription transfer is approved.|
||Properties|# serviceCode: The service code to check for.
|
||Parameters|# {{Subscription}}: subscription
|
h4.SubscriptionReader
||Action name|SubscriptionReader|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SubscriptionSalesDetails
||Action name|SubscriptionSalesDetails|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionSalesDetails}}|
||Available from core version|8.7|
||Description|This action sets a sales rep and a sales store on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: salesRep
# {{String}}: salesStore
|
h4.SubscriptionTransferTo
||Action name|SubscriptionTransferTo|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferTo}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
|
h4.SubscriptionTransferToWithParent
||Action name|SubscriptionTransferToWithParent|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferToWithParent}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
# {{Subscription}}: newParentSubscription
|
h4.TerminateAllChildSubscriptions
||Action name|TerminateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.TerminateAllChildSubscriptionsInList
||Action name|TerminateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties|# consolidateFinalFees: Set consolidate final fees. Default is false.
# disregardBindingPeriod: Set disregard binding period. Default is false.
# endBillingDate: Set end billing date. Default is null.
# finalizeFees: Set finalize fees. Default is false.
|
||Parameters|# {{List}}: subscriptions
# {{Subscription}}: parentSubscription
|
h4.TerminateSubscription
||Action name|TerminateSubscription|
||Class name|{{com.cdrator.main.subscription.action.TerminateSubscription}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: No return value.|
||Properties|# terminateChildSubscriptions: Terminate the child subscriptions (if any) with same termination details as the parent subscription.
|
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionTerminationRequest}}: subscriptionTerminationRequest
|
h3.Main - Subscription - Lockin
h4.CreateNewSubscriptionLockin
||Action name|CreateNewSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.CreateNewSubscriptionLockin}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{SubscriptionLockin}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionLockinType}}: subscriptionLockinType
|
h4.GetAllSubscriptionLockins
||Action name|GetAllSubscriptionLockins|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetAllSubscriptionLockins}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-ins for a given subscription.|
||Return value|{{ArrayList}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionLockinTypes
||Action name|GetSubscriptionLockinTypes|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetSubscriptionLockinTypes}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-in types.|
||Return value|{{List}}: Returns a list of subscription lock-in types.|
||Properties| |
||Parameters| |
h4.HasSubscriptionLockin
||Action name|HasSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.HasSubscriptionLockin}}|
||Available from core version|8.7|
||Description|This action checks if a subscription has a lock-in.|
||Return value|{{String}}: Returns either NO or YES.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetLockinEndDateForLockinWithLeastEndDate
||Action name|SetLockinEndDateForLockinWithLeastEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetLockinEndDateForLockinWithLeastEndDate}}|
||Available from core version|8.7|
||Description|This action updates lockin_end_date of the subscription_lockin with least lockin_end_date and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h4.SetSubscriptionLockinEndDate
||Action name|SetSubscriptionLockinEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate}}|
||Available from core version|8.7|
||Description|This action updates subscription lock-in's end date and saves it. It updates only if a lockin exists.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h3.Main - Subscriptiontermination
h4.DeactivateSubscriptionTermination
||Action name|DeactivateSubscriptionTermination|
||Class name|{{com.cdrator.main.subscriptiontermination.action.DeactivateSubscriptionTermination}}|
||Available from core version|8.7|
||Description|This action deactivates a subscription termination.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SubscriptionTermination}}: subscriptionTermination
|
h3.Main - User
h4.CheckUsernameAvailability
||Action name|CheckUsernameAvailability|
||Class name|{{com.cdrator.main.user.action.CheckUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given username is available.|
||Return value|{{boolean}}: boolean true if the username is available (no user exists with the usename), else false|
||Properties|# caseSensitive: Is the username case sensitive?
|
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetAddress
||Action name|GetAddress|
||Class name|{{com.cdrator.main.user.action.GetAddress}}|
||Available from core version|8.7|
||Description|Action to create and save a new Address object based on the address information of the user passed as argument.|
||Return value|{{Address}}: Returns the newly created Address object.|
||Properties|# doSetCoFromAddress2: Specify whether or not the Address field CO should be set from user.address2.
|
||Parameters|# {{Users}}: user
|
h4.GetUserAccessLevel
||Action name|GetUserAccessLevel|
||Class name|{{com.cdrator.main.user.action.GetUserAccessLevel}}|
||Available from core version|8.7|
||Description|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.|
||Return 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|
||Properties| |
||Parameters|# {{Users}}: user
|
h4.GetUserByEmailAddress
||Action name|GetUserByEmailAddress|
||Class name|{{com.cdrator.main.user.action.GetUserByEmailAddress}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the email address exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: emailAddress
# {{Brand}}: brand
|
h4.GetUserByPhoneNumber
||Action name|GetUserByPhoneNumber|
||Class name|{{com.cdrator.main.user.action.GetUserByPhoneNumber}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the phone number exists. The value null is returned if none exists.|
||Properties|# cancelationPending: Include subscriptions in cancelation pending status.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetUserByUsername
||Action name|GetUserByUsername|
||Class name|{{com.cdrator.main.user.action.GetUserByUsername}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the username exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetUsersByPersonalIDHash
||Action name|GetUsersByPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.GetUsersByPersonalIDHash}}|
||Available from core version|8.7|
||Description|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 http://jira.cdrator.com/browse/CDRP-5401|
||Return value|{{ArrayList}}: An ArrayList of users matching the given personalID. If none exists, an empty ArrayList is returned.|
||Properties|# 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.
|
||Parameters|# {{String}}: personalIDInput
|
h4.SetNewPassword
||Action name|SetNewPassword|
||Class name|{{com.cdrator.main.user.action.SetNewPassword}}|
||Available from core version|8.7|
||Description|This action changes the password of a user. If password is blank, a password will be generated.|
||Return value|{{String}}: The new password.|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h4.SetPersonalIDHash
||Action name|SetPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.SetPersonalIDHash}}|
||Available from core version|8.7|
||Description|This action adds a PersonalID entry for a User. The input parameter must already be hashed/encrypted if so desired.|
||Return value|{{void}}: No return value.|
||Properties|# endDateLastPeriod: To set expiry date on personal id.
# personalIDType: The personal ID type
|
||Parameters|# {{Users}}: user
# {{String}}: hashedPersonalID
|
h4.SetUserAsAccountOwner
||Action name|SetUserAsAccountOwner|
||Class name|{{com.cdrator.main.user.action.SetUserAsAccountOwner}}|
||Available from core version|8.7|
||Description|This action sets the user as account owner. Both user and account is saved.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Users}}: user
# {{Account}}: account
|
h4.UserReader
||Action name|UserReader|
||Class name|{{com.cdrator.main.user.action.UserReader}}|
||Available from core version|8.7|
||Description|Retrieves a User based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - User - Login
h4.LoginUserWithAttemptsCount
||Action name|LoginUserWithAttemptsCount|
||Class name|{{com.cdrator.main.user.login.action.LoginUserWithAttemptsCount}}|
||Available from core version|8.7|
||Description|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)|
||Return value|{{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|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h3.Misc
h4.CreateLongDescriptionElementList
||Action name|CreateLongDescriptionElementList|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElementList}}|
||Available from core version|8.7|
||Description|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()'|
||Return value|{{List}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs. It must be a regular expression. Example : ',|
|
| ' will split at , and newline
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
# {{List}}: addToExistingList
|
h4.CreateLongDescriptionElements
||Action name|CreateLongDescriptionElements|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElements}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{ArrayList}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs.
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FileObjectReader
||Action name|FileObjectReader|
||Class name|{{com.cdrator.misc.action.FileObjectReader}}|
||Available from core version|8.7|
||Description|Retrieves a File Object based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.MailTemplateReader
||Action name|MailTemplateReader|
||Class name|{{com.cdrator.misc.action.MailTemplateReader}}|
||Available from core version|8.7|
||Description|Retrieves a Mail Template based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Misc - Barcodes
h4.GenerateQRCodeImage
||Action name|GenerateQRCodeImage|
||Class name|{{com.cdrator.misc.barcodes.action.GenerateQRCodeImage}}|
||Available from core version|8.7|
||Description|This action retrieves an Image of a QR code of the specified content having the specified size |
||Return value|{{Image}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{int}}: width
# {{int}}: height
# {{String}}: content
|
h3.Np
h4.LookupActiveNpFlow
||Action name|LookupActiveNpFlow|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlow}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow of a given phone number and (optionally) brand (via the subscription).|
||Return value|{{NpFlow}}: The NP Flow matching the phone number and the brand.|
||Properties|# ignoreBrand: Ignore the brand connected to the NP Flow.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.LookupActiveNpFlowBySubscription
||Action name|LookupActiveNpFlowBySubscription|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlowBySubscription}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow for a given subscription.|
||Return value|{{NpFlow}}: The active NP Flow from the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.NpFlowReader
||Action name|NpFlowReader|
||Class name|{{com.cdrator.np.action.NpFlowReader}}|
||Available from core version|8.7|
||Description|Retrieves an NP flow based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveNpFlow
||Action name|SaveNpFlow|
||Class name|{{com.cdrator.np.action.SaveNpFlow}}|
||Available from core version|8.7|
||Description|Sets some initial values on np flow.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{NpFlow}}: npFlow
|
h4.SetRejectCodeOnExportFlow
||Action name|SetRejectCodeOnExportFlow|
||Class name|{{com.cdrator.np.action.SetRejectCodeOnExportFlow}}|
||Available from core version|8.7|
||Description|Set Reject Code and Comment On an Np Export Flow object.|
||Return value|{{void}}: No return value.|
||Properties|# comment: Used for adding a static comment.
# rejectCode: Used for adding reject code.
|
||Parameters|# {{NpExportFlow}}: npFlow
# {{String}}: dynamicComment
|
h4.TeleOperatorReader
||Action name|TeleOperatorReader|
||Class name|{{com.cdrator.np.action.TeleOperatorReader}}|
||Available from core version|8.7|
||Description|Retrievse a tele operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Np - Range
h4.CheckOverlappingRange
||Action name|CheckOverlappingRange|
||Class name|{{com.cdrator.np.range.action.CheckOverlappingRange}}|
||Available from core version|8.7|
||Description|Check if the ranges are overlapping|
||Return value|{{boolean}}: A boolean indicating whether the two ranges overlap each other, fully or partially|
||Properties| |
||Parameters|# {{String}}: newRange
# {{String}}: existingRange
|
h3.Number
h4.AnumberReader
||Action name|AnumberReader|
||Class name|{{com.cdrator.number.action.AnumberReader}}|
||Available from core version|8.7|
||Description|Retrieves an A-number based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AssignAnumberToService
||Action name|AssignAnumberToService|
||Class name|{{com.cdrator.number.action.AssignAnumberToService}}|
||Available from core version|8.7|
||Description|Sets Anumber on Service (Only relevant for Service types with phone numbers.)|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Service}}: service
|
h4.GetANumbersForNumberSearchExact
||Action name|GetANumbersForNumberSearchExact|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchExact}}|
||Available from core version|8.7|
||Description|This action will return the list of anumbers that are exact match of the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchLastDigits
||Action name|GetANumbersForNumberSearchLastDigits|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchLastDigits}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers ending with the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchPattern
||Action name|GetANumbersForNumberSearchPattern|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchPattern}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers that contain the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchRandom
||Action name|GetANumbersForNumberSearchRandom|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchRandom}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random phone numbers according to the group_id.|
||Return value|{{ArrayList}}: List of phone numbers.|
||Properties|# batchLimit: Batch limit to fetch anumbers.
|
||Parameters|# {{Anumber_Group}}: group
# {{int}}: maxRows
|
h4.IsAnumberFree
||Action name|IsAnumberFree|
||Class name|{{com.cdrator.number.action.IsAnumberFree}}|
||Available from core version|8.7|
||Description|Given a phone number, checks if the related anumber is free.|
||Return value|{{boolean}}: True, if the anumber for the phone number is free, else False|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.ReReserveAnumber
||Action name|ReReserveAnumber|
||Class name|{{com.cdrator.number.action.ReReserveAnumber}}|
||Available from core version|8.7|
||Description|Re-reserves an already reserved anumber, if the number is not in use and already reserved with the given id.|
||Return value|{{boolean}}: Returns: boolean true if the number could be re-reserved|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{String}}: reservationId
# {{int}}: reserveTime
|
h4.SetAnumberReservToDate
||Action name|SetAnumberReservToDate|
||Class name|{{com.cdrator.number.action.SetAnumberReservToDate}}|
||Available from core version|8.7|
||Description|Sets the reservToDate on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Date}}: reservToDate
|
h4.SetAnumberStatus
||Action name|SetAnumberStatus|
||Class name|{{com.cdrator.number.action.SetAnumberStatus}}|
||Available from core version|8.7|
||Description|Sets status on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{StatusAnumber}}: status
|
h4.ValidateAnumberReservation
||Action name|ValidateAnumberReservation|
||Class name|{{com.cdrator.number.action.ValidateAnumberReservation}}|
||Available from core version|8.7|
||Description|This action validates that an a-number matches a reservation id, that the a-number has status not used and that the reservation has not expired.|
||Return value|{{boolean}}: boolean true if reservation ID is still valid for the A-number, false otherwise.|
||Properties| |
||Parameters|# {{String}}: anumber
# {{String}}: reservationId
|
h3.Persistence
h4.CheckIfPersisted
||Action name|CheckIfPersisted|
||Class name|{{com.cdrator.persistence.action.CheckIfPersisted}}|
||Available from core version|8.7|
||Description|Check if an object is persisted|
||Return value|{{boolean}}: A boolean indicating whether the object is persisted or not.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Product
h4.ChangeAnumberGroup
||Action name|ChangeAnumberGroup|
||Class name|{{com.cdrator.product.action.ChangeAnumberGroup}}|
||Available from core version|8.7|
||Description|Sets the group on an A-number and saves it.|
||Return value|{{Anumber}}: Returns the updated A-number.|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Anumber_Group}}: group
|
h4.CheckProductServiceClassCode
||Action name|CheckProductServiceClassCode|
||Class name|{{com.cdrator.product.action.CheckProductServiceClassCode}}|
||Available from core version|8.7|
||Description|This action checks the products service class code.|
||Return value|{{boolean}}: Returns true if the product matches the service class configured.|
||Properties|# serviceClassCode: The service class code to check for.
|
||Parameters|# {{Product}}: product
|
h4.CreateCdmaPhoneForMeid
||Action name|CreateCdmaPhoneForMeid|
||Class name|{{com.cdrator.product.action.CreateCdmaPhoneForMeid}}|
||Available from core version|8.7|
||Description|This action creates a CdmaPhone based on the supplied MEID.|
||Return value|{{CdmaPhone}}: The cdmaPhone created is returned.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: meid
|
h4.FilterProductConfigsByShop
||Action name|FilterProductConfigsByShop|
||Class name|{{com.cdrator.product.action.FilterProductConfigsByShop}}|
||Available from core version|8.7|
||Description|This action filters an existing list of product configurations so only the ones set up for the shop is returned.|
||Return value|{{List}}: A list of product configs defined for the shop.|
||Properties| |
||Parameters|# {{List}}: productConfigs
# {{Shop}}: shop
|
h4.MakeSubscription
||Action name|MakeSubscription|
||Class name|{{com.cdrator.product.action.MakeSubscription}}|
||Available from core version|8.7|
||Description|Creates a new subscription, and a service, for a given product on a given account, billing group and user.|
||Return value|{{Subscription}}: Returns the subscription|
||Properties| |
||Parameters|# {{Account}}: account
# {{BillingGroup}}: bg
# {{ProductConfig}}: pc
# {{Users}}: user
|
h4.ProductConfigReader
||Action name|ProductConfigReader|
||Class name|{{com.cdrator.product.action.ProductConfigReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Config based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProductReader
||Action name|ProductReader|
||Class name|{{com.cdrator.product.action.ProductReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.RemoveSharedServiceMemberEndDate
||Action name|RemoveSharedServiceMemberEndDate|
||Class name|{{com.cdrator.product.action.RemoveSharedServiceMemberEndDate}}|
||Available from core version|8.7|
||Description|This action removes the end date of a sharedServiceMember.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SharedServiceMember}}: sharedServiceMember
|
h4.ReserveCdmaPhoneForService
||Action name|ReserveCdmaPhoneForService|
||Class name|{{com.cdrator.product.action.ReserveCdmaPhoneForService}}|
||Available from core version|8.7|
||Description|This action reserves a CdmaPhone for a service.|
||Return value|{{CdmaPhone}}: The CdmaPhone is returned.|
||Properties| |
||Parameters|# {{CdmaPhone}}: cdmaPhone
# {{Service}}: service
|
h3.Product - Option
h4.CompareSubscribedProductOptionParameter
||Action name|CompareSubscribedProductOptionParameter|
||Class name|{{com.cdrator.product.option.action.CompareSubscribedProductOptionParameter}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for.
# parameterKey: The parameter key that we are searching for.
|
||Parameters|# {{Service}}: service
# {{String}}: compareValue
|
h4.ExistsActiveCampaignForEqualOrHigherPackage
||Action name|ExistsActiveCampaignForEqualOrHigherPackage|
||Class name|{{com.cdrator.product.option.action.ExistsActiveCampaignForEqualOrHigherPackage}}|
||Available from core version|8.7|
||Description|Checks if there is campaign for equal or higher package option|
||Return value|{{boolean}}: If there is an active subscriptionCampaign associated to a greater or equal package option returns true|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Subscription}}: subscription
|
h4.GetLowestSubscribedOption
||Action name|GetLowestSubscribedOption|
||Class name|{{com.cdrator.product.option.action.GetLowestSubscribedOption}}|
||Available from core version|8.7|
||Description|Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Return value|{{ProductOption}}: Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
|
h4.GetOptionMetaData
||Action name|GetOptionMetaData|
||Class name|{{com.cdrator.product.option.action.GetOptionMetaData}}|
||Available from core version|8.7|
||Description|This action returns the meta data on an option based on the Option and the Metadata name.|
||Return value|{{ProductOptionMetaData}}: The ProductOptionMetaData for the option and Metadata name. If not found, null is returned.|
||Properties| |
||Parameters|# {{Option}}: option
# {{String}}: metaDataName
|
h4.GetOptionPriceElementsForProductRatePlanAndCategory
||Action name|GetOptionPriceElementsForProductRatePlanAndCategory|
||Class name|{{com.cdrator.product.option.action.GetOptionPriceElementsForProductRatePlanAndCategory}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan, product and category.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time. When category is set cache is always enabled.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
# {{String}}: category
|
h4.GetOptionsForProductAndRatePlan
||Action name|GetOptionsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Product Option available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: An list of product options.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetOptionsPrice
||Action name|GetOptionsPrice|
||Class name|{{com.cdrator.product.option.action.GetOptionsPrice}}|
||Available from core version|8.7|
||Description|Returns a map of product option id and the related price for the given subscription and product options list.|
||Return value|{{Hashtable}}: Returns a map of product option id and the related price.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: optionsList
|
h4.GetOptionsPricesElementsForProductAndRatePlan
||Action name|GetOptionsPricesElementsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsPricesElementsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetProductOptionsFromService
||Action name|GetProductOptionsFromService|
||Class name|{{com.cdrator.product.option.action.GetProductOptionsFromService}}|
||Available from core version|8.7|
||Description|Returns all the product options subscribed to be the given service.|
||Return value|{{ArrayList}}: An array list of product options.|
||Properties|# onlyActive: If this is set, only serviceOptions that are active will be used to get the productOptions.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOption
||Action name|GetServiceOption|
||Class name|{{com.cdrator.product.option.action.GetServiceOption}}|
||Available from core version|8.7|
||Description|Action to retrieve a service option based on the option key.|
||Return value|{{ServiceOption}}: The service option.|
||Properties|# optionKey: The key of the option that will be retrieved.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOptionForParameterWithSpecifiedObjectReference
||Action name|GetServiceOptionForParameterWithSpecifiedObjectReference|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionForParameterWithSpecifiedObjectReference}}|
||Available from core version|8.7|
||Description|Returns a serviceOption for parameter with matching obejct reference.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
# {{String}}: parameterKey
# {{String}}: objectReferenceClass
# {{String}}: objectReferenceId
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Returns a serviceOptionParameter with the specified parameterKey.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: parameterKey
|
h4.GetServiceOptionRecurrentFee
||Action name|GetServiceOptionRecurrentFee|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionRecurrentFee}}|
||Available from core version|8.7|
||Description|Retrieves the recurrent fee of the service option|
||Return value|{{SubscriptionFees}}: Returns the recurrent fee of the service option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetServiceOptionsByCriteria
||Action name|GetServiceOptionsByCriteria|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionsByCriteria}}|
||Available from core version|8.7|
||Description|Returns a list of service option for a service matching the given criteria.|
||Return value|{{List}}: A List of service options matching given criterias.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: criterias
|
h4.GetSiblingServiceOption
||Action name|GetSiblingServiceOption|
||Class name|{{com.cdrator.product.option.action.GetSiblingServiceOption}}|
||Available from core version|8.7|
||Description|Get the sibling service option of a specific service option if that exists|
||Return value|{{ServiceOption}}: Returns the sibling service option of the current service option if that exists. Otherwise returns null|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetTotalPriceForOptionChange
||Action name|GetTotalPriceForOptionChange|
||Class name|{{com.cdrator.product.option.action.GetTotalPriceForOptionChange}}|
||Available from core version|8.7|
||Description|Compares the two list and returns the total price of the change|
||Return value|{{Amount}}: The total price as an amount|
||Properties| |
||Parameters|# {{List}}: oldOptions
# {{List}}: newOptions
|
h4.HasSiblingOptionLowerPackageWeight
||Action name|HasSiblingOptionLowerPackageWeight|
||Class name|{{com.cdrator.product.option.action.HasSiblingOptionLowerPackageWeight}}|
||Available from core version|8.7|
||Description|Checks if the sibling option has lower package_weight than the current option|
||Return value|{{boolean}}: Returns true if the sibling option has lower package_weight than the current option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{ServiceOption}}: siblingServiceOption
|
h4.HasSubscribedProductOption
||Action name|HasSubscribedProductOption|
||Class name|{{com.cdrator.product.option.action.HasSubscribedProductOption}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for
|
||Parameters|# {{Service}}: service
|
h4.IsOptionInExclusiveGroup
||Action name|IsOptionInExclusiveGroup|
||Class name|{{com.cdrator.product.option.action.IsOptionInExclusiveGroup}}|
||Available from core version|8.7|
||Description|Checks if option belongs to an exclusive group|
||Return value|{{boolean}}: Returns true if the option belongs to an exclusive option group|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.OptionReader
||Action name|OptionReader|
||Class name|{{com.cdrator.product.option.action.OptionReader}}|
||Available from core version|8.7|
||Description|Retrieves an option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OptionStatusChangeActionCheck
||Action name|OptionStatusChangeActionCheck|
||Class name|{{com.cdrator.product.option.action.OptionStatusChangeActionCheck}}|
||Available from core version|8.7|
||Description|Compare the action used in option status_change workflow to a predefined action value|
||Return value|{{boolean}}: If the action equals to the predefined action value it returns true. Otherwise it returns false.|
||Properties|# actionValue: The action value that the action should be compared to
|
||Parameters|# {{String}}: action
|
h4.RemoveListOfServiceOptions
||Action name|RemoveListOfServiceOptions|
||Class name|{{com.cdrator.product.option.action.RemoveListOfServiceOptions}}|
||Available from core version|8.7|
||Description|Removes all service options in a list|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
|
h4.RemovePendingTerminationOption
||Action name|RemovePendingTerminationOption|
||Class name|{{com.cdrator.product.option.action.RemovePendingTerminationOption}}|
||Available from core version|8.7|
||Description|Removes a pending termination option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: action
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.RemoveServiceOption
||Action name|RemoveServiceOption|
||Class name|{{com.cdrator.product.option.action.RemoveServiceOption}}|
||Available from core version|8.7|
||Description|Removes the service option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetEndDateOnServiceOptionList
||Action name|SetEndDateOnServiceOptionList|
||Class name|{{com.cdrator.product.option.action.SetEndDateOnServiceOptionList}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date from a list of options retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
# {{Date}}: date
|
h4.SetServiceOptionEndDateRestOfMonth
||Action name|SetServiceOptionEndDateRestOfMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateRestOfMonth}}|
||Available from core version|8.7|
||Description|Sets the end date of the option.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionEndDateToSpecificDate
||Action name|SetServiceOptionEndDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SetServiceOptionEndDateToStartDate
||Action name|SetServiceOptionEndDateToStartDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToStartDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' endDate to the service option's startDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionParameterValue
||Action name|SetServiceOptionParameterValue|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionParameterValue}}|
||Available from core version|8.7|
||Description|Updates a service option parameter value.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{String}}: newValue
|
h4.SetServiceOptionStartDateToNextMonth
||Action name|SetServiceOptionStartDateToNextMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the first day of next month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionStartDateToSpecificDate
||Action name|SetServiceOptionStartDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SubscribeToProductOption
||Action name|SubscribeToProductOption|
||Class name|{{com.cdrator.product.option.action.SubscribeToProductOption}}|
||Available from core version|8.7|
||Description|Subscribes to a product option for a given service and product option.|
||Return value|{{ServiceOption}}: The service option created by subscribing to the option.|
||Properties|# optionKey: The option key that the service will subscribe to.
|
||Parameters|# {{Service}}: service
|
h4.UnsubscribeOptionsWithCampaigns
||Action name|UnsubscribeOptionsWithCampaigns|
||Class name|{{com.cdrator.product.option.action.UnsubscribeOptionsWithCampaigns}}|
||Available from core version|8.7|
||Description|Unsubscribes to options with campaigns (and only options with a campaign) for a given service.|
||Return value|{{List}}: A list of the unsubscribed service options.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.UnsubscribeToOption
||Action name|UnsubscribeToOption|
||Class name|{{com.cdrator.product.option.action.UnsubscribeToOption}}|
||Available from core version|8.7|
||Description|If there is a dynamic optionkey parameter, it will override the optionkey property unless it is null. If neither option key or dynamic option key is set an Action Parameter Exception is thrown.|
||Return value|{{void}}: No value returned|
||Properties|# makeProvisioningTask: Make provisioning task?
# optionKey: The key of the option that will be unsubscribed
|
||Parameters|# {{Service}}: service
# {{String}}: dynamicOptionKey
|
h4.ValidateOptions
||Action name|ValidateOptions|
||Class name|{{com.cdrator.product.option.action.ValidateOptions}}|
||Available from core version|8.7|
||Description|This action validates that options are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config.|
||Properties| |
||Parameters|# {{List}}: options
# {{ProductConfig}}: productConfig
|
h4.ValidateOptionsRateplan
||Action name|ValidateOptionsRateplan|
||Class name|{{com.cdrator.product.option.action.ValidateOptionsRateplan}}|
||Available from core version|8.7|
||Description|This action validates that the list of options passed as a parameter are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config, false otherwise.|
||Properties| |
||Parameters|# {{List}}: options
# {{RatePlan}}: rateplan
|
h3.Product - Service
h4.AssignCdmaPhoneToService
||Action name|AssignCdmaPhoneToService|
||Class name|{{com.cdrator.product.service.action.AssignCdmaPhoneToService}}|
||Available from core version|8.7|
||Description|This action assigns a cdmaPhone to a service.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has been assigned to the service.|
||Properties| |
||Parameters|# {{CdmaService}}: service
# {{CdmaPhone}}: cdmaPhone
|
h4.CanBlockService
||Action name|CanBlockService|
||Class name|{{com.cdrator.product.service.action.CanBlockService}}|
||Available from core version|8.7|
||Description|This action checks if a service can be blocked.|
||Return value|{{boolean}}: A boolean indicating whether the service can be blocked.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.ReleaseCdmaPhone
||Action name|ReleaseCdmaPhone|
||Class name|{{com.cdrator.product.service.action.ReleaseCdmaPhone}}|
||Available from core version|8.7|
||Description|This action releases the CdmaPhone assigned to the service, if a CdmaPhone exists.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has just been released.|
||Properties| |
||Parameters|# {{CdmaService}}: service
|
h4.ServiceReader
||Action name|ServiceReader|
||Class name|{{com.cdrator.product.service.action.ServiceReader}}|
||Available from core version|8.7|
||Description|Retrieves a service based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Product - Service - Fixed
h4.SetPhoneNumberOnFixedLineService
||Action name|SetPhoneNumberOnFixedLineService|
||Class name|{{com.cdrator.product.service.fixed.action.SetPhoneNumberOnFixedLineService}}|
||Available from core version|8.7|
||Description|This action sets the provided phone number on a fixed line service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h3.Product - Service - Option
h4.GetServiceOptionFromOptionMetaData
||Action name|GetServiceOptionFromOptionMetaData|
||Class name|{{com.cdrator.product.service.option.action.GetServiceOptionFromOptionMetaData}}|
||Available from core version|8.7|
||Description|Search in the list of meta data records linked to the Option, if the service provided is subscribed to a product option key that is in the list then the service option is returned.|
||Return value|{{ServiceOption}}: The first service option found if subscribed to the service and in the meta data option list. Null if service not subscribed to any option in the meta data list.|
||Properties|# isAllowed: Check if the option is allowed or not.
|
||Parameters|# {{Option}}: option
# {{Service}}: service
|
h4.ServiceOptionReader
||Action name|ServiceOptionReader|
||Class name|{{com.cdrator.product.service.option.action.ServiceOptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a service option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SwitchServiceOptionsAction
||Action name|SwitchServiceOptionsAction|
||Class name|{{com.cdrator.product.service.option.action.SwitchServiceOptionsAction}}|
||Available from core version|8.7|
||Description|Unsubscribes a current service option and subscribes to a new option.|
||Return value|{{String}}: The id of the newly subscribed service option.|
||Properties|# makeProvisioningTask: If cached options should be completed or not.
|
||Parameters|# {{Subscription}}: subscription
# {{Option}}: optionToUnSubscribe
# {{Option}}: optionToSubscribe
|
h3.Product - Service - Shared
h4.GetAllNonTerminatedSharedServiceMembers
||Action name|GetAllNonTerminatedSharedServiceMembers|
||Class name|{{com.cdrator.product.service.shared.action.GetAllNonTerminatedSharedServiceMembers}}|
||Available from core version|8.7|
||Description|This action returns a list of all non-terminated (active and cancellation pending) members of a shared service.|
||Return value|{{List}}: A list of all non-terminated members of the shared service.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
|
h4.GetNonTerminatedSharedServiceMember
||Action name|GetNonTerminatedSharedServiceMember|
||Class name|{{com.cdrator.product.service.shared.action.GetNonTerminatedSharedServiceMember}}|
||Available from core version|8.7|
||Description|This action returns the direct member to a shared service.|
||Return value|{{SharedServiceMember}}: The SharedServiceMember of the sharedServiceInterface is returned if found.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
# {{SharedServiceInterface}}: sharedServiceInterface
|
h3.Product - Service - Tele
h4.DisconnectOldSimCards
||Action name|DisconnectOldSimCards|
||Class name|{{com.cdrator.product.service.tele.action.DisconnectOldSimCards}}|
||Available from core version|8.7|
||Description|This action disconnect any old SIMcards related to this TeleService (where TeleService.imsi not like SimCard.imsi ).|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h4.TeleServicePhoneNumber
||Action name|TeleServicePhoneNumber|
||Class name|{{com.cdrator.product.service.tele.action.TeleServicePhoneNumber}}|
||Available from core version|8.7|
||Description|This action sets a phone number on a Tele service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h4.UnBlockTeleService
||Action name|UnBlockTeleService|
||Class name|{{com.cdrator.product.service.tele.action.UnBlockTeleService}}|
||Available from core version|8.7|
||Description|This unblocks a service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h3.Product - Voucher
h4.AssignVoucher
||Action name|AssignVoucher|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucher}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{boolean}}: Boolean with the result of the assignment.|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.AssignVoucherToSubscription
||Action name|AssignVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.ChargeVoucherToSubscription
||Action name|ChargeVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.ChargeVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Charge a voucher to a subscription|
||Return value|{{boolean}}: A boolean value indicating whether the voucher was charged successfully|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.CreateNewVoucher
||Action name|CreateNewVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateNewVoucher}}|
||Available from core version|8.7|
||Description|To be used when a new voucher needs to be created. The keyword which is generated is an alphanumeric code.The length of this code is specified by the property numberOfCharacters. A voucherBatch needs to be passed to this action.|
||Return value|{{Voucher}}: The voucher which was created.|
||Properties|# numberOfCharacters: null
|
||Parameters|# {{VoucherBatch}}: voucherBatch
|
h4.CreateVoucher
||Action name|CreateVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateVoucher}}|
||Available from core version|8.7|
||Description|Creates a new voucher with the specified number of alphanumeric characters for the keyword, voucher code, price code and amount.|
||Return value|{{Voucher}}: The created voucher.|
||Properties|# batchVoucherCode: The voucher code.
# currencyCode: The amount currency code.
# numberOfCharacters: The length of the keyword alphanumeric code.
|
||Parameters|# {{Amount}}: amount
# {{String}}: priceCode
|
h4.GetVouchers
||Action name|GetVouchers|
||Class name|{{com.cdrator.product.voucher.action.GetVouchers}}|
||Available from core version|8.7|
||Description|Returns a list of vouchers|
||Return value|{{Collection}}: List of vouchers related to the batchId and the statusId for a given subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: batchId
# {{String}}: statusId
|
h4.VoucherBatchReader
||Action name|VoucherBatchReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherBatchReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.VoucherReader
||Action name|VoucherReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Provisioning
h4.CreateProvisioningTask
||Action name|CreateProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.CreateProvisioningTask}}|
||Available from core version|8.7|
||Description|Create a provisioning task of a specific type (CODE). The status of the new task will be "New". (the workflow instance can be added using "_activity.getWorkflow()")|
||Return value|{{ProvisioningTask}}: Return response code from ProvisioningRequest object.|
||Properties|# priority: Optional priority of the provisioning task. Default is 5
# taskComments: Optional comments to add to the provisioning task
# taskDescription: Optional description to add to the provisioning task
# taskType: The type of task that should be provisioned
|
||Parameters|# {{Service}}: service
# {{WfWorkflow}}: workflow
|
h4.GetProvisioningRequestsByReference
||Action name|GetProvisioningRequestsByReference|
||Class name|{{com.cdrator.provisioning.action.GetProvisioningRequestsByReference}}|
||Available from core version|8.7|
||Description|Retrieves a List of ProvisioningRequest linked to a ProvisioningTask by reference field.|
||Return value|{{List}}: Returns the ProvisioningRequest linked from the task reference.|
||Properties|# linkedFieldOnRequest: Optional to choose the database field from which to retrieve the reference linking the request to the task. Required to be varchar2 field.
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.GetResponseCodeFromProvisioningRequest
||Action name|GetResponseCodeFromProvisioningRequest|
||Class name|{{com.cdrator.provisioning.action.GetResponseCodeFromProvisioningRequest}}|
||Available from core version|8.7|
||Description|Retrieves the Response Code from a ProvisioningRequest.|
||Return value|{{String}}: Return response code from ProvisioningRequest object.|
||Properties|# responseCodeField: Optional to choose the database field from which to retrieve the response code.
|
||Parameters|# {{ProvisioningRequest}}: request
|
h4.NetworkOperatorReader
||Action name|NetworkOperatorReader|
||Class name|{{com.cdrator.provisioning.action.NetworkOperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves a Network Operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProvisioningTaskReader
||Action name|ProvisioningTaskReader|
||Class name|{{com.cdrator.provisioning.action.ProvisioningTaskReader}}|
||Available from core version|8.7|
||Description|Retrieves a Provisioning Task based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ResetStartDateWithDelayOnProvisioningTask
||Action name|ResetStartDateWithDelayOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.ResetStartDateWithDelayOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Adds the delayInMinutes property to start date on Provisioning Task. If no start date on task, adds delay from current date.|
||Return value|{{void}}: No return values|
||Properties|# delayInMinutes: null
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.SetStatusOnProvisioningTask
||Action name|SetStatusOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.SetStatusOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Set Status for Processing on Provisioning Task.|
||Return value|{{void}}: No return values|
||Properties|# statusToSet: The status that the provisioning task will be set to.
|
||Parameters|# {{ProvisioningTask}}: task
|
h3.RecurrentFee
h4.BillSubscriptionFeeListToInvoiceNow
||Action name|BillSubscriptionFeeListToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeeListToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills the supplied subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{List}}: subscriptionFees
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNow
||Action name|BillSubscriptionFeesToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNowForListOfSubs
||Action name|BillSubscriptionFeesToInvoiceNowForListOfSubs|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNowForListOfSubs}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice for a list of subscriptions.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{Invoice}}: invoice
|
h4.SetFeeChargeDateToSiblingFeeChargeDate
||Action name|SetFeeChargeDateToSiblingFeeChargeDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeChargeDateToSiblingFeeChargeDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to sibling fee's next_charge_date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{SubscriptionFees}}: siblingFee
|
h4.SetFeeEndDateLastPeriod
||Action name|SetFeeEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodForFeeList
||Action name|SetFeeEndDateLastPeriodForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodToEndOfMonth
||Action name|SetFeeEndDateLastPeriodToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
h4.SetFeeNextChargeDateForFeeList
||Action name|SetFeeNextChargeDateForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeNextChargeDateToEndOfMonth
||Action name|SetFeeNextChargeDateToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SetFeeNextChargeDateToSpecificDate
||Action name|SetFeeNextChargeDateToSpecificDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.TerminateFeeFromEndDateLastPeriod
||Action name|TerminateFeeFromEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.TerminateFeeFromEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Terminates the fee from its end_date_last_period|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h3.Shop
h4.CheckShopUsernameAvailability
||Action name|CheckShopUsernameAvailability|
||Class name|{{com.cdrator.shop.action.CheckShopUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given shop user name is available.|
||Return value|{{boolean}}: boolean true if the user name is available (no shop exists with the user name), else false.|
||Properties|# caseSensitive: Is the shop user name case sensitive?
|
||Parameters|# {{String}}: username
|
h4.GetSubscriptionsForSalesStoreEstablishedBetween
||Action name|GetSubscriptionsForSalesStoreEstablishedBetween|
||Class name|{{com.cdrator.shop.action.GetSubscriptionsForSalesStoreEstablishedBetween}}|
||Available from core version|8.7|
||Description|Finds subscriptions with a specific sales store established between two dates|
||Return value|{{ArrayList}}: Subscriptions|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.SetShopParentId
||Action name|SetShopParentId|
||Class name|{{com.cdrator.shop.action.SetShopParentId}}|
||Available from core version|8.7|
||Description|This action sets the parent id of a shop and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Shop}}: parentShop
|
h4.ShopReader
||Action name|ShopReader|
||Class name|{{com.cdrator.shop.action.ShopReader}}|
||Available from core version|8.7|
||Description|Retrieves a shop based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Simcard
h4.ChangeSimStatus
||Action name|ChangeSimStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM card status. If softblocked, barred or stolen is set, the blocked from date is updated. If in use is set, the blocked from date is set null.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.ChangeSimTypeStatus
||Action name|ChangeSimTypeStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimTypeStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM type status.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status types to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.FindSimcardsByIccAndPUK
||Action name|FindSimcardsByIccAndPUK|
||Class name|{{com.cdrator.simcard.action.FindSimcardsByIccAndPUK}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM cards from the database based on ICC and PUK.|
||Return value|{{ArrayList}}: The SIM cards with the ICC substring or the complete PUK. If no SIM cards are found, null is returned.|
||Properties|# onlyAvailableSIM: Only return available simcards?
|
||Parameters|# {{String}}: icc
# {{String}}: puk
|
h4.GetAvailableRandomSimCard
||Action name|GetAvailableRandomSimCard|
||Class name|{{com.cdrator.simcard.action.GetAvailableRandomSimCard}}|
||Available from core version|8.7|
||Description|Fetches a random available SIM card. Available means that the status is 0 (open and active) and it's not reserved. The SIM card type can be specified as a parameter.|
||Return value|{{SimCard}}: The available SIM card if found.|
||Properties| |
||Parameters|# {{String}}: simTypeId
|
h4.GetSimcardByIcc
||Action name|GetSimcardByIcc|
||Class name|{{com.cdrator.simcard.action.GetSimcardByIcc}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM card from the database by ICC.|
||Return value|{{SimCard}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{String}}: icc
|
h4.ReserveSimcard
||Action name|ReserveSimcard|
||Class name|{{com.cdrator.simcard.action.ReserveSimcard}}|
||Available from core version|8.7|
||Description|Action for reserving a SIM card to a service.|
||Return value|{{boolean}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{SimCard}}: simcard
# {{Service}}: service
|
h4.SimCardReader
||Action name|SimCardReader|
||Class name|{{com.cdrator.simcard.action.SimCardReader}}|
||Available from core version|8.7|
||Description|Retrieves a SIM card based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Util
h4.AddHookpointResult
||Action name|AddHookpointResult|
||Class name|{{com.cdrator.util.action.AddHookpointResult}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result.|
||Return value|{{void}}: No return value|
||Properties|# clearHookpointResult: Clear hookpoint result except for keys starting with LAST_OUTCOME_
# key1: Key 1
# key2: Key 2
# key3: Key 3
|
||Parameters|# {{HookpointResult}}: result
# {{String}}: value1
# {{String}}: value2
# {{String}}: value3
|
h4.CreateCdrParameter
||Action name|CreateCdrParameter|
||Class name|{{com.cdrator.util.action.CreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action creates a new cdrparameter based on the given code. The description, value and object, will be set based on the given information.|
||Return value|{{CdrParameter}}: The created cdrparameter.|
||Properties|# code: The code to create the cdrparameter from.
# description: The description of the cdrparameter.
|
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FormatString
||Action name|FormatString|
||Class name|{{com.cdrator.util.action.FormatString}}|
||Available from core version|8.7|
||Description|Format a string. Uses standard String.format|
||Return value|{{String}}: The formatted string.|
||Properties|# format: The format string.
|
||Parameters|# {{Object}}: param1
# {{Object}}: param2
# {{Object}}: param3
# {{Object}}: param4
# {{Object}}: param5
|
h4.GeneratePDFAction
||Action name|GeneratePDFAction|
||Class name|{{com.cdrator.util.action.GeneratePDFAction}}|
||Available from core version|8.7|
||Description|Generates a PDF specification based on the specified type.|
||Return value|{{String}}: The generated PDF string - Base64 encoded.|
||Properties|# PDFType: Specify the type of PDF generation.
|
||Parameters|# {{PersistentObject}}: object
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.GenerateXMLFromPO
||Action name|GenerateXMLFromPO|
||Class name|{{com.cdrator.util.action.GenerateXMLFromPO}}|
||Available from core version|8.7|
||Description|This action generates a XML document based on the given XMLDocumentDefinition and Persistant object. The resulting XML is placed in the provided dirName with the provided name+timestamp|
||Return value|{{boolean}}: Returns a persistentObject from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: documentDefKey
# {{String}}: dirName
# {{String}}: fileName
# {{PersistentObject}}: persistantObject
# {{String}}: persistentObjectKey
|
h4.GetCdrParameter
||Action name|GetCdrParameter|
||Class name|{{com.cdrator.util.action.GetCdrParameter}}|
||Available from core version|8.7|
||Description|This action adds a new cdrparameter based on the given objects and text string. Throws NullPointerException if both the cdrParameter and the parameter definition does not exist in the database.|
||Return value|{{CdrParameter}}: Returns cdr parameter based on the given objecs.|
||Properties| |
||Parameters|# {{CdrParameterIf}}: object
# {{String}}: varname
# {{CdrParameterIf}}: alternativeObject
|
h4.GetHashedValueFromString
||Action name|GetHashedValueFromString|
||Class name|{{com.cdrator.util.action.GetHashedValueFromString}}|
||Available from core version|8.7|
||Description|This action returns a hashed string based on the input given and the chosen hash type.|
||Return value|{{String}}: Returns a string hash of the suppplied input.|
||Properties|# selectedHashAlgorithm: Chosen hashing algorithm. Only SHA-1, SHA-256, SHA-384, SHA-512, MD2, MD5 are supported. If none is specified or no match, then SHA-1 is assumed.
|
||Parameters|# {{String}}: input
|
h4.GetInstanceFromDB
||Action name|GetInstanceFromDB|
||Class name|{{com.cdrator.util.action.GetInstanceFromDB}}|
||Available from core version|8.7|
||Description|This action retrieves a persistentObject from the database.|
||Return value|{{PersistentObject}}: Returns a persistent object from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{String}}: className
# {{Broker}}: broker
# {{String}}: clause
|
h4.GetParameterTreeValues
||Action name|GetParameterTreeValues|
||Class name|{{com.cdrator.util.action.GetParameterTreeValues}}|
||Available from core version|8.7|
||Description|This action retrieves all parameter values for a given node path and brand.|
||Return value|{{List}}: Returns the list of parameter values for the given node path.|
||Properties|# nodePath: Path to parameter tree node. Example: ALERTS.ALERT_GROUPS.
|
||Parameters|# {{Brand}}: brand
|
h4.GetStatusTypesFor
||Action name|GetStatusTypesFor|
||Class name|{{com.cdrator.util.action.GetStatusTypesFor}}|
||Available from core version|8.7|
||Description|This action retrieves the statuses for a given status type code.|
||Return value|{{List}}: Returns statuses for the given code.|
||Properties| |
||Parameters|# {{String}}: code
|
h4.IsStringInDelimitedString
||Action name|IsStringInDelimitedString|
||Class name|{{com.cdrator.util.action.IsStringInDelimitedString}}|
||Available from core version|8.7|
||Description|This action returns true if a given string val is in the comma separated string values. Remark: Both strings are trimmed before comparison to avoid unintended results.|
||Return value|{{boolean}}: Returns true if the given val is in the values string, false in all other cases.|
||Properties| |
||Parameters|# {{String}}: val
# {{String}}: values
|
h4.SimpleReturn
||Action name|SimpleReturn|
||Class name|{{com.cdrator.util.action.SimpleReturn}}|
||Available from core version|8.7|
||Description|Returns the argument object|
||Return value|{{Object}}: The argument object|
||Properties| |
||Parameters|# {{Object}}: executionArg
|
h4.Throttle
||Action name|Throttle|
||Class name|{{com.cdrator.util.action.Throttle}}|
||Available from core version|8.7|
||Description|Throttles a process
Requires 2 parameters:
WORKFLOW.THROTTLING.<name>.CAP number of times the throttled process may be performed in each interval
WORKFLOW.THROTTLING.<name>.INTERVAL number of seconds each interval lasts|
||Return value|{{boolean}}: Returns true if the process can continue.|
||Properties|# name: Used to generate the keys for the properties and parameters.
|
||Parameters| |
h4.ThrowNewUserMessageSysExceptionAction
||Action name|ThrowNewUserMessageSysExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewUserMessageSysExceptionAction}}|
||Available from core version|8.7|
||Description|Will throw an exception with a user defined message. Use this action to manually throw an exception to force a rollback while also specifying an error message to the end user, e.g. in the SOAP response instead of displaying BUSINESS_ERROR.|
||Return value|{{void}}: No return value.|
||Properties|# userMessage: The user message to pass along the exception. Specify labels, max 5 labels, in the message using <LABEL(X)>, e.g. This is <LABEL1> example label one.
|
||Parameters|# {{String}}: label1
# {{String}}: label2
# {{String}}: label3
# {{String}}: label4
# {{String}}: label5
|
h4.ThrowNewWorkflowExceptionAction
||Action name|ThrowNewWorkflowExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewWorkflowExceptionAction}}|
||Available from core version|8.7|
||Description|Finalizes logistics file.|
||Return value|{{void}}: No return value.|
||Properties|# recordNo: Error message to log throw with exception.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h4.UpdatePersistentObject
||Action name|UpdatePersistentObject|
||Class name|{{com.cdrator.util.action.UpdatePersistentObject}}|
||Available from core version|8.7|
||Description|This action updates a persistent object by calling a method on it with one or more parameters. The persistent object is saved afterwards. Example: PersistentObject=USERS, method="setAccount", params=ACCOUNT result: USERS.setAccount(ACCOUNT); USERS.save();|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
# {{String}}: method
# {{Object[]}}: params
|
h3.Util - Date
h4.DateChanger
||Action name|DateChanger|
||Class name|{{com.cdrator.util.date.action.DateChanger}}|
||Available from core version|8.7|
||Description|Changes values on a given date, al values are given as numbers where e.g. Month=1 sets the date to January.|
||Return value|{{Date}}: The modified date.|
||Properties| |
||Parameters|# {{Date}}: date
# {{String}}: milliSecond
# {{String}}: second
# {{String}}: minute
# {{String}}: hour
# {{String}}: day
# {{String}}: month
# {{String}}: year
|
h4.DateComparator
||Action name|DateComparator|
||Class name|{{com.cdrator.util.date.action.DateComparator}}|
||Available from core version|8.7|
||Description|Compares two given dates for one of these actions: AFTER, BEFORE, or EQUALS. Date1 is compared against date2 with the action (e.g. date1 after date2).|
||Return value|{{boolean}}: A boolean representing the outcome of the specified operation.|
||Properties|# action: Specify the operation between dates.
|
||Parameters|# {{Date}}: date1
# {{Date}}: date2
|
h4.DateStaticAdder
||Action name|DateStaticAdder|
||Class name|{{com.cdrator.util.date.action.DateStaticAdder}}|
||Available from core version|8.7|
||Description|Adds day, hours, minutes, and second to the given date|
||Return value|{{Date}}: The modified date.|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters|# {{Date}}: date
|
h4.FormatDate
||Action name|FormatDate|
||Class name|{{com.cdrator.util.date.action.FormatDate}}|
||Available from core version|8.7|
||Description|Turns a given date into a string using a specified format.|
||Return value|{{String}}: The formatted date.|
||Properties|# format: The format to format the date by.
|
||Parameters|# {{Date}}: date
|
h4.GetDate
||Action name|GetDate|
||Class name|{{com.cdrator.util.date.action.GetDate}}|
||Available from core version|8.7|
||Description|An action to retrieve the current or a future date|
||Return value|{{Date}}: A date representing the sysdate + eventual added minutes, hours, days or months|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters| |
h4.GetEndOfMonthDate
||Action name|GetEndOfMonthDate|
||Class name|{{com.cdrator.util.date.action.GetEndOfMonthDate}}|
||Available from core version|8.7|
||Description|This action returns a calendar representing the last day of the current month.|
||Return value|{{Calendar}}: A calendar representing the last day of the current month.|
||Properties| |
||Parameters| |
h4.GetFirstDayOfMonth
||Action name|GetFirstDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetFirstDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the first day of the month of the supplied date|
||Return value|{{Date}}: A date representing the first day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetFormattedCalendarField
||Action name|GetFormattedCalendarField|
||Class name|{{com.cdrator.util.date.action.GetFormattedCalendarField}}|
||Available from core version|8.7|
||Description|Returns the string representation of the calendar field value in the given style and locale. Parameters requrired: dateField - the calendar field for which the string representation is returned (Calendar.MONTH ...); date - The source date; locale - The locale used for formatting. (no ...); dateStyle - The locale used for formatting.(Calendar.SHORT, Calendar.LONG).|
||Return value|{{String}}: Returns the string representation of the calendar field value in the given style and locale.|
||Properties| |
||Parameters|# {{int}}: dateField
# {{Date}}: date
# {{String}}: locale
# {{int}}: dateStyle
|
h4.GetLastDayOfMonth
||Action name|GetLastDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetLastDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the last day of the month of the supplied date|
||Return value|{{Date}}: A date representing the last day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetNextWorkingDay
||Action name|GetNextWorkingDay|
||Class name|{{com.cdrator.util.date.action.GetNextWorkingDay}}|
||Available from core version|8.7|
||Description|Get the next working day if the supplied date is a holiday|
||Return value|{{Date}}: The next working day|
||Properties| |
||Parameters|# {{Date}}: fromDate
|
h3.Util - Image
h4.GetImage
||Action name|GetImage|
||Class name|{{com.cdrator.util.image.action.GetImage}}|
||Available from core version|8.7|
||Description|Loads an image from a specific path given as parameter or context object|
||Return value|{{Image}}: Returns the Image object loaded from the given path.|
||Properties| |
||Parameters|# {{String}}: imagePath
|
h3.Util - Parameter
h4.CdrParameterReader
||Action name|CdrParameterReader|
||Class name|{{com.cdrator.util.parameter.action.CdrParameterReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDR Parameter based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.UpdateCreateCdrParameter
||Action name|UpdateCreateCdrParameter|
||Class name|{{com.cdrator.util.parameter.action.UpdateCreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action updates a cdr parameter, if the cdr parameter doesn't exist it will create a new one. The value, name and object will be set based on the given information.|
||Return value|{{CdrParameter}}: The updated/created cdr parameter.|
||Properties| |
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
h3.Unknown package
h4.SingleValueReader
||Action name|SingleValueReader|
||Class name|{{com.cdrator.util.SingleValueReader}}|
||Available from core version|8.7|
||Description|Reads a single value from a persistent object. Column name must be specified.|
||Return value|{{String}}: The string value of the specified column name of the persistent object|
||Properties|# columnName: The column name of the persistent object, from where to read the value from
|
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Util - String
h4.CreateListOfStringsFromDelimitedText
||Action name|CreateListOfStringsFromDelimitedText|
||Class name|{{com.cdrator.util.string.action.CreateListOfStringsFromDelimitedText}}|
||Available from core version|8.7|
||Description|Creates a List of strings from a delimited text|
||Return value|{{List}}: The list of strings computed by splitting the delimited text|
||Properties|# delimiter: The delimiter used in the text
|
||Parameters|# {{String}}: delimitedText
|
h3.Workflow
h4.PushWorkflow
||Action name|PushWorkflow|
||Class name|{{com.cdrator.workflow.action.PushWorkflow}}|
||Available from core version|8.7|
||Description|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
|
||Return value|{{WfActivity}}: The activity the workflow was waiting in.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{WfWorkflow}}: workflow
|
h4.PushWorkflowById
||Action name|PushWorkflowById|
||Class name|{{com.cdrator.workflow.action.PushWorkflowById}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{WfWorkflow}}: The pushed workflow.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{String}}: workflowId
# {{Broker}}: broker
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.StartNewWorkflow
||Action name|StartNewWorkflow|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflow}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{HookpointResult}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
|
h4.StartNewWorkflowList
||Action name|StartNewWorkflowList|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflowList}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
# {{List}}: objectList
# {{String}}: objectContextKey
|
h4.WorkflowActivityReader
||Action name|WorkflowActivityReader|
||Class name|{{com.cdrator.workflow.action.WorkflowActivityReader}}|
||Available from core version|8.7|
||Description|Retrieves a workflow activity based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Workflow - Context
h4.IsObjectInContext
||Action name|IsObjectInContext|
||Class name|{{com.cdrator.workflow.context.action.IsObjectInContext}}|
||Available from core version|8.7|
||Description|Checks if the object is in the context|
||Return value|{{boolean}}: true if the object is in the context|
||Properties|# objectKey: The key of the object to check in the context
|
||Parameters|# {{Map}}: context
|
h3.Workflow - Hookpointresult
h4.AddHookpointResultObjects
||Action name|AddHookpointResultObjects|
||Class name|{{com.cdrator.workflow.hookpointresult.action.AddHookpointResultObjects}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result. Allows having objects in HOOKPOINT_RESULT|
||Return value|{{void}}: No return value|
||Properties|# key1: Key 1
# key2: Key 2
# key3: Key 3
# key4: Key 4
# key5: Key 5
|
||Parameters|# {{HookpointResult}}: result
# {{Object}}: value1
# {{Object}}: value2
# {{Object}}: value3
# {{Object}}: value4
# {{Object}}: value5
|
h4.CheckHookpointResult
||Action name|CheckHookpointResult|
||Class name|{{com.cdrator.workflow.hookpointresult.action.CheckHookpointResult}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: True if result is success, False otherwise.|
||Properties|# errorCodesToIgnore: List of error codes to ignore. Use semicolon (;) to separate the values of the list.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h3.Billing - Billingcycle
h4.BillingCycleReader
||Action name|BillingCycleReader|
||Class name|{{com.cdrator.billing.billingcycle.action.BillingCycleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Cycle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetEndOfBillingCycleDate
||Action name|GetEndOfBillingCycleDate|
||Class name|{{com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate}}|
||Available from core version|8.7|
||Description|This action returns a date representing the last day of the current billing cycle for the given billing group.|
||Return value|{{Date}}: A Date representing the last day of the current billing cycle.|
||Properties| |
||Parameters|# {{Date}}: date
# {{BillingGroup}}: bg
|
h3.Billing - Billinggroup
h4.BillingGroupReader
||Action name|BillingGroupReader|
||Class name|{{com.cdrator.billing.billinggroup.action.BillingGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Group based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveBillingGroupMembers
||Action name|GetActiveBillingGroupMembers|
||Class name|{{com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers}}|
||Available from core version|8.7|
||Description|Retrieves the active members of the billing group|
||Return value|{{List}}: The active members of the billing group|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.HardBlockAllTeleServicesOnBillingGroup
||Action name|HardBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.SoftBlockAllTeleServicesOnBillingGroup
||Action name|SoftBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.UnBlockAllTeleServicesOnBillingGroup
||Action name|UnBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h3.Billing - Charge
h4.CreateSingleChargeForBillingGroup
||Action name|CreateSingleChargeForBillingGroup|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Billing Group. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.CreateSingleChargeForSubscription
||Action name|CreateSingleChargeForSubscription|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForSubscription}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Subscription. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{Subscription}}: subscription
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.RoundAllInvoicesInBatch
||Action name|RoundAllInvoicesInBatch|
||Class name|{{com.cdrator.billing.charge.action.RoundAllInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Rounds all invoices on an invoicebatch, to nearest whole number.|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: batch
# {{ChargeItem}}: chargeItem
|
h3.Billing - Financial - Billing
h4.AddChargeToBillingGroup
||Action name|AddChargeToBillingGroup|
||Class name|{{com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Number}}: amount
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.BuildAccountPaymentsForInvoicesOnBatch
||Action name|BuildAccountPaymentsForInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# paymentType: The account payment type that should be used for the payment.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: cdrParameterName
# {{String}}: parameterValue
|
h4.DoAccountPayment
||Action name|DoAccountPayment|
||Class name|{{com.cdrator.billing.financial.billing.action.DoAccountPayment}}|
||Available from core version|8.7|
||Description|Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.|
||Return value|{{AccountPayment}}: Returns the account payment|
||Properties|# accountPaymentTypeId: The account payment type of the recharge ticket.
# skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.
|
||Parameters|# {{RechargeTicket}}: rechargeTicket
# {{Invoice}}: invoice
# {{BillingGroup}}: billingGroup
# {{String}}: paymentRequestRef
# {{HookpointResult}}: hookpointResult
|
h4.GetListOfServicesInStatusFromSubscriptions
||Action name|GetListOfServicesInStatusFromSubscriptions|
||Class name|{{com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions}}|
||Available from core version|8.7|
||Description|Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.|
||Return value|{{List}}: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{List}}: statuses
|
h4.GetNewInvoice
||Action name|GetNewInvoice|
||Class name|{{com.cdrator.billing.financial.billing.action.GetNewInvoice}}|
||Available from core version|8.7|
||Description|This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.|
||Return value|{{Invoice}}: The newly created Invoice|
||Properties|# invoiceType: The available invoice types
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.MakeInvoicePaymentOnInvoicesInBatch
||Action name|MakeInvoicePaymentOnInvoicesInBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h4.ManualDebitOrCredit
||Action name|ManualDebitOrCredit|
||Class name|{{com.cdrator.billing.financial.billing.action.ManualDebitOrCredit}}|
||Available from core version|8.7|
||Description|This action calls the function addManualDebitOrCredit on the provided set of parameters.|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{TimeCharge}}: timeCharge
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{boolean}}: isDebit
# {{Amount}}: amount
# {{Currency}}: amountCurrency
# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.PayInvoicesOnBatch
||Action name|PayInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h3.Unknown package
h4.PaymentMethodReader
||Action name|PaymentMethodReader|
||Class name|{{com.cdrator.billing.financial.PaymentMethodReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Method entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Financial - Payments
h4.PaymentLogReader
||Action name|PaymentLogReader|
||Class name|{{com.cdrator.billing.financial.payments.action.PaymentLogReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Log based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Invoice
h4.CloseInvoiceWithCurrentDate
||Action name|CloseInvoiceWithCurrentDate|
||Class name|{{com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate}}|
||Available from core version|8.7|
||Description|Calls closeWithDueDate on a given invoice with current date.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.GetAccountPaymentsForInvoice
||Action name|GetAccountPaymentsForInvoice|
||Class name|{{com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice}}|
||Available from core version|8.7|
||Description|Gets a list of account payments related to the invoice.|
||Return value|{{List}}: A list of accountPayments.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.InvoiceCompareToLastStepId
||Action name|InvoiceCompareToLastStepId|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId}}|
||Available from core version|8.7|
||Description|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 |
||Return value|{{boolean}}: true or false|
||Properties| |
||Parameters|# {{Invoice}}: invoice
# {{String}}: compareString
# {{boolean}}: defaultForBlank
|
h4.InvoiceReader
||Action name|InvoiceReader|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceReader}}|
||Available from core version|8.7|
||Description|Retrieves an invoice based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.PayInvoicesInBatchWithAccountPayments
||Action name|PayInvoicesInBatchWithAccountPayments|
||Class name|{{com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments}}|
||Available from core version|8.7|
||Description|Marks all invoice on batch as paid|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: invoiceBatch
# {{String}}: reference
# {{String}}: transactionNumber
# {{AccountPaymentType}}: accountPaymentType
|
h4.PublishInvoice
||Action name|PublishInvoice|
||Class name|{{com.cdrator.billing.invoice.action.PublishInvoice}}|
||Available from core version|8.7|
||Description|Publishes a given invoice.|
||Return value|{{Invoice}}: The published invoice|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h3.Billing - Main
h4.GetBillingGroupsByUserID
||Action name|GetBillingGroupsByUserID|
||Class name|{{com.cdrator.billing.main.action.GetBillingGroupsByUserID}}|
||Available from core version|8.7|
||Description|This action will return an arraylist of billing groups that a given userID is the owner of.|
||Return value|{{ArrayList}}: An array list of billing groups.|
||Properties| |
||Parameters|# {{String}}: userID
|
h4.SetBillingGroupCurrencyCode
||Action name|SetBillingGroupCurrencyCode|
||Class name|{{com.cdrator.billing.main.action.SetBillingGroupCurrencyCode}}|
||Available from core version|8.7|
||Description|This action sets the currency code on the billing group. The billing group is saved.|
||Return value|{{void}}: No return value.|
||Properties|# currencyCode: The currency code which is set on the billing group.
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.TerminateSharedServiceIfNoTeleservices
||Action name|TerminateSharedServiceIfNoTeleservices|
||Class name|{{com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Boolean}}: Returns true if a shared Service was attempted terminated.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{Date}}: terminationDate
# {{String}}: hookpointKey
# {{String}}: reason
|
h3.Billing - Misc
h4.GetParameterValue
||Action name|GetParameterValue|
||Class name|{{com.cdrator.billing.misc.action.GetParameterValue}}|
||Available from core version|8.7|
||Description|This action retrieves a string representation of a parameter value.|
||Return value|{{String}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{String}}: key
# {{Brand}}: brand
|
h3.Billing - Payment
h4.AccountPaymentReader
||Action name|AccountPaymentReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AccountPaymentSetAuthorized
||Action name|AccountPaymentSetAuthorized|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetAuthorized}}|
||Available from core version|8.7|
||Description|Calls setAuthorized on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentSetCaptureInfo
||Action name|AccountPaymentSetCaptureInfo|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo}}|
||Available from core version|8.7|
||Description|Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage) |
||Return value|{{void}}: No return value|
||Properties|# captureMessage: Capture message to be set.
# useCaptureDate: Should Capture Date be set (to current time.
|
||Parameters|# {{AccountPayment}}: ap
|
h4.AccountPaymentSetDoCapture
||Action name|AccountPaymentSetDoCapture|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetDoCapture}}|
||Available from core version|8.7|
||Description|Calls setDoCapture on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentTypeReader
||Action name|AccountPaymentTypeReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AcountPaymentSetCaptureMessage
||Action name|AcountPaymentSetCaptureMessage|
||Class name|{{com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage}}|
||Available from core version|8.7|
||Description|Set capture message on AccountPayment|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{AccountPayment}}: ap
# {{String}}: captureMessage
|
h4.GetRechargeTicketForBillingGroup
||Action name|GetRechargeTicketForBillingGroup|
||Class name|{{com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup}}|
||Available from core version|8.7|
||Description|This action returns a rechargeTicket for a BillingGroup.|
||Return value|{{RechargeTicket}}: The recharge ticket, if it exists.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h3.Billing - Product
h4.DeviceCanUseOn
||Action name|DeviceCanUseOn|
||Class name|{{com.cdrator.billing.product.action.DeviceCanUseOn}}|
||Available from core version|8.7|
||Description|Calls CanUseOn on a given device with a given service.|
||Return value|{{boolean}}: Boolean showing if a given device can be used on a given service.|
||Properties| |
||Parameters|# {{Device}}: device
# {{Service}}: service
|
h4.GetDeviceFromParameterValue
||Action name|GetDeviceFromParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceFromParameterValue}}|
||Available from core version|8.7|
||Description|Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.|
||Return value|{{Device}}: The located device.|
||Properties| |
||Parameters|# {{String}}: name
# {{String}}: value
|
h4.GetDeviceParameterValue
||Action name|GetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action returns the value of a given device parameter or throws a NullValueException if none is found.|
||Return value|{{String}}: Value of the given parameter (as a string).|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
|
h4.SetDeviceParameterValue
||Action name|SetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.SetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action updates a device parameter value if it's found, otherwise it will be created.|
||Return value|{{boolean}}: True if the parameter was created, false if the parameter was updated.|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
# {{String}}: value
|
h3.Billing - Product - RatePlanChange
h4.CompleteRatePlanChange
||Action name|CompleteRatePlanChange|
||Class name|{{com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange}}|
||Available from core version|8.7|
||Description|This action completes the rateplan change by subscribing to the default and mandatory options.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{RatePlanChange}}: rpc
# {{boolean}}: cache
|
h3.Billing - Rating
h4.GetActiveRatePlanForSubscription
||Action name|GetActiveRatePlanForSubscription|
||Class name|{{com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the currently active rate plan for a subscription.|
||Return value|{{RatePlan}}: Returns a rate plan that is currently active for the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetPlanElement
||Action name|GetPlanElement|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElement}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters| |
h4.GetPlanElementForRatePlan
||Action name|GetPlanElementForRatePlan|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElementForRatePlan}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters|# {{RatePlan}}: ratePlan
|
h4.GetRatePlansByProduct
||Action name|GetRatePlansByProduct|
||Class name|{{com.cdrator.billing.rating.action.GetRatePlansByProduct}}|
||Available from core version|8.7|
||Description|This action retrieves rate plans for a product.|
||Return value|{{List}}: Returns a list of rate plans related to this product.|
||Properties| |
||Parameters|# {{Product}}: product
|
h3.Billing - Rating - Simulate
h4.BillingRecordBuilder
||Action name|BillingRecordBuilder|
||Class name|{{com.cdrator.billing.rating.simulate.action.BillingRecordBuilder}}|
||Available from core version|8.7|
||Description|Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.|
||Return value|{{BillingRecordSimulated}}: A new unrated billing record. Not persisted.|
||Properties|# BNumber: B-Number of the billing record.
# ratingCode: Rating code to be set on the Billing Record.
# ratingDuration: Rating duration to be set on the Billing Record.
# ratingKey: Rating key to be set on the Billing Record.
# ratingVolumne: Rating volume to be set on the Billing Record.
|
||Parameters|# {{Service}}: service
|
h4.CalculateInvoiceDetailLinesTotalChargeSum
||Action name|CalculateInvoiceDetailLinesTotalChargeSum|
||Class name|{{com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Amount}}: The sum to the total charges of the Invoice Detail Lines Wrappers|
||Properties|# ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
# throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
|
||Parameters|# {{List}}: idlList
|
h4.RatingSimulator
||Action name|RatingSimulator|
||Class name|{{com.cdrator.billing.rating.simulate.action.RatingSimulator}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{ArrayList}}: ArrayList of the Invoice Detail Lines|
||Properties| |
||Parameters|# {{Service}}: service
# {{BillingRecords}}: billingRecord
|
h3.Billing - Status
h4.StatusReader
||Action name|StatusReader|
||Class name|{{com.cdrator.billing.status.action.StatusReader}}|
||Available from core version|8.7|
||Description|Retrieves a Status object based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - SubscriptionFees
h4.AddFee
||Action name|AddFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddFee}}|
||Available from core version|8.7|
||Description|Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Returns the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# feeCode: The fee code for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
h4.AddSubscriptionFee
||Action name|AddSubscriptionFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee}}|
||Available from core version|8.7|
||Description|Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Return the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# planElement: The plan element for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SubscriptionFeesReader
||Action name|SubscriptionFeesReader|
||Class name|{{com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader}}|
||Available from core version|8.7|
||Description|Gets a subscription fee.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - TodoTask
h4.CreateTodoTask
||Action name|CreateTodoTask|
||Class name|{{com.cdrator.billing.todoTask.action.CreateTodoTask}}|
||Available from core version|8.7|
||Description|Creates a TodoTask based on configurable properties|
||Return value|{{void}}: No return values|
||Properties|# assignedToOperator: The operator the todo task is assigned to
# category: Task category
# contactPhoneNumber: Contact phone number
# description: Task Description
# reminderTimeInMinutes: Reminder time in minutes
# subject: Subject
# typeOfFollowUp: The type of follow up: email,letter,phone call,sms
|
||Parameters|# {{Service}}: service
|
h3.Brand
h4.BrandReader
||Action name|BrandReader|
||Class name|{{com.cdrator.brand.action.BrandReader}}|
||Available from core version|8.7|
||Description|Retrieves a Brand based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Campaign
h4.CampaignReader
||Action name|CampaignReader|
||Class name|{{com.cdrator.campaign.action.CampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a Campaign definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetBundlesFromCampaign
||Action name|GetBundlesFromCampaign|
||Class name|{{com.cdrator.campaign.action.GetBundlesFromCampaign}}|
||Available from core version|8.7|
||Description|Returns an list of campaign bundles from a campaign.|
||Return value|{{ArrayList}}: a list of campaign bundles|
||Properties| |
||Parameters|# {{Campaign}}: campaign
|
h4.GetCampaignForKey
||Action name|GetCampaignForKey|
||Class name|{{com.cdrator.campaign.action.GetCampaignForKey}}|
||Available from core version|8.7|
||Description|This action returns a campaign for which the campaign key is provided as a property.|
||Return value|{{Campaign}}: The campaign associated with the provided campaign key.|
||Properties|# campaignKey: The campaign key for the campaign.
|
||Parameters| |
h4.GetCurrentSubscriptionCampaign
||Action name|GetCurrentSubscriptionCampaign|
||Class name|{{com.cdrator.campaign.action.GetCurrentSubscriptionCampaign}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a subscription and campaign.|
||Return value|{{SubscriptionCampaign}}: The current SubscriptionCampaign.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Campaign}}: campaign
|
h4.GetNewSubscriptionBundle
||Action name|GetNewSubscriptionBundle|
||Class name|{{com.cdrator.campaign.action.GetNewSubscriptionBundle}}|
||Available from core version|8.7|
||Description|This action creates and returns a new SubscriptionBundle.|
||Return value|{{SubscriptionBundle}}: Returns a new SubscriptionBundle|
||Properties| |
||Parameters|# {{Bundle}}: bundle
# {{Subscription}}: subscription
# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.GetSubscriptionCampaignsByCriteria
||Action name|GetSubscriptionCampaignsByCriteria|
||Class name|{{com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.|
||Return value|{{List}}: A list of SubscriptionCampaign matching given criterias.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: criterias
|
h4.SetListOfSubscriptionCampaignToDateToSpecificDate
||Action name|SetListOfSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: subscriptionCampaigns
# {{Date}}: date
|
h4.SetSubBundleVal1FromServiceOption
||Action name|SetSubBundleVal1FromServiceOption|
||Class name|{{com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption}}|
||Available from core version|8.7|
||Description|This action updates value1 if an associated serviceOptionParameter with a given key can be found.|
||Return value|{{boolean}}: Boolean indicating success of finding and setting the parameter.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
# parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.
|
||Parameters|# {{SubscriptionBundle}}: bundle
# {{Broker}}: broker
|
h4.SetSubscriptionCampaignCollectionFromToDate
||Action name|SetSubscriptionCampaignCollectionFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.|
||Return value|{{boolean}}: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{ArrayList}}: subscriptionCampaignList
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignFromDateToNextMonth
||Action name|SetSubscriptionCampaignFromDateToNextMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to the first day of next month.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignFromDateToSpecificDate
||Action name|SetSubscriptionCampaignFromDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to a specific date.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SetSubscriptionCampaignInstanceFromToDate
||Action name|SetSubscriptionCampaignInstanceFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.|
||Return value|{{boolean}}: Returns true if the date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignParameter
||Action name|SetSubscriptionCampaignParameter|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignParameter}}|
||Available from core version|8.7|
||Description|An action to set subscriptionCampaign parameters.|
||Return value|{{void}}: No return value.|
||Properties|# parameterName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{String}}: value
|
h4.SetSubscriptionCampaignToDateRestOfMonth
||Action name|SetSubscriptionCampaignToDateRestOfMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth}}|
||Available from core version|8.7|
||Description|This action sets the toDate on a subscriptionCampaign to the end of the current month.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign.|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignToDateToSpecificDate
||Action name|SetSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SubCampaignSetParameter
||Action name|SubCampaignSetParameter|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameter}}|
||Available from core version|8.7|
||Description|This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# paramName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{Subscription}}: sub
# {{ServiceOptionParameter}}: sop
|
h4.SubCampaignSetParameterFromSOP
||Action name|SubCampaignSetParameterFromSOP|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameterFromSOP}}|
||Available from core version|8.7|
||Description|This action updates a subscription campaign parameter from a service option parameter with a given key.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
# paramName: The name of the subscription campaign parameter that should be set.
# parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.
|
||Parameters|# {{SubscriptionBundle}}: bundle
|
h4.SubscriptionCampaignReader
||Action name|SubscriptionCampaignReader|
||Class name|{{com.cdrator.campaign.action.SubscriptionCampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a subscription campaign based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.TerminateCampaignWithFromDate
||Action name|TerminateCampaignWithFromDate|
||Class name|{{com.cdrator.campaign.action.TerminateCampaignWithFromDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h3.Campaign - Bundle
h4.BundleReader
||Action name|BundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.BundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Bundle definition based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveSubscriptionBundlesDefinedByDate
||Action name|GetActiveSubscriptionBundlesDefinedByDate|
||Class name|{{com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate}}|
||Available from core version|8.7|
||Description|Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: date
|
h4.GetBundleForCampaignAndBundleKey
||Action name|GetBundleForCampaignAndBundleKey|
||Class name|{{com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey}}|
||Available from core version|8.7|
||Description|This action returns the bundle associated with the supplied campaign and bundleKey.|
||Return value|{{Bundle}}: The bundle associated with the supplied campaign and bundleKey.|
||Properties| |
||Parameters|# {{Campaign}}: campaign
# {{String}}: bundleKey
|
h4.GetCurrentSubscriptionBundlesNotUsedUpForCode
||Action name|GetCurrentSubscriptionBundlesNotUsedUpForCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleParameter
||Action name|GetSubscriptionBundleParameter|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter}}|
||Available from core version|8.7|
||Description|Finds a bundle parameter from a SubscriptionBundle.|
||Return value|{{String}}: The value of the Bundle parameter.|
||Properties|# optionKey: The parameter that should be read from the Bundle.
|
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundles
||Action name|GetSubscriptionBundles|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundles}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription.|
||Return value|{{ArrayList}}: The value of the Bundle parameter.|
||Properties|# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundlesWithCode
||Action name|GetSubscriptionBundlesWithCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleType
||Action name|GetSubscriptionBundleType|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleType}}|
||Available from core version|8.7|
||Description|Finds the type of a SubscriptionBundle.|
||Return value|{{String}}: The code of the SubscriptionBundle.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundleValue
||Action name|GetSubscriptionBundleValue|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue}}|
||Available from core version|8.7|
||Description|Get the defined Value field in the subscription bundle for the specified bundle.|
||Return value|{{Amount}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{Subscription}}: subscription
|
h4.IsSubscriptionBundleUsedUp
||Action name|IsSubscriptionBundleUsedUp|
||Class name|{{com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp}}|
||Available from core version|8.7|
||Description|Determines if a given subscription bundle is used up by comparing the maximum value with the current value.|
||Return value|{{boolean}}: True if the subscription bundle is completely used up, false otherwise.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.ProrateActivationSubscriptionCampaignBundles
||Action name|ProrateActivationSubscriptionCampaignBundles|
||Class name|{{com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles}}|
||Available from core version|8.7|
||Description|Create and prorate the bundles of the given subscription campaign for a certain start date.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign with the updated bundles|
||Properties|# roundPrecission: The precission used when rounding the bundles.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: fromDate
|
h4.SetSubscriptionBundleValueFromServiceOptionParameter
||Action name|SetSubscriptionBundleValueFromServiceOptionParameter|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified service option parameter.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{SubscriptionBundle}}: subscriptionBundle
|
h4.SetSubscriptionBundleValues
||Action name|SetSubscriptionBundleValues|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified bundles.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# value1: Set value 1
# value2: Set value 2
# value3: Set value 3
# value4: Set value 4
|
||Parameters|# {{String}}: value
# {{Subscription}}: subscription
|
h4.SubscriptionBundleReader
||Action name|SubscriptionBundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.SubscriptionBundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription Bundle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Correspondence - Archive
h4.DocArchiveReader
||Action name|DocArchiveReader|
||Class name|{{com.cdrator.correspondence.archive.action.DocArchiveReader}}|
||Available from core version|8.7|
||Description|Retrieves a DocArchive entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveDocArchiveFile
||Action name|SaveDocArchiveFile|
||Class name|{{com.cdrator.correspondence.archive.action.SaveDocArchiveFile}}|
||Available from core version|8.7|
||Description|If property FilePath is set, it will override the FilePath parameter. Throws ActionParameterException if neither is specified|
||Return value|{{void}}: No value returned|
||Properties|# filePath: FilePath
|
||Parameters|# {{DocArchive}}: archive
# {{String}}: filePathParameter
|
h3.Device
h4.DeviceReader
||Action name|DeviceReader|
||Class name|{{com.cdrator.device.action.DeviceReader}}|
||Available from core version|8.7|
||Description|Retrieves a Device based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Device - Cdmaphone
h4.CdmaPhoneReader
||Action name|CdmaPhoneReader|
||Class name|{{com.cdrator.device.cdmaphone.action.CdmaPhoneReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDMA phone based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Fraud - Addresscheck
h4.PerformAddressCheck
||Action name|PerformAddressCheck|
||Class name|{{com.cdrator.fraud.addresscheck.action.PerformAddressCheck}}|
||Available from core version|8.7|
||Description|This action performs an address check on a user.|
||Return value|{{AddressCheckResult}}: The AddressCheckResult is returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{AddressCheck}}: ac
|
h3.Fraud - Creditcheck
h4.PerformCreditCheck
||Action name|PerformCreditCheck|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheck}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{CreditCheck}}: cc
|
h4.PerformCreditCheckOnUser
||Action name|PerformCreditCheckOnUser|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheckOnUser}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
|
h3.Main - Account
h4.AccountIsNewSignupAllowed
||Action name|AccountIsNewSignupAllowed|
||Class name|{{com.cdrator.main.account.action.AccountIsNewSignupAllowed}}|
||Available from core version|8.7|
||Description|This action check if it is allowed to add a new subscription to an account |
||Return value|{{boolean}}: true(default) or false based on workflow with hook_point SUB_SIGNUP_ALLOWED.|
||Properties| |
||Parameters|# {{Account}}: account
|
h4.AccountReader
||Action name|AccountReader|
||Class name|{{com.cdrator.main.account.action.AccountReader}}|
||Available from core version|8.7|
||Description|Retrieves an Account based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AddAccountWarning
||Action name|AddAccountWarning|
||Class name|{{com.cdrator.main.account.action.AddAccountWarning}}|
||Available from core version|8.7|
||Description|This action adds a warning to an account.
You can use the FormatString action to format the warning before calling this activity|
||Return value|{{void}}: No return value.|
||Properties|# category: null
|
||Parameters|# {{Account}}: account
# {{String}}: key
# {{String}}: description
# {{PersistentObject}}: sourcePO
# {{Date}}: expireDate
|
h4.AddWorkflowToAccount
||Action name|AddWorkflowToAccount|
||Class name|{{com.cdrator.main.account.action.AddWorkflowToAccount}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the WfWorkflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Account}}: account
# {{WfWorkflow}}: wfWorkflow
|
h4.CheckIfAccountInState
||Action name|CheckIfAccountInState|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountInState}}|
||Available from core version|8.7|
||Description|This action checks if an account is in one of the given states.|
||Return value|{{Boolean}}: Returns TRUE if the account state matches one of the given states.|
||Properties|# possibleStates: The possible states separated by ';'
|
||Parameters|# {{Account}}: account
|
h4.CheckIfAccountIsClosed
||Action name|CheckIfAccountIsClosed|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountIsClosed}}|
||Available from core version|8.7|
||Description|This action checks if an account is closed.|
||Return value|{{Boolean}}: Returns TRUE if the account is closed.|
||Properties| |
||Parameters|# {{Account}}: account
|
h3.Main
h4.ProductMakeSubscription
||Action name|ProductMakeSubscription|
||Class name|{{com.cdrator.main.action.ProductMakeSubscription}}|
||Available from core version|8.7|
||Description|This action creates a subscription based on the supplied product configuration, account and billing group.|
||Return value|{{Subscription}}: Returns the newly created subscription.|
||Properties| |
||Parameters|# {{ProductConfig}}: productConfig
# {{Account}}: account
# {{BillingGroup}}: billingGroup
|
h3.Main - Alert
h4.AlertGroupReader
||Action name|AlertGroupReader|
||Class name|{{com.cdrator.main.alert.action.AlertGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves an AlertGroup based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Operator
h4.OperatorAuthentication
||Action name|OperatorAuthentication|
||Class name|{{com.cdrator.main.operator.action.OperatorAuthentication}}|
||Available from core version|8.7|
||Description|This action authenticates the operator based on the username and password provided. If username or password are null or empty, null is returned.|
||Return value|{{Operators}}: The operator matching the username and password. Otherwise null.|
||Properties| |
||Parameters|# {{String}}: username
# {{String}}: password
|
h4.OperatorHookpointBlockRevoke
||Action name|OperatorHookpointBlockRevoke|
||Class name|{{com.cdrator.main.operator.action.OperatorHookpointBlockRevoke}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{OperatorAccessTags}}: The operator access tag matching the username and hookpoint key. Otherwise null.|
||Properties|# accessTagPostfix: Alternative access tag postfix. Default is _BLOCK_REVOKED
|
||Parameters|# {{String}}: username
# {{String}}: hookpointKey
|
h4.OperatorReader
||Action name|OperatorReader|
||Class name|{{com.cdrator.main.operator.action.OperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves an Operator based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OperatorTypeReader
||Action name|OperatorTypeReader|
||Class name|{{com.cdrator.main.operator.action.OperatorTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an operator type based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Service
h4.ChangeDevice
||Action name|ChangeDevice|
||Class name|{{com.cdrator.main.service.action.ChangeDevice}}|
||Available from core version|8.7|
||Description|This action assigns a device to a given service.|
||Return value|{{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.|
||Properties|# autoAssignDevice: Auto assign device? If true, then newDevice parameter will be disregarded and the underlying workflow will assign a device automatically.
|
||Parameters|# {{Service}}: service
# {{Device}}: newDevice
# {{boolean}}: addFee
# {{String}}: sendType
# {{Status}}: reason
# {{String}}: comment
|
h4.ChangeServiceStatus
||Action name|ChangeServiceStatus|
||Class name|{{com.cdrator.main.service.action.ChangeServiceStatus}}|
||Available from core version|8.7|
||Description|This action sets and saves the Service status. |
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{Service}}: service
|
h4.CompleteCachedOptions
||Action name|CompleteCachedOptions|
||Class name|{{com.cdrator.main.service.action.CompleteCachedOptions}}|
||Available from core version|8.7|
||Description|Complete cached options on service|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceCode
||Action name|GetServiceCode|
||Class name|{{com.cdrator.main.service.action.GetServiceCode}}|
||Available from core version|8.7|
||Description|Return the code of the service.|
||Return value|{{String}}: The code of the service.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceFromPhoneNumber
||Action name|GetServiceFromPhoneNumber|
||Class name|{{com.cdrator.main.service.action.GetServiceFromPhoneNumber}}|
||Available from core version|8.7|
||Description|This action gets an active service from the phone number and optionally the brand.|
||Return value|{{Service}}: The active service matching the phone number and brand.|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.main.service.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|This action gets a service option parameter given an option key and a parameter key.|
||Return value|{{ServiceOptionParameter}}: The service option parameter. If the service does not have the service option or the service option parameter, null is returned.|
||Properties|# optionKey: The option key to look for on service.
|
||Parameters|# {{Service}}: service
# {{String}}: parameterKey
|
h4.GetServicesForAccountAndProduct
||Action name|GetServicesForAccountAndProduct|
||Class name|{{com.cdrator.main.service.action.GetServicesForAccountAndProduct}}|
||Available from core version|8.7|
||Description|Return a list of services belonging to the account, with the a specific product code and with the status selected.|
||Return value|{{ArrayList}}: The list of recovered services, based on the input parameters.|
||Properties|# productIdDescription: The product for the service. If empty all services will be returned.
# serviceStatus: The service status. If empty all services will be returned.
|
||Parameters|# {{Account}}: account
|
h3.Main - Subscription
h4.ActivateSubscription
||Action name|ActivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ActivateSubscription}}|
||Available from core version|8.7|
||Description|This action activates a subscription in Rator.|
||Return value|{{Subscription}}: Returns the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.AddWorkflow
||Action name|AddWorkflow|
||Class name|{{com.cdrator.main.subscription.action.AddWorkflow}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the workflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{WfWorkflow}}: workflow
|
h4.ChangeRatePlan
||Action name|ChangeRatePlan|
||Class name|{{com.cdrator.main.subscription.action.ChangeRatePlan}}|
||Available from core version|8.7|
||Description|This action schedules a rateplan change.|
||Return value|{{RatePlanChange}}: Sets up, saves and returns a rate plan change.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{RatePlan}}: newRatePlan
# {{Product}}: newProduct
# {{Date}}: changeDate
# {{ArrayList}}: options
|
h4.CheckIfParentSubscriptionIsInState
||Action name|CheckIfParentSubscriptionIsInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfParentSubscriptionIsInState}}|
||Available from core version|8.7|
||Description|This action checks if a parent subscription is in a given state.|
||Return value|{{boolean}}: Returns true if the parent exists and state matches the given state.|
||Properties|# controlState: The available states.
|
||Parameters|# {{Subscription}}: subscription
|
h4.CheckIfSubscriptionInState
||Action name|CheckIfSubscriptionInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfSubscriptionInState}}|
||Available from core version|8.7|
||Description|This action checks if a subscription is in given states.|
||Return value|{{boolean}}: Returns YES if the subscription state matches one of the given states.|
||Properties|# possibleState: The possible states separated by ';'
|
||Parameters|# {{Subscription}}: subscription
|
h4.CreateSubscriptionTerminationRequest
||Action name|CreateSubscriptionTerminationRequest|
||Class name|{{com.cdrator.main.subscription.action.CreateSubscriptionTerminationRequest}}|
||Available from core version|8.7|
||Description|This action assembles subscription termination details in a termination request.|
||Return value|{{SubscriptionTerminationRequest}}: The constructed termination request object.|
||Properties|# addTerminationFee: If termination fee should be added. Default is false.
# terminationReason: Set the terminate reason text.
# terminationReasonID: Set the terminate reason id.
|
||Parameters|# {{String}}: comment
# {{Date}}: expectedTerminationDate
# {{Date}}: terminationOrderDate
# {{Date}}: endBillingDate
# {{Date}}: chargeUntilDate
# {{boolean}}: canContactCustomer
|
h4.DeepSave
||Action name|DeepSave|
||Class name|{{com.cdrator.main.subscription.action.DeepSave}}|
||Available from core version|8.7|
||Description|This action deep-saves a subscription in Rator.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetActiveBillingGroupOfSubscription
||Action name|GetActiveBillingGroupOfSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetActiveBillingGroupOfSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the active billing group of the subscription|
||Return value|{{BillingGroup}}: The active billing group of the subscription|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllActiveWorkflowsForSubscription
||Action name|GetAllActiveWorkflowsForSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscription}}|
||Available from core version|8.7|
||Description|This action returns all active workflows for a subscription.|
||Return value|{{ArrayList}}: An arrayList of workflows.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllChildSubscriptions
||Action name|GetAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.GetAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action returns all child subscriptions of a given subscription.|
||Return value|{{List}}: A list of child subscriptions.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Broker}}: broker
|
h4.IsSubscriptionActive
||Action name|IsSubscriptionActive|
||Class name|{{com.cdrator.main.subscription.action.IsSubscriptionActive}}|
||Available from core version|8.7|
||Description|Checks if the subscription is active|
||Return value|{{boolean}}: Returns true if the subscription is active|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptions
||Action name|ReactivateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptionsInList
||Action name|ReactivateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{List}}: subscriptions
|
h4.ReactivateSubscription
||Action name|ReactivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscription}}|
||Available from core version|8.7|
||Description|This action reactivates a subscription by setting the end date to null and the status to active.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateSubscriptionCore
||Action name|ReactivateSubscriptionCore|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscriptionCore}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{SubscriptionTermination}}: The Subscription Termination connected to the termination|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetAlertGroup
||Action name|SetAlertGroup|
||Class name|{{com.cdrator.main.subscription.action.SetAlertGroup}}|
||Available from core version|8.7|
||Description|An action to set the alert group on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{AlertGroup}}: alertGroup
|
h4.SetOwner
||Action name|SetOwner|
||Class name|{{com.cdrator.main.subscription.action.SetOwner}}|
||Available from core version|8.7|
||Description|This action sets the owner of a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Users}}: owner
|
h4.SetSubscriptionEndDate
||Action name|SetSubscriptionEndDate|
||Class name|{{com.cdrator.main.subscription.action.SetSubscriptionEndDate}}|
||Available from core version|8.7|
||Description|This action sets the subscription end date and saves the subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: endDate
|
h4.SubscriptionHasServiceCode
||Action name|SubscriptionHasServiceCode|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionHasServiceCode}}|
||Available from core version|8.7|
||Description|Determines whether or not the transfer of a subscription to another account is approved.|
||Return value|{{Boolean}}: Boolean result indicating whether or not this subscription transfer is approved.|
||Properties|# serviceCode: The service code to check for.
|
||Parameters|# {{Subscription}}: subscription
|
h4.SubscriptionReader
||Action name|SubscriptionReader|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SubscriptionSalesDetails
||Action name|SubscriptionSalesDetails|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionSalesDetails}}|
||Available from core version|8.7|
||Description|This action sets a sales rep and a sales store on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: salesRep
# {{String}}: salesStore
|
h4.SubscriptionTransferTo
||Action name|SubscriptionTransferTo|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferTo}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
|
h4.SubscriptionTransferToWithParent
||Action name|SubscriptionTransferToWithParent|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferToWithParent}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
# {{Subscription}}: newParentSubscription
|
h4.TerminateAllChildSubscriptions
||Action name|TerminateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.TerminateAllChildSubscriptionsInList
||Action name|TerminateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties|# consolidateFinalFees: Set consolidate final fees. Default is false.
# disregardBindingPeriod: Set disregard binding period. Default is false.
# endBillingDate: Set end billing date. Default is null.
# finalizeFees: Set finalize fees. Default is false.
|
||Parameters|# {{List}}: subscriptions
# {{Subscription}}: parentSubscription
|
h4.TerminateSubscription
||Action name|TerminateSubscription|
||Class name|{{com.cdrator.main.subscription.action.TerminateSubscription}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: No return value.|
||Properties|# terminateChildSubscriptions: Terminate the child subscriptions (if any) with same termination details as the parent subscription.
|
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionTerminationRequest}}: subscriptionTerminationRequest
|
h3.Main - Subscription - Lockin
h4.CreateNewSubscriptionLockin
||Action name|CreateNewSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.CreateNewSubscriptionLockin}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{SubscriptionLockin}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionLockinType}}: subscriptionLockinType
|
h4.GetAllSubscriptionLockins
||Action name|GetAllSubscriptionLockins|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetAllSubscriptionLockins}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-ins for a given subscription.|
||Return value|{{ArrayList}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionLockinTypes
||Action name|GetSubscriptionLockinTypes|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetSubscriptionLockinTypes}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-in types.|
||Return value|{{List}}: Returns a list of subscription lock-in types.|
||Properties| |
||Parameters| |
h4.HasSubscriptionLockin
||Action name|HasSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.HasSubscriptionLockin}}|
||Available from core version|8.7|
||Description|This action checks if a subscription has a lock-in.|
||Return value|{{String}}: Returns either NO or YES.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetLockinEndDateForLockinWithLeastEndDate
||Action name|SetLockinEndDateForLockinWithLeastEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetLockinEndDateForLockinWithLeastEndDate}}|
||Available from core version|8.7|
||Description|This action updates lockin_end_date of the subscription_lockin with least lockin_end_date and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h4.SetSubscriptionLockinEndDate
||Action name|SetSubscriptionLockinEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate}}|
||Available from core version|8.7|
||Description|This action updates subscription lock-in's end date and saves it. It updates only if a lockin exists.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h3.Main - Subscriptiontermination
h4.DeactivateSubscriptionTermination
||Action name|DeactivateSubscriptionTermination|
||Class name|{{com.cdrator.main.subscriptiontermination.action.DeactivateSubscriptionTermination}}|
||Available from core version|8.7|
||Description|This action deactivates a subscription termination.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SubscriptionTermination}}: subscriptionTermination
|
h3.Main - User
h4.CheckUsernameAvailability
||Action name|CheckUsernameAvailability|
||Class name|{{com.cdrator.main.user.action.CheckUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given username is available.|
||Return value|{{boolean}}: boolean true if the username is available (no user exists with the usename), else false|
||Properties|# caseSensitive: Is the username case sensitive?
|
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetAddress
||Action name|GetAddress|
||Class name|{{com.cdrator.main.user.action.GetAddress}}|
||Available from core version|8.7|
||Description|Action to create and save a new Address object based on the address information of the user passed as argument.|
||Return value|{{Address}}: Returns the newly created Address object.|
||Properties|# doSetCoFromAddress2: Specify whether or not the Address field CO should be set from user.address2.
|
||Parameters|# {{Users}}: user
|
h4.GetUserAccessLevel
||Action name|GetUserAccessLevel|
||Class name|{{com.cdrator.main.user.action.GetUserAccessLevel}}|
||Available from core version|8.7|
||Description|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.|
||Return 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|
||Properties| |
||Parameters|# {{Users}}: user
|
h4.GetUserByEmailAddress
||Action name|GetUserByEmailAddress|
||Class name|{{com.cdrator.main.user.action.GetUserByEmailAddress}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the email address exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: emailAddress
# {{Brand}}: brand
|
h4.GetUserByPhoneNumber
||Action name|GetUserByPhoneNumber|
||Class name|{{com.cdrator.main.user.action.GetUserByPhoneNumber}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the phone number exists. The value null is returned if none exists.|
||Properties|# cancelationPending: Include subscriptions in cancelation pending status.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetUserByUsername
||Action name|GetUserByUsername|
||Class name|{{com.cdrator.main.user.action.GetUserByUsername}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the username exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetUsersByPersonalIDHash
||Action name|GetUsersByPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.GetUsersByPersonalIDHash}}|
||Available from core version|8.7|
||Description|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 http://jira.cdrator.com/browse/CDRP-5401|
||Return value|{{ArrayList}}: An ArrayList of users matching the given personalID. If none exists, an empty ArrayList is returned.|
||Properties|# 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.
|
||Parameters|# {{String}}: personalIDInput
|
h4.SetNewPassword
||Action name|SetNewPassword|
||Class name|{{com.cdrator.main.user.action.SetNewPassword}}|
||Available from core version|8.7|
||Description|This action changes the password of a user. If password is blank, a password will be generated.|
||Return value|{{String}}: The new password.|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h4.SetPersonalIDHash
||Action name|SetPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.SetPersonalIDHash}}|
||Available from core version|8.7|
||Description|This action adds a PersonalID entry for a User. The input parameter must already be hashed/encrypted if so desired.|
||Return value|{{void}}: No return value.|
||Properties|# endDateLastPeriod: To set expiry date on personal id.
# personalIDType: The personal ID type
|
||Parameters|# {{Users}}: user
# {{String}}: hashedPersonalID
|
h4.SetUserAsAccountOwner
||Action name|SetUserAsAccountOwner|
||Class name|{{com.cdrator.main.user.action.SetUserAsAccountOwner}}|
||Available from core version|8.7|
||Description|This action sets the user as account owner. Both user and account is saved.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Users}}: user
# {{Account}}: account
|
h4.UserReader
||Action name|UserReader|
||Class name|{{com.cdrator.main.user.action.UserReader}}|
||Available from core version|8.7|
||Description|Retrieves a User based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - User - Login
h4.LoginUserWithAttemptsCount
||Action name|LoginUserWithAttemptsCount|
||Class name|{{com.cdrator.main.user.login.action.LoginUserWithAttemptsCount}}|
||Available from core version|8.7|
||Description|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)|
||Return value|{{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|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h3.Misc
h4.CreateLongDescriptionElementList
||Action name|CreateLongDescriptionElementList|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElementList}}|
||Available from core version|8.7|
||Description|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()'|
||Return value|{{List}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs. It must be a regular expression. Example : ',|
|
| ' will split at , and newline
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
# {{List}}: addToExistingList
|
h4.CreateLongDescriptionElements
||Action name|CreateLongDescriptionElements|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElements}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{ArrayList}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs.
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FileObjectReader
||Action name|FileObjectReader|
||Class name|{{com.cdrator.misc.action.FileObjectReader}}|
||Available from core version|8.7|
||Description|Retrieves a File Object based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.MailTemplateReader
||Action name|MailTemplateReader|
||Class name|{{com.cdrator.misc.action.MailTemplateReader}}|
||Available from core version|8.7|
||Description|Retrieves a Mail Template based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Misc - Barcodes
h4.GenerateQRCodeImage
||Action name|GenerateQRCodeImage|
||Class name|{{com.cdrator.misc.barcodes.action.GenerateQRCodeImage}}|
||Available from core version|8.7|
||Description|This action retrieves an Image of a QR code of the specified content having the specified size |
||Return value|{{Image}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{int}}: width
# {{int}}: height
# {{String}}: content
|
h3.Np
h4.LookupActiveNpFlow
||Action name|LookupActiveNpFlow|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlow}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow of a given phone number and (optionally) brand (via the subscription).|
||Return value|{{NpFlow}}: The NP Flow matching the phone number and the brand.|
||Properties|# ignoreBrand: Ignore the brand connected to the NP Flow.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.LookupActiveNpFlowBySubscription
||Action name|LookupActiveNpFlowBySubscription|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlowBySubscription}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow for a given subscription.|
||Return value|{{NpFlow}}: The active NP Flow from the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.NpFlowReader
||Action name|NpFlowReader|
||Class name|{{com.cdrator.np.action.NpFlowReader}}|
||Available from core version|8.7|
||Description|Retrieves an NP flow based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveNpFlow
||Action name|SaveNpFlow|
||Class name|{{com.cdrator.np.action.SaveNpFlow}}|
||Available from core version|8.7|
||Description|Sets some initial values on np flow.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{NpFlow}}: npFlow
|
h4.SetRejectCodeOnExportFlow
||Action name|SetRejectCodeOnExportFlow|
||Class name|{{com.cdrator.np.action.SetRejectCodeOnExportFlow}}|
||Available from core version|8.7|
||Description|Set Reject Code and Comment On an Np Export Flow object.|
||Return value|{{void}}: No return value.|
||Properties|# comment: Used for adding a static comment.
# rejectCode: Used for adding reject code.
|
||Parameters|# {{NpExportFlow}}: npFlow
# {{String}}: dynamicComment
|
h4.TeleOperatorReader
||Action name|TeleOperatorReader|
||Class name|{{com.cdrator.np.action.TeleOperatorReader}}|
||Available from core version|8.7|
||Description|Retrievse a tele operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Np - Range
h4.CheckOverlappingRange
||Action name|CheckOverlappingRange|
||Class name|{{com.cdrator.np.range.action.CheckOverlappingRange}}|
||Available from core version|8.7|
||Description|Check if the ranges are overlapping|
||Return value|{{boolean}}: A boolean indicating whether the two ranges overlap each other, fully or partially|
||Properties| |
||Parameters|# {{String}}: newRange
# {{String}}: existingRange
|
h3.Number
h4.AnumberReader
||Action name|AnumberReader|
||Class name|{{com.cdrator.number.action.AnumberReader}}|
||Available from core version|8.7|
||Description|Retrieves an A-number based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AssignAnumberToService
||Action name|AssignAnumberToService|
||Class name|{{com.cdrator.number.action.AssignAnumberToService}}|
||Available from core version|8.7|
||Description|Sets Anumber on Service (Only relevant for Service types with phone numbers.)|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Service}}: service
|
h4.GetANumbersForNumberSearchExact
||Action name|GetANumbersForNumberSearchExact|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchExact}}|
||Available from core version|8.7|
||Description|This action will return the list of anumbers that are exact match of the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchLastDigits
||Action name|GetANumbersForNumberSearchLastDigits|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchLastDigits}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers ending with the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchPattern
||Action name|GetANumbersForNumberSearchPattern|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchPattern}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers that contain the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchRandom
||Action name|GetANumbersForNumberSearchRandom|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchRandom}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random phone numbers according to the group_id.|
||Return value|{{ArrayList}}: List of phone numbers.|
||Properties|# batchLimit: Batch limit to fetch anumbers.
|
||Parameters|# {{Anumber_Group}}: group
# {{int}}: maxRows
|
h4.IsAnumberFree
||Action name|IsAnumberFree|
||Class name|{{com.cdrator.number.action.IsAnumberFree}}|
||Available from core version|8.7|
||Description|Given a phone number, checks if the related anumber is free.|
||Return value|{{boolean}}: True, if the anumber for the phone number is free, else False|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.ReReserveAnumber
||Action name|ReReserveAnumber|
||Class name|{{com.cdrator.number.action.ReReserveAnumber}}|
||Available from core version|8.7|
||Description|Re-reserves an already reserved anumber, if the number is not in use and already reserved with the given id.|
||Return value|{{boolean}}: Returns: boolean true if the number could be re-reserved|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{String}}: reservationId
# {{int}}: reserveTime
|
h4.SetAnumberReservToDate
||Action name|SetAnumberReservToDate|
||Class name|{{com.cdrator.number.action.SetAnumberReservToDate}}|
||Available from core version|8.7|
||Description|Sets the reservToDate on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Date}}: reservToDate
|
h4.SetAnumberStatus
||Action name|SetAnumberStatus|
||Class name|{{com.cdrator.number.action.SetAnumberStatus}}|
||Available from core version|8.7|
||Description|Sets status on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{StatusAnumber}}: status
|
h4.ValidateAnumberReservation
||Action name|ValidateAnumberReservation|
||Class name|{{com.cdrator.number.action.ValidateAnumberReservation}}|
||Available from core version|8.7|
||Description|This action validates that an a-number matches a reservation id, that the a-number has status not used and that the reservation has not expired.|
||Return value|{{boolean}}: boolean true if reservation ID is still valid for the A-number, false otherwise.|
||Properties| |
||Parameters|# {{String}}: anumber
# {{String}}: reservationId
|
h3.Persistence
h4.CheckIfPersisted
||Action name|CheckIfPersisted|
||Class name|{{com.cdrator.persistence.action.CheckIfPersisted}}|
||Available from core version|8.7|
||Description|Check if an object is persisted|
||Return value|{{boolean}}: A boolean indicating whether the object is persisted or not.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Product
h4.ChangeAnumberGroup
||Action name|ChangeAnumberGroup|
||Class name|{{com.cdrator.product.action.ChangeAnumberGroup}}|
||Available from core version|8.7|
||Description|Sets the group on an A-number and saves it.|
||Return value|{{Anumber}}: Returns the updated A-number.|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Anumber_Group}}: group
|
h4.CheckProductServiceClassCode
||Action name|CheckProductServiceClassCode|
||Class name|{{com.cdrator.product.action.CheckProductServiceClassCode}}|
||Available from core version|8.7|
||Description|This action checks the products service class code.|
||Return value|{{boolean}}: Returns true if the product matches the service class configured.|
||Properties|# serviceClassCode: The service class code to check for.
|
||Parameters|# {{Product}}: product
|
h4.CreateCdmaPhoneForMeid
||Action name|CreateCdmaPhoneForMeid|
||Class name|{{com.cdrator.product.action.CreateCdmaPhoneForMeid}}|
||Available from core version|8.7|
||Description|This action creates a CdmaPhone based on the supplied MEID.|
||Return value|{{CdmaPhone}}: The cdmaPhone created is returned.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: meid
|
h4.FilterProductConfigsByShop
||Action name|FilterProductConfigsByShop|
||Class name|{{com.cdrator.product.action.FilterProductConfigsByShop}}|
||Available from core version|8.7|
||Description|This action filters an existing list of product configurations so only the ones set up for the shop is returned.|
||Return value|{{List}}: A list of product configs defined for the shop.|
||Properties| |
||Parameters|# {{List}}: productConfigs
# {{Shop}}: shop
|
h4.MakeSubscription
||Action name|MakeSubscription|
||Class name|{{com.cdrator.product.action.MakeSubscription}}|
||Available from core version|8.7|
||Description|Creates a new subscription, and a service, for a given product on a given account, billing group and user.|
||Return value|{{Subscription}}: Returns the subscription|
||Properties| |
||Parameters|# {{Account}}: account
# {{BillingGroup}}: bg
# {{ProductConfig}}: pc
# {{Users}}: user
|
h4.ProductConfigReader
||Action name|ProductConfigReader|
||Class name|{{com.cdrator.product.action.ProductConfigReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Config based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProductReader
||Action name|ProductReader|
||Class name|{{com.cdrator.product.action.ProductReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.RemoveSharedServiceMemberEndDate
||Action name|RemoveSharedServiceMemberEndDate|
||Class name|{{com.cdrator.product.action.RemoveSharedServiceMemberEndDate}}|
||Available from core version|8.7|
||Description|This action removes the end date of a sharedServiceMember.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SharedServiceMember}}: sharedServiceMember
|
h4.ReserveCdmaPhoneForService
||Action name|ReserveCdmaPhoneForService|
||Class name|{{com.cdrator.product.action.ReserveCdmaPhoneForService}}|
||Available from core version|8.7|
||Description|This action reserves a CdmaPhone for a service.|
||Return value|{{CdmaPhone}}: The CdmaPhone is returned.|
||Properties| |
||Parameters|# {{CdmaPhone}}: cdmaPhone
# {{Service}}: service
|
h3.Product - Option
h4.CompareSubscribedProductOptionParameter
||Action name|CompareSubscribedProductOptionParameter|
||Class name|{{com.cdrator.product.option.action.CompareSubscribedProductOptionParameter}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for.
# parameterKey: The parameter key that we are searching for.
|
||Parameters|# {{Service}}: service
# {{String}}: compareValue
|
h4.ExistsActiveCampaignForEqualOrHigherPackage
||Action name|ExistsActiveCampaignForEqualOrHigherPackage|
||Class name|{{com.cdrator.product.option.action.ExistsActiveCampaignForEqualOrHigherPackage}}|
||Available from core version|8.7|
||Description|Checks if there is campaign for equal or higher package option|
||Return value|{{boolean}}: If there is an active subscriptionCampaign associated to a greater or equal package option returns true|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Subscription}}: subscription
|
h4.GetLowestSubscribedOption
||Action name|GetLowestSubscribedOption|
||Class name|{{com.cdrator.product.option.action.GetLowestSubscribedOption}}|
||Available from core version|8.7|
||Description|Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Return value|{{ProductOption}}: Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
|
h4.GetOptionMetaData
||Action name|GetOptionMetaData|
||Class name|{{com.cdrator.product.option.action.GetOptionMetaData}}|
||Available from core version|8.7|
||Description|This action returns the meta data on an option based on the Option and the Metadata name.|
||Return value|{{ProductOptionMetaData}}: The ProductOptionMetaData for the option and Metadata name. If not found, null is returned.|
||Properties| |
||Parameters|# {{Option}}: option
# {{String}}: metaDataName
|
h4.GetOptionPriceElementsForProductRatePlanAndCategory
||Action name|GetOptionPriceElementsForProductRatePlanAndCategory|
||Class name|{{com.cdrator.product.option.action.GetOptionPriceElementsForProductRatePlanAndCategory}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan, product and category.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time. When category is set cache is always enabled.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
# {{String}}: category
|
h4.GetOptionsForProductAndRatePlan
||Action name|GetOptionsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Product Option available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: An list of product options.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetOptionsPrice
||Action name|GetOptionsPrice|
||Class name|{{com.cdrator.product.option.action.GetOptionsPrice}}|
||Available from core version|8.7|
||Description|Returns a map of product option id and the related price for the given subscription and product options list.|
||Return value|{{Hashtable}}: Returns a map of product option id and the related price.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: optionsList
|
h4.GetOptionsPricesElementsForProductAndRatePlan
||Action name|GetOptionsPricesElementsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsPricesElementsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetProductOptionsFromService
||Action name|GetProductOptionsFromService|
||Class name|{{com.cdrator.product.option.action.GetProductOptionsFromService}}|
||Available from core version|8.7|
||Description|Returns all the product options subscribed to be the given service.|
||Return value|{{ArrayList}}: An array list of product options.|
||Properties|# onlyActive: If this is set, only serviceOptions that are active will be used to get the productOptions.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOption
||Action name|GetServiceOption|
||Class name|{{com.cdrator.product.option.action.GetServiceOption}}|
||Available from core version|8.7|
||Description|Action to retrieve a service option based on the option key.|
||Return value|{{ServiceOption}}: The service option.|
||Properties|# optionKey: The key of the option that will be retrieved.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOptionForParameterWithSpecifiedObjectReference
||Action name|GetServiceOptionForParameterWithSpecifiedObjectReference|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionForParameterWithSpecifiedObjectReference}}|
||Available from core version|8.7|
||Description|Returns a serviceOption for parameter with matching obejct reference.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
# {{String}}: parameterKey
# {{String}}: objectReferenceClass
# {{String}}: objectReferenceId
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Returns a serviceOptionParameter with the specified parameterKey.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: parameterKey
|
h4.GetServiceOptionRecurrentFee
||Action name|GetServiceOptionRecurrentFee|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionRecurrentFee}}|
||Available from core version|8.7|
||Description|Retrieves the recurrent fee of the service option|
||Return value|{{SubscriptionFees}}: Returns the recurrent fee of the service option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetServiceOptionsByCriteria
||Action name|GetServiceOptionsByCriteria|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionsByCriteria}}|
||Available from core version|8.7|
||Description|Returns a list of service option for a service matching the given criteria.|
||Return value|{{List}}: A List of service options matching given criterias.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: criterias
|
h4.GetSiblingServiceOption
||Action name|GetSiblingServiceOption|
||Class name|{{com.cdrator.product.option.action.GetSiblingServiceOption}}|
||Available from core version|8.7|
||Description|Get the sibling service option of a specific service option if that exists|
||Return value|{{ServiceOption}}: Returns the sibling service option of the current service option if that exists. Otherwise returns null|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetTotalPriceForOptionChange
||Action name|GetTotalPriceForOptionChange|
||Class name|{{com.cdrator.product.option.action.GetTotalPriceForOptionChange}}|
||Available from core version|8.7|
||Description|Compares the two list and returns the total price of the change|
||Return value|{{Amount}}: The total price as an amount|
||Properties| |
||Parameters|# {{List}}: oldOptions
# {{List}}: newOptions
|
h4.HasSiblingOptionLowerPackageWeight
||Action name|HasSiblingOptionLowerPackageWeight|
||Class name|{{com.cdrator.product.option.action.HasSiblingOptionLowerPackageWeight}}|
||Available from core version|8.7|
||Description|Checks if the sibling option has lower package_weight than the current option|
||Return value|{{boolean}}: Returns true if the sibling option has lower package_weight than the current option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{ServiceOption}}: siblingServiceOption
|
h4.HasSubscribedProductOption
||Action name|HasSubscribedProductOption|
||Class name|{{com.cdrator.product.option.action.HasSubscribedProductOption}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for
|
||Parameters|# {{Service}}: service
|
h4.IsOptionInExclusiveGroup
||Action name|IsOptionInExclusiveGroup|
||Class name|{{com.cdrator.product.option.action.IsOptionInExclusiveGroup}}|
||Available from core version|8.7|
||Description|Checks if option belongs to an exclusive group|
||Return value|{{boolean}}: Returns true if the option belongs to an exclusive option group|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.OptionReader
||Action name|OptionReader|
||Class name|{{com.cdrator.product.option.action.OptionReader}}|
||Available from core version|8.7|
||Description|Retrieves an option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OptionStatusChangeActionCheck
||Action name|OptionStatusChangeActionCheck|
||Class name|{{com.cdrator.product.option.action.OptionStatusChangeActionCheck}}|
||Available from core version|8.7|
||Description|Compare the action used in option status_change workflow to a predefined action value|
||Return value|{{boolean}}: If the action equals to the predefined action value it returns true. Otherwise it returns false.|
||Properties|# actionValue: The action value that the action should be compared to
|
||Parameters|# {{String}}: action
|
h4.RemoveListOfServiceOptions
||Action name|RemoveListOfServiceOptions|
||Class name|{{com.cdrator.product.option.action.RemoveListOfServiceOptions}}|
||Available from core version|8.7|
||Description|Removes all service options in a list|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
|
h4.RemovePendingTerminationOption
||Action name|RemovePendingTerminationOption|
||Class name|{{com.cdrator.product.option.action.RemovePendingTerminationOption}}|
||Available from core version|8.7|
||Description|Removes a pending termination option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: action
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.RemoveServiceOption
||Action name|RemoveServiceOption|
||Class name|{{com.cdrator.product.option.action.RemoveServiceOption}}|
||Available from core version|8.7|
||Description|Removes the service option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetEndDateOnServiceOptionList
||Action name|SetEndDateOnServiceOptionList|
||Class name|{{com.cdrator.product.option.action.SetEndDateOnServiceOptionList}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date from a list of options retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
# {{Date}}: date
|
h4.SetServiceOptionEndDateRestOfMonth
||Action name|SetServiceOptionEndDateRestOfMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateRestOfMonth}}|
||Available from core version|8.7|
||Description|Sets the end date of the option.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionEndDateToSpecificDate
||Action name|SetServiceOptionEndDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SetServiceOptionEndDateToStartDate
||Action name|SetServiceOptionEndDateToStartDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToStartDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' endDate to the service option's startDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionParameterValue
||Action name|SetServiceOptionParameterValue|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionParameterValue}}|
||Available from core version|8.7|
||Description|Updates a service option parameter value.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{String}}: newValue
|
h4.SetServiceOptionStartDateToNextMonth
||Action name|SetServiceOptionStartDateToNextMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the first day of next month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionStartDateToSpecificDate
||Action name|SetServiceOptionStartDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SubscribeToProductOption
||Action name|SubscribeToProductOption|
||Class name|{{com.cdrator.product.option.action.SubscribeToProductOption}}|
||Available from core version|8.7|
||Description|Subscribes to a product option for a given service and product option.|
||Return value|{{ServiceOption}}: The service option created by subscribing to the option.|
||Properties|# optionKey: The option key that the service will subscribe to.
|
||Parameters|# {{Service}}: service
|
h4.UnsubscribeOptionsWithCampaigns
||Action name|UnsubscribeOptionsWithCampaigns|
||Class name|{{com.cdrator.product.option.action.UnsubscribeOptionsWithCampaigns}}|
||Available from core version|8.7|
||Description|Unsubscribes to options with campaigns (and only options with a campaign) for a given service.|
||Return value|{{List}}: A list of the unsubscribed service options.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.UnsubscribeToOption
||Action name|UnsubscribeToOption|
||Class name|{{com.cdrator.product.option.action.UnsubscribeToOption}}|
||Available from core version|8.7|
||Description|If there is a dynamic optionkey parameter, it will override the optionkey property unless it is null. If neither option key or dynamic option key is set an Action Parameter Exception is thrown.|
||Return value|{{void}}: No value returned|
||Properties|# makeProvisioningTask: Make provisioning task?
# optionKey: The key of the option that will be unsubscribed
|
||Parameters|# {{Service}}: service
# {{String}}: dynamicOptionKey
|
h4.ValidateOptions
||Action name|ValidateOptions|
||Class name|{{com.cdrator.product.option.action.ValidateOptions}}|
||Available from core version|8.7|
||Description|This action validates that options are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config.|
||Properties| |
||Parameters|# {{List}}: options
# {{ProductConfig}}: productConfig
|
h4.ValidateOptionsRateplan
||Action name|ValidateOptionsRateplan|
||Class name|{{com.cdrator.product.option.action.ValidateOptionsRateplan}}|
||Available from core version|8.7|
||Description|This action validates that the list of options passed as a parameter are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config, false otherwise.|
||Properties| |
||Parameters|# {{List}}: options
# {{RatePlan}}: rateplan
|
h3.Product - Service
h4.AssignCdmaPhoneToService
||Action name|AssignCdmaPhoneToService|
||Class name|{{com.cdrator.product.service.action.AssignCdmaPhoneToService}}|
||Available from core version|8.7|
||Description|This action assigns a cdmaPhone to a service.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has been assigned to the service.|
||Properties| |
||Parameters|# {{CdmaService}}: service
# {{CdmaPhone}}: cdmaPhone
|
h4.CanBlockService
||Action name|CanBlockService|
||Class name|{{com.cdrator.product.service.action.CanBlockService}}|
||Available from core version|8.7|
||Description|This action checks if a service can be blocked.|
||Return value|{{boolean}}: A boolean indicating whether the service can be blocked.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.ReleaseCdmaPhone
||Action name|ReleaseCdmaPhone|
||Class name|{{com.cdrator.product.service.action.ReleaseCdmaPhone}}|
||Available from core version|8.7|
||Description|This action releases the CdmaPhone assigned to the service, if a CdmaPhone exists.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has just been released.|
||Properties| |
||Parameters|# {{CdmaService}}: service
|
h4.ServiceReader
||Action name|ServiceReader|
||Class name|{{com.cdrator.product.service.action.ServiceReader}}|
||Available from core version|8.7|
||Description|Retrieves a service based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Product - Service - Fixed
h4.SetPhoneNumberOnFixedLineService
||Action name|SetPhoneNumberOnFixedLineService|
||Class name|{{com.cdrator.product.service.fixed.action.SetPhoneNumberOnFixedLineService}}|
||Available from core version|8.7|
||Description|This action sets the provided phone number on a fixed line service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h3.Product - Service - Option
h4.GetServiceOptionFromOptionMetaData
||Action name|GetServiceOptionFromOptionMetaData|
||Class name|{{com.cdrator.product.service.option.action.GetServiceOptionFromOptionMetaData}}|
||Available from core version|8.7|
||Description|Search in the list of meta data records linked to the Option, if the service provided is subscribed to a product option key that is in the list then the service option is returned.|
||Return value|{{ServiceOption}}: The first service option found if subscribed to the service and in the meta data option list. Null if service not subscribed to any option in the meta data list.|
||Properties|# isAllowed: Check if the option is allowed or not.
|
||Parameters|# {{Option}}: option
# {{Service}}: service
|
h4.ServiceOptionReader
||Action name|ServiceOptionReader|
||Class name|{{com.cdrator.product.service.option.action.ServiceOptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a service option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SwitchServiceOptionsAction
||Action name|SwitchServiceOptionsAction|
||Class name|{{com.cdrator.product.service.option.action.SwitchServiceOptionsAction}}|
||Available from core version|8.7|
||Description|Unsubscribes a current service option and subscribes to a new option.|
||Return value|{{String}}: The id of the newly subscribed service option.|
||Properties|# makeProvisioningTask: If cached options should be completed or not.
|
||Parameters|# {{Subscription}}: subscription
# {{Option}}: optionToUnSubscribe
# {{Option}}: optionToSubscribe
|
h3.Product - Service - Shared
h4.GetAllNonTerminatedSharedServiceMembers
||Action name|GetAllNonTerminatedSharedServiceMembers|
||Class name|{{com.cdrator.product.service.shared.action.GetAllNonTerminatedSharedServiceMembers}}|
||Available from core version|8.7|
||Description|This action returns a list of all non-terminated (active and cancellation pending) members of a shared service.|
||Return value|{{List}}: A list of all non-terminated members of the shared service.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
|
h4.GetNonTerminatedSharedServiceMember
||Action name|GetNonTerminatedSharedServiceMember|
||Class name|{{com.cdrator.product.service.shared.action.GetNonTerminatedSharedServiceMember}}|
||Available from core version|8.7|
||Description|This action returns the direct member to a shared service.|
||Return value|{{SharedServiceMember}}: The SharedServiceMember of the sharedServiceInterface is returned if found.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
# {{SharedServiceInterface}}: sharedServiceInterface
|
h3.Product - Service - Tele
h4.DisconnectOldSimCards
||Action name|DisconnectOldSimCards|
||Class name|{{com.cdrator.product.service.tele.action.DisconnectOldSimCards}}|
||Available from core version|8.7|
||Description|This action disconnect any old SIMcards related to this TeleService (where TeleService.imsi not like SimCard.imsi ).|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h4.TeleServicePhoneNumber
||Action name|TeleServicePhoneNumber|
||Class name|{{com.cdrator.product.service.tele.action.TeleServicePhoneNumber}}|
||Available from core version|8.7|
||Description|This action sets a phone number on a Tele service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h4.UnBlockTeleService
||Action name|UnBlockTeleService|
||Class name|{{com.cdrator.product.service.tele.action.UnBlockTeleService}}|
||Available from core version|8.7|
||Description|This unblocks a service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h3.Product - Voucher
h4.AssignVoucher
||Action name|AssignVoucher|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucher}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{boolean}}: Boolean with the result of the assignment.|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.AssignVoucherToSubscription
||Action name|AssignVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.ChargeVoucherToSubscription
||Action name|ChargeVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.ChargeVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Charge a voucher to a subscription|
||Return value|{{boolean}}: A boolean value indicating whether the voucher was charged successfully|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.CreateNewVoucher
||Action name|CreateNewVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateNewVoucher}}|
||Available from core version|8.7|
||Description|To be used when a new voucher needs to be created. The keyword which is generated is an alphanumeric code.The length of this code is specified by the property numberOfCharacters. A voucherBatch needs to be passed to this action.|
||Return value|{{Voucher}}: The voucher which was created.|
||Properties|# numberOfCharacters: null
|
||Parameters|# {{VoucherBatch}}: voucherBatch
|
h4.CreateVoucher
||Action name|CreateVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateVoucher}}|
||Available from core version|8.7|
||Description|Creates a new voucher with the specified number of alphanumeric characters for the keyword, voucher code, price code and amount.|
||Return value|{{Voucher}}: The created voucher.|
||Properties|# batchVoucherCode: The voucher code.
# currencyCode: The amount currency code.
# numberOfCharacters: The length of the keyword alphanumeric code.
|
||Parameters|# {{Amount}}: amount
# {{String}}: priceCode
|
h4.GetVouchers
||Action name|GetVouchers|
||Class name|{{com.cdrator.product.voucher.action.GetVouchers}}|
||Available from core version|8.7|
||Description|Returns a list of vouchers|
||Return value|{{Collection}}: List of vouchers related to the batchId and the statusId for a given subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: batchId
# {{String}}: statusId
|
h4.VoucherBatchReader
||Action name|VoucherBatchReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherBatchReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.VoucherReader
||Action name|VoucherReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Provisioning
h4.CreateProvisioningTask
||Action name|CreateProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.CreateProvisioningTask}}|
||Available from core version|8.7|
||Description|Create a provisioning task of a specific type (CODE). The status of the new task will be "New". (the workflow instance can be added using "_activity.getWorkflow()")|
||Return value|{{ProvisioningTask}}: Return response code from ProvisioningRequest object.|
||Properties|# priority: Optional priority of the provisioning task. Default is 5
# taskComments: Optional comments to add to the provisioning task
# taskDescription: Optional description to add to the provisioning task
# taskType: The type of task that should be provisioned
|
||Parameters|# {{Service}}: service
# {{WfWorkflow}}: workflow
|
h4.GetProvisioningRequestsByReference
||Action name|GetProvisioningRequestsByReference|
||Class name|{{com.cdrator.provisioning.action.GetProvisioningRequestsByReference}}|
||Available from core version|8.7|
||Description|Retrieves a List of ProvisioningRequest linked to a ProvisioningTask by reference field.|
||Return value|{{List}}: Returns the ProvisioningRequest linked from the task reference.|
||Properties|# linkedFieldOnRequest: Optional to choose the database field from which to retrieve the reference linking the request to the task. Required to be varchar2 field.
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.GetResponseCodeFromProvisioningRequest
||Action name|GetResponseCodeFromProvisioningRequest|
||Class name|{{com.cdrator.provisioning.action.GetResponseCodeFromProvisioningRequest}}|
||Available from core version|8.7|
||Description|Retrieves the Response Code from a ProvisioningRequest.|
||Return value|{{String}}: Return response code from ProvisioningRequest object.|
||Properties|# responseCodeField: Optional to choose the database field from which to retrieve the response code.
|
||Parameters|# {{ProvisioningRequest}}: request
|
h4.NetworkOperatorReader
||Action name|NetworkOperatorReader|
||Class name|{{com.cdrator.provisioning.action.NetworkOperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves a Network Operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProvisioningTaskReader
||Action name|ProvisioningTaskReader|
||Class name|{{com.cdrator.provisioning.action.ProvisioningTaskReader}}|
||Available from core version|8.7|
||Description|Retrieves a Provisioning Task based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ResetStartDateWithDelayOnProvisioningTask
||Action name|ResetStartDateWithDelayOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.ResetStartDateWithDelayOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Adds the delayInMinutes property to start date on Provisioning Task. If no start date on task, adds delay from current date.|
||Return value|{{void}}: No return values|
||Properties|# delayInMinutes: null
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.SetStatusOnProvisioningTask
||Action name|SetStatusOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.SetStatusOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Set Status for Processing on Provisioning Task.|
||Return value|{{void}}: No return values|
||Properties|# statusToSet: The status that the provisioning task will be set to.
|
||Parameters|# {{ProvisioningTask}}: task
|
h3.RecurrentFee
h4.BillSubscriptionFeeListToInvoiceNow
||Action name|BillSubscriptionFeeListToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeeListToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills the supplied subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{List}}: subscriptionFees
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNow
||Action name|BillSubscriptionFeesToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNowForListOfSubs
||Action name|BillSubscriptionFeesToInvoiceNowForListOfSubs|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNowForListOfSubs}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice for a list of subscriptions.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{Invoice}}: invoice
|
h4.SetFeeChargeDateToSiblingFeeChargeDate
||Action name|SetFeeChargeDateToSiblingFeeChargeDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeChargeDateToSiblingFeeChargeDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to sibling fee's next_charge_date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{SubscriptionFees}}: siblingFee
|
h4.SetFeeEndDateLastPeriod
||Action name|SetFeeEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodForFeeList
||Action name|SetFeeEndDateLastPeriodForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodToEndOfMonth
||Action name|SetFeeEndDateLastPeriodToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
h4.SetFeeNextChargeDateForFeeList
||Action name|SetFeeNextChargeDateForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeNextChargeDateToEndOfMonth
||Action name|SetFeeNextChargeDateToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SetFeeNextChargeDateToSpecificDate
||Action name|SetFeeNextChargeDateToSpecificDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.TerminateFeeFromEndDateLastPeriod
||Action name|TerminateFeeFromEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.TerminateFeeFromEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Terminates the fee from its end_date_last_period|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h3.Shop
h4.CheckShopUsernameAvailability
||Action name|CheckShopUsernameAvailability|
||Class name|{{com.cdrator.shop.action.CheckShopUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given shop user name is available.|
||Return value|{{boolean}}: boolean true if the user name is available (no shop exists with the user name), else false.|
||Properties|# caseSensitive: Is the shop user name case sensitive?
|
||Parameters|# {{String}}: username
|
h4.GetSubscriptionsForSalesStoreEstablishedBetween
||Action name|GetSubscriptionsForSalesStoreEstablishedBetween|
||Class name|{{com.cdrator.shop.action.GetSubscriptionsForSalesStoreEstablishedBetween}}|
||Available from core version|8.7|
||Description|Finds subscriptions with a specific sales store established between two dates|
||Return value|{{ArrayList}}: Subscriptions|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.SetShopParentId
||Action name|SetShopParentId|
||Class name|{{com.cdrator.shop.action.SetShopParentId}}|
||Available from core version|8.7|
||Description|This action sets the parent id of a shop and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Shop}}: parentShop
|
h4.ShopReader
||Action name|ShopReader|
||Class name|{{com.cdrator.shop.action.ShopReader}}|
||Available from core version|8.7|
||Description|Retrieves a shop based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Simcard
h4.ChangeSimStatus
||Action name|ChangeSimStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM card status. If softblocked, barred or stolen is set, the blocked from date is updated. If in use is set, the blocked from date is set null.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.ChangeSimTypeStatus
||Action name|ChangeSimTypeStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimTypeStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM type status.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status types to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.FindSimcardsByIccAndPUK
||Action name|FindSimcardsByIccAndPUK|
||Class name|{{com.cdrator.simcard.action.FindSimcardsByIccAndPUK}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM cards from the database based on ICC and PUK.|
||Return value|{{ArrayList}}: The SIM cards with the ICC substring or the complete PUK. If no SIM cards are found, null is returned.|
||Properties|# onlyAvailableSIM: Only return available simcards?
|
||Parameters|# {{String}}: icc
# {{String}}: puk
|
h4.GetAvailableRandomSimCard
||Action name|GetAvailableRandomSimCard|
||Class name|{{com.cdrator.simcard.action.GetAvailableRandomSimCard}}|
||Available from core version|8.7|
||Description|Fetches a random available SIM card. Available means that the status is 0 (open and active) and it's not reserved. The SIM card type can be specified as a parameter.|
||Return value|{{SimCard}}: The available SIM card if found.|
||Properties| |
||Parameters|# {{String}}: simTypeId
|
h4.GetSimcardByIcc
||Action name|GetSimcardByIcc|
||Class name|{{com.cdrator.simcard.action.GetSimcardByIcc}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM card from the database by ICC.|
||Return value|{{SimCard}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{String}}: icc
|
h4.ReserveSimcard
||Action name|ReserveSimcard|
||Class name|{{com.cdrator.simcard.action.ReserveSimcard}}|
||Available from core version|8.7|
||Description|Action for reserving a SIM card to a service.|
||Return value|{{boolean}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{SimCard}}: simcard
# {{Service}}: service
|
h4.SimCardReader
||Action name|SimCardReader|
||Class name|{{com.cdrator.simcard.action.SimCardReader}}|
||Available from core version|8.7|
||Description|Retrieves a SIM card based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Util
h4.AddHookpointResult
||Action name|AddHookpointResult|
||Class name|{{com.cdrator.util.action.AddHookpointResult}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result.|
||Return value|{{void}}: No return value|
||Properties|# clearHookpointResult: Clear hookpoint result except for keys starting with LAST_OUTCOME_
# key1: Key 1
# key2: Key 2
# key3: Key 3
|
||Parameters|# {{HookpointResult}}: result
# {{String}}: value1
# {{String}}: value2
# {{String}}: value3
|
h4.CreateCdrParameter
||Action name|CreateCdrParameter|
||Class name|{{com.cdrator.util.action.CreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action creates a new cdrparameter based on the given code. The description, value and object, will be set based on the given information.|
||Return value|{{CdrParameter}}: The created cdrparameter.|
||Properties|# code: The code to create the cdrparameter from.
# description: The description of the cdrparameter.
|
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FormatString
||Action name|FormatString|
||Class name|{{com.cdrator.util.action.FormatString}}|
||Available from core version|8.7|
||Description|Format a string. Uses standard String.format|
||Return value|{{String}}: The formatted string.|
||Properties|# format: The format string.
|
||Parameters|# {{Object}}: param1
# {{Object}}: param2
# {{Object}}: param3
# {{Object}}: param4
# {{Object}}: param5
|
h4.GeneratePDFAction
||Action name|GeneratePDFAction|
||Class name|{{com.cdrator.util.action.GeneratePDFAction}}|
||Available from core version|8.7|
||Description|Generates a PDF specification based on the specified type.|
||Return value|{{String}}: The generated PDF string - Base64 encoded.|
||Properties|# PDFType: Specify the type of PDF generation.
|
||Parameters|# {{PersistentObject}}: object
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.GenerateXMLFromPO
||Action name|GenerateXMLFromPO|
||Class name|{{com.cdrator.util.action.GenerateXMLFromPO}}|
||Available from core version|8.7|
||Description|This action generates a XML document based on the given XMLDocumentDefinition and Persistant object. The resulting XML is placed in the provided dirName with the provided name+timestamp|
||Return value|{{boolean}}: Returns a persistentObject from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: documentDefKey
# {{String}}: dirName
# {{String}}: fileName
# {{PersistentObject}}: persistantObject
# {{String}}: persistentObjectKey
|
h4.GetCdrParameter
||Action name|GetCdrParameter|
||Class name|{{com.cdrator.util.action.GetCdrParameter}}|
||Available from core version|8.7|
||Description|This action adds a new cdrparameter based on the given objects and text string. Throws NullPointerException if both the cdrParameter and the parameter definition does not exist in the database.|
||Return value|{{CdrParameter}}: Returns cdr parameter based on the given objecs.|
||Properties| |
||Parameters|# {{CdrParameterIf}}: object
# {{String}}: varname
# {{CdrParameterIf}}: alternativeObject
|
h4.GetHashedValueFromString
||Action name|GetHashedValueFromString|
||Class name|{{com.cdrator.util.action.GetHashedValueFromString}}|
||Available from core version|8.7|
||Description|This action returns a hashed string based on the input given and the chosen hash type.|
||Return value|{{String}}: Returns a string hash of the suppplied input.|
||Properties|# selectedHashAlgorithm: Chosen hashing algorithm. Only SHA-1, SHA-256, SHA-384, SHA-512, MD2, MD5 are supported. If none is specified or no match, then SHA-1 is assumed.
|
||Parameters|# {{String}}: input
|
h4.GetInstanceFromDB
||Action name|GetInstanceFromDB|
||Class name|{{com.cdrator.util.action.GetInstanceFromDB}}|
||Available from core version|8.7|
||Description|This action retrieves a persistentObject from the database.|
||Return value|{{PersistentObject}}: Returns a persistent object from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{String}}: className
# {{Broker}}: broker
# {{String}}: clause
|
h4.GetParameterTreeValues
||Action name|GetParameterTreeValues|
||Class name|{{com.cdrator.util.action.GetParameterTreeValues}}|
||Available from core version|8.7|
||Description|This action retrieves all parameter values for a given node path and brand.|
||Return value|{{List}}: Returns the list of parameter values for the given node path.|
||Properties|# nodePath: Path to parameter tree node. Example: ALERTS.ALERT_GROUPS.
|
||Parameters|# {{Brand}}: brand
|
h4.GetStatusTypesFor
||Action name|GetStatusTypesFor|
||Class name|{{com.cdrator.util.action.GetStatusTypesFor}}|
||Available from core version|8.7|
||Description|This action retrieves the statuses for a given status type code.|
||Return value|{{List}}: Returns statuses for the given code.|
||Properties| |
||Parameters|# {{String}}: code
|
h4.IsStringInDelimitedString
||Action name|IsStringInDelimitedString|
||Class name|{{com.cdrator.util.action.IsStringInDelimitedString}}|
||Available from core version|8.7|
||Description|This action returns true if a given string val is in the comma separated string values. Remark: Both strings are trimmed before comparison to avoid unintended results.|
||Return value|{{boolean}}: Returns true if the given val is in the values string, false in all other cases.|
||Properties| |
||Parameters|# {{String}}: val
# {{String}}: values
|
h4.SimpleReturn
||Action name|SimpleReturn|
||Class name|{{com.cdrator.util.action.SimpleReturn}}|
||Available from core version|8.7|
||Description|Returns the argument object|
||Return value|{{Object}}: The argument object|
||Properties| |
||Parameters|# {{Object}}: executionArg
|
h4.Throttle
||Action name|Throttle|
||Class name|{{com.cdrator.util.action.Throttle}}|
||Available from core version|8.7|
||Description|Throttles a process
Requires 2 parameters:
WORKFLOW.THROTTLING.<name>.CAP number of times the throttled process may be performed in each interval
WORKFLOW.THROTTLING.<name>.INTERVAL number of seconds each interval lasts|
||Return value|{{boolean}}: Returns true if the process can continue.|
||Properties|# name: Used to generate the keys for the properties and parameters.
|
||Parameters| |
h4.ThrowNewUserMessageSysExceptionAction
||Action name|ThrowNewUserMessageSysExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewUserMessageSysExceptionAction}}|
||Available from core version|8.7|
||Description|Will throw an exception with a user defined message. Use this action to manually throw an exception to force a rollback while also specifying an error message to the end user, e.g. in the SOAP response instead of displaying BUSINESS_ERROR.|
||Return value|{{void}}: No return value.|
||Properties|# userMessage: The user message to pass along the exception. Specify labels, max 5 labels, in the message using <LABEL(X)>, e.g. This is <LABEL1> example label one.
|
||Parameters|# {{String}}: label1
# {{String}}: label2
# {{String}}: label3
# {{String}}: label4
# {{String}}: label5
|
h4.ThrowNewWorkflowExceptionAction
||Action name|ThrowNewWorkflowExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewWorkflowExceptionAction}}|
||Available from core version|8.7|
||Description|Finalizes logistics file.|
||Return value|{{void}}: No return value.|
||Properties|# recordNo: Error message to log throw with exception.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h4.UpdatePersistentObject
||Action name|UpdatePersistentObject|
||Class name|{{com.cdrator.util.action.UpdatePersistentObject}}|
||Available from core version|8.7|
||Description|This action updates a persistent object by calling a method on it with one or more parameters. The persistent object is saved afterwards. Example: PersistentObject=USERS, method="setAccount", params=ACCOUNT result: USERS.setAccount(ACCOUNT); USERS.save();|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
# {{String}}: method
# {{Object[]}}: params
|
h3.Util - Date
h4.DateChanger
||Action name|DateChanger|
||Class name|{{com.cdrator.util.date.action.DateChanger}}|
||Available from core version|8.7|
||Description|Changes values on a given date, al values are given as numbers where e.g. Month=1 sets the date to January.|
||Return value|{{Date}}: The modified date.|
||Properties| |
||Parameters|# {{Date}}: date
# {{String}}: milliSecond
# {{String}}: second
# {{String}}: minute
# {{String}}: hour
# {{String}}: day
# {{String}}: month
# {{String}}: year
|
h4.DateComparator
||Action name|DateComparator|
||Class name|{{com.cdrator.util.date.action.DateComparator}}|
||Available from core version|8.7|
||Description|Compares two given dates for one of these actions: AFTER, BEFORE, or EQUALS. Date1 is compared against date2 with the action (e.g. date1 after date2).|
||Return value|{{boolean}}: A boolean representing the outcome of the specified operation.|
||Properties|# action: Specify the operation between dates.
|
||Parameters|# {{Date}}: date1
# {{Date}}: date2
|
h4.DateStaticAdder
||Action name|DateStaticAdder|
||Class name|{{com.cdrator.util.date.action.DateStaticAdder}}|
||Available from core version|8.7|
||Description|Adds day, hours, minutes, and second to the given date|
||Return value|{{Date}}: The modified date.|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters|# {{Date}}: date
|
h4.FormatDate
||Action name|FormatDate|
||Class name|{{com.cdrator.util.date.action.FormatDate}}|
||Available from core version|8.7|
||Description|Turns a given date into a string using a specified format.|
||Return value|{{String}}: The formatted date.|
||Properties|# format: The format to format the date by.
|
||Parameters|# {{Date}}: date
|
h4.GetDate
||Action name|GetDate|
||Class name|{{com.cdrator.util.date.action.GetDate}}|
||Available from core version|8.7|
||Description|An action to retrieve the current or a future date|
||Return value|{{Date}}: A date representing the sysdate + eventual added minutes, hours, days or months|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters| |
h4.GetEndOfMonthDate
||Action name|GetEndOfMonthDate|
||Class name|{{com.cdrator.util.date.action.GetEndOfMonthDate}}|
||Available from core version|8.7|
||Description|This action returns a calendar representing the last day of the current month.|
||Return value|{{Calendar}}: A calendar representing the last day of the current month.|
||Properties| |
||Parameters| |
h4.GetFirstDayOfMonth
||Action name|GetFirstDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetFirstDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the first day of the month of the supplied date|
||Return value|{{Date}}: A date representing the first day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetFormattedCalendarField
||Action name|GetFormattedCalendarField|
||Class name|{{com.cdrator.util.date.action.GetFormattedCalendarField}}|
||Available from core version|8.7|
||Description|Returns the string representation of the calendar field value in the given style and locale. Parameters requrired: dateField - the calendar field for which the string representation is returned (Calendar.MONTH ...); date - The source date; locale - The locale used for formatting. (no ...); dateStyle - The locale used for formatting.(Calendar.SHORT, Calendar.LONG).|
||Return value|{{String}}: Returns the string representation of the calendar field value in the given style and locale.|
||Properties| |
||Parameters|# {{int}}: dateField
# {{Date}}: date
# {{String}}: locale
# {{int}}: dateStyle
|
h4.GetLastDayOfMonth
||Action name|GetLastDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetLastDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the last day of the month of the supplied date|
||Return value|{{Date}}: A date representing the last day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetNextWorkingDay
||Action name|GetNextWorkingDay|
||Class name|{{com.cdrator.util.date.action.GetNextWorkingDay}}|
||Available from core version|8.7|
||Description|Get the next working day if the supplied date is a holiday|
||Return value|{{Date}}: The next working day|
||Properties| |
||Parameters|# {{Date}}: fromDate
|
h3.Util - Image
h4.GetImage
||Action name|GetImage|
||Class name|{{com.cdrator.util.image.action.GetImage}}|
||Available from core version|8.7|
||Description|Loads an image from a specific path given as parameter or context object|
||Return value|{{Image}}: Returns the Image object loaded from the given path.|
||Properties| |
||Parameters|# {{String}}: imagePath
|
h3.Util - Parameter
h4.CdrParameterReader
||Action name|CdrParameterReader|
||Class name|{{com.cdrator.util.parameter.action.CdrParameterReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDR Parameter based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.UpdateCreateCdrParameter
||Action name|UpdateCreateCdrParameter|
||Class name|{{com.cdrator.util.parameter.action.UpdateCreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action updates a cdr parameter, if the cdr parameter doesn't exist it will create a new one. The value, name and object will be set based on the given information.|
||Return value|{{CdrParameter}}: The updated/created cdr parameter.|
||Properties| |
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
h3.Unknown package
h4.SingleValueReader
||Action name|SingleValueReader|
||Class name|{{com.cdrator.util.SingleValueReader}}|
||Available from core version|8.7|
||Description|Reads a single value from a persistent object. Column name must be specified.|
||Return value|{{String}}: The string value of the specified column name of the persistent object|
||Properties|# columnName: The column name of the persistent object, from where to read the value from
|
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Util - String
h4.CreateListOfStringsFromDelimitedText
||Action name|CreateListOfStringsFromDelimitedText|
||Class name|{{com.cdrator.util.string.action.CreateListOfStringsFromDelimitedText}}|
||Available from core version|8.7|
||Description|Creates a List of strings from a delimited text|
||Return value|{{List}}: The list of strings computed by splitting the delimited text|
||Properties|# delimiter: The delimiter used in the text
|
||Parameters|# {{String}}: delimitedText
|
h3.Workflow
h4.PushWorkflow
||Action name|PushWorkflow|
||Class name|{{com.cdrator.workflow.action.PushWorkflow}}|
||Available from core version|8.7|
||Description|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
|
||Return value|{{WfActivity}}: The activity the workflow was waiting in.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{WfWorkflow}}: workflow
|
h4.PushWorkflowById
||Action name|PushWorkflowById|
||Class name|{{com.cdrator.workflow.action.PushWorkflowById}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{WfWorkflow}}: The pushed workflow.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{String}}: workflowId
# {{Broker}}: broker
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.StartNewWorkflow
||Action name|StartNewWorkflow|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflow}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{HookpointResult}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
|
h4.StartNewWorkflowList
||Action name|StartNewWorkflowList|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflowList}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
# {{List}}: objectList
# {{String}}: objectContextKey
|
h4.WorkflowActivityReader
||Action name|WorkflowActivityReader|
||Class name|{{com.cdrator.workflow.action.WorkflowActivityReader}}|
||Available from core version|8.7|
||Description|Retrieves a workflow activity based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Workflow - Context
h4.IsObjectInContext
||Action name|IsObjectInContext|
||Class name|{{com.cdrator.workflow.context.action.IsObjectInContext}}|
||Available from core version|8.7|
||Description|Checks if the object is in the context|
||Return value|{{boolean}}: true if the object is in the context|
||Properties|# objectKey: The key of the object to check in the context
|
||Parameters|# {{Map}}: context
|
h3.Workflow - Hookpointresult
h4.AddHookpointResultObjects
||Action name|AddHookpointResultObjects|
||Class name|{{com.cdrator.workflow.hookpointresult.action.AddHookpointResultObjects}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result. Allows having objects in HOOKPOINT_RESULT|
||Return value|{{void}}: No return value|
||Properties|# key1: Key 1
# key2: Key 2
# key3: Key 3
# key4: Key 4
# key5: Key 5
|
||Parameters|# {{HookpointResult}}: result
# {{Object}}: value1
# {{Object}}: value2
# {{Object}}: value3
# {{Object}}: value4
# {{Object}}: value5
|
h4.CheckHookpointResult
||Action name|CheckHookpointResult|
||Class name|{{com.cdrator.workflow.hookpointresult.action.CheckHookpointResult}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: True if result is success, False otherwise.|
||Properties|# errorCodesToIgnore: List of error codes to ignore. Use semicolon (;) to separate the values of the list.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h3.Billing - Billingcycle
h4.BillingCycleReader
||Action name|BillingCycleReader|
||Class name|{{com.cdrator.billing.billingcycle.action.BillingCycleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Cycle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetEndOfBillingCycleDate
||Action name|GetEndOfBillingCycleDate|
||Class name|{{com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate}}|
||Available from core version|8.7|
||Description|This action returns a date representing the last day of the current billing cycle for the given billing group.|
||Return value|{{Date}}: A Date representing the last day of the current billing cycle.|
||Properties| |
||Parameters|# {{Date}}: date
# {{BillingGroup}}: bg
|
h3.Billing - Billinggroup
h4.BillingGroupReader
||Action name|BillingGroupReader|
||Class name|{{com.cdrator.billing.billinggroup.action.BillingGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Group based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveBillingGroupMembers
||Action name|GetActiveBillingGroupMembers|
||Class name|{{com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers}}|
||Available from core version|8.7|
||Description|Retrieves the active members of the billing group|
||Return value|{{List}}: The active members of the billing group|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.HardBlockAllTeleServicesOnBillingGroup
||Action name|HardBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.SoftBlockAllTeleServicesOnBillingGroup
||Action name|SoftBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.UnBlockAllTeleServicesOnBillingGroup
||Action name|UnBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h3.Billing - Charge
h4.CreateSingleChargeForBillingGroup
||Action name|CreateSingleChargeForBillingGroup|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Billing Group. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.CreateSingleChargeForSubscription
||Action name|CreateSingleChargeForSubscription|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForSubscription}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Subscription. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{Subscription}}: subscription
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.RoundAllInvoicesInBatch
||Action name|RoundAllInvoicesInBatch|
||Class name|{{com.cdrator.billing.charge.action.RoundAllInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Rounds all invoices on an invoicebatch, to nearest whole number.|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: batch
# {{ChargeItem}}: chargeItem
|
h3.Billing - Financial - Billing
h4.AddChargeToBillingGroup
||Action name|AddChargeToBillingGroup|
||Class name|{{com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Number}}: amount
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.BuildAccountPaymentsForInvoicesOnBatch
||Action name|BuildAccountPaymentsForInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# paymentType: The account payment type that should be used for the payment.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: cdrParameterName
# {{String}}: parameterValue
|
h4.DoAccountPayment
||Action name|DoAccountPayment|
||Class name|{{com.cdrator.billing.financial.billing.action.DoAccountPayment}}|
||Available from core version|8.7|
||Description|Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.|
||Return value|{{AccountPayment}}: Returns the account payment|
||Properties|# accountPaymentTypeId: The account payment type of the recharge ticket.
# skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.
|
||Parameters|# {{RechargeTicket}}: rechargeTicket
# {{Invoice}}: invoice
# {{BillingGroup}}: billingGroup
# {{String}}: paymentRequestRef
# {{HookpointResult}}: hookpointResult
|
h4.GetListOfServicesInStatusFromSubscriptions
||Action name|GetListOfServicesInStatusFromSubscriptions|
||Class name|{{com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions}}|
||Available from core version|8.7|
||Description|Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.|
||Return value|{{List}}: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{List}}: statuses
|
h4.GetNewInvoice
||Action name|GetNewInvoice|
||Class name|{{com.cdrator.billing.financial.billing.action.GetNewInvoice}}|
||Available from core version|8.7|
||Description|This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.|
||Return value|{{Invoice}}: The newly created Invoice|
||Properties|# invoiceType: The available invoice types
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.MakeInvoicePaymentOnInvoicesInBatch
||Action name|MakeInvoicePaymentOnInvoicesInBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h4.ManualDebitOrCredit
||Action name|ManualDebitOrCredit|
||Class name|{{com.cdrator.billing.financial.billing.action.ManualDebitOrCredit}}|
||Available from core version|8.7|
||Description|This action calls the function addManualDebitOrCredit on the provided set of parameters.|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{TimeCharge}}: timeCharge
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{boolean}}: isDebit
# {{Amount}}: amount
# {{Currency}}: amountCurrency
# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.PayInvoicesOnBatch
||Action name|PayInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h3.Unknown package
h4.PaymentMethodReader
||Action name|PaymentMethodReader|
||Class name|{{com.cdrator.billing.financial.PaymentMethodReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Method entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Financial - Payments
h4.PaymentLogReader
||Action name|PaymentLogReader|
||Class name|{{com.cdrator.billing.financial.payments.action.PaymentLogReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Log based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Invoice
h4.CloseInvoiceWithCurrentDate
||Action name|CloseInvoiceWithCurrentDate|
||Class name|{{com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate}}|
||Available from core version|8.7|
||Description|Calls closeWithDueDate on a given invoice with current date.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.GetAccountPaymentsForInvoice
||Action name|GetAccountPaymentsForInvoice|
||Class name|{{com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice}}|
||Available from core version|8.7|
||Description|Gets a list of account payments related to the invoice.|
||Return value|{{List}}: A list of accountPayments.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.InvoiceCompareToLastStepId
||Action name|InvoiceCompareToLastStepId|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId}}|
||Available from core version|8.7|
||Description|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 |
||Return value|{{boolean}}: true or false|
||Properties| |
||Parameters|# {{Invoice}}: invoice
# {{String}}: compareString
# {{boolean}}: defaultForBlank
|
h4.InvoiceReader
||Action name|InvoiceReader|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceReader}}|
||Available from core version|8.7|
||Description|Retrieves an invoice based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.PayInvoicesInBatchWithAccountPayments
||Action name|PayInvoicesInBatchWithAccountPayments|
||Class name|{{com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments}}|
||Available from core version|8.7|
||Description|Marks all invoice on batch as paid|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: invoiceBatch
# {{String}}: reference
# {{String}}: transactionNumber
# {{AccountPaymentType}}: accountPaymentType
|
h4.PublishInvoice
||Action name|PublishInvoice|
||Class name|{{com.cdrator.billing.invoice.action.PublishInvoice}}|
||Available from core version|8.7|
||Description|Publishes a given invoice.|
||Return value|{{Invoice}}: The published invoice|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h3.Billing - Main
h4.GetBillingGroupsByUserID
||Action name|GetBillingGroupsByUserID|
||Class name|{{com.cdrator.billing.main.action.GetBillingGroupsByUserID}}|
||Available from core version|8.7|
||Description|This action will return an arraylist of billing groups that a given userID is the owner of.|
||Return value|{{ArrayList}}: An array list of billing groups.|
||Properties| |
||Parameters|# {{String}}: userID
|
h4.SetBillingGroupCurrencyCode
||Action name|SetBillingGroupCurrencyCode|
||Class name|{{com.cdrator.billing.main.action.SetBillingGroupCurrencyCode}}|
||Available from core version|8.7|
||Description|This action sets the currency code on the billing group. The billing group is saved.|
||Return value|{{void}}: No return value.|
||Properties|# currencyCode: The currency code which is set on the billing group.
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.TerminateSharedServiceIfNoTeleservices
||Action name|TerminateSharedServiceIfNoTeleservices|
||Class name|{{com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Boolean}}: Returns true if a shared Service was attempted terminated.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{Date}}: terminationDate
# {{String}}: hookpointKey
# {{String}}: reason
|
h3.Billing - Misc
h4.GetParameterValue
||Action name|GetParameterValue|
||Class name|{{com.cdrator.billing.misc.action.GetParameterValue}}|
||Available from core version|8.7|
||Description|This action retrieves a string representation of a parameter value.|
||Return value|{{String}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{String}}: key
# {{Brand}}: brand
|
h3.Billing - Payment
h4.AccountPaymentReader
||Action name|AccountPaymentReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AccountPaymentSetAuthorized
||Action name|AccountPaymentSetAuthorized|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetAuthorized}}|
||Available from core version|8.7|
||Description|Calls setAuthorized on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentSetCaptureInfo
||Action name|AccountPaymentSetCaptureInfo|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo}}|
||Available from core version|8.7|
||Description|Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage) |
||Return value|{{void}}: No return value|
||Properties|# captureMessage: Capture message to be set.
# useCaptureDate: Should Capture Date be set (to current time.
|
||Parameters|# {{AccountPayment}}: ap
|
h4.AccountPaymentSetDoCapture
||Action name|AccountPaymentSetDoCapture|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetDoCapture}}|
||Available from core version|8.7|
||Description|Calls setDoCapture on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentTypeReader
||Action name|AccountPaymentTypeReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AcountPaymentSetCaptureMessage
||Action name|AcountPaymentSetCaptureMessage|
||Class name|{{com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage}}|
||Available from core version|8.7|
||Description|Set capture message on AccountPayment|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{AccountPayment}}: ap
# {{String}}: captureMessage
|
h4.GetRechargeTicketForBillingGroup
||Action name|GetRechargeTicketForBillingGroup|
||Class name|{{com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup}}|
||Available from core version|8.7|
||Description|This action returns a rechargeTicket for a BillingGroup.|
||Return value|{{RechargeTicket}}: The recharge ticket, if it exists.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h3.Billing - Product
h4.DeviceCanUseOn
||Action name|DeviceCanUseOn|
||Class name|{{com.cdrator.billing.product.action.DeviceCanUseOn}}|
||Available from core version|8.7|
||Description|Calls CanUseOn on a given device with a given service.|
||Return value|{{boolean}}: Boolean showing if a given device can be used on a given service.|
||Properties| |
||Parameters|# {{Device}}: device
# {{Service}}: service
|
h4.GetDeviceFromParameterValue
||Action name|GetDeviceFromParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceFromParameterValue}}|
||Available from core version|8.7|
||Description|Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.|
||Return value|{{Device}}: The located device.|
||Properties| |
||Parameters|# {{String}}: name
# {{String}}: value
|
h4.GetDeviceParameterValue
||Action name|GetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action returns the value of a given device parameter or throws a NullValueException if none is found.|
||Return value|{{String}}: Value of the given parameter (as a string).|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
|
h4.SetDeviceParameterValue
||Action name|SetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.SetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action updates a device parameter value if it's found, otherwise it will be created.|
||Return value|{{boolean}}: True if the parameter was created, false if the parameter was updated.|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
# {{String}}: value
|
h3.Billing - Product - RatePlanChange
h4.CompleteRatePlanChange
||Action name|CompleteRatePlanChange|
||Class name|{{com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange}}|
||Available from core version|8.7|
||Description|This action completes the rateplan change by subscribing to the default and mandatory options.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{RatePlanChange}}: rpc
# {{boolean}}: cache
|
h3.Billing - Rating
h4.GetActiveRatePlanForSubscription
||Action name|GetActiveRatePlanForSubscription|
||Class name|{{com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the currently active rate plan for a subscription.|
||Return value|{{RatePlan}}: Returns a rate plan that is currently active for the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetPlanElement
||Action name|GetPlanElement|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElement}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters| |
h4.GetPlanElementForRatePlan
||Action name|GetPlanElementForRatePlan|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElementForRatePlan}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters|# {{RatePlan}}: ratePlan
|
h4.GetRatePlansByProduct
||Action name|GetRatePlansByProduct|
||Class name|{{com.cdrator.billing.rating.action.GetRatePlansByProduct}}|
||Available from core version|8.7|
||Description|This action retrieves rate plans for a product.|
||Return value|{{List}}: Returns a list of rate plans related to this product.|
||Properties| |
||Parameters|# {{Product}}: product
|
h3.Billing - Rating - Simulate
h4.BillingRecordBuilder
||Action name|BillingRecordBuilder|
||Class name|{{com.cdrator.billing.rating.simulate.action.BillingRecordBuilder}}|
||Available from core version|8.7|
||Description|Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.|
||Return value|{{BillingRecordSimulated}}: A new unrated billing record. Not persisted.|
||Properties|# BNumber: B-Number of the billing record.
# ratingCode: Rating code to be set on the Billing Record.
# ratingDuration: Rating duration to be set on the Billing Record.
# ratingKey: Rating key to be set on the Billing Record.
# ratingVolumne: Rating volume to be set on the Billing Record.
|
||Parameters|# {{Service}}: service
|
h4.CalculateInvoiceDetailLinesTotalChargeSum
||Action name|CalculateInvoiceDetailLinesTotalChargeSum|
||Class name|{{com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Amount}}: The sum to the total charges of the Invoice Detail Lines Wrappers|
||Properties|# ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
# throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
|
||Parameters|# {{List}}: idlList
|
h4.RatingSimulator
||Action name|RatingSimulator|
||Class name|{{com.cdrator.billing.rating.simulate.action.RatingSimulator}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{ArrayList}}: ArrayList of the Invoice Detail Lines|
||Properties| |
||Parameters|# {{Service}}: service
# {{BillingRecords}}: billingRecord
|
h3.Billing - Status
h4.StatusReader
||Action name|StatusReader|
||Class name|{{com.cdrator.billing.status.action.StatusReader}}|
||Available from core version|8.7|
||Description|Retrieves a Status object based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - SubscriptionFees
h4.AddFee
||Action name|AddFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddFee}}|
||Available from core version|8.7|
||Description|Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Returns the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# feeCode: The fee code for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
h4.AddSubscriptionFee
||Action name|AddSubscriptionFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee}}|
||Available from core version|8.7|
||Description|Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Return the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# planElement: The plan element for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SubscriptionFeesReader
||Action name|SubscriptionFeesReader|
||Class name|{{com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader}}|
||Available from core version|8.7|
||Description|Gets a subscription fee.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - TodoTask
h4.CreateTodoTask
||Action name|CreateTodoTask|
||Class name|{{com.cdrator.billing.todoTask.action.CreateTodoTask}}|
||Available from core version|8.7|
||Description|Creates a TodoTask based on configurable properties|
||Return value|{{void}}: No return values|
||Properties|# assignedToOperator: The operator the todo task is assigned to
# category: Task category
# contactPhoneNumber: Contact phone number
# description: Task Description
# reminderTimeInMinutes: Reminder time in minutes
# subject: Subject
# typeOfFollowUp: The type of follow up: email,letter,phone call,sms
|
||Parameters|# {{Service}}: service
|
h3.Brand
h4.BrandReader
||Action name|BrandReader|
||Class name|{{com.cdrator.brand.action.BrandReader}}|
||Available from core version|8.7|
||Description|Retrieves a Brand based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Campaign
h4.CampaignReader
||Action name|CampaignReader|
||Class name|{{com.cdrator.campaign.action.CampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a Campaign definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetBundlesFromCampaign
||Action name|GetBundlesFromCampaign|
||Class name|{{com.cdrator.campaign.action.GetBundlesFromCampaign}}|
||Available from core version|8.7|
||Description|Returns an list of campaign bundles from a campaign.|
||Return value|{{ArrayList}}: a list of campaign bundles|
||Properties| |
||Parameters|# {{Campaign}}: campaign
|
h4.GetCampaignForKey
||Action name|GetCampaignForKey|
||Class name|{{com.cdrator.campaign.action.GetCampaignForKey}}|
||Available from core version|8.7|
||Description|This action returns a campaign for which the campaign key is provided as a property.|
||Return value|{{Campaign}}: The campaign associated with the provided campaign key.|
||Properties|# campaignKey: The campaign key for the campaign.
|
||Parameters| |
h4.GetCurrentSubscriptionCampaign
||Action name|GetCurrentSubscriptionCampaign|
||Class name|{{com.cdrator.campaign.action.GetCurrentSubscriptionCampaign}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a subscription and campaign.|
||Return value|{{SubscriptionCampaign}}: The current SubscriptionCampaign.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Campaign}}: campaign
|
h4.GetNewSubscriptionBundle
||Action name|GetNewSubscriptionBundle|
||Class name|{{com.cdrator.campaign.action.GetNewSubscriptionBundle}}|
||Available from core version|8.7|
||Description|This action creates and returns a new SubscriptionBundle.|
||Return value|{{SubscriptionBundle}}: Returns a new SubscriptionBundle|
||Properties| |
||Parameters|# {{Bundle}}: bundle
# {{Subscription}}: subscription
# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.GetSubscriptionCampaignsByCriteria
||Action name|GetSubscriptionCampaignsByCriteria|
||Class name|{{com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.|
||Return value|{{List}}: A list of SubscriptionCampaign matching given criterias.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: criterias
|
h4.SetListOfSubscriptionCampaignToDateToSpecificDate
||Action name|SetListOfSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: subscriptionCampaigns
# {{Date}}: date
|
h4.SetSubBundleVal1FromServiceOption
||Action name|SetSubBundleVal1FromServiceOption|
||Class name|{{com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption}}|
||Available from core version|8.7|
||Description|This action updates value1 if an associated serviceOptionParameter with a given key can be found.|
||Return value|{{boolean}}: Boolean indicating success of finding and setting the parameter.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
# parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.
|
||Parameters|# {{SubscriptionBundle}}: bundle
# {{Broker}}: broker
|
h4.SetSubscriptionCampaignCollectionFromToDate
||Action name|SetSubscriptionCampaignCollectionFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.|
||Return value|{{boolean}}: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{ArrayList}}: subscriptionCampaignList
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignFromDateToNextMonth
||Action name|SetSubscriptionCampaignFromDateToNextMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to the first day of next month.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignFromDateToSpecificDate
||Action name|SetSubscriptionCampaignFromDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to a specific date.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SetSubscriptionCampaignInstanceFromToDate
||Action name|SetSubscriptionCampaignInstanceFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.|
||Return value|{{boolean}}: Returns true if the date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignParameter
||Action name|SetSubscriptionCampaignParameter|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignParameter}}|
||Available from core version|8.7|
||Description|An action to set subscriptionCampaign parameters.|
||Return value|{{void}}: No return value.|
||Properties|# parameterName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{String}}: value
|
h4.SetSubscriptionCampaignToDateRestOfMonth
||Action name|SetSubscriptionCampaignToDateRestOfMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth}}|
||Available from core version|8.7|
||Description|This action sets the toDate on a subscriptionCampaign to the end of the current month.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign.|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignToDateToSpecificDate
||Action name|SetSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SubCampaignSetParameter
||Action name|SubCampaignSetParameter|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameter}}|
||Available from core version|8.7|
||Description|This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# paramName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{Subscription}}: sub
# {{ServiceOptionParameter}}: sop
|
h4.SubCampaignSetParameterFromSOP
||Action name|SubCampaignSetParameterFromSOP|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameterFromSOP}}|
||Available from core version|8.7|
||Description|This action updates a subscription campaign parameter from a service option parameter with a given key.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
# paramName: The name of the subscription campaign parameter that should be set.
# parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.
|
||Parameters|# {{SubscriptionBundle}}: bundle
|
h4.SubscriptionCampaignReader
||Action name|SubscriptionCampaignReader|
||Class name|{{com.cdrator.campaign.action.SubscriptionCampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a subscription campaign based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.TerminateCampaignWithFromDate
||Action name|TerminateCampaignWithFromDate|
||Class name|{{com.cdrator.campaign.action.TerminateCampaignWithFromDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h3.Campaign - Bundle
h4.BundleReader
||Action name|BundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.BundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Bundle definition based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveSubscriptionBundlesDefinedByDate
||Action name|GetActiveSubscriptionBundlesDefinedByDate|
||Class name|{{com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate}}|
||Available from core version|8.7|
||Description|Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: date
|
h4.GetBundleForCampaignAndBundleKey
||Action name|GetBundleForCampaignAndBundleKey|
||Class name|{{com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey}}|
||Available from core version|8.7|
||Description|This action returns the bundle associated with the supplied campaign and bundleKey.|
||Return value|{{Bundle}}: The bundle associated with the supplied campaign and bundleKey.|
||Properties| |
||Parameters|# {{Campaign}}: campaign
# {{String}}: bundleKey
|
h4.GetCurrentSubscriptionBundlesNotUsedUpForCode
||Action name|GetCurrentSubscriptionBundlesNotUsedUpForCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleParameter
||Action name|GetSubscriptionBundleParameter|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter}}|
||Available from core version|8.7|
||Description|Finds a bundle parameter from a SubscriptionBundle.|
||Return value|{{String}}: The value of the Bundle parameter.|
||Properties|# optionKey: The parameter that should be read from the Bundle.
|
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundles
||Action name|GetSubscriptionBundles|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundles}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription.|
||Return value|{{ArrayList}}: The value of the Bundle parameter.|
||Properties|# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundlesWithCode
||Action name|GetSubscriptionBundlesWithCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleType
||Action name|GetSubscriptionBundleType|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleType}}|
||Available from core version|8.7|
||Description|Finds the type of a SubscriptionBundle.|
||Return value|{{String}}: The code of the SubscriptionBundle.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundleValue
||Action name|GetSubscriptionBundleValue|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue}}|
||Available from core version|8.7|
||Description|Get the defined Value field in the subscription bundle for the specified bundle.|
||Return value|{{Amount}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{Subscription}}: subscription
|
h4.IsSubscriptionBundleUsedUp
||Action name|IsSubscriptionBundleUsedUp|
||Class name|{{com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp}}|
||Available from core version|8.7|
||Description|Determines if a given subscription bundle is used up by comparing the maximum value with the current value.|
||Return value|{{boolean}}: True if the subscription bundle is completely used up, false otherwise.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.ProrateActivationSubscriptionCampaignBundles
||Action name|ProrateActivationSubscriptionCampaignBundles|
||Class name|{{com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles}}|
||Available from core version|8.7|
||Description|Create and prorate the bundles of the given subscription campaign for a certain start date.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign with the updated bundles|
||Properties|# roundPrecission: The precission used when rounding the bundles.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: fromDate
|
h4.SetSubscriptionBundleValueFromServiceOptionParameter
||Action name|SetSubscriptionBundleValueFromServiceOptionParameter|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified service option parameter.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{SubscriptionBundle}}: subscriptionBundle
|
h4.SetSubscriptionBundleValues
||Action name|SetSubscriptionBundleValues|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified bundles.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# value1: Set value 1
# value2: Set value 2
# value3: Set value 3
# value4: Set value 4
|
||Parameters|# {{String}}: value
# {{Subscription}}: subscription
|
h4.SubscriptionBundleReader
||Action name|SubscriptionBundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.SubscriptionBundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription Bundle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Correspondence - Archive
h4.DocArchiveReader
||Action name|DocArchiveReader|
||Class name|{{com.cdrator.correspondence.archive.action.DocArchiveReader}}|
||Available from core version|8.7|
||Description|Retrieves a DocArchive entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveDocArchiveFile
||Action name|SaveDocArchiveFile|
||Class name|{{com.cdrator.correspondence.archive.action.SaveDocArchiveFile}}|
||Available from core version|8.7|
||Description|If property FilePath is set, it will override the FilePath parameter. Throws ActionParameterException if neither is specified|
||Return value|{{void}}: No value returned|
||Properties|# filePath: FilePath
|
||Parameters|# {{DocArchive}}: archive
# {{String}}: filePathParameter
|
h3.Device
h4.DeviceReader
||Action name|DeviceReader|
||Class name|{{com.cdrator.device.action.DeviceReader}}|
||Available from core version|8.7|
||Description|Retrieves a Device based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Device - Cdmaphone
h4.CdmaPhoneReader
||Action name|CdmaPhoneReader|
||Class name|{{com.cdrator.device.cdmaphone.action.CdmaPhoneReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDMA phone based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Fraud - Addresscheck
h4.PerformAddressCheck
||Action name|PerformAddressCheck|
||Class name|{{com.cdrator.fraud.addresscheck.action.PerformAddressCheck}}|
||Available from core version|8.7|
||Description|This action performs an address check on a user.|
||Return value|{{AddressCheckResult}}: The AddressCheckResult is returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{AddressCheck}}: ac
|
h3.Fraud - Creditcheck
h4.PerformCreditCheck
||Action name|PerformCreditCheck|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheck}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{CreditCheck}}: cc
|
h4.PerformCreditCheckOnUser
||Action name|PerformCreditCheckOnUser|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheckOnUser}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
|
h3.Main - Account
h4.AccountIsNewSignupAllowed
||Action name|AccountIsNewSignupAllowed|
||Class name|{{com.cdrator.main.account.action.AccountIsNewSignupAllowed}}|
||Available from core version|8.7|
||Description|This action check if it is allowed to add a new subscription to an account |
||Return value|{{boolean}}: true(default) or false based on workflow with hook_point SUB_SIGNUP_ALLOWED.|
||Properties| |
||Parameters|# {{Account}}: account
|
h4.AccountReader
||Action name|AccountReader|
||Class name|{{com.cdrator.main.account.action.AccountReader}}|
||Available from core version|8.7|
||Description|Retrieves an Account based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AddAccountWarning
||Action name|AddAccountWarning|
||Class name|{{com.cdrator.main.account.action.AddAccountWarning}}|
||Available from core version|8.7|
||Description|This action adds a warning to an account.
You can use the FormatString action to format the warning before calling this activity|
||Return value|{{void}}: No return value.|
||Properties|# category: null
|
||Parameters|# {{Account}}: account
# {{String}}: key
# {{String}}: description
# {{PersistentObject}}: sourcePO
# {{Date}}: expireDate
|
h4.AddWorkflowToAccount
||Action name|AddWorkflowToAccount|
||Class name|{{com.cdrator.main.account.action.AddWorkflowToAccount}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the WfWorkflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Account}}: account
# {{WfWorkflow}}: wfWorkflow
|
h4.CheckIfAccountInState
||Action name|CheckIfAccountInState|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountInState}}|
||Available from core version|8.7|
||Description|This action checks if an account is in one of the given states.|
||Return value|{{Boolean}}: Returns TRUE if the account state matches one of the given states.|
||Properties|# possibleStates: The possible states separated by ';'
|
||Parameters|# {{Account}}: account
|
h4.CheckIfAccountIsClosed
||Action name|CheckIfAccountIsClosed|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountIsClosed}}|
||Available from core version|8.7|
||Description|This action checks if an account is closed.|
||Return value|{{Boolean}}: Returns TRUE if the account is closed.|
||Properties| |
||Parameters|# {{Account}}: account
|
h3.Main
h4.ProductMakeSubscription
||Action name|ProductMakeSubscription|
||Class name|{{com.cdrator.main.action.ProductMakeSubscription}}|
||Available from core version|8.7|
||Description|This action creates a subscription based on the supplied product configuration, account and billing group.|
||Return value|{{Subscription}}: Returns the newly created subscription.|
||Properties| |
||Parameters|# {{ProductConfig}}: productConfig
# {{Account}}: account
# {{BillingGroup}}: billingGroup
|
h3.Main - Alert
h4.AlertGroupReader
||Action name|AlertGroupReader|
||Class name|{{com.cdrator.main.alert.action.AlertGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves an AlertGroup based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Operator
h4.OperatorAuthentication
||Action name|OperatorAuthentication|
||Class name|{{com.cdrator.main.operator.action.OperatorAuthentication}}|
||Available from core version|8.7|
||Description|This action authenticates the operator based on the username and password provided. If username or password are null or empty, null is returned.|
||Return value|{{Operators}}: The operator matching the username and password. Otherwise null.|
||Properties| |
||Parameters|# {{String}}: username
# {{String}}: password
|
h4.OperatorHookpointBlockRevoke
||Action name|OperatorHookpointBlockRevoke|
||Class name|{{com.cdrator.main.operator.action.OperatorHookpointBlockRevoke}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{OperatorAccessTags}}: The operator access tag matching the username and hookpoint key. Otherwise null.|
||Properties|# accessTagPostfix: Alternative access tag postfix. Default is _BLOCK_REVOKED
|
||Parameters|# {{String}}: username
# {{String}}: hookpointKey
|
h4.OperatorReader
||Action name|OperatorReader|
||Class name|{{com.cdrator.main.operator.action.OperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves an Operator based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OperatorTypeReader
||Action name|OperatorTypeReader|
||Class name|{{com.cdrator.main.operator.action.OperatorTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an operator type based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Service
h4.ChangeDevice
||Action name|ChangeDevice|
||Class name|{{com.cdrator.main.service.action.ChangeDevice}}|
||Available from core version|8.7|
||Description|This action assigns a device to a given service.|
||Return value|{{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.|
||Properties|# autoAssignDevice: Auto assign device? If true, then newDevice parameter will be disregarded and the underlying workflow will assign a device automatically.
|
||Parameters|# {{Service}}: service
# {{Device}}: newDevice
# {{boolean}}: addFee
# {{String}}: sendType
# {{Status}}: reason
# {{String}}: comment
|
h4.ChangeServiceStatus
||Action name|ChangeServiceStatus|
||Class name|{{com.cdrator.main.service.action.ChangeServiceStatus}}|
||Available from core version|8.7|
||Description|This action sets and saves the Service status. |
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{Service}}: service
|
h4.CompleteCachedOptions
||Action name|CompleteCachedOptions|
||Class name|{{com.cdrator.main.service.action.CompleteCachedOptions}}|
||Available from core version|8.7|
||Description|Complete cached options on service|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceCode
||Action name|GetServiceCode|
||Class name|{{com.cdrator.main.service.action.GetServiceCode}}|
||Available from core version|8.7|
||Description|Return the code of the service.|
||Return value|{{String}}: The code of the service.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceFromPhoneNumber
||Action name|GetServiceFromPhoneNumber|
||Class name|{{com.cdrator.main.service.action.GetServiceFromPhoneNumber}}|
||Available from core version|8.7|
||Description|This action gets an active service from the phone number and optionally the brand.|
||Return value|{{Service}}: The active service matching the phone number and brand.|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.main.service.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|This action gets a service option parameter given an option key and a parameter key.|
||Return value|{{ServiceOptionParameter}}: The service option parameter. If the service does not have the service option or the service option parameter, null is returned.|
||Properties|# optionKey: The option key to look for on service.
|
||Parameters|# {{Service}}: service
# {{String}}: parameterKey
|
h4.GetServicesForAccountAndProduct
||Action name|GetServicesForAccountAndProduct|
||Class name|{{com.cdrator.main.service.action.GetServicesForAccountAndProduct}}|
||Available from core version|8.7|
||Description|Return a list of services belonging to the account, with the a specific product code and with the status selected.|
||Return value|{{ArrayList}}: The list of recovered services, based on the input parameters.|
||Properties|# productIdDescription: The product for the service. If empty all services will be returned.
# serviceStatus: The service status. If empty all services will be returned.
|
||Parameters|# {{Account}}: account
|
h3.Main - Subscription
h4.ActivateSubscription
||Action name|ActivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ActivateSubscription}}|
||Available from core version|8.7|
||Description|This action activates a subscription in Rator.|
||Return value|{{Subscription}}: Returns the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.AddWorkflow
||Action name|AddWorkflow|
||Class name|{{com.cdrator.main.subscription.action.AddWorkflow}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the workflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{WfWorkflow}}: workflow
|
h4.ChangeRatePlan
||Action name|ChangeRatePlan|
||Class name|{{com.cdrator.main.subscription.action.ChangeRatePlan}}|
||Available from core version|8.7|
||Description|This action schedules a rateplan change.|
||Return value|{{RatePlanChange}}: Sets up, saves and returns a rate plan change.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{RatePlan}}: newRatePlan
# {{Product}}: newProduct
# {{Date}}: changeDate
# {{ArrayList}}: options
|
h4.CheckIfParentSubscriptionIsInState
||Action name|CheckIfParentSubscriptionIsInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfParentSubscriptionIsInState}}|
||Available from core version|8.7|
||Description|This action checks if a parent subscription is in a given state.|
||Return value|{{boolean}}: Returns true if the parent exists and state matches the given state.|
||Properties|# controlState: The available states.
|
||Parameters|# {{Subscription}}: subscription
|
h4.CheckIfSubscriptionInState
||Action name|CheckIfSubscriptionInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfSubscriptionInState}}|
||Available from core version|8.7|
||Description|This action checks if a subscription is in given states.|
||Return value|{{boolean}}: Returns YES if the subscription state matches one of the given states.|
||Properties|# possibleState: The possible states separated by ';'
|
||Parameters|# {{Subscription}}: subscription
|
h4.CreateSubscriptionTerminationRequest
||Action name|CreateSubscriptionTerminationRequest|
||Class name|{{com.cdrator.main.subscription.action.CreateSubscriptionTerminationRequest}}|
||Available from core version|8.7|
||Description|This action assembles subscription termination details in a termination request.|
||Return value|{{SubscriptionTerminationRequest}}: The constructed termination request object.|
||Properties|# addTerminationFee: If termination fee should be added. Default is false.
# terminationReason: Set the terminate reason text.
# terminationReasonID: Set the terminate reason id.
|
||Parameters|# {{String}}: comment
# {{Date}}: expectedTerminationDate
# {{Date}}: terminationOrderDate
# {{Date}}: endBillingDate
# {{Date}}: chargeUntilDate
# {{boolean}}: canContactCustomer
|
h4.DeepSave
||Action name|DeepSave|
||Class name|{{com.cdrator.main.subscription.action.DeepSave}}|
||Available from core version|8.7|
||Description|This action deep-saves a subscription in Rator.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetActiveBillingGroupOfSubscription
||Action name|GetActiveBillingGroupOfSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetActiveBillingGroupOfSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the active billing group of the subscription|
||Return value|{{BillingGroup}}: The active billing group of the subscription|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllActiveWorkflowsForSubscription
||Action name|GetAllActiveWorkflowsForSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscription}}|
||Available from core version|8.7|
||Description|This action returns all active workflows for a subscription.|
||Return value|{{ArrayList}}: An arrayList of workflows.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllChildSubscriptions
||Action name|GetAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.GetAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action returns all child subscriptions of a given subscription.|
||Return value|{{List}}: A list of child subscriptions.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Broker}}: broker
|
h4.IsSubscriptionActive
||Action name|IsSubscriptionActive|
||Class name|{{com.cdrator.main.subscription.action.IsSubscriptionActive}}|
||Available from core version|8.7|
||Description|Checks if the subscription is active|
||Return value|{{boolean}}: Returns true if the subscription is active|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptions
||Action name|ReactivateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptionsInList
||Action name|ReactivateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{List}}: subscriptions
|
h4.ReactivateSubscription
||Action name|ReactivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscription}}|
||Available from core version|8.7|
||Description|This action reactivates a subscription by setting the end date to null and the status to active.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateSubscriptionCore
||Action name|ReactivateSubscriptionCore|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscriptionCore}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{SubscriptionTermination}}: The Subscription Termination connected to the termination|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetAlertGroup
||Action name|SetAlertGroup|
||Class name|{{com.cdrator.main.subscription.action.SetAlertGroup}}|
||Available from core version|8.7|
||Description|An action to set the alert group on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{AlertGroup}}: alertGroup
|
h4.SetOwner
||Action name|SetOwner|
||Class name|{{com.cdrator.main.subscription.action.SetOwner}}|
||Available from core version|8.7|
||Description|This action sets the owner of a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Users}}: owner
|
h4.SetSubscriptionEndDate
||Action name|SetSubscriptionEndDate|
||Class name|{{com.cdrator.main.subscription.action.SetSubscriptionEndDate}}|
||Available from core version|8.7|
||Description|This action sets the subscription end date and saves the subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: endDate
|
h4.SubscriptionHasServiceCode
||Action name|SubscriptionHasServiceCode|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionHasServiceCode}}|
||Available from core version|8.7|
||Description|Determines whether or not the transfer of a subscription to another account is approved.|
||Return value|{{Boolean}}: Boolean result indicating whether or not this subscription transfer is approved.|
||Properties|# serviceCode: The service code to check for.
|
||Parameters|# {{Subscription}}: subscription
|
h4.SubscriptionReader
||Action name|SubscriptionReader|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SubscriptionSalesDetails
||Action name|SubscriptionSalesDetails|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionSalesDetails}}|
||Available from core version|8.7|
||Description|This action sets a sales rep and a sales store on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: salesRep
# {{String}}: salesStore
|
h4.SubscriptionTransferTo
||Action name|SubscriptionTransferTo|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferTo}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
|
h4.SubscriptionTransferToWithParent
||Action name|SubscriptionTransferToWithParent|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferToWithParent}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
# {{Subscription}}: newParentSubscription
|
h4.TerminateAllChildSubscriptions
||Action name|TerminateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.TerminateAllChildSubscriptionsInList
||Action name|TerminateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties|# consolidateFinalFees: Set consolidate final fees. Default is false.
# disregardBindingPeriod: Set disregard binding period. Default is false.
# endBillingDate: Set end billing date. Default is null.
# finalizeFees: Set finalize fees. Default is false.
|
||Parameters|# {{List}}: subscriptions
# {{Subscription}}: parentSubscription
|
h4.TerminateSubscription
||Action name|TerminateSubscription|
||Class name|{{com.cdrator.main.subscription.action.TerminateSubscription}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: No return value.|
||Properties|# terminateChildSubscriptions: Terminate the child subscriptions (if any) with same termination details as the parent subscription.
|
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionTerminationRequest}}: subscriptionTerminationRequest
|
h3.Main - Subscription - Lockin
h4.CreateNewSubscriptionLockin
||Action name|CreateNewSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.CreateNewSubscriptionLockin}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{SubscriptionLockin}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionLockinType}}: subscriptionLockinType
|
h4.GetAllSubscriptionLockins
||Action name|GetAllSubscriptionLockins|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetAllSubscriptionLockins}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-ins for a given subscription.|
||Return value|{{ArrayList}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionLockinTypes
||Action name|GetSubscriptionLockinTypes|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetSubscriptionLockinTypes}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-in types.|
||Return value|{{List}}: Returns a list of subscription lock-in types.|
||Properties| |
||Parameters| |
h4.HasSubscriptionLockin
||Action name|HasSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.HasSubscriptionLockin}}|
||Available from core version|8.7|
||Description|This action checks if a subscription has a lock-in.|
||Return value|{{String}}: Returns either NO or YES.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetLockinEndDateForLockinWithLeastEndDate
||Action name|SetLockinEndDateForLockinWithLeastEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetLockinEndDateForLockinWithLeastEndDate}}|
||Available from core version|8.7|
||Description|This action updates lockin_end_date of the subscription_lockin with least lockin_end_date and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h4.SetSubscriptionLockinEndDate
||Action name|SetSubscriptionLockinEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate}}|
||Available from core version|8.7|
||Description|This action updates subscription lock-in's end date and saves it. It updates only if a lockin exists.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h3.Main - Subscriptiontermination
h4.DeactivateSubscriptionTermination
||Action name|DeactivateSubscriptionTermination|
||Class name|{{com.cdrator.main.subscriptiontermination.action.DeactivateSubscriptionTermination}}|
||Available from core version|8.7|
||Description|This action deactivates a subscription termination.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SubscriptionTermination}}: subscriptionTermination
|
h3.Main - User
h4.CheckUsernameAvailability
||Action name|CheckUsernameAvailability|
||Class name|{{com.cdrator.main.user.action.CheckUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given username is available.|
||Return value|{{boolean}}: boolean true if the username is available (no user exists with the usename), else false|
||Properties|# caseSensitive: Is the username case sensitive?
|
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetAddress
||Action name|GetAddress|
||Class name|{{com.cdrator.main.user.action.GetAddress}}|
||Available from core version|8.7|
||Description|Action to create and save a new Address object based on the address information of the user passed as argument.|
||Return value|{{Address}}: Returns the newly created Address object.|
||Properties|# doSetCoFromAddress2: Specify whether or not the Address field CO should be set from user.address2.
|
||Parameters|# {{Users}}: user
|
h4.GetUserAccessLevel
||Action name|GetUserAccessLevel|
||Class name|{{com.cdrator.main.user.action.GetUserAccessLevel}}|
||Available from core version|8.7|
||Description|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.|
||Return 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|
||Properties| |
||Parameters|# {{Users}}: user
|
h4.GetUserByEmailAddress
||Action name|GetUserByEmailAddress|
||Class name|{{com.cdrator.main.user.action.GetUserByEmailAddress}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the email address exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: emailAddress
# {{Brand}}: brand
|
h4.GetUserByPhoneNumber
||Action name|GetUserByPhoneNumber|
||Class name|{{com.cdrator.main.user.action.GetUserByPhoneNumber}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the phone number exists. The value null is returned if none exists.|
||Properties|# cancelationPending: Include subscriptions in cancelation pending status.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetUserByUsername
||Action name|GetUserByUsername|
||Class name|{{com.cdrator.main.user.action.GetUserByUsername}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the username exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetUsersByPersonalIDHash
||Action name|GetUsersByPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.GetUsersByPersonalIDHash}}|
||Available from core version|8.7|
||Description|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 http://jira.cdrator.com/browse/CDRP-5401|
||Return value|{{ArrayList}}: An ArrayList of users matching the given personalID. If none exists, an empty ArrayList is returned.|
||Properties|# 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.
|
||Parameters|# {{String}}: personalIDInput
|
h4.SetNewPassword
||Action name|SetNewPassword|
||Class name|{{com.cdrator.main.user.action.SetNewPassword}}|
||Available from core version|8.7|
||Description|This action changes the password of a user. If password is blank, a password will be generated.|
||Return value|{{String}}: The new password.|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h4.SetPersonalIDHash
||Action name|SetPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.SetPersonalIDHash}}|
||Available from core version|8.7|
||Description|This action adds a PersonalID entry for a User. The input parameter must already be hashed/encrypted if so desired.|
||Return value|{{void}}: No return value.|
||Properties|# endDateLastPeriod: To set expiry date on personal id.
# personalIDType: The personal ID type
|
||Parameters|# {{Users}}: user
# {{String}}: hashedPersonalID
|
h4.SetUserAsAccountOwner
||Action name|SetUserAsAccountOwner|
||Class name|{{com.cdrator.main.user.action.SetUserAsAccountOwner}}|
||Available from core version|8.7|
||Description|This action sets the user as account owner. Both user and account is saved.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Users}}: user
# {{Account}}: account
|
h4.UserReader
||Action name|UserReader|
||Class name|{{com.cdrator.main.user.action.UserReader}}|
||Available from core version|8.7|
||Description|Retrieves a User based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - User - Login
h4.LoginUserWithAttemptsCount
||Action name|LoginUserWithAttemptsCount|
||Class name|{{com.cdrator.main.user.login.action.LoginUserWithAttemptsCount}}|
||Available from core version|8.7|
||Description|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)|
||Return value|{{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|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h3.Misc
h4.CreateLongDescriptionElementList
||Action name|CreateLongDescriptionElementList|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElementList}}|
||Available from core version|8.7|
||Description|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()'|
||Return value|{{List}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs. It must be a regular expression. Example : ',|
|
| ' will split at , and newline
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
# {{List}}: addToExistingList
|
h4.CreateLongDescriptionElements
||Action name|CreateLongDescriptionElements|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElements}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{ArrayList}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs.
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FileObjectReader
||Action name|FileObjectReader|
||Class name|{{com.cdrator.misc.action.FileObjectReader}}|
||Available from core version|8.7|
||Description|Retrieves a File Object based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.MailTemplateReader
||Action name|MailTemplateReader|
||Class name|{{com.cdrator.misc.action.MailTemplateReader}}|
||Available from core version|8.7|
||Description|Retrieves a Mail Template based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Misc - Barcodes
h4.GenerateQRCodeImage
||Action name|GenerateQRCodeImage|
||Class name|{{com.cdrator.misc.barcodes.action.GenerateQRCodeImage}}|
||Available from core version|8.7|
||Description|This action retrieves an Image of a QR code of the specified content having the specified size |
||Return value|{{Image}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{int}}: width
# {{int}}: height
# {{String}}: content
|
h3.Np
h4.LookupActiveNpFlow
||Action name|LookupActiveNpFlow|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlow}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow of a given phone number and (optionally) brand (via the subscription).|
||Return value|{{NpFlow}}: The NP Flow matching the phone number and the brand.|
||Properties|# ignoreBrand: Ignore the brand connected to the NP Flow.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.LookupActiveNpFlowBySubscription
||Action name|LookupActiveNpFlowBySubscription|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlowBySubscription}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow for a given subscription.|
||Return value|{{NpFlow}}: The active NP Flow from the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.NpFlowReader
||Action name|NpFlowReader|
||Class name|{{com.cdrator.np.action.NpFlowReader}}|
||Available from core version|8.7|
||Description|Retrieves an NP flow based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveNpFlow
||Action name|SaveNpFlow|
||Class name|{{com.cdrator.np.action.SaveNpFlow}}|
||Available from core version|8.7|
||Description|Sets some initial values on np flow.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{NpFlow}}: npFlow
|
h4.SetRejectCodeOnExportFlow
||Action name|SetRejectCodeOnExportFlow|
||Class name|{{com.cdrator.np.action.SetRejectCodeOnExportFlow}}|
||Available from core version|8.7|
||Description|Set Reject Code and Comment On an Np Export Flow object.|
||Return value|{{void}}: No return value.|
||Properties|# comment: Used for adding a static comment.
# rejectCode: Used for adding reject code.
|
||Parameters|# {{NpExportFlow}}: npFlow
# {{String}}: dynamicComment
|
h4.TeleOperatorReader
||Action name|TeleOperatorReader|
||Class name|{{com.cdrator.np.action.TeleOperatorReader}}|
||Available from core version|8.7|
||Description|Retrievse a tele operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Np - Range
h4.CheckOverlappingRange
||Action name|CheckOverlappingRange|
||Class name|{{com.cdrator.np.range.action.CheckOverlappingRange}}|
||Available from core version|8.7|
||Description|Check if the ranges are overlapping|
||Return value|{{boolean}}: A boolean indicating whether the two ranges overlap each other, fully or partially|
||Properties| |
||Parameters|# {{String}}: newRange
# {{String}}: existingRange
|
h3.Number
h4.AnumberReader
||Action name|AnumberReader|
||Class name|{{com.cdrator.number.action.AnumberReader}}|
||Available from core version|8.7|
||Description|Retrieves an A-number based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AssignAnumberToService
||Action name|AssignAnumberToService|
||Class name|{{com.cdrator.number.action.AssignAnumberToService}}|
||Available from core version|8.7|
||Description|Sets Anumber on Service (Only relevant for Service types with phone numbers.)|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Service}}: service
|
h4.GetANumbersForNumberSearchExact
||Action name|GetANumbersForNumberSearchExact|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchExact}}|
||Available from core version|8.7|
||Description|This action will return the list of anumbers that are exact match of the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchLastDigits
||Action name|GetANumbersForNumberSearchLastDigits|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchLastDigits}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers ending with the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchPattern
||Action name|GetANumbersForNumberSearchPattern|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchPattern}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers that contain the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchRandom
||Action name|GetANumbersForNumberSearchRandom|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchRandom}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random phone numbers according to the group_id.|
||Return value|{{ArrayList}}: List of phone numbers.|
||Properties|# batchLimit: Batch limit to fetch anumbers.
|
||Parameters|# {{Anumber_Group}}: group
# {{int}}: maxRows
|
h4.IsAnumberFree
||Action name|IsAnumberFree|
||Class name|{{com.cdrator.number.action.IsAnumberFree}}|
||Available from core version|8.7|
||Description|Given a phone number, checks if the related anumber is free.|
||Return value|{{boolean}}: True, if the anumber for the phone number is free, else False|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.ReReserveAnumber
||Action name|ReReserveAnumber|
||Class name|{{com.cdrator.number.action.ReReserveAnumber}}|
||Available from core version|8.7|
||Description|Re-reserves an already reserved anumber, if the number is not in use and already reserved with the given id.|
||Return value|{{boolean}}: Returns: boolean true if the number could be re-reserved|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{String}}: reservationId
# {{int}}: reserveTime
|
h4.SetAnumberReservToDate
||Action name|SetAnumberReservToDate|
||Class name|{{com.cdrator.number.action.SetAnumberReservToDate}}|
||Available from core version|8.7|
||Description|Sets the reservToDate on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Date}}: reservToDate
|
h4.SetAnumberStatus
||Action name|SetAnumberStatus|
||Class name|{{com.cdrator.number.action.SetAnumberStatus}}|
||Available from core version|8.7|
||Description|Sets status on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{StatusAnumber}}: status
|
h4.ValidateAnumberReservation
||Action name|ValidateAnumberReservation|
||Class name|{{com.cdrator.number.action.ValidateAnumberReservation}}|
||Available from core version|8.7|
||Description|This action validates that an a-number matches a reservation id, that the a-number has status not used and that the reservation has not expired.|
||Return value|{{boolean}}: boolean true if reservation ID is still valid for the A-number, false otherwise.|
||Properties| |
||Parameters|# {{String}}: anumber
# {{String}}: reservationId
|
h3.Persistence
h4.CheckIfPersisted
||Action name|CheckIfPersisted|
||Class name|{{com.cdrator.persistence.action.CheckIfPersisted}}|
||Available from core version|8.7|
||Description|Check if an object is persisted|
||Return value|{{boolean}}: A boolean indicating whether the object is persisted or not.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Product
h4.ChangeAnumberGroup
||Action name|ChangeAnumberGroup|
||Class name|{{com.cdrator.product.action.ChangeAnumberGroup}}|
||Available from core version|8.7|
||Description|Sets the group on an A-number and saves it.|
||Return value|{{Anumber}}: Returns the updated A-number.|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Anumber_Group}}: group
|
h4.CheckProductServiceClassCode
||Action name|CheckProductServiceClassCode|
||Class name|{{com.cdrator.product.action.CheckProductServiceClassCode}}|
||Available from core version|8.7|
||Description|This action checks the products service class code.|
||Return value|{{boolean}}: Returns true if the product matches the service class configured.|
||Properties|# serviceClassCode: The service class code to check for.
|
||Parameters|# {{Product}}: product
|
h4.CreateCdmaPhoneForMeid
||Action name|CreateCdmaPhoneForMeid|
||Class name|{{com.cdrator.product.action.CreateCdmaPhoneForMeid}}|
||Available from core version|8.7|
||Description|This action creates a CdmaPhone based on the supplied MEID.|
||Return value|{{CdmaPhone}}: The cdmaPhone created is returned.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: meid
|
h4.FilterProductConfigsByShop
||Action name|FilterProductConfigsByShop|
||Class name|{{com.cdrator.product.action.FilterProductConfigsByShop}}|
||Available from core version|8.7|
||Description|This action filters an existing list of product configurations so only the ones set up for the shop is returned.|
||Return value|{{List}}: A list of product configs defined for the shop.|
||Properties| |
||Parameters|# {{List}}: productConfigs
# {{Shop}}: shop
|
h4.MakeSubscription
||Action name|MakeSubscription|
||Class name|{{com.cdrator.product.action.MakeSubscription}}|
||Available from core version|8.7|
||Description|Creates a new subscription, and a service, for a given product on a given account, billing group and user.|
||Return value|{{Subscription}}: Returns the subscription|
||Properties| |
||Parameters|# {{Account}}: account
# {{BillingGroup}}: bg
# {{ProductConfig}}: pc
# {{Users}}: user
|
h4.ProductConfigReader
||Action name|ProductConfigReader|
||Class name|{{com.cdrator.product.action.ProductConfigReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Config based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProductReader
||Action name|ProductReader|
||Class name|{{com.cdrator.product.action.ProductReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.RemoveSharedServiceMemberEndDate
||Action name|RemoveSharedServiceMemberEndDate|
||Class name|{{com.cdrator.product.action.RemoveSharedServiceMemberEndDate}}|
||Available from core version|8.7|
||Description|This action removes the end date of a sharedServiceMember.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SharedServiceMember}}: sharedServiceMember
|
h4.ReserveCdmaPhoneForService
||Action name|ReserveCdmaPhoneForService|
||Class name|{{com.cdrator.product.action.ReserveCdmaPhoneForService}}|
||Available from core version|8.7|
||Description|This action reserves a CdmaPhone for a service.|
||Return value|{{CdmaPhone}}: The CdmaPhone is returned.|
||Properties| |
||Parameters|# {{CdmaPhone}}: cdmaPhone
# {{Service}}: service
|
h3.Product - Option
h4.CompareSubscribedProductOptionParameter
||Action name|CompareSubscribedProductOptionParameter|
||Class name|{{com.cdrator.product.option.action.CompareSubscribedProductOptionParameter}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for.
# parameterKey: The parameter key that we are searching for.
|
||Parameters|# {{Service}}: service
# {{String}}: compareValue
|
h4.ExistsActiveCampaignForEqualOrHigherPackage
||Action name|ExistsActiveCampaignForEqualOrHigherPackage|
||Class name|{{com.cdrator.product.option.action.ExistsActiveCampaignForEqualOrHigherPackage}}|
||Available from core version|8.7|
||Description|Checks if there is campaign for equal or higher package option|
||Return value|{{boolean}}: If there is an active subscriptionCampaign associated to a greater or equal package option returns true|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Subscription}}: subscription
|
h4.GetLowestSubscribedOption
||Action name|GetLowestSubscribedOption|
||Class name|{{com.cdrator.product.option.action.GetLowestSubscribedOption}}|
||Available from core version|8.7|
||Description|Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Return value|{{ProductOption}}: Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
|
h4.GetOptionMetaData
||Action name|GetOptionMetaData|
||Class name|{{com.cdrator.product.option.action.GetOptionMetaData}}|
||Available from core version|8.7|
||Description|This action returns the meta data on an option based on the Option and the Metadata name.|
||Return value|{{ProductOptionMetaData}}: The ProductOptionMetaData for the option and Metadata name. If not found, null is returned.|
||Properties| |
||Parameters|# {{Option}}: option
# {{String}}: metaDataName
|
h4.GetOptionPriceElementsForProductRatePlanAndCategory
||Action name|GetOptionPriceElementsForProductRatePlanAndCategory|
||Class name|{{com.cdrator.product.option.action.GetOptionPriceElementsForProductRatePlanAndCategory}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan, product and category.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time. When category is set cache is always enabled.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
# {{String}}: category
|
h4.GetOptionsForProductAndRatePlan
||Action name|GetOptionsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Product Option available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: An list of product options.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetOptionsPrice
||Action name|GetOptionsPrice|
||Class name|{{com.cdrator.product.option.action.GetOptionsPrice}}|
||Available from core version|8.7|
||Description|Returns a map of product option id and the related price for the given subscription and product options list.|
||Return value|{{Hashtable}}: Returns a map of product option id and the related price.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: optionsList
|
h4.GetOptionsPricesElementsForProductAndRatePlan
||Action name|GetOptionsPricesElementsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsPricesElementsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetProductOptionsFromService
||Action name|GetProductOptionsFromService|
||Class name|{{com.cdrator.product.option.action.GetProductOptionsFromService}}|
||Available from core version|8.7|
||Description|Returns all the product options subscribed to be the given service.|
||Return value|{{ArrayList}}: An array list of product options.|
||Properties|# onlyActive: If this is set, only serviceOptions that are active will be used to get the productOptions.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOption
||Action name|GetServiceOption|
||Class name|{{com.cdrator.product.option.action.GetServiceOption}}|
||Available from core version|8.7|
||Description|Action to retrieve a service option based on the option key.|
||Return value|{{ServiceOption}}: The service option.|
||Properties|# optionKey: The key of the option that will be retrieved.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOptionForParameterWithSpecifiedObjectReference
||Action name|GetServiceOptionForParameterWithSpecifiedObjectReference|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionForParameterWithSpecifiedObjectReference}}|
||Available from core version|8.7|
||Description|Returns a serviceOption for parameter with matching obejct reference.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
# {{String}}: parameterKey
# {{String}}: objectReferenceClass
# {{String}}: objectReferenceId
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Returns a serviceOptionParameter with the specified parameterKey.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: parameterKey
|
h4.GetServiceOptionRecurrentFee
||Action name|GetServiceOptionRecurrentFee|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionRecurrentFee}}|
||Available from core version|8.7|
||Description|Retrieves the recurrent fee of the service option|
||Return value|{{SubscriptionFees}}: Returns the recurrent fee of the service option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetServiceOptionsByCriteria
||Action name|GetServiceOptionsByCriteria|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionsByCriteria}}|
||Available from core version|8.7|
||Description|Returns a list of service option for a service matching the given criteria.|
||Return value|{{List}}: A List of service options matching given criterias.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: criterias
|
h4.GetSiblingServiceOption
||Action name|GetSiblingServiceOption|
||Class name|{{com.cdrator.product.option.action.GetSiblingServiceOption}}|
||Available from core version|8.7|
||Description|Get the sibling service option of a specific service option if that exists|
||Return value|{{ServiceOption}}: Returns the sibling service option of the current service option if that exists. Otherwise returns null|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetTotalPriceForOptionChange
||Action name|GetTotalPriceForOptionChange|
||Class name|{{com.cdrator.product.option.action.GetTotalPriceForOptionChange}}|
||Available from core version|8.7|
||Description|Compares the two list and returns the total price of the change|
||Return value|{{Amount}}: The total price as an amount|
||Properties| |
||Parameters|# {{List}}: oldOptions
# {{List}}: newOptions
|
h4.HasSiblingOptionLowerPackageWeight
||Action name|HasSiblingOptionLowerPackageWeight|
||Class name|{{com.cdrator.product.option.action.HasSiblingOptionLowerPackageWeight}}|
||Available from core version|8.7|
||Description|Checks if the sibling option has lower package_weight than the current option|
||Return value|{{boolean}}: Returns true if the sibling option has lower package_weight than the current option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{ServiceOption}}: siblingServiceOption
|
h4.HasSubscribedProductOption
||Action name|HasSubscribedProductOption|
||Class name|{{com.cdrator.product.option.action.HasSubscribedProductOption}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for
|
||Parameters|# {{Service}}: service
|
h4.IsOptionInExclusiveGroup
||Action name|IsOptionInExclusiveGroup|
||Class name|{{com.cdrator.product.option.action.IsOptionInExclusiveGroup}}|
||Available from core version|8.7|
||Description|Checks if option belongs to an exclusive group|
||Return value|{{boolean}}: Returns true if the option belongs to an exclusive option group|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.OptionReader
||Action name|OptionReader|
||Class name|{{com.cdrator.product.option.action.OptionReader}}|
||Available from core version|8.7|
||Description|Retrieves an option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OptionStatusChangeActionCheck
||Action name|OptionStatusChangeActionCheck|
||Class name|{{com.cdrator.product.option.action.OptionStatusChangeActionCheck}}|
||Available from core version|8.7|
||Description|Compare the action used in option status_change workflow to a predefined action value|
||Return value|{{boolean}}: If the action equals to the predefined action value it returns true. Otherwise it returns false.|
||Properties|# actionValue: The action value that the action should be compared to
|
||Parameters|# {{String}}: action
|
h4.RemoveListOfServiceOptions
||Action name|RemoveListOfServiceOptions|
||Class name|{{com.cdrator.product.option.action.RemoveListOfServiceOptions}}|
||Available from core version|8.7|
||Description|Removes all service options in a list|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
|
h4.RemovePendingTerminationOption
||Action name|RemovePendingTerminationOption|
||Class name|{{com.cdrator.product.option.action.RemovePendingTerminationOption}}|
||Available from core version|8.7|
||Description|Removes a pending termination option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: action
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.RemoveServiceOption
||Action name|RemoveServiceOption|
||Class name|{{com.cdrator.product.option.action.RemoveServiceOption}}|
||Available from core version|8.7|
||Description|Removes the service option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetEndDateOnServiceOptionList
||Action name|SetEndDateOnServiceOptionList|
||Class name|{{com.cdrator.product.option.action.SetEndDateOnServiceOptionList}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date from a list of options retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
# {{Date}}: date
|
h4.SetServiceOptionEndDateRestOfMonth
||Action name|SetServiceOptionEndDateRestOfMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateRestOfMonth}}|
||Available from core version|8.7|
||Description|Sets the end date of the option.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionEndDateToSpecificDate
||Action name|SetServiceOptionEndDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SetServiceOptionEndDateToStartDate
||Action name|SetServiceOptionEndDateToStartDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToStartDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' endDate to the service option's startDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionParameterValue
||Action name|SetServiceOptionParameterValue|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionParameterValue}}|
||Available from core version|8.7|
||Description|Updates a service option parameter value.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{String}}: newValue
|
h4.SetServiceOptionStartDateToNextMonth
||Action name|SetServiceOptionStartDateToNextMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the first day of next month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionStartDateToSpecificDate
||Action name|SetServiceOptionStartDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SubscribeToProductOption
||Action name|SubscribeToProductOption|
||Class name|{{com.cdrator.product.option.action.SubscribeToProductOption}}|
||Available from core version|8.7|
||Description|Subscribes to a product option for a given service and product option.|
||Return value|{{ServiceOption}}: The service option created by subscribing to the option.|
||Properties|# optionKey: The option key that the service will subscribe to.
|
||Parameters|# {{Service}}: service
|
h4.UnsubscribeOptionsWithCampaigns
||Action name|UnsubscribeOptionsWithCampaigns|
||Class name|{{com.cdrator.product.option.action.UnsubscribeOptionsWithCampaigns}}|
||Available from core version|8.7|
||Description|Unsubscribes to options with campaigns (and only options with a campaign) for a given service.|
||Return value|{{List}}: A list of the unsubscribed service options.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.UnsubscribeToOption
||Action name|UnsubscribeToOption|
||Class name|{{com.cdrator.product.option.action.UnsubscribeToOption}}|
||Available from core version|8.7|
||Description|If there is a dynamic optionkey parameter, it will override the optionkey property unless it is null. If neither option key or dynamic option key is set an Action Parameter Exception is thrown.|
||Return value|{{void}}: No value returned|
||Properties|# makeProvisioningTask: Make provisioning task?
# optionKey: The key of the option that will be unsubscribed
|
||Parameters|# {{Service}}: service
# {{String}}: dynamicOptionKey
|
h4.ValidateOptions
||Action name|ValidateOptions|
||Class name|{{com.cdrator.product.option.action.ValidateOptions}}|
||Available from core version|8.7|
||Description|This action validates that options are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config.|
||Properties| |
||Parameters|# {{List}}: options
# {{ProductConfig}}: productConfig
|
h4.ValidateOptionsRateplan
||Action name|ValidateOptionsRateplan|
||Class name|{{com.cdrator.product.option.action.ValidateOptionsRateplan}}|
||Available from core version|8.7|
||Description|This action validates that the list of options passed as a parameter are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config, false otherwise.|
||Properties| |
||Parameters|# {{List}}: options
# {{RatePlan}}: rateplan
|
h3.Product - Service
h4.AssignCdmaPhoneToService
||Action name|AssignCdmaPhoneToService|
||Class name|{{com.cdrator.product.service.action.AssignCdmaPhoneToService}}|
||Available from core version|8.7|
||Description|This action assigns a cdmaPhone to a service.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has been assigned to the service.|
||Properties| |
||Parameters|# {{CdmaService}}: service
# {{CdmaPhone}}: cdmaPhone
|
h4.CanBlockService
||Action name|CanBlockService|
||Class name|{{com.cdrator.product.service.action.CanBlockService}}|
||Available from core version|8.7|
||Description|This action checks if a service can be blocked.|
||Return value|{{boolean}}: A boolean indicating whether the service can be blocked.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.ReleaseCdmaPhone
||Action name|ReleaseCdmaPhone|
||Class name|{{com.cdrator.product.service.action.ReleaseCdmaPhone}}|
||Available from core version|8.7|
||Description|This action releases the CdmaPhone assigned to the service, if a CdmaPhone exists.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has just been released.|
||Properties| |
||Parameters|# {{CdmaService}}: service
|
h4.ServiceReader
||Action name|ServiceReader|
||Class name|{{com.cdrator.product.service.action.ServiceReader}}|
||Available from core version|8.7|
||Description|Retrieves a service based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Product - Service - Fixed
h4.SetPhoneNumberOnFixedLineService
||Action name|SetPhoneNumberOnFixedLineService|
||Class name|{{com.cdrator.product.service.fixed.action.SetPhoneNumberOnFixedLineService}}|
||Available from core version|8.7|
||Description|This action sets the provided phone number on a fixed line service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h3.Product - Service - Option
h4.GetServiceOptionFromOptionMetaData
||Action name|GetServiceOptionFromOptionMetaData|
||Class name|{{com.cdrator.product.service.option.action.GetServiceOptionFromOptionMetaData}}|
||Available from core version|8.7|
||Description|Search in the list of meta data records linked to the Option, if the service provided is subscribed to a product option key that is in the list then the service option is returned.|
||Return value|{{ServiceOption}}: The first service option found if subscribed to the service and in the meta data option list. Null if service not subscribed to any option in the meta data list.|
||Properties|# isAllowed: Check if the option is allowed or not.
|
||Parameters|# {{Option}}: option
# {{Service}}: service
|
h4.ServiceOptionReader
||Action name|ServiceOptionReader|
||Class name|{{com.cdrator.product.service.option.action.ServiceOptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a service option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SwitchServiceOptionsAction
||Action name|SwitchServiceOptionsAction|
||Class name|{{com.cdrator.product.service.option.action.SwitchServiceOptionsAction}}|
||Available from core version|8.7|
||Description|Unsubscribes a current service option and subscribes to a new option.|
||Return value|{{String}}: The id of the newly subscribed service option.|
||Properties|# makeProvisioningTask: If cached options should be completed or not.
|
||Parameters|# {{Subscription}}: subscription
# {{Option}}: optionToUnSubscribe
# {{Option}}: optionToSubscribe
|
h3.Product - Service - Shared
h4.GetAllNonTerminatedSharedServiceMembers
||Action name|GetAllNonTerminatedSharedServiceMembers|
||Class name|{{com.cdrator.product.service.shared.action.GetAllNonTerminatedSharedServiceMembers}}|
||Available from core version|8.7|
||Description|This action returns a list of all non-terminated (active and cancellation pending) members of a shared service.|
||Return value|{{List}}: A list of all non-terminated members of the shared service.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
|
h4.GetNonTerminatedSharedServiceMember
||Action name|GetNonTerminatedSharedServiceMember|
||Class name|{{com.cdrator.product.service.shared.action.GetNonTerminatedSharedServiceMember}}|
||Available from core version|8.7|
||Description|This action returns the direct member to a shared service.|
||Return value|{{SharedServiceMember}}: The SharedServiceMember of the sharedServiceInterface is returned if found.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
# {{SharedServiceInterface}}: sharedServiceInterface
|
h3.Product - Service - Tele
h4.DisconnectOldSimCards
||Action name|DisconnectOldSimCards|
||Class name|{{com.cdrator.product.service.tele.action.DisconnectOldSimCards}}|
||Available from core version|8.7|
||Description|This action disconnect any old SIMcards related to this TeleService (where TeleService.imsi not like SimCard.imsi ).|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h4.TeleServicePhoneNumber
||Action name|TeleServicePhoneNumber|
||Class name|{{com.cdrator.product.service.tele.action.TeleServicePhoneNumber}}|
||Available from core version|8.7|
||Description|This action sets a phone number on a Tele service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h4.UnBlockTeleService
||Action name|UnBlockTeleService|
||Class name|{{com.cdrator.product.service.tele.action.UnBlockTeleService}}|
||Available from core version|8.7|
||Description|This unblocks a service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h3.Product - Voucher
h4.AssignVoucher
||Action name|AssignVoucher|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucher}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{boolean}}: Boolean with the result of the assignment.|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.AssignVoucherToSubscription
||Action name|AssignVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.ChargeVoucherToSubscription
||Action name|ChargeVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.ChargeVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Charge a voucher to a subscription|
||Return value|{{boolean}}: A boolean value indicating whether the voucher was charged successfully|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.CreateNewVoucher
||Action name|CreateNewVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateNewVoucher}}|
||Available from core version|8.7|
||Description|To be used when a new voucher needs to be created. The keyword which is generated is an alphanumeric code.The length of this code is specified by the property numberOfCharacters. A voucherBatch needs to be passed to this action.|
||Return value|{{Voucher}}: The voucher which was created.|
||Properties|# numberOfCharacters: null
|
||Parameters|# {{VoucherBatch}}: voucherBatch
|
h4.CreateVoucher
||Action name|CreateVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateVoucher}}|
||Available from core version|8.7|
||Description|Creates a new voucher with the specified number of alphanumeric characters for the keyword, voucher code, price code and amount.|
||Return value|{{Voucher}}: The created voucher.|
||Properties|# batchVoucherCode: The voucher code.
# currencyCode: The amount currency code.
# numberOfCharacters: The length of the keyword alphanumeric code.
|
||Parameters|# {{Amount}}: amount
# {{String}}: priceCode
|
h4.GetVouchers
||Action name|GetVouchers|
||Class name|{{com.cdrator.product.voucher.action.GetVouchers}}|
||Available from core version|8.7|
||Description|Returns a list of vouchers|
||Return value|{{Collection}}: List of vouchers related to the batchId and the statusId for a given subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: batchId
# {{String}}: statusId
|
h4.VoucherBatchReader
||Action name|VoucherBatchReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherBatchReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.VoucherReader
||Action name|VoucherReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Provisioning
h4.CreateProvisioningTask
||Action name|CreateProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.CreateProvisioningTask}}|
||Available from core version|8.7|
||Description|Create a provisioning task of a specific type (CODE). The status of the new task will be "New". (the workflow instance can be added using "_activity.getWorkflow()")|
||Return value|{{ProvisioningTask}}: Return response code from ProvisioningRequest object.|
||Properties|# priority: Optional priority of the provisioning task. Default is 5
# taskComments: Optional comments to add to the provisioning task
# taskDescription: Optional description to add to the provisioning task
# taskType: The type of task that should be provisioned
|
||Parameters|# {{Service}}: service
# {{WfWorkflow}}: workflow
|
h4.GetProvisioningRequestsByReference
||Action name|GetProvisioningRequestsByReference|
||Class name|{{com.cdrator.provisioning.action.GetProvisioningRequestsByReference}}|
||Available from core version|8.7|
||Description|Retrieves a List of ProvisioningRequest linked to a ProvisioningTask by reference field.|
||Return value|{{List}}: Returns the ProvisioningRequest linked from the task reference.|
||Properties|# linkedFieldOnRequest: Optional to choose the database field from which to retrieve the reference linking the request to the task. Required to be varchar2 field.
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.GetResponseCodeFromProvisioningRequest
||Action name|GetResponseCodeFromProvisioningRequest|
||Class name|{{com.cdrator.provisioning.action.GetResponseCodeFromProvisioningRequest}}|
||Available from core version|8.7|
||Description|Retrieves the Response Code from a ProvisioningRequest.|
||Return value|{{String}}: Return response code from ProvisioningRequest object.|
||Properties|# responseCodeField: Optional to choose the database field from which to retrieve the response code.
|
||Parameters|# {{ProvisioningRequest}}: request
|
h4.NetworkOperatorReader
||Action name|NetworkOperatorReader|
||Class name|{{com.cdrator.provisioning.action.NetworkOperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves a Network Operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProvisioningTaskReader
||Action name|ProvisioningTaskReader|
||Class name|{{com.cdrator.provisioning.action.ProvisioningTaskReader}}|
||Available from core version|8.7|
||Description|Retrieves a Provisioning Task based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ResetStartDateWithDelayOnProvisioningTask
||Action name|ResetStartDateWithDelayOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.ResetStartDateWithDelayOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Adds the delayInMinutes property to start date on Provisioning Task. If no start date on task, adds delay from current date.|
||Return value|{{void}}: No return values|
||Properties|# delayInMinutes: null
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.SetStatusOnProvisioningTask
||Action name|SetStatusOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.SetStatusOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Set Status for Processing on Provisioning Task.|
||Return value|{{void}}: No return values|
||Properties|# statusToSet: The status that the provisioning task will be set to.
|
||Parameters|# {{ProvisioningTask}}: task
|
h3.RecurrentFee
h4.BillSubscriptionFeeListToInvoiceNow
||Action name|BillSubscriptionFeeListToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeeListToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills the supplied subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{List}}: subscriptionFees
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNow
||Action name|BillSubscriptionFeesToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNowForListOfSubs
||Action name|BillSubscriptionFeesToInvoiceNowForListOfSubs|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNowForListOfSubs}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice for a list of subscriptions.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{Invoice}}: invoice
|
h4.SetFeeChargeDateToSiblingFeeChargeDate
||Action name|SetFeeChargeDateToSiblingFeeChargeDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeChargeDateToSiblingFeeChargeDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to sibling fee's next_charge_date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{SubscriptionFees}}: siblingFee
|
h4.SetFeeEndDateLastPeriod
||Action name|SetFeeEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodForFeeList
||Action name|SetFeeEndDateLastPeriodForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodToEndOfMonth
||Action name|SetFeeEndDateLastPeriodToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
h4.SetFeeNextChargeDateForFeeList
||Action name|SetFeeNextChargeDateForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeNextChargeDateToEndOfMonth
||Action name|SetFeeNextChargeDateToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SetFeeNextChargeDateToSpecificDate
||Action name|SetFeeNextChargeDateToSpecificDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.TerminateFeeFromEndDateLastPeriod
||Action name|TerminateFeeFromEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.TerminateFeeFromEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Terminates the fee from its end_date_last_period|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h3.Shop
h4.CheckShopUsernameAvailability
||Action name|CheckShopUsernameAvailability|
||Class name|{{com.cdrator.shop.action.CheckShopUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given shop user name is available.|
||Return value|{{boolean}}: boolean true if the user name is available (no shop exists with the user name), else false.|
||Properties|# caseSensitive: Is the shop user name case sensitive?
|
||Parameters|# {{String}}: username
|
h4.GetSubscriptionsForSalesStoreEstablishedBetween
||Action name|GetSubscriptionsForSalesStoreEstablishedBetween|
||Class name|{{com.cdrator.shop.action.GetSubscriptionsForSalesStoreEstablishedBetween}}|
||Available from core version|8.7|
||Description|Finds subscriptions with a specific sales store established between two dates|
||Return value|{{ArrayList}}: Subscriptions|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.SetShopParentId
||Action name|SetShopParentId|
||Class name|{{com.cdrator.shop.action.SetShopParentId}}|
||Available from core version|8.7|
||Description|This action sets the parent id of a shop and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Shop}}: parentShop
|
h4.ShopReader
||Action name|ShopReader|
||Class name|{{com.cdrator.shop.action.ShopReader}}|
||Available from core version|8.7|
||Description|Retrieves a shop based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Simcard
h4.ChangeSimStatus
||Action name|ChangeSimStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM card status. If softblocked, barred or stolen is set, the blocked from date is updated. If in use is set, the blocked from date is set null.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.ChangeSimTypeStatus
||Action name|ChangeSimTypeStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimTypeStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM type status.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status types to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.FindSimcardsByIccAndPUK
||Action name|FindSimcardsByIccAndPUK|
||Class name|{{com.cdrator.simcard.action.FindSimcardsByIccAndPUK}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM cards from the database based on ICC and PUK.|
||Return value|{{ArrayList}}: The SIM cards with the ICC substring or the complete PUK. If no SIM cards are found, null is returned.|
||Properties|# onlyAvailableSIM: Only return available simcards?
|
||Parameters|# {{String}}: icc
# {{String}}: puk
|
h4.GetAvailableRandomSimCard
||Action name|GetAvailableRandomSimCard|
||Class name|{{com.cdrator.simcard.action.GetAvailableRandomSimCard}}|
||Available from core version|8.7|
||Description|Fetches a random available SIM card. Available means that the status is 0 (open and active) and it's not reserved. The SIM card type can be specified as a parameter.|
||Return value|{{SimCard}}: The available SIM card if found.|
||Properties| |
||Parameters|# {{String}}: simTypeId
|
h4.GetSimcardByIcc
||Action name|GetSimcardByIcc|
||Class name|{{com.cdrator.simcard.action.GetSimcardByIcc}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM card from the database by ICC.|
||Return value|{{SimCard}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{String}}: icc
|
h4.ReserveSimcard
||Action name|ReserveSimcard|
||Class name|{{com.cdrator.simcard.action.ReserveSimcard}}|
||Available from core version|8.7|
||Description|Action for reserving a SIM card to a service.|
||Return value|{{boolean}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{SimCard}}: simcard
# {{Service}}: service
|
h4.SimCardReader
||Action name|SimCardReader|
||Class name|{{com.cdrator.simcard.action.SimCardReader}}|
||Available from core version|8.7|
||Description|Retrieves a SIM card based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Util
h4.AddHookpointResult
||Action name|AddHookpointResult|
||Class name|{{com.cdrator.util.action.AddHookpointResult}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result.|
||Return value|{{void}}: No return value|
||Properties|# clearHookpointResult: Clear hookpoint result except for keys starting with LAST_OUTCOME_
# key1: Key 1
# key2: Key 2
# key3: Key 3
|
||Parameters|# {{HookpointResult}}: result
# {{String}}: value1
# {{String}}: value2
# {{String}}: value3
|
h4.CreateCdrParameter
||Action name|CreateCdrParameter|
||Class name|{{com.cdrator.util.action.CreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action creates a new cdrparameter based on the given code. The description, value and object, will be set based on the given information.|
||Return value|{{CdrParameter}}: The created cdrparameter.|
||Properties|# code: The code to create the cdrparameter from.
# description: The description of the cdrparameter.
|
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FormatString
||Action name|FormatString|
||Class name|{{com.cdrator.util.action.FormatString}}|
||Available from core version|8.7|
||Description|Format a string. Uses standard String.format|
||Return value|{{String}}: The formatted string.|
||Properties|# format: The format string.
|
||Parameters|# {{Object}}: param1
# {{Object}}: param2
# {{Object}}: param3
# {{Object}}: param4
# {{Object}}: param5
|
h4.GeneratePDFAction
||Action name|GeneratePDFAction|
||Class name|{{com.cdrator.util.action.GeneratePDFAction}}|
||Available from core version|8.7|
||Description|Generates a PDF specification based on the specified type.|
||Return value|{{String}}: The generated PDF string - Base64 encoded.|
||Properties|# PDFType: Specify the type of PDF generation.
|
||Parameters|# {{PersistentObject}}: object
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.GenerateXMLFromPO
||Action name|GenerateXMLFromPO|
||Class name|{{com.cdrator.util.action.GenerateXMLFromPO}}|
||Available from core version|8.7|
||Description|This action generates a XML document based on the given XMLDocumentDefinition and Persistant object. The resulting XML is placed in the provided dirName with the provided name+timestamp|
||Return value|{{boolean}}: Returns a persistentObject from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: documentDefKey
# {{String}}: dirName
# {{String}}: fileName
# {{PersistentObject}}: persistantObject
# {{String}}: persistentObjectKey
|
h4.GetCdrParameter
||Action name|GetCdrParameter|
||Class name|{{com.cdrator.util.action.GetCdrParameter}}|
||Available from core version|8.7|
||Description|This action adds a new cdrparameter based on the given objects and text string. Throws NullPointerException if both the cdrParameter and the parameter definition does not exist in the database.|
||Return value|{{CdrParameter}}: Returns cdr parameter based on the given objecs.|
||Properties| |
||Parameters|# {{CdrParameterIf}}: object
# {{String}}: varname
# {{CdrParameterIf}}: alternativeObject
|
h4.GetHashedValueFromString
||Action name|GetHashedValueFromString|
||Class name|{{com.cdrator.util.action.GetHashedValueFromString}}|
||Available from core version|8.7|
||Description|This action returns a hashed string based on the input given and the chosen hash type.|
||Return value|{{String}}: Returns a string hash of the suppplied input.|
||Properties|# selectedHashAlgorithm: Chosen hashing algorithm. Only SHA-1, SHA-256, SHA-384, SHA-512, MD2, MD5 are supported. If none is specified or no match, then SHA-1 is assumed.
|
||Parameters|# {{String}}: input
|
h4.GetInstanceFromDB
||Action name|GetInstanceFromDB|
||Class name|{{com.cdrator.util.action.GetInstanceFromDB}}|
||Available from core version|8.7|
||Description|This action retrieves a persistentObject from the database.|
||Return value|{{PersistentObject}}: Returns a persistent object from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{String}}: className
# {{Broker}}: broker
# {{String}}: clause
|
h4.GetParameterTreeValues
||Action name|GetParameterTreeValues|
||Class name|{{com.cdrator.util.action.GetParameterTreeValues}}|
||Available from core version|8.7|
||Description|This action retrieves all parameter values for a given node path and brand.|
||Return value|{{List}}: Returns the list of parameter values for the given node path.|
||Properties|# nodePath: Path to parameter tree node. Example: ALERTS.ALERT_GROUPS.
|
||Parameters|# {{Brand}}: brand
|
h4.GetStatusTypesFor
||Action name|GetStatusTypesFor|
||Class name|{{com.cdrator.util.action.GetStatusTypesFor}}|
||Available from core version|8.7|
||Description|This action retrieves the statuses for a given status type code.|
||Return value|{{List}}: Returns statuses for the given code.|
||Properties| |
||Parameters|# {{String}}: code
|
h4.IsStringInDelimitedString
||Action name|IsStringInDelimitedString|
||Class name|{{com.cdrator.util.action.IsStringInDelimitedString}}|
||Available from core version|8.7|
||Description|This action returns true if a given string val is in the comma separated string values. Remark: Both strings are trimmed before comparison to avoid unintended results.|
||Return value|{{boolean}}: Returns true if the given val is in the values string, false in all other cases.|
||Properties| |
||Parameters|# {{String}}: val
# {{String}}: values
|
h4.SimpleReturn
||Action name|SimpleReturn|
||Class name|{{com.cdrator.util.action.SimpleReturn}}|
||Available from core version|8.7|
||Description|Returns the argument object|
||Return value|{{Object}}: The argument object|
||Properties| |
||Parameters|# {{Object}}: executionArg
|
h4.Throttle
||Action name|Throttle|
||Class name|{{com.cdrator.util.action.Throttle}}|
||Available from core version|8.7|
||Description|Throttles a process
Requires 2 parameters:
WORKFLOW.THROTTLING.<name>.CAP number of times the throttled process may be performed in each interval
WORKFLOW.THROTTLING.<name>.INTERVAL number of seconds each interval lasts|
||Return value|{{boolean}}: Returns true if the process can continue.|
||Properties|# name: Used to generate the keys for the properties and parameters.
|
||Parameters| |
h4.ThrowNewUserMessageSysExceptionAction
||Action name|ThrowNewUserMessageSysExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewUserMessageSysExceptionAction}}|
||Available from core version|8.7|
||Description|Will throw an exception with a user defined message. Use this action to manually throw an exception to force a rollback while also specifying an error message to the end user, e.g. in the SOAP response instead of displaying BUSINESS_ERROR.|
||Return value|{{void}}: No return value.|
||Properties|# userMessage: The user message to pass along the exception. Specify labels, max 5 labels, in the message using <LABEL(X)>, e.g. This is <LABEL1> example label one.
|
||Parameters|# {{String}}: label1
# {{String}}: label2
# {{String}}: label3
# {{String}}: label4
# {{String}}: label5
|
h4.ThrowNewWorkflowExceptionAction
||Action name|ThrowNewWorkflowExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewWorkflowExceptionAction}}|
||Available from core version|8.7|
||Description|Finalizes logistics file.|
||Return value|{{void}}: No return value.|
||Properties|# recordNo: Error message to log throw with exception.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h4.UpdatePersistentObject
||Action name|UpdatePersistentObject|
||Class name|{{com.cdrator.util.action.UpdatePersistentObject}}|
||Available from core version|8.7|
||Description|This action updates a persistent object by calling a method on it with one or more parameters. The persistent object is saved afterwards. Example: PersistentObject=USERS, method="setAccount", params=ACCOUNT result: USERS.setAccount(ACCOUNT); USERS.save();|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
# {{String}}: method
# {{Object[]}}: params
|
h3.Util - Date
h4.DateChanger
||Action name|DateChanger|
||Class name|{{com.cdrator.util.date.action.DateChanger}}|
||Available from core version|8.7|
||Description|Changes values on a given date, al values are given as numbers where e.g. Month=1 sets the date to January.|
||Return value|{{Date}}: The modified date.|
||Properties| |
||Parameters|# {{Date}}: date
# {{String}}: milliSecond
# {{String}}: second
# {{String}}: minute
# {{String}}: hour
# {{String}}: day
# {{String}}: month
# {{String}}: year
|
h4.DateComparator
||Action name|DateComparator|
||Class name|{{com.cdrator.util.date.action.DateComparator}}|
||Available from core version|8.7|
||Description|Compares two given dates for one of these actions: AFTER, BEFORE, or EQUALS. Date1 is compared against date2 with the action (e.g. date1 after date2).|
||Return value|{{boolean}}: A boolean representing the outcome of the specified operation.|
||Properties|# action: Specify the operation between dates.
|
||Parameters|# {{Date}}: date1
# {{Date}}: date2
|
h4.DateStaticAdder
||Action name|DateStaticAdder|
||Class name|{{com.cdrator.util.date.action.DateStaticAdder}}|
||Available from core version|8.7|
||Description|Adds day, hours, minutes, and second to the given date|
||Return value|{{Date}}: The modified date.|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters|# {{Date}}: date
|
h4.FormatDate
||Action name|FormatDate|
||Class name|{{com.cdrator.util.date.action.FormatDate}}|
||Available from core version|8.7|
||Description|Turns a given date into a string using a specified format.|
||Return value|{{String}}: The formatted date.|
||Properties|# format: The format to format the date by.
|
||Parameters|# {{Date}}: date
|
h4.GetDate
||Action name|GetDate|
||Class name|{{com.cdrator.util.date.action.GetDate}}|
||Available from core version|8.7|
||Description|An action to retrieve the current or a future date|
||Return value|{{Date}}: A date representing the sysdate + eventual added minutes, hours, days or months|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters| |
h4.GetEndOfMonthDate
||Action name|GetEndOfMonthDate|
||Class name|{{com.cdrator.util.date.action.GetEndOfMonthDate}}|
||Available from core version|8.7|
||Description|This action returns a calendar representing the last day of the current month.|
||Return value|{{Calendar}}: A calendar representing the last day of the current month.|
||Properties| |
||Parameters| |
h4.GetFirstDayOfMonth
||Action name|GetFirstDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetFirstDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the first day of the month of the supplied date|
||Return value|{{Date}}: A date representing the first day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetFormattedCalendarField
||Action name|GetFormattedCalendarField|
||Class name|{{com.cdrator.util.date.action.GetFormattedCalendarField}}|
||Available from core version|8.7|
||Description|Returns the string representation of the calendar field value in the given style and locale. Parameters requrired: dateField - the calendar field for which the string representation is returned (Calendar.MONTH ...); date - The source date; locale - The locale used for formatting. (no ...); dateStyle - The locale used for formatting.(Calendar.SHORT, Calendar.LONG).|
||Return value|{{String}}: Returns the string representation of the calendar field value in the given style and locale.|
||Properties| |
||Parameters|# {{int}}: dateField
# {{Date}}: date
# {{String}}: locale
# {{int}}: dateStyle
|
h4.GetLastDayOfMonth
||Action name|GetLastDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetLastDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the last day of the month of the supplied date|
||Return value|{{Date}}: A date representing the last day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetNextWorkingDay
||Action name|GetNextWorkingDay|
||Class name|{{com.cdrator.util.date.action.GetNextWorkingDay}}|
||Available from core version|8.7|
||Description|Get the next working day if the supplied date is a holiday|
||Return value|{{Date}}: The next working day|
||Properties| |
||Parameters|# {{Date}}: fromDate
|
h3.Util - Image
h4.GetImage
||Action name|GetImage|
||Class name|{{com.cdrator.util.image.action.GetImage}}|
||Available from core version|8.7|
||Description|Loads an image from a specific path given as parameter or context object|
||Return value|{{Image}}: Returns the Image object loaded from the given path.|
||Properties| |
||Parameters|# {{String}}: imagePath
|
h3.Util - Parameter
h4.CdrParameterReader
||Action name|CdrParameterReader|
||Class name|{{com.cdrator.util.parameter.action.CdrParameterReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDR Parameter based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.UpdateCreateCdrParameter
||Action name|UpdateCreateCdrParameter|
||Class name|{{com.cdrator.util.parameter.action.UpdateCreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action updates a cdr parameter, if the cdr parameter doesn't exist it will create a new one. The value, name and object will be set based on the given information.|
||Return value|{{CdrParameter}}: The updated/created cdr parameter.|
||Properties| |
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
h3.Unknown package
h4.SingleValueReader
||Action name|SingleValueReader|
||Class name|{{com.cdrator.util.SingleValueReader}}|
||Available from core version|8.7|
||Description|Reads a single value from a persistent object. Column name must be specified.|
||Return value|{{String}}: The string value of the specified column name of the persistent object|
||Properties|# columnName: The column name of the persistent object, from where to read the value from
|
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Util - String
h4.CreateListOfStringsFromDelimitedText
||Action name|CreateListOfStringsFromDelimitedText|
||Class name|{{com.cdrator.util.string.action.CreateListOfStringsFromDelimitedText}}|
||Available from core version|8.7|
||Description|Creates a List of strings from a delimited text|
||Return value|{{List}}: The list of strings computed by splitting the delimited text|
||Properties|# delimiter: The delimiter used in the text
|
||Parameters|# {{String}}: delimitedText
|
h3.Workflow
h4.PushWorkflow
||Action name|PushWorkflow|
||Class name|{{com.cdrator.workflow.action.PushWorkflow}}|
||Available from core version|8.7|
||Description|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
|
||Return value|{{WfActivity}}: The activity the workflow was waiting in.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{WfWorkflow}}: workflow
|
h4.PushWorkflowById
||Action name|PushWorkflowById|
||Class name|{{com.cdrator.workflow.action.PushWorkflowById}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{WfWorkflow}}: The pushed workflow.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{String}}: workflowId
# {{Broker}}: broker
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.StartNewWorkflow
||Action name|StartNewWorkflow|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflow}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{HookpointResult}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
|
h4.StartNewWorkflowList
||Action name|StartNewWorkflowList|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflowList}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
# {{List}}: objectList
# {{String}}: objectContextKey
|
h4.WorkflowActivityReader
||Action name|WorkflowActivityReader|
||Class name|{{com.cdrator.workflow.action.WorkflowActivityReader}}|
||Available from core version|8.7|
||Description|Retrieves a workflow activity based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Workflow - Context
h4.IsObjectInContext
||Action name|IsObjectInContext|
||Class name|{{com.cdrator.workflow.context.action.IsObjectInContext}}|
||Available from core version|8.7|
||Description|Checks if the object is in the context|
||Return value|{{boolean}}: true if the object is in the context|
||Properties|# objectKey: The key of the object to check in the context
|
||Parameters|# {{Map}}: context
|
h3.Workflow - Hookpointresult
h4.AddHookpointResultObjects
||Action name|AddHookpointResultObjects|
||Class name|{{com.cdrator.workflow.hookpointresult.action.AddHookpointResultObjects}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result. Allows having objects in HOOKPOINT_RESULT|
||Return value|{{void}}: No return value|
||Properties|# key1: Key 1
# key2: Key 2
# key3: Key 3
# key4: Key 4
# key5: Key 5
|
||Parameters|# {{HookpointResult}}: result
# {{Object}}: value1
# {{Object}}: value2
# {{Object}}: value3
# {{Object}}: value4
# {{Object}}: value5
|
h4.CheckHookpointResult
||Action name|CheckHookpointResult|
||Class name|{{com.cdrator.workflow.hookpointresult.action.CheckHookpointResult}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: True if result is success, False otherwise.|
||Properties|# errorCodesToIgnore: List of error codes to ignore. Use semicolon (;) to separate the values of the list.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h3.Billing - Billingcycle
h4.BillingCycleReader
||Action name|BillingCycleReader|
||Class name|{{com.cdrator.billing.billingcycle.action.BillingCycleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Cycle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetEndOfBillingCycleDate
||Action name|GetEndOfBillingCycleDate|
||Class name|{{com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate}}|
||Available from core version|8.7|
||Description|This action returns a date representing the last day of the current billing cycle for the given billing group.|
||Return value|{{Date}}: A Date representing the last day of the current billing cycle.|
||Properties| |
||Parameters|# {{Date}}: date
# {{BillingGroup}}: bg
|
h3.Billing - Billinggroup
h4.BillingGroupReader
||Action name|BillingGroupReader|
||Class name|{{com.cdrator.billing.billinggroup.action.BillingGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves a Billing Group based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveBillingGroupMembers
||Action name|GetActiveBillingGroupMembers|
||Class name|{{com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers}}|
||Available from core version|8.7|
||Description|Retrieves the active members of the billing group|
||Return value|{{List}}: The active members of the billing group|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.HardBlockAllTeleServicesOnBillingGroup
||Action name|HardBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.SoftBlockAllTeleServicesOnBillingGroup
||Action name|SoftBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h4.UnBlockAllTeleServicesOnBillingGroup
||Action name|UnBlockAllTeleServicesOnBillingGroup|
||Class name|{{com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: null|
||Properties|# historyTag: Add translation tag for the history line if needed
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{String}}: historyLine
|
h3.Billing - Charge
h4.CreateSingleChargeForBillingGroup
||Action name|CreateSingleChargeForBillingGroup|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Billing Group. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.CreateSingleChargeForSubscription
||Action name|CreateSingleChargeForSubscription|
||Class name|{{com.cdrator.billing.charge.action.CreateSingleChargeForSubscription}}|
||Available from core version|8.7|
||Description|Creates and saves a Charge for a Subscription. Adding the charge directly is optional.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties|# addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.
|
||Parameters|# {{Subscription}}: subscription
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Amount}}: amount
|
h4.RoundAllInvoicesInBatch
||Action name|RoundAllInvoicesInBatch|
||Class name|{{com.cdrator.billing.charge.action.RoundAllInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Rounds all invoices on an invoicebatch, to nearest whole number.|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: batch
# {{ChargeItem}}: chargeItem
|
h3.Billing - Financial - Billing
h4.AddChargeToBillingGroup
||Action name|AddChargeToBillingGroup|
||Class name|{{com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{Charge}}: The created charge is returned.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{Number}}: amount
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.BuildAccountPaymentsForInvoicesOnBatch
||Action name|BuildAccountPaymentsForInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# paymentType: The account payment type that should be used for the payment.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: cdrParameterName
# {{String}}: parameterValue
|
h4.DoAccountPayment
||Action name|DoAccountPayment|
||Class name|{{com.cdrator.billing.financial.billing.action.DoAccountPayment}}|
||Available from core version|8.7|
||Description|Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.|
||Return value|{{AccountPayment}}: Returns the account payment|
||Properties|# accountPaymentTypeId: The account payment type of the recharge ticket.
# skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.
|
||Parameters|# {{RechargeTicket}}: rechargeTicket
# {{Invoice}}: invoice
# {{BillingGroup}}: billingGroup
# {{String}}: paymentRequestRef
# {{HookpointResult}}: hookpointResult
|
h4.GetListOfServicesInStatusFromSubscriptions
||Action name|GetListOfServicesInStatusFromSubscriptions|
||Class name|{{com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions}}|
||Available from core version|8.7|
||Description|Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.|
||Return value|{{List}}: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{List}}: statuses
|
h4.GetNewInvoice
||Action name|GetNewInvoice|
||Class name|{{com.cdrator.billing.financial.billing.action.GetNewInvoice}}|
||Available from core version|8.7|
||Description|This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.|
||Return value|{{Invoice}}: The newly created Invoice|
||Properties|# invoiceType: The available invoice types
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.MakeInvoicePaymentOnInvoicesInBatch
||Action name|MakeInvoicePaymentOnInvoicesInBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch}}|
||Available from core version|8.7|
||Description|Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h4.ManualDebitOrCredit
||Action name|ManualDebitOrCredit|
||Class name|{{com.cdrator.billing.financial.billing.action.ManualDebitOrCredit}}|
||Available from core version|8.7|
||Description|This action calls the function addManualDebitOrCredit on the provided set of parameters.|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{TimeCharge}}: timeCharge
# {{ChargeItem}}: chargeItem
# {{String}}: description
# {{boolean}}: isDebit
# {{Amount}}: amount
# {{Currency}}: amountCurrency
# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.PayInvoicesOnBatch
||Action name|PayInvoicesOnBatch|
||Class name|{{com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch}}|
||Available from core version|8.7|
||Description|Adds a charge to a billing group.|
||Return value|{{boolean}}: True is always returned.|
||Properties|# payPostPaidInvoices: Should postpaid invoices be marked as paid.
# payPrePaidInvoices: Should prepaid invoices be marked as paid.
|
||Parameters|# {{InvoiceBatch}}: batch
# {{String}}: paymentTypeId
# {{String}}: bObjectId
# {{String}}: reference
# {{String}}: source
|
h3.Unknown package
h4.PaymentMethodReader
||Action name|PaymentMethodReader|
||Class name|{{com.cdrator.billing.financial.PaymentMethodReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Method entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Financial - Payments
h4.PaymentLogReader
||Action name|PaymentLogReader|
||Class name|{{com.cdrator.billing.financial.payments.action.PaymentLogReader}}|
||Available from core version|8.7|
||Description|Retrieves a Payment Log based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - Invoice
h4.CloseInvoiceWithCurrentDate
||Action name|CloseInvoiceWithCurrentDate|
||Class name|{{com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate}}|
||Available from core version|8.7|
||Description|Calls closeWithDueDate on a given invoice with current date.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.GetAccountPaymentsForInvoice
||Action name|GetAccountPaymentsForInvoice|
||Class name|{{com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice}}|
||Available from core version|8.7|
||Description|Gets a list of account payments related to the invoice.|
||Return value|{{List}}: A list of accountPayments.|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h4.InvoiceCompareToLastStepId
||Action name|InvoiceCompareToLastStepId|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId}}|
||Available from core version|8.7|
||Description|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 |
||Return value|{{boolean}}: true or false|
||Properties| |
||Parameters|# {{Invoice}}: invoice
# {{String}}: compareString
# {{boolean}}: defaultForBlank
|
h4.InvoiceReader
||Action name|InvoiceReader|
||Class name|{{com.cdrator.billing.invoice.action.InvoiceReader}}|
||Available from core version|8.7|
||Description|Retrieves an invoice based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.PayInvoicesInBatchWithAccountPayments
||Action name|PayInvoicesInBatchWithAccountPayments|
||Class name|{{com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments}}|
||Available from core version|8.7|
||Description|Marks all invoice on batch as paid|
||Return value|{{void}}: null|
||Properties| |
||Parameters|# {{InvoiceBatch}}: invoiceBatch
# {{String}}: reference
# {{String}}: transactionNumber
# {{AccountPaymentType}}: accountPaymentType
|
h4.PublishInvoice
||Action name|PublishInvoice|
||Class name|{{com.cdrator.billing.invoice.action.PublishInvoice}}|
||Available from core version|8.7|
||Description|Publishes a given invoice.|
||Return value|{{Invoice}}: The published invoice|
||Properties| |
||Parameters|# {{Invoice}}: invoice
|
h3.Billing - Main
h4.GetBillingGroupsByUserID
||Action name|GetBillingGroupsByUserID|
||Class name|{{com.cdrator.billing.main.action.GetBillingGroupsByUserID}}|
||Available from core version|8.7|
||Description|This action will return an arraylist of billing groups that a given userID is the owner of.|
||Return value|{{ArrayList}}: An array list of billing groups.|
||Properties| |
||Parameters|# {{String}}: userID
|
h4.SetBillingGroupCurrencyCode
||Action name|SetBillingGroupCurrencyCode|
||Class name|{{com.cdrator.billing.main.action.SetBillingGroupCurrencyCode}}|
||Available from core version|8.7|
||Description|This action sets the currency code on the billing group. The billing group is saved.|
||Return value|{{void}}: No return value.|
||Properties|# currencyCode: The currency code which is set on the billing group.
|
||Parameters|# {{BillingGroup}}: billingGroup
|
h4.TerminateSharedServiceIfNoTeleservices
||Action name|TerminateSharedServiceIfNoTeleservices|
||Class name|{{com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Boolean}}: Returns true if a shared Service was attempted terminated.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
# {{Date}}: terminationDate
# {{String}}: hookpointKey
# {{String}}: reason
|
h3.Billing - Misc
h4.GetParameterValue
||Action name|GetParameterValue|
||Class name|{{com.cdrator.billing.misc.action.GetParameterValue}}|
||Available from core version|8.7|
||Description|This action retrieves a string representation of a parameter value.|
||Return value|{{String}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{String}}: key
# {{Brand}}: brand
|
h3.Billing - Payment
h4.AccountPaymentReader
||Action name|AccountPaymentReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AccountPaymentSetAuthorized
||Action name|AccountPaymentSetAuthorized|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetAuthorized}}|
||Available from core version|8.7|
||Description|Calls setAuthorized on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentSetCaptureInfo
||Action name|AccountPaymentSetCaptureInfo|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo}}|
||Available from core version|8.7|
||Description|Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage) |
||Return value|{{void}}: No return value|
||Properties|# captureMessage: Capture message to be set.
# useCaptureDate: Should Capture Date be set (to current time.
|
||Parameters|# {{AccountPayment}}: ap
|
h4.AccountPaymentSetDoCapture
||Action name|AccountPaymentSetDoCapture|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentSetDoCapture}}|
||Available from core version|8.7|
||Description|Calls setDoCapture on a given account payment and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{AccountPayment}}: accountPayment
|
h4.AccountPaymentTypeReader
||Action name|AccountPaymentTypeReader|
||Class name|{{com.cdrator.billing.payment.action.AccountPaymentTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an account payment based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AcountPaymentSetCaptureMessage
||Action name|AcountPaymentSetCaptureMessage|
||Class name|{{com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage}}|
||Available from core version|8.7|
||Description|Set capture message on AccountPayment|
||Return value|{{void}}: No return value|
||Properties| |
||Parameters|# {{AccountPayment}}: ap
# {{String}}: captureMessage
|
h4.GetRechargeTicketForBillingGroup
||Action name|GetRechargeTicketForBillingGroup|
||Class name|{{com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup}}|
||Available from core version|8.7|
||Description|This action returns a rechargeTicket for a BillingGroup.|
||Return value|{{RechargeTicket}}: The recharge ticket, if it exists.|
||Properties| |
||Parameters|# {{BillingGroup}}: billingGroup
|
h3.Billing - Product
h4.DeviceCanUseOn
||Action name|DeviceCanUseOn|
||Class name|{{com.cdrator.billing.product.action.DeviceCanUseOn}}|
||Available from core version|8.7|
||Description|Calls CanUseOn on a given device with a given service.|
||Return value|{{boolean}}: Boolean showing if a given device can be used on a given service.|
||Properties| |
||Parameters|# {{Device}}: device
# {{Service}}: service
|
h4.GetDeviceFromParameterValue
||Action name|GetDeviceFromParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceFromParameterValue}}|
||Available from core version|8.7|
||Description|Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.|
||Return value|{{Device}}: The located device.|
||Properties| |
||Parameters|# {{String}}: name
# {{String}}: value
|
h4.GetDeviceParameterValue
||Action name|GetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.GetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action returns the value of a given device parameter or throws a NullValueException if none is found.|
||Return value|{{String}}: Value of the given parameter (as a string).|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
|
h4.SetDeviceParameterValue
||Action name|SetDeviceParameterValue|
||Class name|{{com.cdrator.billing.product.action.SetDeviceParameterValue}}|
||Available from core version|8.7|
||Description|This action updates a device parameter value if it's found, otherwise it will be created.|
||Return value|{{boolean}}: True if the parameter was created, false if the parameter was updated.|
||Properties| |
||Parameters|# {{Device}}: device
# {{String}}: name
# {{String}}: value
|
h3.Billing - Product - RatePlanChange
h4.CompleteRatePlanChange
||Action name|CompleteRatePlanChange|
||Class name|{{com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange}}|
||Available from core version|8.7|
||Description|This action completes the rateplan change by subscribing to the default and mandatory options.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{RatePlanChange}}: rpc
# {{boolean}}: cache
|
h3.Billing - Rating
h4.GetActiveRatePlanForSubscription
||Action name|GetActiveRatePlanForSubscription|
||Class name|{{com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the currently active rate plan for a subscription.|
||Return value|{{RatePlan}}: Returns a rate plan that is currently active for the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetPlanElement
||Action name|GetPlanElement|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElement}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters| |
h4.GetPlanElementForRatePlan
||Action name|GetPlanElementForRatePlan|
||Class name|{{com.cdrator.billing.rating.action.GetPlanElementForRatePlan}}|
||Available from core version|8.7|
||Description|This action returns a planElement based on a fee code|
||Return value|{{PlanElements}}: Return the planElement|
||Properties|# planElement: The plan elements.
|
||Parameters|# {{RatePlan}}: ratePlan
|
h4.GetRatePlansByProduct
||Action name|GetRatePlansByProduct|
||Class name|{{com.cdrator.billing.rating.action.GetRatePlansByProduct}}|
||Available from core version|8.7|
||Description|This action retrieves rate plans for a product.|
||Return value|{{List}}: Returns a list of rate plans related to this product.|
||Properties| |
||Parameters|# {{Product}}: product
|
h3.Billing - Rating - Simulate
h4.BillingRecordBuilder
||Action name|BillingRecordBuilder|
||Class name|{{com.cdrator.billing.rating.simulate.action.BillingRecordBuilder}}|
||Available from core version|8.7|
||Description|Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.|
||Return value|{{BillingRecordSimulated}}: A new unrated billing record. Not persisted.|
||Properties|# BNumber: B-Number of the billing record.
# ratingCode: Rating code to be set on the Billing Record.
# ratingDuration: Rating duration to be set on the Billing Record.
# ratingKey: Rating key to be set on the Billing Record.
# ratingVolumne: Rating volume to be set on the Billing Record.
|
||Parameters|# {{Service}}: service
|
h4.CalculateInvoiceDetailLinesTotalChargeSum
||Action name|CalculateInvoiceDetailLinesTotalChargeSum|
||Class name|{{com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Amount}}: The sum to the total charges of the Invoice Detail Lines Wrappers|
||Properties|# ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
# throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
|
||Parameters|# {{List}}: idlList
|
h4.RatingSimulator
||Action name|RatingSimulator|
||Class name|{{com.cdrator.billing.rating.simulate.action.RatingSimulator}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{ArrayList}}: ArrayList of the Invoice Detail Lines|
||Properties| |
||Parameters|# {{Service}}: service
# {{BillingRecords}}: billingRecord
|
h3.Billing - Status
h4.StatusReader
||Action name|StatusReader|
||Class name|{{com.cdrator.billing.status.action.StatusReader}}|
||Available from core version|8.7|
||Description|Retrieves a Status object based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - SubscriptionFees
h4.AddFee
||Action name|AddFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddFee}}|
||Available from core version|8.7|
||Description|Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Returns the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# feeCode: The fee code for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
h4.AddSubscriptionFee
||Action name|AddSubscriptionFee|
||Class name|{{com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee}}|
||Available from core version|8.7|
||Description|Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.|
||Return value|{{SubscriptionFees}}: Return the added subscription fee.|
||Properties|# chargeStartDate: Charge the given start date.
# planElement: The plan element for the subscription fee.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: startDate
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SubscriptionFeesReader
||Action name|SubscriptionFeesReader|
||Class name|{{com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader}}|
||Available from core version|8.7|
||Description|Gets a subscription fee.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Billing - TodoTask
h4.CreateTodoTask
||Action name|CreateTodoTask|
||Class name|{{com.cdrator.billing.todoTask.action.CreateTodoTask}}|
||Available from core version|8.7|
||Description|Creates a TodoTask based on configurable properties|
||Return value|{{void}}: No return values|
||Properties|# assignedToOperator: The operator the todo task is assigned to
# category: Task category
# contactPhoneNumber: Contact phone number
# description: Task Description
# reminderTimeInMinutes: Reminder time in minutes
# subject: Subject
# typeOfFollowUp: The type of follow up: email,letter,phone call,sms
|
||Parameters|# {{Service}}: service
|
h3.Brand
h4.BrandReader
||Action name|BrandReader|
||Class name|{{com.cdrator.brand.action.BrandReader}}|
||Available from core version|8.7|
||Description|Retrieves a Brand based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Campaign
h4.CampaignReader
||Action name|CampaignReader|
||Class name|{{com.cdrator.campaign.action.CampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a Campaign definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetBundlesFromCampaign
||Action name|GetBundlesFromCampaign|
||Class name|{{com.cdrator.campaign.action.GetBundlesFromCampaign}}|
||Available from core version|8.7|
||Description|Returns an list of campaign bundles from a campaign.|
||Return value|{{ArrayList}}: a list of campaign bundles|
||Properties| |
||Parameters|# {{Campaign}}: campaign
|
h4.GetCampaignForKey
||Action name|GetCampaignForKey|
||Class name|{{com.cdrator.campaign.action.GetCampaignForKey}}|
||Available from core version|8.7|
||Description|This action returns a campaign for which the campaign key is provided as a property.|
||Return value|{{Campaign}}: The campaign associated with the provided campaign key.|
||Properties|# campaignKey: The campaign key for the campaign.
|
||Parameters| |
h4.GetCurrentSubscriptionCampaign
||Action name|GetCurrentSubscriptionCampaign|
||Class name|{{com.cdrator.campaign.action.GetCurrentSubscriptionCampaign}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a subscription and campaign.|
||Return value|{{SubscriptionCampaign}}: The current SubscriptionCampaign.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Campaign}}: campaign
|
h4.GetNewSubscriptionBundle
||Action name|GetNewSubscriptionBundle|
||Class name|{{com.cdrator.campaign.action.GetNewSubscriptionBundle}}|
||Available from core version|8.7|
||Description|This action creates and returns a new SubscriptionBundle.|
||Return value|{{SubscriptionBundle}}: Returns a new SubscriptionBundle|
||Properties| |
||Parameters|# {{Bundle}}: bundle
# {{Subscription}}: subscription
# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.GetSubscriptionCampaignsByCriteria
||Action name|GetSubscriptionCampaignsByCriteria|
||Class name|{{com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria}}|
||Available from core version|8.7|
||Description|This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.|
||Return value|{{List}}: A list of SubscriptionCampaign matching given criterias.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: criterias
|
h4.SetListOfSubscriptionCampaignToDateToSpecificDate
||Action name|SetListOfSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: subscriptionCampaigns
# {{Date}}: date
|
h4.SetSubBundleVal1FromServiceOption
||Action name|SetSubBundleVal1FromServiceOption|
||Class name|{{com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption}}|
||Available from core version|8.7|
||Description|This action updates value1 if an associated serviceOptionParameter with a given key can be found.|
||Return value|{{boolean}}: Boolean indicating success of finding and setting the parameter.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
# parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.
|
||Parameters|# {{SubscriptionBundle}}: bundle
# {{Broker}}: broker
|
h4.SetSubscriptionCampaignCollectionFromToDate
||Action name|SetSubscriptionCampaignCollectionFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.|
||Return value|{{boolean}}: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{ArrayList}}: subscriptionCampaignList
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignFromDateToNextMonth
||Action name|SetSubscriptionCampaignFromDateToNextMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to the first day of next month.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignFromDateToSpecificDate
||Action name|SetSubscriptionCampaignFromDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.fromDate to a specific date.|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SetSubscriptionCampaignInstanceFromToDate
||Action name|SetSubscriptionCampaignInstanceFromToDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate}}|
||Available from core version|8.7|
||Description|Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.|
||Return value|{{boolean}}: Returns true if the date is set on a subscription campaigns, otherwise returns false.|
||Properties|# calendarField: The calendar field type.
# dateColumn: The date that should be changed.
# quantity: Amount +/- that should be added or subtracted to the date.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: newDate
|
h4.SetSubscriptionCampaignParameter
||Action name|SetSubscriptionCampaignParameter|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignParameter}}|
||Available from core version|8.7|
||Description|An action to set subscriptionCampaign parameters.|
||Return value|{{void}}: No return value.|
||Properties|# parameterName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{String}}: value
|
h4.SetSubscriptionCampaignToDateRestOfMonth
||Action name|SetSubscriptionCampaignToDateRestOfMonth|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth}}|
||Available from core version|8.7|
||Description|This action sets the toDate on a subscriptionCampaign to the end of the current month.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign.|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h4.SetSubscriptionCampaignToDateToSpecificDate
||Action name|SetSubscriptionCampaignToDateToSpecificDate|
||Class name|{{com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the subscription_campaign's to_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: date
|
h4.SubCampaignSetParameter
||Action name|SubCampaignSetParameter|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameter}}|
||Available from core version|8.7|
||Description|This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# paramName: The name of the Subscription Campaign parameter that should be set.
|
||Parameters|# {{Subscription}}: sub
# {{ServiceOptionParameter}}: sop
|
h4.SubCampaignSetParameterFromSOP
||Action name|SubCampaignSetParameterFromSOP|
||Class name|{{com.cdrator.campaign.action.SubCampaignSetParameterFromSOP}}|
||Available from core version|8.7|
||Description|This action updates a subscription campaign parameter from a service option parameter with a given key.|
||Return value|{{boolean}}: True if the parameter is set, false otherwise.|
||Properties|# bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
# paramName: The name of the subscription campaign parameter that should be set.
# parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.
|
||Parameters|# {{SubscriptionBundle}}: bundle
|
h4.SubscriptionCampaignReader
||Action name|SubscriptionCampaignReader|
||Class name|{{com.cdrator.campaign.action.SubscriptionCampaignReader}}|
||Available from core version|8.7|
||Description|Retrieves a subscription campaign based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.TerminateCampaignWithFromDate
||Action name|TerminateCampaignWithFromDate|
||Class name|{{com.cdrator.campaign.action.TerminateCampaignWithFromDate}}|
||Available from core version|8.7|
||Description|Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
|
h3.Campaign - Bundle
h4.BundleReader
||Action name|BundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.BundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Bundle definition based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.GetActiveSubscriptionBundlesDefinedByDate
||Action name|GetActiveSubscriptionBundlesDefinedByDate|
||Class name|{{com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate}}|
||Available from core version|8.7|
||Description|Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.
|
||Parameters|# {{Subscription}}: subscription
# {{Date}}: date
|
h4.GetBundleForCampaignAndBundleKey
||Action name|GetBundleForCampaignAndBundleKey|
||Class name|{{com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey}}|
||Available from core version|8.7|
||Description|This action returns the bundle associated with the supplied campaign and bundleKey.|
||Return value|{{Bundle}}: The bundle associated with the supplied campaign and bundleKey.|
||Properties| |
||Parameters|# {{Campaign}}: campaign
# {{String}}: bundleKey
|
h4.GetCurrentSubscriptionBundlesNotUsedUpForCode
||Action name|GetCurrentSubscriptionBundlesNotUsedUpForCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleParameter
||Action name|GetSubscriptionBundleParameter|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter}}|
||Available from core version|8.7|
||Description|Finds a bundle parameter from a SubscriptionBundle.|
||Return value|{{String}}: The value of the Bundle parameter.|
||Properties|# optionKey: The parameter that should be read from the Bundle.
|
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundles
||Action name|GetSubscriptionBundles|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundles}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription.|
||Return value|{{ArrayList}}: The value of the Bundle parameter.|
||Properties|# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundlesWithCode
||Action name|GetSubscriptionBundlesWithCode|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode}}|
||Available from core version|8.7|
||Description|Returns the subscription bundles for a given subscription and the given code.|
||Return value|{{ArrayList}}: The list of subscription bundles.|
||Properties|# bundleCode: The code of the subscription bundles.
# status: The status of the subscription bundles.
|
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionBundleType
||Action name|GetSubscriptionBundleType|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleType}}|
||Available from core version|8.7|
||Description|Finds the type of a SubscriptionBundle.|
||Return value|{{String}}: The code of the SubscriptionBundle.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.GetSubscriptionBundleValue
||Action name|GetSubscriptionBundleValue|
||Class name|{{com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue}}|
||Available from core version|8.7|
||Description|Get the defined Value field in the subscription bundle for the specified bundle.|
||Return value|{{Amount}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{Subscription}}: subscription
|
h4.IsSubscriptionBundleUsedUp
||Action name|IsSubscriptionBundleUsedUp|
||Class name|{{com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp}}|
||Available from core version|8.7|
||Description|Determines if a given subscription bundle is used up by comparing the maximum value with the current value.|
||Return value|{{boolean}}: True if the subscription bundle is completely used up, false otherwise.|
||Properties| |
||Parameters|# {{SubscriptionBundle}}: subscriptionBundle
|
h4.ProrateActivationSubscriptionCampaignBundles
||Action name|ProrateActivationSubscriptionCampaignBundles|
||Class name|{{com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles}}|
||Available from core version|8.7|
||Description|Create and prorate the bundles of the given subscription campaign for a certain start date.|
||Return value|{{SubscriptionCampaign}}: The subscription campaign with the updated bundles|
||Properties|# roundPrecission: The precission used when rounding the bundles.
|
||Parameters|# {{SubscriptionCampaign}}: subscriptionCampaign
# {{Date}}: fromDate
|
h4.SetSubscriptionBundleValueFromServiceOptionParameter
||Action name|SetSubscriptionBundleValueFromServiceOptionParameter|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified service option parameter.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# valueMethodNumber: The bundle value that will be updated.
|
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{SubscriptionBundle}}: subscriptionBundle
|
h4.SetSubscriptionBundleValues
||Action name|SetSubscriptionBundleValues|
||Class name|{{com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues}}|
||Available from core version|8.7|
||Description|Set the defined Value field in the subscription bundle for the specified bundles.|
||Return value|{{void}}: The value of the Bundle parameter.|
||Properties|# bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
# bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
# campaignKey: The key of the campaign
# value1: Set value 1
# value2: Set value 2
# value3: Set value 3
# value4: Set value 4
|
||Parameters|# {{String}}: value
# {{Subscription}}: subscription
|
h4.SubscriptionBundleReader
||Action name|SubscriptionBundleReader|
||Class name|{{com.cdrator.campaign.bundle.action.SubscriptionBundleReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription Bundle based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Correspondence - Archive
h4.DocArchiveReader
||Action name|DocArchiveReader|
||Class name|{{com.cdrator.correspondence.archive.action.DocArchiveReader}}|
||Available from core version|8.7|
||Description|Retrieves a DocArchive entity based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveDocArchiveFile
||Action name|SaveDocArchiveFile|
||Class name|{{com.cdrator.correspondence.archive.action.SaveDocArchiveFile}}|
||Available from core version|8.7|
||Description|If property FilePath is set, it will override the FilePath parameter. Throws ActionParameterException if neither is specified|
||Return value|{{void}}: No value returned|
||Properties|# filePath: FilePath
|
||Parameters|# {{DocArchive}}: archive
# {{String}}: filePathParameter
|
h3.Device
h4.DeviceReader
||Action name|DeviceReader|
||Class name|{{com.cdrator.device.action.DeviceReader}}|
||Available from core version|8.7|
||Description|Retrieves a Device based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Device - Cdmaphone
h4.CdmaPhoneReader
||Action name|CdmaPhoneReader|
||Class name|{{com.cdrator.device.cdmaphone.action.CdmaPhoneReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDMA phone based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Fraud - Addresscheck
h4.PerformAddressCheck
||Action name|PerformAddressCheck|
||Class name|{{com.cdrator.fraud.addresscheck.action.PerformAddressCheck}}|
||Available from core version|8.7|
||Description|This action performs an address check on a user.|
||Return value|{{AddressCheckResult}}: The AddressCheckResult is returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{AddressCheck}}: ac
|
h3.Fraud - Creditcheck
h4.PerformCreditCheck
||Action name|PerformCreditCheck|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheck}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
# {{CreditCheck}}: cc
|
h4.PerformCreditCheckOnUser
||Action name|PerformCreditCheckOnUser|
||Class name|{{com.cdrator.fraud.creditcheck.action.PerformCreditCheckOnUser}}|
||Available from core version|8.7|
||Description|This action performs a credit check on a user.|
||Return value|{{CreditCheckResult}}: The CreditCheckResult will be returned.|
||Properties| |
||Parameters|# {{Users}}: user
|
h3.Main - Account
h4.AccountIsNewSignupAllowed
||Action name|AccountIsNewSignupAllowed|
||Class name|{{com.cdrator.main.account.action.AccountIsNewSignupAllowed}}|
||Available from core version|8.7|
||Description|This action check if it is allowed to add a new subscription to an account |
||Return value|{{boolean}}: true(default) or false based on workflow with hook_point SUB_SIGNUP_ALLOWED.|
||Properties| |
||Parameters|# {{Account}}: account
|
h4.AccountReader
||Action name|AccountReader|
||Class name|{{com.cdrator.main.account.action.AccountReader}}|
||Available from core version|8.7|
||Description|Retrieves an Account based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AddAccountWarning
||Action name|AddAccountWarning|
||Class name|{{com.cdrator.main.account.action.AddAccountWarning}}|
||Available from core version|8.7|
||Description|This action adds a warning to an account.
You can use the FormatString action to format the warning before calling this activity|
||Return value|{{void}}: No return value.|
||Properties|# category: null
|
||Parameters|# {{Account}}: account
# {{String}}: key
# {{String}}: description
# {{PersistentObject}}: sourcePO
# {{Date}}: expireDate
|
h4.AddWorkflowToAccount
||Action name|AddWorkflowToAccount|
||Class name|{{com.cdrator.main.account.action.AddWorkflowToAccount}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the WfWorkflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Account}}: account
# {{WfWorkflow}}: wfWorkflow
|
h4.CheckIfAccountInState
||Action name|CheckIfAccountInState|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountInState}}|
||Available from core version|8.7|
||Description|This action checks if an account is in one of the given states.|
||Return value|{{Boolean}}: Returns TRUE if the account state matches one of the given states.|
||Properties|# possibleStates: The possible states separated by ';'
|
||Parameters|# {{Account}}: account
|
h4.CheckIfAccountIsClosed
||Action name|CheckIfAccountIsClosed|
||Class name|{{com.cdrator.main.account.action.CheckIfAccountIsClosed}}|
||Available from core version|8.7|
||Description|This action checks if an account is closed.|
||Return value|{{Boolean}}: Returns TRUE if the account is closed.|
||Properties| |
||Parameters|# {{Account}}: account
|
h3.Main
h4.ProductMakeSubscription
||Action name|ProductMakeSubscription|
||Class name|{{com.cdrator.main.action.ProductMakeSubscription}}|
||Available from core version|8.7|
||Description|This action creates a subscription based on the supplied product configuration, account and billing group.|
||Return value|{{Subscription}}: Returns the newly created subscription.|
||Properties| |
||Parameters|# {{ProductConfig}}: productConfig
# {{Account}}: account
# {{BillingGroup}}: billingGroup
|
h3.Main - Alert
h4.AlertGroupReader
||Action name|AlertGroupReader|
||Class name|{{com.cdrator.main.alert.action.AlertGroupReader}}|
||Available from core version|8.7|
||Description|Retrieves an AlertGroup based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Operator
h4.OperatorAuthentication
||Action name|OperatorAuthentication|
||Class name|{{com.cdrator.main.operator.action.OperatorAuthentication}}|
||Available from core version|8.7|
||Description|This action authenticates the operator based on the username and password provided. If username or password are null or empty, null is returned.|
||Return value|{{Operators}}: The operator matching the username and password. Otherwise null.|
||Properties| |
||Parameters|# {{String}}: username
# {{String}}: password
|
h4.OperatorHookpointBlockRevoke
||Action name|OperatorHookpointBlockRevoke|
||Class name|{{com.cdrator.main.operator.action.OperatorHookpointBlockRevoke}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{OperatorAccessTags}}: The operator access tag matching the username and hookpoint key. Otherwise null.|
||Properties|# accessTagPostfix: Alternative access tag postfix. Default is _BLOCK_REVOKED
|
||Parameters|# {{String}}: username
# {{String}}: hookpointKey
|
h4.OperatorReader
||Action name|OperatorReader|
||Class name|{{com.cdrator.main.operator.action.OperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves an Operator based on configurable parameters|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OperatorTypeReader
||Action name|OperatorTypeReader|
||Class name|{{com.cdrator.main.operator.action.OperatorTypeReader}}|
||Available from core version|8.7|
||Description|Retrieves an operator type based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - Service
h4.ChangeDevice
||Action name|ChangeDevice|
||Class name|{{com.cdrator.main.service.action.ChangeDevice}}|
||Available from core version|8.7|
||Description|This action assigns a device to a given service.|
||Return value|{{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.|
||Properties|# autoAssignDevice: Auto assign device? If true, then newDevice parameter will be disregarded and the underlying workflow will assign a device automatically.
|
||Parameters|# {{Service}}: service
# {{Device}}: newDevice
# {{boolean}}: addFee
# {{String}}: sendType
# {{Status}}: reason
# {{String}}: comment
|
h4.ChangeServiceStatus
||Action name|ChangeServiceStatus|
||Class name|{{com.cdrator.main.service.action.ChangeServiceStatus}}|
||Available from core version|8.7|
||Description|This action sets and saves the Service status. |
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{Service}}: service
|
h4.CompleteCachedOptions
||Action name|CompleteCachedOptions|
||Class name|{{com.cdrator.main.service.action.CompleteCachedOptions}}|
||Available from core version|8.7|
||Description|Complete cached options on service|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceCode
||Action name|GetServiceCode|
||Class name|{{com.cdrator.main.service.action.GetServiceCode}}|
||Available from core version|8.7|
||Description|Return the code of the service.|
||Return value|{{String}}: The code of the service.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.GetServiceFromPhoneNumber
||Action name|GetServiceFromPhoneNumber|
||Class name|{{com.cdrator.main.service.action.GetServiceFromPhoneNumber}}|
||Available from core version|8.7|
||Description|This action gets an active service from the phone number and optionally the brand.|
||Return value|{{Service}}: The active service matching the phone number and brand.|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.main.service.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|This action gets a service option parameter given an option key and a parameter key.|
||Return value|{{ServiceOptionParameter}}: The service option parameter. If the service does not have the service option or the service option parameter, null is returned.|
||Properties|# optionKey: The option key to look for on service.
|
||Parameters|# {{Service}}: service
# {{String}}: parameterKey
|
h4.GetServicesForAccountAndProduct
||Action name|GetServicesForAccountAndProduct|
||Class name|{{com.cdrator.main.service.action.GetServicesForAccountAndProduct}}|
||Available from core version|8.7|
||Description|Return a list of services belonging to the account, with the a specific product code and with the status selected.|
||Return value|{{ArrayList}}: The list of recovered services, based on the input parameters.|
||Properties|# productIdDescription: The product for the service. If empty all services will be returned.
# serviceStatus: The service status. If empty all services will be returned.
|
||Parameters|# {{Account}}: account
|
h3.Main - Subscription
h4.ActivateSubscription
||Action name|ActivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ActivateSubscription}}|
||Available from core version|8.7|
||Description|This action activates a subscription in Rator.|
||Return value|{{Subscription}}: Returns the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.AddWorkflow
||Action name|AddWorkflow|
||Class name|{{com.cdrator.main.subscription.action.AddWorkflow}}|
||Available from core version|8.7|
||Description|This action associates a subscription with a workflow by setting the subscription ID on the workflow.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{WfWorkflow}}: workflow
|
h4.ChangeRatePlan
||Action name|ChangeRatePlan|
||Class name|{{com.cdrator.main.subscription.action.ChangeRatePlan}}|
||Available from core version|8.7|
||Description|This action schedules a rateplan change.|
||Return value|{{RatePlanChange}}: Sets up, saves and returns a rate plan change.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{RatePlan}}: newRatePlan
# {{Product}}: newProduct
# {{Date}}: changeDate
# {{ArrayList}}: options
|
h4.CheckIfParentSubscriptionIsInState
||Action name|CheckIfParentSubscriptionIsInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfParentSubscriptionIsInState}}|
||Available from core version|8.7|
||Description|This action checks if a parent subscription is in a given state.|
||Return value|{{boolean}}: Returns true if the parent exists and state matches the given state.|
||Properties|# controlState: The available states.
|
||Parameters|# {{Subscription}}: subscription
|
h4.CheckIfSubscriptionInState
||Action name|CheckIfSubscriptionInState|
||Class name|{{com.cdrator.main.subscription.action.CheckIfSubscriptionInState}}|
||Available from core version|8.7|
||Description|This action checks if a subscription is in given states.|
||Return value|{{boolean}}: Returns YES if the subscription state matches one of the given states.|
||Properties|# possibleState: The possible states separated by ';'
|
||Parameters|# {{Subscription}}: subscription
|
h4.CreateSubscriptionTerminationRequest
||Action name|CreateSubscriptionTerminationRequest|
||Class name|{{com.cdrator.main.subscription.action.CreateSubscriptionTerminationRequest}}|
||Available from core version|8.7|
||Description|This action assembles subscription termination details in a termination request.|
||Return value|{{SubscriptionTerminationRequest}}: The constructed termination request object.|
||Properties|# addTerminationFee: If termination fee should be added. Default is false.
# terminationReason: Set the terminate reason text.
# terminationReasonID: Set the terminate reason id.
|
||Parameters|# {{String}}: comment
# {{Date}}: expectedTerminationDate
# {{Date}}: terminationOrderDate
# {{Date}}: endBillingDate
# {{Date}}: chargeUntilDate
# {{boolean}}: canContactCustomer
|
h4.DeepSave
||Action name|DeepSave|
||Class name|{{com.cdrator.main.subscription.action.DeepSave}}|
||Available from core version|8.7|
||Description|This action deep-saves a subscription in Rator.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetActiveBillingGroupOfSubscription
||Action name|GetActiveBillingGroupOfSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetActiveBillingGroupOfSubscription}}|
||Available from core version|8.7|
||Description|Retrieves the active billing group of the subscription|
||Return value|{{BillingGroup}}: The active billing group of the subscription|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllActiveWorkflowsForSubscription
||Action name|GetAllActiveWorkflowsForSubscription|
||Class name|{{com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscription}}|
||Available from core version|8.7|
||Description|This action returns all active workflows for a subscription.|
||Return value|{{ArrayList}}: An arrayList of workflows.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetAllChildSubscriptions
||Action name|GetAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.GetAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action returns all child subscriptions of a given subscription.|
||Return value|{{List}}: A list of child subscriptions.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Broker}}: broker
|
h4.IsSubscriptionActive
||Action name|IsSubscriptionActive|
||Class name|{{com.cdrator.main.subscription.action.IsSubscriptionActive}}|
||Available from core version|8.7|
||Description|Checks if the subscription is active|
||Return value|{{boolean}}: Returns true if the subscription is active|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptions
||Action name|ReactivateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateAllChildSubscriptionsInList
||Action name|ReactivateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.ReactivateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action reactivates all child subscriptions.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{List}}: subscriptions
|
h4.ReactivateSubscription
||Action name|ReactivateSubscription|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscription}}|
||Available from core version|8.7|
||Description|This action reactivates a subscription by setting the end date to null and the status to active.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.ReactivateSubscriptionCore
||Action name|ReactivateSubscriptionCore|
||Class name|{{com.cdrator.main.subscription.action.ReactivateSubscriptionCore}}|
||Available from core version|8.7|
||Description|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|
||Return value|{{SubscriptionTermination}}: The Subscription Termination connected to the termination|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetAlertGroup
||Action name|SetAlertGroup|
||Class name|{{com.cdrator.main.subscription.action.SetAlertGroup}}|
||Available from core version|8.7|
||Description|An action to set the alert group on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{AlertGroup}}: alertGroup
|
h4.SetOwner
||Action name|SetOwner|
||Class name|{{com.cdrator.main.subscription.action.SetOwner}}|
||Available from core version|8.7|
||Description|This action sets the owner of a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Users}}: owner
|
h4.SetSubscriptionEndDate
||Action name|SetSubscriptionEndDate|
||Class name|{{com.cdrator.main.subscription.action.SetSubscriptionEndDate}}|
||Available from core version|8.7|
||Description|This action sets the subscription end date and saves the subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: endDate
|
h4.SubscriptionHasServiceCode
||Action name|SubscriptionHasServiceCode|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionHasServiceCode}}|
||Available from core version|8.7|
||Description|Determines whether or not the transfer of a subscription to another account is approved.|
||Return value|{{Boolean}}: Boolean result indicating whether or not this subscription transfer is approved.|
||Properties|# serviceCode: The service code to check for.
|
||Parameters|# {{Subscription}}: subscription
|
h4.SubscriptionReader
||Action name|SubscriptionReader|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a Subscription based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SubscriptionSalesDetails
||Action name|SubscriptionSalesDetails|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionSalesDetails}}|
||Available from core version|8.7|
||Description|This action sets a sales rep and a sales store on a subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: salesRep
# {{String}}: salesStore
|
h4.SubscriptionTransferTo
||Action name|SubscriptionTransferTo|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferTo}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
|
h4.SubscriptionTransferToWithParent
||Action name|SubscriptionTransferToWithParent|
||Class name|{{com.cdrator.main.subscription.action.SubscriptionTransferToWithParent}}|
||Available from core version|8.7|
||Description|This action calls the function transferTo with the provided parameters.|
||Return value|{{boolean}}: Boolean result indicating success or failure.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Account}}: newAccount
# {{BillingGroup}}: newBillingGroup
# {{Subscription}}: newParentSubscription
|
h4.TerminateAllChildSubscriptions
||Action name|TerminateAllChildSubscriptions|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptions}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.TerminateAllChildSubscriptionsInList
||Action name|TerminateAllChildSubscriptionsInList|
||Class name|{{com.cdrator.main.subscription.action.TerminateAllChildSubscriptionsInList}}|
||Available from core version|8.7|
||Description|This action terminates child subscriptions with same details as the parent subscription.|
||Return value|{{void}}: No return value.|
||Properties|# consolidateFinalFees: Set consolidate final fees. Default is false.
# disregardBindingPeriod: Set disregard binding period. Default is false.
# endBillingDate: Set end billing date. Default is null.
# finalizeFees: Set finalize fees. Default is false.
|
||Parameters|# {{List}}: subscriptions
# {{Subscription}}: parentSubscription
|
h4.TerminateSubscription
||Action name|TerminateSubscription|
||Class name|{{com.cdrator.main.subscription.action.TerminateSubscription}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{void}}: No return value.|
||Properties|# terminateChildSubscriptions: Terminate the child subscriptions (if any) with same termination details as the parent subscription.
|
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionTerminationRequest}}: subscriptionTerminationRequest
|
h3.Main - Subscription - Lockin
h4.CreateNewSubscriptionLockin
||Action name|CreateNewSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.CreateNewSubscriptionLockin}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{SubscriptionLockin}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{SubscriptionLockinType}}: subscriptionLockinType
|
h4.GetAllSubscriptionLockins
||Action name|GetAllSubscriptionLockins|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetAllSubscriptionLockins}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-ins for a given subscription.|
||Return value|{{ArrayList}}: Returns the subscription lock-in created.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.GetSubscriptionLockinTypes
||Action name|GetSubscriptionLockinTypes|
||Class name|{{com.cdrator.main.subscription.lockin.action.GetSubscriptionLockinTypes}}|
||Available from core version|8.7|
||Description|This action retrieves all subscription lock-in types.|
||Return value|{{List}}: Returns a list of subscription lock-in types.|
||Properties| |
||Parameters| |
h4.HasSubscriptionLockin
||Action name|HasSubscriptionLockin|
||Class name|{{com.cdrator.main.subscription.lockin.action.HasSubscriptionLockin}}|
||Available from core version|8.7|
||Description|This action checks if a subscription has a lock-in.|
||Return value|{{String}}: Returns either NO or YES.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.SetLockinEndDateForLockinWithLeastEndDate
||Action name|SetLockinEndDateForLockinWithLeastEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetLockinEndDateForLockinWithLeastEndDate}}|
||Available from core version|8.7|
||Description|This action updates lockin_end_date of the subscription_lockin with least lockin_end_date and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h4.SetSubscriptionLockinEndDate
||Action name|SetSubscriptionLockinEndDate|
||Class name|{{com.cdrator.main.subscription.lockin.action.SetSubscriptionLockinEndDate}}|
||Available from core version|8.7|
||Description|This action updates subscription lock-in's end date and saves it. It updates only if a lockin exists.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{Date}}: lockinEndDate
|
h3.Main - Subscriptiontermination
h4.DeactivateSubscriptionTermination
||Action name|DeactivateSubscriptionTermination|
||Class name|{{com.cdrator.main.subscriptiontermination.action.DeactivateSubscriptionTermination}}|
||Available from core version|8.7|
||Description|This action deactivates a subscription termination.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SubscriptionTermination}}: subscriptionTermination
|
h3.Main - User
h4.CheckUsernameAvailability
||Action name|CheckUsernameAvailability|
||Class name|{{com.cdrator.main.user.action.CheckUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given username is available.|
||Return value|{{boolean}}: boolean true if the username is available (no user exists with the usename), else false|
||Properties|# caseSensitive: Is the username case sensitive?
|
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetAddress
||Action name|GetAddress|
||Class name|{{com.cdrator.main.user.action.GetAddress}}|
||Available from core version|8.7|
||Description|Action to create and save a new Address object based on the address information of the user passed as argument.|
||Return value|{{Address}}: Returns the newly created Address object.|
||Properties|# doSetCoFromAddress2: Specify whether or not the Address field CO should be set from user.address2.
|
||Parameters|# {{Users}}: user
|
h4.GetUserAccessLevel
||Action name|GetUserAccessLevel|
||Class name|{{com.cdrator.main.user.action.GetUserAccessLevel}}|
||Available from core version|8.7|
||Description|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.|
||Return 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|
||Properties| |
||Parameters|# {{Users}}: user
|
h4.GetUserByEmailAddress
||Action name|GetUserByEmailAddress|
||Class name|{{com.cdrator.main.user.action.GetUserByEmailAddress}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the email address exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: emailAddress
# {{Brand}}: brand
|
h4.GetUserByPhoneNumber
||Action name|GetUserByPhoneNumber|
||Class name|{{com.cdrator.main.user.action.GetUserByPhoneNumber}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the phone number exists. The value null is returned if none exists.|
||Properties|# cancelationPending: Include subscriptions in cancelation pending status.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.GetUserByUsername
||Action name|GetUserByUsername|
||Class name|{{com.cdrator.main.user.action.GetUserByUsername}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{Users}}: The user object if a user with the username exists. The value null is returned if none exists.|
||Properties| |
||Parameters|# {{String}}: username
# {{Brand}}: brand
|
h4.GetUsersByPersonalIDHash
||Action name|GetUsersByPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.GetUsersByPersonalIDHash}}|
||Available from core version|8.7|
||Description|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 http://jira.cdrator.com/browse/CDRP-5401|
||Return value|{{ArrayList}}: An ArrayList of users matching the given personalID. If none exists, an empty ArrayList is returned.|
||Properties|# 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.
|
||Parameters|# {{String}}: personalIDInput
|
h4.SetNewPassword
||Action name|SetNewPassword|
||Class name|{{com.cdrator.main.user.action.SetNewPassword}}|
||Available from core version|8.7|
||Description|This action changes the password of a user. If password is blank, a password will be generated.|
||Return value|{{String}}: The new password.|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h4.SetPersonalIDHash
||Action name|SetPersonalIDHash|
||Class name|{{com.cdrator.main.user.action.SetPersonalIDHash}}|
||Available from core version|8.7|
||Description|This action adds a PersonalID entry for a User. The input parameter must already be hashed/encrypted if so desired.|
||Return value|{{void}}: No return value.|
||Properties|# endDateLastPeriod: To set expiry date on personal id.
# personalIDType: The personal ID type
|
||Parameters|# {{Users}}: user
# {{String}}: hashedPersonalID
|
h4.SetUserAsAccountOwner
||Action name|SetUserAsAccountOwner|
||Class name|{{com.cdrator.main.user.action.SetUserAsAccountOwner}}|
||Available from core version|8.7|
||Description|This action sets the user as account owner. Both user and account is saved.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Users}}: user
# {{Account}}: account
|
h4.UserReader
||Action name|UserReader|
||Class name|{{com.cdrator.main.user.action.UserReader}}|
||Available from core version|8.7|
||Description|Retrieves a User based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Main - User - Login
h4.LoginUserWithAttemptsCount
||Action name|LoginUserWithAttemptsCount|
||Class name|{{com.cdrator.main.user.login.action.LoginUserWithAttemptsCount}}|
||Available from core version|8.7|
||Description|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)|
||Return value|{{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|
||Properties| |
||Parameters|# {{Users}}: user
# {{String}}: password
|
h3.Misc
h4.CreateLongDescriptionElementList
||Action name|CreateLongDescriptionElementList|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElementList}}|
||Available from core version|8.7|
||Description|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()'|
||Return value|{{List}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs. It must be a regular expression. Example : ',|
|
| ' will split at , and newline
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
# {{List}}: addToExistingList
|
h4.CreateLongDescriptionElements
||Action name|CreateLongDescriptionElements|
||Class name|{{com.cdrator.misc.action.CreateLongDescriptionElements}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{ArrayList}}: List of LongDescriptionElements|
||Properties|# delimiter: Delimiter used for splitting the mail template text into key/value pairs.
|
||Parameters|# {{String}}: template
# {{WfContext}}: context
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FileObjectReader
||Action name|FileObjectReader|
||Class name|{{com.cdrator.misc.action.FileObjectReader}}|
||Available from core version|8.7|
||Description|Retrieves a File Object based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.MailTemplateReader
||Action name|MailTemplateReader|
||Class name|{{com.cdrator.misc.action.MailTemplateReader}}|
||Available from core version|8.7|
||Description|Retrieves a Mail Template based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Misc - Barcodes
h4.GenerateQRCodeImage
||Action name|GenerateQRCodeImage|
||Class name|{{com.cdrator.misc.barcodes.action.GenerateQRCodeImage}}|
||Available from core version|8.7|
||Description|This action retrieves an Image of a QR code of the specified content having the specified size |
||Return value|{{Image}}: Returns the string value of the parameter requested. Or an empty string, if none exists.|
||Properties| |
||Parameters|# {{int}}: width
# {{int}}: height
# {{String}}: content
|
h3.Np
h4.LookupActiveNpFlow
||Action name|LookupActiveNpFlow|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlow}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow of a given phone number and (optionally) brand (via the subscription).|
||Return value|{{NpFlow}}: The NP Flow matching the phone number and the brand.|
||Properties|# ignoreBrand: Ignore the brand connected to the NP Flow.
|
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.LookupActiveNpFlowBySubscription
||Action name|LookupActiveNpFlowBySubscription|
||Class name|{{com.cdrator.np.action.LookupActiveNpFlowBySubscription}}|
||Available from core version|8.7|
||Description|Looks for an active NP Flow for a given subscription.|
||Return value|{{NpFlow}}: The active NP Flow from the subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
|
h4.NpFlowReader
||Action name|NpFlowReader|
||Class name|{{com.cdrator.np.action.NpFlowReader}}|
||Available from core version|8.7|
||Description|Retrieves an NP flow based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SaveNpFlow
||Action name|SaveNpFlow|
||Class name|{{com.cdrator.np.action.SaveNpFlow}}|
||Available from core version|8.7|
||Description|Sets some initial values on np flow.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{NpFlow}}: npFlow
|
h4.SetRejectCodeOnExportFlow
||Action name|SetRejectCodeOnExportFlow|
||Class name|{{com.cdrator.np.action.SetRejectCodeOnExportFlow}}|
||Available from core version|8.7|
||Description|Set Reject Code and Comment On an Np Export Flow object.|
||Return value|{{void}}: No return value.|
||Properties|# comment: Used for adding a static comment.
# rejectCode: Used for adding reject code.
|
||Parameters|# {{NpExportFlow}}: npFlow
# {{String}}: dynamicComment
|
h4.TeleOperatorReader
||Action name|TeleOperatorReader|
||Class name|{{com.cdrator.np.action.TeleOperatorReader}}|
||Available from core version|8.7|
||Description|Retrievse a tele operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Np - Range
h4.CheckOverlappingRange
||Action name|CheckOverlappingRange|
||Class name|{{com.cdrator.np.range.action.CheckOverlappingRange}}|
||Available from core version|8.7|
||Description|Check if the ranges are overlapping|
||Return value|{{boolean}}: A boolean indicating whether the two ranges overlap each other, fully or partially|
||Properties| |
||Parameters|# {{String}}: newRange
# {{String}}: existingRange
|
h3.Number
h4.AnumberReader
||Action name|AnumberReader|
||Class name|{{com.cdrator.number.action.AnumberReader}}|
||Available from core version|8.7|
||Description|Retrieves an A-number based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.AssignAnumberToService
||Action name|AssignAnumberToService|
||Class name|{{com.cdrator.number.action.AssignAnumberToService}}|
||Available from core version|8.7|
||Description|Sets Anumber on Service (Only relevant for Service types with phone numbers.)|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Service}}: service
|
h4.GetANumbersForNumberSearchExact
||Action name|GetANumbersForNumberSearchExact|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchExact}}|
||Available from core version|8.7|
||Description|This action will return the list of anumbers that are exact match of the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchLastDigits
||Action name|GetANumbersForNumberSearchLastDigits|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchLastDigits}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers ending with the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchPattern
||Action name|GetANumbersForNumberSearchPattern|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchPattern}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random anumbers that contain the pattern.|
||Return value|{{ArrayList}}: List of anumbers.|
||Properties| |
||Parameters|# {{Anumber_Group}}: group
# {{String}}: searchPattern
# {{int}}: maxCount
|
h4.GetANumbersForNumberSearchRandom
||Action name|GetANumbersForNumberSearchRandom|
||Class name|{{com.cdrator.number.action.GetANumbersForNumberSearchRandom}}|
||Available from core version|8.7|
||Description|This action will retrieve the list of random phone numbers according to the group_id.|
||Return value|{{ArrayList}}: List of phone numbers.|
||Properties|# batchLimit: Batch limit to fetch anumbers.
|
||Parameters|# {{Anumber_Group}}: group
# {{int}}: maxRows
|
h4.IsAnumberFree
||Action name|IsAnumberFree|
||Class name|{{com.cdrator.number.action.IsAnumberFree}}|
||Available from core version|8.7|
||Description|Given a phone number, checks if the related anumber is free.|
||Return value|{{boolean}}: True, if the anumber for the phone number is free, else False|
||Properties| |
||Parameters|# {{String}}: phoneNumber
# {{Brand}}: brand
|
h4.ReReserveAnumber
||Action name|ReReserveAnumber|
||Class name|{{com.cdrator.number.action.ReReserveAnumber}}|
||Available from core version|8.7|
||Description|Re-reserves an already reserved anumber, if the number is not in use and already reserved with the given id.|
||Return value|{{boolean}}: Returns: boolean true if the number could be re-reserved|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{String}}: reservationId
# {{int}}: reserveTime
|
h4.SetAnumberReservToDate
||Action name|SetAnumberReservToDate|
||Class name|{{com.cdrator.number.action.SetAnumberReservToDate}}|
||Available from core version|8.7|
||Description|Sets the reservToDate on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Date}}: reservToDate
|
h4.SetAnumberStatus
||Action name|SetAnumberStatus|
||Class name|{{com.cdrator.number.action.SetAnumberStatus}}|
||Available from core version|8.7|
||Description|Sets status on Anumber.|
||Return value|{{void}}: No Return Value|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{StatusAnumber}}: status
|
h4.ValidateAnumberReservation
||Action name|ValidateAnumberReservation|
||Class name|{{com.cdrator.number.action.ValidateAnumberReservation}}|
||Available from core version|8.7|
||Description|This action validates that an a-number matches a reservation id, that the a-number has status not used and that the reservation has not expired.|
||Return value|{{boolean}}: boolean true if reservation ID is still valid for the A-number, false otherwise.|
||Properties| |
||Parameters|# {{String}}: anumber
# {{String}}: reservationId
|
h3.Persistence
h4.CheckIfPersisted
||Action name|CheckIfPersisted|
||Class name|{{com.cdrator.persistence.action.CheckIfPersisted}}|
||Available from core version|8.7|
||Description|Check if an object is persisted|
||Return value|{{boolean}}: A boolean indicating whether the object is persisted or not.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Product
h4.ChangeAnumberGroup
||Action name|ChangeAnumberGroup|
||Class name|{{com.cdrator.product.action.ChangeAnumberGroup}}|
||Available from core version|8.7|
||Description|Sets the group on an A-number and saves it.|
||Return value|{{Anumber}}: Returns the updated A-number.|
||Properties| |
||Parameters|# {{Anumber}}: anumber
# {{Anumber_Group}}: group
|
h4.CheckProductServiceClassCode
||Action name|CheckProductServiceClassCode|
||Class name|{{com.cdrator.product.action.CheckProductServiceClassCode}}|
||Available from core version|8.7|
||Description|This action checks the products service class code.|
||Return value|{{boolean}}: Returns true if the product matches the service class configured.|
||Properties|# serviceClassCode: The service class code to check for.
|
||Parameters|# {{Product}}: product
|
h4.CreateCdmaPhoneForMeid
||Action name|CreateCdmaPhoneForMeid|
||Class name|{{com.cdrator.product.action.CreateCdmaPhoneForMeid}}|
||Available from core version|8.7|
||Description|This action creates a CdmaPhone based on the supplied MEID.|
||Return value|{{CdmaPhone}}: The cdmaPhone created is returned.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: meid
|
h4.FilterProductConfigsByShop
||Action name|FilterProductConfigsByShop|
||Class name|{{com.cdrator.product.action.FilterProductConfigsByShop}}|
||Available from core version|8.7|
||Description|This action filters an existing list of product configurations so only the ones set up for the shop is returned.|
||Return value|{{List}}: A list of product configs defined for the shop.|
||Properties| |
||Parameters|# {{List}}: productConfigs
# {{Shop}}: shop
|
h4.MakeSubscription
||Action name|MakeSubscription|
||Class name|{{com.cdrator.product.action.MakeSubscription}}|
||Available from core version|8.7|
||Description|Creates a new subscription, and a service, for a given product on a given account, billing group and user.|
||Return value|{{Subscription}}: Returns the subscription|
||Properties| |
||Parameters|# {{Account}}: account
# {{BillingGroup}}: bg
# {{ProductConfig}}: pc
# {{Users}}: user
|
h4.ProductConfigReader
||Action name|ProductConfigReader|
||Class name|{{com.cdrator.product.action.ProductConfigReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Config based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProductReader
||Action name|ProductReader|
||Class name|{{com.cdrator.product.action.ProductReader}}|
||Available from core version|8.7|
||Description|Retrieves a Product Definition based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.RemoveSharedServiceMemberEndDate
||Action name|RemoveSharedServiceMemberEndDate|
||Class name|{{com.cdrator.product.action.RemoveSharedServiceMemberEndDate}}|
||Available from core version|8.7|
||Description|This action removes the end date of a sharedServiceMember.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{SharedServiceMember}}: sharedServiceMember
|
h4.ReserveCdmaPhoneForService
||Action name|ReserveCdmaPhoneForService|
||Class name|{{com.cdrator.product.action.ReserveCdmaPhoneForService}}|
||Available from core version|8.7|
||Description|This action reserves a CdmaPhone for a service.|
||Return value|{{CdmaPhone}}: The CdmaPhone is returned.|
||Properties| |
||Parameters|# {{CdmaPhone}}: cdmaPhone
# {{Service}}: service
|
h3.Product - Option
h4.CompareSubscribedProductOptionParameter
||Action name|CompareSubscribedProductOptionParameter|
||Class name|{{com.cdrator.product.option.action.CompareSubscribedProductOptionParameter}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for.
# parameterKey: The parameter key that we are searching for.
|
||Parameters|# {{Service}}: service
# {{String}}: compareValue
|
h4.ExistsActiveCampaignForEqualOrHigherPackage
||Action name|ExistsActiveCampaignForEqualOrHigherPackage|
||Class name|{{com.cdrator.product.option.action.ExistsActiveCampaignForEqualOrHigherPackage}}|
||Available from core version|8.7|
||Description|Checks if there is campaign for equal or higher package option|
||Return value|{{boolean}}: If there is an active subscriptionCampaign associated to a greater or equal package option returns true|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Subscription}}: subscription
|
h4.GetLowestSubscribedOption
||Action name|GetLowestSubscribedOption|
||Class name|{{com.cdrator.product.option.action.GetLowestSubscribedOption}}|
||Available from core version|8.7|
||Description|Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Return value|{{ProductOption}}: Returns the option that the service is subscriped to. If none is found, the action will look through the suboptions.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
|
h4.GetOptionMetaData
||Action name|GetOptionMetaData|
||Class name|{{com.cdrator.product.option.action.GetOptionMetaData}}|
||Available from core version|8.7|
||Description|This action returns the meta data on an option based on the Option and the Metadata name.|
||Return value|{{ProductOptionMetaData}}: The ProductOptionMetaData for the option and Metadata name. If not found, null is returned.|
||Properties| |
||Parameters|# {{Option}}: option
# {{String}}: metaDataName
|
h4.GetOptionPriceElementsForProductRatePlanAndCategory
||Action name|GetOptionPriceElementsForProductRatePlanAndCategory|
||Class name|{{com.cdrator.product.option.action.GetOptionPriceElementsForProductRatePlanAndCategory}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan, product and category.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time. When category is set cache is always enabled.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
# {{String}}: category
|
h4.GetOptionsForProductAndRatePlan
||Action name|GetOptionsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Product Option available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: An list of product options.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetOptionsPrice
||Action name|GetOptionsPrice|
||Class name|{{com.cdrator.product.option.action.GetOptionsPrice}}|
||Available from core version|8.7|
||Description|Returns a map of product option id and the related price for the given subscription and product options list.|
||Return value|{{Hashtable}}: Returns a map of product option id and the related price.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{List}}: optionsList
|
h4.GetOptionsPricesElementsForProductAndRatePlan
||Action name|GetOptionsPricesElementsForProductAndRatePlan|
||Class name|{{com.cdrator.product.option.action.GetOptionsPricesElementsForProductAndRatePlan}}|
||Available from core version|8.7|
||Description|Returns all the Option Price Elements available at sign-up for a given rate plan and price plan.|
||Return value|{{List}}: A list of option price elements.|
||Properties|# ignoreCache: Set to true if the cache should be ignored and option loaded every time.
# signUpOnly: Only get the sign-up options.
|
||Parameters|# {{RatePlan}}: ratePlan
# {{Product}}: product
|
h4.GetProductOptionsFromService
||Action name|GetProductOptionsFromService|
||Class name|{{com.cdrator.product.option.action.GetProductOptionsFromService}}|
||Available from core version|8.7|
||Description|Returns all the product options subscribed to be the given service.|
||Return value|{{ArrayList}}: An array list of product options.|
||Properties|# onlyActive: If this is set, only serviceOptions that are active will be used to get the productOptions.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOption
||Action name|GetServiceOption|
||Class name|{{com.cdrator.product.option.action.GetServiceOption}}|
||Available from core version|8.7|
||Description|Action to retrieve a service option based on the option key.|
||Return value|{{ServiceOption}}: The service option.|
||Properties|# optionKey: The key of the option that will be retrieved.
|
||Parameters|# {{Service}}: service
|
h4.GetServiceOptionForParameterWithSpecifiedObjectReference
||Action name|GetServiceOptionForParameterWithSpecifiedObjectReference|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionForParameterWithSpecifiedObjectReference}}|
||Available from core version|8.7|
||Description|Returns a serviceOption for parameter with matching obejct reference.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: optionKey
# {{String}}: parameterKey
# {{String}}: objectReferenceClass
# {{String}}: objectReferenceId
|
h4.GetServiceOptionParameter
||Action name|GetServiceOptionParameter|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionParameter}}|
||Available from core version|8.7|
||Description|Returns a serviceOptionParameter with the specified parameterKey.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: parameterKey
|
h4.GetServiceOptionRecurrentFee
||Action name|GetServiceOptionRecurrentFee|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionRecurrentFee}}|
||Available from core version|8.7|
||Description|Retrieves the recurrent fee of the service option|
||Return value|{{SubscriptionFees}}: Returns the recurrent fee of the service option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetServiceOptionsByCriteria
||Action name|GetServiceOptionsByCriteria|
||Class name|{{com.cdrator.product.option.action.GetServiceOptionsByCriteria}}|
||Available from core version|8.7|
||Description|Returns a list of service option for a service matching the given criteria.|
||Return value|{{List}}: A List of service options matching given criterias.|
||Properties| |
||Parameters|# {{Service}}: service
# {{String}}: criterias
|
h4.GetSiblingServiceOption
||Action name|GetSiblingServiceOption|
||Class name|{{com.cdrator.product.option.action.GetSiblingServiceOption}}|
||Available from core version|8.7|
||Description|Get the sibling service option of a specific service option if that exists|
||Return value|{{ServiceOption}}: Returns the sibling service option of the current service option if that exists. Otherwise returns null|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.GetTotalPriceForOptionChange
||Action name|GetTotalPriceForOptionChange|
||Class name|{{com.cdrator.product.option.action.GetTotalPriceForOptionChange}}|
||Available from core version|8.7|
||Description|Compares the two list and returns the total price of the change|
||Return value|{{Amount}}: The total price as an amount|
||Properties| |
||Parameters|# {{List}}: oldOptions
# {{List}}: newOptions
|
h4.HasSiblingOptionLowerPackageWeight
||Action name|HasSiblingOptionLowerPackageWeight|
||Class name|{{com.cdrator.product.option.action.HasSiblingOptionLowerPackageWeight}}|
||Available from core version|8.7|
||Description|Checks if the sibling option has lower package_weight than the current option|
||Return value|{{boolean}}: Returns true if the sibling option has lower package_weight than the current option|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{ServiceOption}}: siblingServiceOption
|
h4.HasSubscribedProductOption
||Action name|HasSubscribedProductOption|
||Class name|{{com.cdrator.product.option.action.HasSubscribedProductOption}}|
||Available from core version|8.7|
||Description|Checks if a product option with a given code is subscribed or initial.|
||Return value|{{boolean}}: If a given service has a subscribed product option with a given code.|
||Properties|# initialAlso: Also look for initial options?
# optionKey: The option key that we are searching for
|
||Parameters|# {{Service}}: service
|
h4.IsOptionInExclusiveGroup
||Action name|IsOptionInExclusiveGroup|
||Class name|{{com.cdrator.product.option.action.IsOptionInExclusiveGroup}}|
||Available from core version|8.7|
||Description|Checks if option belongs to an exclusive group|
||Return value|{{boolean}}: Returns true if the option belongs to an exclusive option group|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.OptionReader
||Action name|OptionReader|
||Class name|{{com.cdrator.product.option.action.OptionReader}}|
||Available from core version|8.7|
||Description|Retrieves an option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.OptionStatusChangeActionCheck
||Action name|OptionStatusChangeActionCheck|
||Class name|{{com.cdrator.product.option.action.OptionStatusChangeActionCheck}}|
||Available from core version|8.7|
||Description|Compare the action used in option status_change workflow to a predefined action value|
||Return value|{{boolean}}: If the action equals to the predefined action value it returns true. Otherwise it returns false.|
||Properties|# actionValue: The action value that the action should be compared to
|
||Parameters|# {{String}}: action
|
h4.RemoveListOfServiceOptions
||Action name|RemoveListOfServiceOptions|
||Class name|{{com.cdrator.product.option.action.RemoveListOfServiceOptions}}|
||Available from core version|8.7|
||Description|Removes all service options in a list|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
|
h4.RemovePendingTerminationOption
||Action name|RemovePendingTerminationOption|
||Class name|{{com.cdrator.product.option.action.RemovePendingTerminationOption}}|
||Available from core version|8.7|
||Description|Removes a pending termination option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{String}}: action
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.RemoveServiceOption
||Action name|RemoveServiceOption|
||Class name|{{com.cdrator.product.option.action.RemoveServiceOption}}|
||Available from core version|8.7|
||Description|Removes the service option|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetEndDateOnServiceOptionList
||Action name|SetEndDateOnServiceOptionList|
||Class name|{{com.cdrator.product.option.action.SetEndDateOnServiceOptionList}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date from a list of options retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: serviceOptions
# {{Date}}: date
|
h4.SetServiceOptionEndDateRestOfMonth
||Action name|SetServiceOptionEndDateRestOfMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateRestOfMonth}}|
||Available from core version|8.7|
||Description|Sets the end date of the option.|
||Return value|{{ServiceOption}}: Returns the service option.|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionEndDateToSpecificDate
||Action name|SetServiceOptionEndDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service_option's and suboptions' end_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SetServiceOptionEndDateToStartDate
||Action name|SetServiceOptionEndDateToStartDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionEndDateToStartDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' endDate to the service option's startDate|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionParameterValue
||Action name|SetServiceOptionParameterValue|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionParameterValue}}|
||Available from core version|8.7|
||Description|Updates a service option parameter value.|
||Return value|{{ServiceOptionParameter}}: Returns the service option parameter.|
||Properties| |
||Parameters|# {{ServiceOptionParameter}}: serviceOptionParameter
# {{String}}: newValue
|
h4.SetServiceOptionStartDateToNextMonth
||Action name|SetServiceOptionStartDateToNextMonth|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToNextMonth}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the first day of next month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
|
h4.SetServiceOptionStartDateToSpecificDate
||Action name|SetServiceOptionStartDateToSpecificDate|
||Class name|{{com.cdrator.product.option.action.SetServiceOptionStartDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the service option's and its suboptions' startDate to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{ServiceOption}}: serviceOption
# {{Date}}: date
|
h4.SubscribeToProductOption
||Action name|SubscribeToProductOption|
||Class name|{{com.cdrator.product.option.action.SubscribeToProductOption}}|
||Available from core version|8.7|
||Description|Subscribes to a product option for a given service and product option.|
||Return value|{{ServiceOption}}: The service option created by subscribing to the option.|
||Properties|# optionKey: The option key that the service will subscribe to.
|
||Parameters|# {{Service}}: service
|
h4.UnsubscribeOptionsWithCampaigns
||Action name|UnsubscribeOptionsWithCampaigns|
||Class name|{{com.cdrator.product.option.action.UnsubscribeOptionsWithCampaigns}}|
||Available from core version|8.7|
||Description|Unsubscribes to options with campaigns (and only options with a campaign) for a given service.|
||Return value|{{List}}: A list of the unsubscribed service options.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.UnsubscribeToOption
||Action name|UnsubscribeToOption|
||Class name|{{com.cdrator.product.option.action.UnsubscribeToOption}}|
||Available from core version|8.7|
||Description|If there is a dynamic optionkey parameter, it will override the optionkey property unless it is null. If neither option key or dynamic option key is set an Action Parameter Exception is thrown.|
||Return value|{{void}}: No value returned|
||Properties|# makeProvisioningTask: Make provisioning task?
# optionKey: The key of the option that will be unsubscribed
|
||Parameters|# {{Service}}: service
# {{String}}: dynamicOptionKey
|
h4.ValidateOptions
||Action name|ValidateOptions|
||Class name|{{com.cdrator.product.option.action.ValidateOptions}}|
||Available from core version|8.7|
||Description|This action validates that options are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config.|
||Properties| |
||Parameters|# {{List}}: options
# {{ProductConfig}}: productConfig
|
h4.ValidateOptionsRateplan
||Action name|ValidateOptionsRateplan|
||Class name|{{com.cdrator.product.option.action.ValidateOptionsRateplan}}|
||Available from core version|8.7|
||Description|This action validates that the list of options passed as a parameter are available according to product config.|
||Return value|{{boolean}}: Returns true if the options are available for the product config, false otherwise.|
||Properties| |
||Parameters|# {{List}}: options
# {{RatePlan}}: rateplan
|
h3.Product - Service
h4.AssignCdmaPhoneToService
||Action name|AssignCdmaPhoneToService|
||Class name|{{com.cdrator.product.service.action.AssignCdmaPhoneToService}}|
||Available from core version|8.7|
||Description|This action assigns a cdmaPhone to a service.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has been assigned to the service.|
||Properties| |
||Parameters|# {{CdmaService}}: service
# {{CdmaPhone}}: cdmaPhone
|
h4.CanBlockService
||Action name|CanBlockService|
||Class name|{{com.cdrator.product.service.action.CanBlockService}}|
||Available from core version|8.7|
||Description|This action checks if a service can be blocked.|
||Return value|{{boolean}}: A boolean indicating whether the service can be blocked.|
||Properties| |
||Parameters|# {{Service}}: service
|
h4.ReleaseCdmaPhone
||Action name|ReleaseCdmaPhone|
||Class name|{{com.cdrator.product.service.action.ReleaseCdmaPhone}}|
||Available from core version|8.7|
||Description|This action releases the CdmaPhone assigned to the service, if a CdmaPhone exists.|
||Return value|{{CdmaPhone}}: Returns the cdmaPhone that has just been released.|
||Properties| |
||Parameters|# {{CdmaService}}: service
|
h4.ServiceReader
||Action name|ServiceReader|
||Class name|{{com.cdrator.product.service.action.ServiceReader}}|
||Available from core version|8.7|
||Description|Retrieves a service based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Product - Service - Fixed
h4.SetPhoneNumberOnFixedLineService
||Action name|SetPhoneNumberOnFixedLineService|
||Class name|{{com.cdrator.product.service.fixed.action.SetPhoneNumberOnFixedLineService}}|
||Available from core version|8.7|
||Description|This action sets the provided phone number on a fixed line service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h3.Product - Service - Option
h4.GetServiceOptionFromOptionMetaData
||Action name|GetServiceOptionFromOptionMetaData|
||Class name|{{com.cdrator.product.service.option.action.GetServiceOptionFromOptionMetaData}}|
||Available from core version|8.7|
||Description|Search in the list of meta data records linked to the Option, if the service provided is subscribed to a product option key that is in the list then the service option is returned.|
||Return value|{{ServiceOption}}: The first service option found if subscribed to the service and in the meta data option list. Null if service not subscribed to any option in the meta data list.|
||Properties|# isAllowed: Check if the option is allowed or not.
|
||Parameters|# {{Option}}: option
# {{Service}}: service
|
h4.ServiceOptionReader
||Action name|ServiceOptionReader|
||Class name|{{com.cdrator.product.service.option.action.ServiceOptionReader}}|
||Available from core version|8.7|
||Description|Retrieves a service option based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.SwitchServiceOptionsAction
||Action name|SwitchServiceOptionsAction|
||Class name|{{com.cdrator.product.service.option.action.SwitchServiceOptionsAction}}|
||Available from core version|8.7|
||Description|Unsubscribes a current service option and subscribes to a new option.|
||Return value|{{String}}: The id of the newly subscribed service option.|
||Properties|# makeProvisioningTask: If cached options should be completed or not.
|
||Parameters|# {{Subscription}}: subscription
# {{Option}}: optionToUnSubscribe
# {{Option}}: optionToSubscribe
|
h3.Product - Service - Shared
h4.GetAllNonTerminatedSharedServiceMembers
||Action name|GetAllNonTerminatedSharedServiceMembers|
||Class name|{{com.cdrator.product.service.shared.action.GetAllNonTerminatedSharedServiceMembers}}|
||Available from core version|8.7|
||Description|This action returns a list of all non-terminated (active and cancellation pending) members of a shared service.|
||Return value|{{List}}: A list of all non-terminated members of the shared service.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
|
h4.GetNonTerminatedSharedServiceMember
||Action name|GetNonTerminatedSharedServiceMember|
||Class name|{{com.cdrator.product.service.shared.action.GetNonTerminatedSharedServiceMember}}|
||Available from core version|8.7|
||Description|This action returns the direct member to a shared service.|
||Return value|{{SharedServiceMember}}: The SharedServiceMember of the sharedServiceInterface is returned if found.|
||Properties| |
||Parameters|# {{SharedService}}: sharedService
# {{SharedServiceInterface}}: sharedServiceInterface
|
h3.Product - Service - Tele
h4.DisconnectOldSimCards
||Action name|DisconnectOldSimCards|
||Class name|{{com.cdrator.product.service.tele.action.DisconnectOldSimCards}}|
||Available from core version|8.7|
||Description|This action disconnect any old SIMcards related to this TeleService (where TeleService.imsi not like SimCard.imsi ).|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h4.TeleServicePhoneNumber
||Action name|TeleServicePhoneNumber|
||Class name|{{com.cdrator.product.service.tele.action.TeleServicePhoneNumber}}|
||Available from core version|8.7|
||Description|This action sets a phone number on a Tele service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: phoneNumber
|
h4.UnBlockTeleService
||Action name|UnBlockTeleService|
||Class name|{{com.cdrator.product.service.tele.action.UnBlockTeleService}}|
||Available from core version|8.7|
||Description|This unblocks a service.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{TeleService}}: service
|
h3.Product - Voucher
h4.AssignVoucher
||Action name|AssignVoucher|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucher}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{boolean}}: Boolean with the result of the assignment.|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.AssignVoucherToSubscription
||Action name|AssignVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.AssignVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Assign a voucher to a subscription|
||Return value|{{void}}: Void|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.ChargeVoucherToSubscription
||Action name|ChargeVoucherToSubscription|
||Class name|{{com.cdrator.product.voucher.action.ChargeVoucherToSubscription}}|
||Available from core version|8.7|
||Description|Charge a voucher to a subscription|
||Return value|{{boolean}}: A boolean value indicating whether the voucher was charged successfully|
||Properties| |
||Parameters|# {{Voucher}}: voucher
# {{Subscription}}: subscription
|
h4.CreateNewVoucher
||Action name|CreateNewVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateNewVoucher}}|
||Available from core version|8.7|
||Description|To be used when a new voucher needs to be created. The keyword which is generated is an alphanumeric code.The length of this code is specified by the property numberOfCharacters. A voucherBatch needs to be passed to this action.|
||Return value|{{Voucher}}: The voucher which was created.|
||Properties|# numberOfCharacters: null
|
||Parameters|# {{VoucherBatch}}: voucherBatch
|
h4.CreateVoucher
||Action name|CreateVoucher|
||Class name|{{com.cdrator.product.voucher.action.CreateVoucher}}|
||Available from core version|8.7|
||Description|Creates a new voucher with the specified number of alphanumeric characters for the keyword, voucher code, price code and amount.|
||Return value|{{Voucher}}: The created voucher.|
||Properties|# batchVoucherCode: The voucher code.
# currencyCode: The amount currency code.
# numberOfCharacters: The length of the keyword alphanumeric code.
|
||Parameters|# {{Amount}}: amount
# {{String}}: priceCode
|
h4.GetVouchers
||Action name|GetVouchers|
||Class name|{{com.cdrator.product.voucher.action.GetVouchers}}|
||Available from core version|8.7|
||Description|Returns a list of vouchers|
||Return value|{{Collection}}: List of vouchers related to the batchId and the statusId for a given subscription.|
||Properties| |
||Parameters|# {{Subscription}}: subscription
# {{String}}: batchId
# {{String}}: statusId
|
h4.VoucherBatchReader
||Action name|VoucherBatchReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherBatchReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.VoucherReader
||Action name|VoucherReader|
||Class name|{{com.cdrator.product.voucher.action.VoucherReader}}|
||Available from core version|8.7|
||Description|Retrieves a Voucher based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Provisioning
h4.CreateProvisioningTask
||Action name|CreateProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.CreateProvisioningTask}}|
||Available from core version|8.7|
||Description|Create a provisioning task of a specific type (CODE). The status of the new task will be "New". (the workflow instance can be added using "_activity.getWorkflow()")|
||Return value|{{ProvisioningTask}}: Return response code from ProvisioningRequest object.|
||Properties|# priority: Optional priority of the provisioning task. Default is 5
# taskComments: Optional comments to add to the provisioning task
# taskDescription: Optional description to add to the provisioning task
# taskType: The type of task that should be provisioned
|
||Parameters|# {{Service}}: service
# {{WfWorkflow}}: workflow
|
h4.GetProvisioningRequestsByReference
||Action name|GetProvisioningRequestsByReference|
||Class name|{{com.cdrator.provisioning.action.GetProvisioningRequestsByReference}}|
||Available from core version|8.7|
||Description|Retrieves a List of ProvisioningRequest linked to a ProvisioningTask by reference field.|
||Return value|{{List}}: Returns the ProvisioningRequest linked from the task reference.|
||Properties|# linkedFieldOnRequest: Optional to choose the database field from which to retrieve the reference linking the request to the task. Required to be varchar2 field.
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.GetResponseCodeFromProvisioningRequest
||Action name|GetResponseCodeFromProvisioningRequest|
||Class name|{{com.cdrator.provisioning.action.GetResponseCodeFromProvisioningRequest}}|
||Available from core version|8.7|
||Description|Retrieves the Response Code from a ProvisioningRequest.|
||Return value|{{String}}: Return response code from ProvisioningRequest object.|
||Properties|# responseCodeField: Optional to choose the database field from which to retrieve the response code.
|
||Parameters|# {{ProvisioningRequest}}: request
|
h4.NetworkOperatorReader
||Action name|NetworkOperatorReader|
||Class name|{{com.cdrator.provisioning.action.NetworkOperatorReader}}|
||Available from core version|8.7|
||Description|Retrieves a Network Operator based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ProvisioningTaskReader
||Action name|ProvisioningTaskReader|
||Class name|{{com.cdrator.provisioning.action.ProvisioningTaskReader}}|
||Available from core version|8.7|
||Description|Retrieves a Provisioning Task based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.ResetStartDateWithDelayOnProvisioningTask
||Action name|ResetStartDateWithDelayOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.ResetStartDateWithDelayOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Adds the delayInMinutes property to start date on Provisioning Task. If no start date on task, adds delay from current date.|
||Return value|{{void}}: No return values|
||Properties|# delayInMinutes: null
|
||Parameters|# {{ProvisioningTask}}: task
|
h4.SetStatusOnProvisioningTask
||Action name|SetStatusOnProvisioningTask|
||Class name|{{com.cdrator.provisioning.action.SetStatusOnProvisioningTask}}|
||Available from core version|8.7|
||Description|Set Status for Processing on Provisioning Task.|
||Return value|{{void}}: No return values|
||Properties|# statusToSet: The status that the provisioning task will be set to.
|
||Parameters|# {{ProvisioningTask}}: task
|
h3.RecurrentFee
h4.BillSubscriptionFeeListToInvoiceNow
||Action name|BillSubscriptionFeeListToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeeListToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills the supplied subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{List}}: subscriptionFees
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNow
||Action name|BillSubscriptionFeesToInvoiceNow|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNow}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties|# endDateLastPeriod: To set end_date_last_period on subscription fees.
|
||Parameters|# {{Subscription}}: subscription
# {{Invoice}}: invoice
|
h4.BillSubscriptionFeesToInvoiceNowForListOfSubs
||Action name|BillSubscriptionFeesToInvoiceNowForListOfSubs|
||Class name|{{com.cdrator.recurrentFee.action.BillSubscriptionFeesToInvoiceNowForListOfSubs}}|
||Available from core version|8.7|
||Description|This action bills all subscription fees to the supplied invoice for a list of subscriptions.|
||Return value|{{List}}: A list of all the invoice lines produced.|
||Properties| |
||Parameters|# {{List}}: subscriptions
# {{Invoice}}: invoice
|
h4.SetFeeChargeDateToSiblingFeeChargeDate
||Action name|SetFeeChargeDateToSiblingFeeChargeDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeChargeDateToSiblingFeeChargeDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to sibling fee's next_charge_date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{SubscriptionFees}}: siblingFee
|
h4.SetFeeEndDateLastPeriod
||Action name|SetFeeEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodForFeeList
||Action name|SetFeeEndDateLastPeriodForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeEndDateLastPeriodToEndOfMonth
||Action name|SetFeeEndDateLastPeriodToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeEndDateLastPeriodToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's end_date_last_period to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
h4.SetFeeNextChargeDateForFeeList
||Action name|SetFeeNextChargeDateForFeeList|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateForFeeList}}|
||Available from core version|8.7|
||Description|Sets the fees end_date_last_period to the specified date|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{List}}: fees
# {{Date}}: date
|
h4.SetFeeNextChargeDateToEndOfMonth
||Action name|SetFeeNextChargeDateToEndOfMonth|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToEndOfMonth}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to end of month|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.SetFeeNextChargeDateToSpecificDate
||Action name|SetFeeNextChargeDateToSpecificDate|
||Class name|{{com.cdrator.recurrentFee.action.SetFeeNextChargeDateToSpecificDate}}|
||Available from core version|8.7|
||Description|Sets the fee's next_charge_date to a specific date retrieved from the context|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
# {{Date}}: date
|
h4.TerminateFeeFromEndDateLastPeriod
||Action name|TerminateFeeFromEndDateLastPeriod|
||Class name|{{com.cdrator.recurrentFee.action.TerminateFeeFromEndDateLastPeriod}}|
||Available from core version|8.7|
||Description|Terminates the fee from its end_date_last_period|
||Return value|{{void}}: No return values|
||Properties| |
||Parameters|# {{SubscriptionFees}}: fee
|
||Deprecated|This action is deprecated and therefore should not be used.|
h3.Shop
h4.CheckShopUsernameAvailability
||Action name|CheckShopUsernameAvailability|
||Class name|{{com.cdrator.shop.action.CheckShopUsernameAvailability}}|
||Available from core version|8.7|
||Description|This action checks if a given shop user name is available.|
||Return value|{{boolean}}: boolean true if the user name is available (no shop exists with the user name), else false.|
||Properties|# caseSensitive: Is the shop user name case sensitive?
|
||Parameters|# {{String}}: username
|
h4.GetSubscriptionsForSalesStoreEstablishedBetween
||Action name|GetSubscriptionsForSalesStoreEstablishedBetween|
||Class name|{{com.cdrator.shop.action.GetSubscriptionsForSalesStoreEstablishedBetween}}|
||Available from core version|8.7|
||Description|Finds subscriptions with a specific sales store established between two dates|
||Return value|{{ArrayList}}: Subscriptions|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.SetShopParentId
||Action name|SetShopParentId|
||Class name|{{com.cdrator.shop.action.SetShopParentId}}|
||Available from core version|8.7|
||Description|This action sets the parent id of a shop and saves it.|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{Shop}}: shop
# {{Shop}}: parentShop
|
h4.ShopReader
||Action name|ShopReader|
||Class name|{{com.cdrator.shop.action.ShopReader}}|
||Available from core version|8.7|
||Description|Retrieves a shop based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Simcard
h4.ChangeSimStatus
||Action name|ChangeSimStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM card status. If softblocked, barred or stolen is set, the blocked from date is updated. If in use is set, the blocked from date is set null.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status options to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.ChangeSimTypeStatus
||Action name|ChangeSimTypeStatus|
||Class name|{{com.cdrator.simcard.action.ChangeSimTypeStatus}}|
||Available from core version|8.7|
||Description|This action sets the SIM type status.|
||Return value|{{void}}: No return value.|
||Properties|# selectedStatus: Status types to choose from.
|
||Parameters|# {{SimCard}}: simcard
|
h4.FindSimcardsByIccAndPUK
||Action name|FindSimcardsByIccAndPUK|
||Class name|{{com.cdrator.simcard.action.FindSimcardsByIccAndPUK}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM cards from the database based on ICC and PUK.|
||Return value|{{ArrayList}}: The SIM cards with the ICC substring or the complete PUK. If no SIM cards are found, null is returned.|
||Properties|# onlyAvailableSIM: Only return available simcards?
|
||Parameters|# {{String}}: icc
# {{String}}: puk
|
h4.GetAvailableRandomSimCard
||Action name|GetAvailableRandomSimCard|
||Class name|{{com.cdrator.simcard.action.GetAvailableRandomSimCard}}|
||Available from core version|8.7|
||Description|Fetches a random available SIM card. Available means that the status is 0 (open and active) and it's not reserved. The SIM card type can be specified as a parameter.|
||Return value|{{SimCard}}: The available SIM card if found.|
||Properties| |
||Parameters|# {{String}}: simTypeId
|
h4.GetSimcardByIcc
||Action name|GetSimcardByIcc|
||Class name|{{com.cdrator.simcard.action.GetSimcardByIcc}}|
||Available from core version|8.7|
||Description|Action for retrieving a SIM card from the database by ICC.|
||Return value|{{SimCard}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{String}}: icc
|
h4.ReserveSimcard
||Action name|ReserveSimcard|
||Class name|{{com.cdrator.simcard.action.ReserveSimcard}}|
||Available from core version|8.7|
||Description|Action for reserving a SIM card to a service.|
||Return value|{{boolean}}: The SIM card with the specified ICC. If no SIM card is found, null is returned.|
||Properties| |
||Parameters|# {{SimCard}}: simcard
# {{Service}}: service
|
h4.SimCardReader
||Action name|SimCardReader|
||Class name|{{com.cdrator.simcard.action.SimCardReader}}|
||Available from core version|8.7|
||Description|Retrieves a SIM card based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Util
h4.AddHookpointResult
||Action name|AddHookpointResult|
||Class name|{{com.cdrator.util.action.AddHookpointResult}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result.|
||Return value|{{void}}: No return value|
||Properties|# clearHookpointResult: Clear hookpoint result except for keys starting with LAST_OUTCOME_
# key1: Key 1
# key2: Key 2
# key3: Key 3
|
||Parameters|# {{HookpointResult}}: result
# {{String}}: value1
# {{String}}: value2
# {{String}}: value3
|
h4.CreateCdrParameter
||Action name|CreateCdrParameter|
||Class name|{{com.cdrator.util.action.CreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action creates a new cdrparameter based on the given code. The description, value and object, will be set based on the given information.|
||Return value|{{CdrParameter}}: The created cdrparameter.|
||Properties|# code: The code to create the cdrparameter from.
# description: The description of the cdrparameter.
|
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.FormatString
||Action name|FormatString|
||Class name|{{com.cdrator.util.action.FormatString}}|
||Available from core version|8.7|
||Description|Format a string. Uses standard String.format|
||Return value|{{String}}: The formatted string.|
||Properties|# format: The format string.
|
||Parameters|# {{Object}}: param1
# {{Object}}: param2
# {{Object}}: param3
# {{Object}}: param4
# {{Object}}: param5
|
h4.GeneratePDFAction
||Action name|GeneratePDFAction|
||Class name|{{com.cdrator.util.action.GeneratePDFAction}}|
||Available from core version|8.7|
||Description|Generates a PDF specification based on the specified type.|
||Return value|{{String}}: The generated PDF string - Base64 encoded.|
||Properties|# PDFType: Specify the type of PDF generation.
|
||Parameters|# {{PersistentObject}}: object
# {{Date}}: startDate
# {{Date}}: endDate
|
h4.GenerateXMLFromPO
||Action name|GenerateXMLFromPO|
||Class name|{{com.cdrator.util.action.GenerateXMLFromPO}}|
||Available from core version|8.7|
||Description|This action generates a XML document based on the given XMLDocumentDefinition and Persistant object. The resulting XML is placed in the provided dirName with the provided name+timestamp|
||Return value|{{boolean}}: Returns a persistentObject from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{Broker}}: broker
# {{String}}: documentDefKey
# {{String}}: dirName
# {{String}}: fileName
# {{PersistentObject}}: persistantObject
# {{String}}: persistentObjectKey
|
h4.GetCdrParameter
||Action name|GetCdrParameter|
||Class name|{{com.cdrator.util.action.GetCdrParameter}}|
||Available from core version|8.7|
||Description|This action adds a new cdrparameter based on the given objects and text string. Throws NullPointerException if both the cdrParameter and the parameter definition does not exist in the database.|
||Return value|{{CdrParameter}}: Returns cdr parameter based on the given objecs.|
||Properties| |
||Parameters|# {{CdrParameterIf}}: object
# {{String}}: varname
# {{CdrParameterIf}}: alternativeObject
|
h4.GetHashedValueFromString
||Action name|GetHashedValueFromString|
||Class name|{{com.cdrator.util.action.GetHashedValueFromString}}|
||Available from core version|8.7|
||Description|This action returns a hashed string based on the input given and the chosen hash type.|
||Return value|{{String}}: Returns a string hash of the suppplied input.|
||Properties|# selectedHashAlgorithm: Chosen hashing algorithm. Only SHA-1, SHA-256, SHA-384, SHA-512, MD2, MD5 are supported. If none is specified or no match, then SHA-1 is assumed.
|
||Parameters|# {{String}}: input
|
h4.GetInstanceFromDB
||Action name|GetInstanceFromDB|
||Class name|{{com.cdrator.util.action.GetInstanceFromDB}}|
||Available from core version|8.7|
||Description|This action retrieves a persistentObject from the database.|
||Return value|{{PersistentObject}}: Returns a persistent object from the database based on the className and the clause.|
||Properties| |
||Parameters|# {{String}}: className
# {{Broker}}: broker
# {{String}}: clause
|
h4.GetParameterTreeValues
||Action name|GetParameterTreeValues|
||Class name|{{com.cdrator.util.action.GetParameterTreeValues}}|
||Available from core version|8.7|
||Description|This action retrieves all parameter values for a given node path and brand.|
||Return value|{{List}}: Returns the list of parameter values for the given node path.|
||Properties|# nodePath: Path to parameter tree node. Example: ALERTS.ALERT_GROUPS.
|
||Parameters|# {{Brand}}: brand
|
h4.GetStatusTypesFor
||Action name|GetStatusTypesFor|
||Class name|{{com.cdrator.util.action.GetStatusTypesFor}}|
||Available from core version|8.7|
||Description|This action retrieves the statuses for a given status type code.|
||Return value|{{List}}: Returns statuses for the given code.|
||Properties| |
||Parameters|# {{String}}: code
|
h4.IsStringInDelimitedString
||Action name|IsStringInDelimitedString|
||Class name|{{com.cdrator.util.action.IsStringInDelimitedString}}|
||Available from core version|8.7|
||Description|This action returns true if a given string val is in the comma separated string values. Remark: Both strings are trimmed before comparison to avoid unintended results.|
||Return value|{{boolean}}: Returns true if the given val is in the values string, false in all other cases.|
||Properties| |
||Parameters|# {{String}}: val
# {{String}}: values
|
h4.SimpleReturn
||Action name|SimpleReturn|
||Class name|{{com.cdrator.util.action.SimpleReturn}}|
||Available from core version|8.7|
||Description|Returns the argument object|
||Return value|{{Object}}: The argument object|
||Properties| |
||Parameters|# {{Object}}: executionArg
|
h4.Throttle
||Action name|Throttle|
||Class name|{{com.cdrator.util.action.Throttle}}|
||Available from core version|8.7|
||Description|Throttles a process
Requires 2 parameters:
WORKFLOW.THROTTLING.<name>.CAP number of times the throttled process may be performed in each interval
WORKFLOW.THROTTLING.<name>.INTERVAL number of seconds each interval lasts|
||Return value|{{boolean}}: Returns true if the process can continue.|
||Properties|# name: Used to generate the keys for the properties and parameters.
|
||Parameters| |
h4.ThrowNewUserMessageSysExceptionAction
||Action name|ThrowNewUserMessageSysExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewUserMessageSysExceptionAction}}|
||Available from core version|8.7|
||Description|Will throw an exception with a user defined message. Use this action to manually throw an exception to force a rollback while also specifying an error message to the end user, e.g. in the SOAP response instead of displaying BUSINESS_ERROR.|
||Return value|{{void}}: No return value.|
||Properties|# userMessage: The user message to pass along the exception. Specify labels, max 5 labels, in the message using <LABEL(X)>, e.g. This is <LABEL1> example label one.
|
||Parameters|# {{String}}: label1
# {{String}}: label2
# {{String}}: label3
# {{String}}: label4
# {{String}}: label5
|
h4.ThrowNewWorkflowExceptionAction
||Action name|ThrowNewWorkflowExceptionAction|
||Class name|{{com.cdrator.util.action.ThrowNewWorkflowExceptionAction}}|
||Available from core version|8.7|
||Description|Finalizes logistics file.|
||Return value|{{void}}: No return value.|
||Properties|# recordNo: Error message to log throw with exception.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|
h4.UpdatePersistentObject
||Action name|UpdatePersistentObject|
||Class name|{{com.cdrator.util.action.UpdatePersistentObject}}|
||Available from core version|8.7|
||Description|This action updates a persistent object by calling a method on it with one or more parameters. The persistent object is saved afterwards. Example: PersistentObject=USERS, method="setAccount", params=ACCOUNT result: USERS.setAccount(ACCOUNT); USERS.save();|
||Return value|{{void}}: No return value.|
||Properties| |
||Parameters|# {{PersistentObject}}: persistentObject
# {{String}}: method
# {{Object[]}}: params
|
h3.Util - Date
h4.DateChanger
||Action name|DateChanger|
||Class name|{{com.cdrator.util.date.action.DateChanger}}|
||Available from core version|8.7|
||Description|Changes values on a given date, al values are given as numbers where e.g. Month=1 sets the date to January.|
||Return value|{{Date}}: The modified date.|
||Properties| |
||Parameters|# {{Date}}: date
# {{String}}: milliSecond
# {{String}}: second
# {{String}}: minute
# {{String}}: hour
# {{String}}: day
# {{String}}: month
# {{String}}: year
|
h4.DateComparator
||Action name|DateComparator|
||Class name|{{com.cdrator.util.date.action.DateComparator}}|
||Available from core version|8.7|
||Description|Compares two given dates for one of these actions: AFTER, BEFORE, or EQUALS. Date1 is compared against date2 with the action (e.g. date1 after date2).|
||Return value|{{boolean}}: A boolean representing the outcome of the specified operation.|
||Properties|# action: Specify the operation between dates.
|
||Parameters|# {{Date}}: date1
# {{Date}}: date2
|
h4.DateStaticAdder
||Action name|DateStaticAdder|
||Class name|{{com.cdrator.util.date.action.DateStaticAdder}}|
||Available from core version|8.7|
||Description|Adds day, hours, minutes, and second to the given date|
||Return value|{{Date}}: The modified date.|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters|# {{Date}}: date
|
h4.FormatDate
||Action name|FormatDate|
||Class name|{{com.cdrator.util.date.action.FormatDate}}|
||Available from core version|8.7|
||Description|Turns a given date into a string using a specified format.|
||Return value|{{String}}: The formatted date.|
||Properties|# format: The format to format the date by.
|
||Parameters|# {{Date}}: date
|
h4.GetDate
||Action name|GetDate|
||Class name|{{com.cdrator.util.date.action.GetDate}}|
||Available from core version|8.7|
||Description|An action to retrieve the current or a future date|
||Return value|{{Date}}: A date representing the sysdate + eventual added minutes, hours, days or months|
||Properties|# addDays: The number of days that should be added to current date
# addHours: The number of hours that should be added to current date
# addMinutes: The number of minutes that should be added to current date
# addMonths: The number of months that should be added to current date
|
||Parameters| |
h4.GetEndOfMonthDate
||Action name|GetEndOfMonthDate|
||Class name|{{com.cdrator.util.date.action.GetEndOfMonthDate}}|
||Available from core version|8.7|
||Description|This action returns a calendar representing the last day of the current month.|
||Return value|{{Calendar}}: A calendar representing the last day of the current month.|
||Properties| |
||Parameters| |
h4.GetFirstDayOfMonth
||Action name|GetFirstDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetFirstDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the first day of the month of the supplied date|
||Return value|{{Date}}: A date representing the first day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetFormattedCalendarField
||Action name|GetFormattedCalendarField|
||Class name|{{com.cdrator.util.date.action.GetFormattedCalendarField}}|
||Available from core version|8.7|
||Description|Returns the string representation of the calendar field value in the given style and locale. Parameters requrired: dateField - the calendar field for which the string representation is returned (Calendar.MONTH ...); date - The source date; locale - The locale used for formatting. (no ...); dateStyle - The locale used for formatting.(Calendar.SHORT, Calendar.LONG).|
||Return value|{{String}}: Returns the string representation of the calendar field value in the given style and locale.|
||Properties| |
||Parameters|# {{int}}: dateField
# {{Date}}: date
# {{String}}: locale
# {{int}}: dateStyle
|
h4.GetLastDayOfMonth
||Action name|GetLastDayOfMonth|
||Class name|{{com.cdrator.util.date.action.GetLastDayOfMonth}}|
||Available from core version|8.7|
||Description|Get the last day of the month of the supplied date|
||Return value|{{Date}}: A date representing the last day of the month of the supplied date|
||Properties| |
||Parameters|# {{Date}}: date
|
h4.GetNextWorkingDay
||Action name|GetNextWorkingDay|
||Class name|{{com.cdrator.util.date.action.GetNextWorkingDay}}|
||Available from core version|8.7|
||Description|Get the next working day if the supplied date is a holiday|
||Return value|{{Date}}: The next working day|
||Properties| |
||Parameters|# {{Date}}: fromDate
|
h3.Util - Image
h4.GetImage
||Action name|GetImage|
||Class name|{{com.cdrator.util.image.action.GetImage}}|
||Available from core version|8.7|
||Description|Loads an image from a specific path given as parameter or context object|
||Return value|{{Image}}: Returns the Image object loaded from the given path.|
||Properties| |
||Parameters|# {{String}}: imagePath
|
h3.Util - Parameter
h4.CdrParameterReader
||Action name|CdrParameterReader|
||Class name|{{com.cdrator.util.parameter.action.CdrParameterReader}}|
||Available from core version|8.7|
||Description|Retrieves a CDR Parameter based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h4.UpdateCreateCdrParameter
||Action name|UpdateCreateCdrParameter|
||Class name|{{com.cdrator.util.parameter.action.UpdateCreateCdrParameter}}|
||Available from core version|8.7|
||Description|This action updates a cdr parameter, if the cdr parameter doesn't exist it will create a new one. The value, name and object will be set based on the given information.|
||Return value|{{CdrParameter}}: The updated/created cdr parameter.|
||Properties| |
||Parameters|# {{PersistentObject}}: object
# {{String}}: name
# {{Object}}: value
|
h3.Unknown package
h4.SingleValueReader
||Action name|SingleValueReader|
||Class name|{{com.cdrator.util.SingleValueReader}}|
||Available from core version|8.7|
||Description|Reads a single value from a persistent object. Column name must be specified.|
||Return value|{{String}}: The string value of the specified column name of the persistent object|
||Properties|# columnName: The column name of the persistent object, from where to read the value from
|
||Parameters|# {{PersistentObject}}: persistentObject
|
h3.Util - String
h4.CreateListOfStringsFromDelimitedText
||Action name|CreateListOfStringsFromDelimitedText|
||Class name|{{com.cdrator.util.string.action.CreateListOfStringsFromDelimitedText}}|
||Available from core version|8.7|
||Description|Creates a List of strings from a delimited text|
||Return value|{{List}}: The list of strings computed by splitting the delimited text|
||Properties|# delimiter: The delimiter used in the text
|
||Parameters|# {{String}}: delimitedText
|
h3.Workflow
h4.PushWorkflow
||Action name|PushWorkflow|
||Class name|{{com.cdrator.workflow.action.PushWorkflow}}|
||Available from core version|8.7|
||Description|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
|
||Return value|{{WfActivity}}: The activity the workflow was waiting in.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{WfWorkflow}}: workflow
|
h4.PushWorkflowById
||Action name|PushWorkflowById|
||Class name|{{com.cdrator.workflow.action.PushWorkflowById}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{WfWorkflow}}: The pushed workflow.|
||Properties|# activityKey: The name of the activity to push.
# outcome: The outcome of the activity.
|
||Parameters|# {{String}}: workflowId
# {{Broker}}: broker
|
||Deprecated|This action is deprecated and therefore should not be used.|
h4.StartNewWorkflow
||Action name|StartNewWorkflow|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflow}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{HookpointResult}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
|
h4.StartNewWorkflowList
||Action name|StartNewWorkflowList|
||Class name|{{com.cdrator.workflow.action.StartNewWorkflowList}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: Returns the hookpointResult from the new workflow.|
||Properties| |
||Parameters|# {{String}}: hookpointKey
# {{String}}: contextKeys
# {{Context}}: existingContext
# {{List}}: objectList
# {{String}}: objectContextKey
|
h4.WorkflowActivityReader
||Action name|WorkflowActivityReader|
||Class name|{{com.cdrator.workflow.action.WorkflowActivityReader}}|
||Available from core version|8.7|
||Description|Retrieves a workflow activity based on configurable parameters.|
||Return value|{{PersistentObject}}: Retrieves the a persistent object based on the constraints from the properties and parameters.|
||Properties|# attributeName1: Attribute 1
# attributeName2: Attribute 2
# attributeName3: Attribute 3
|
||Parameters|# {{Object}}: constraint1
# {{Object}}: constraint2
# {{Object}}: constraint3
|
h3.Workflow - Context
h4.IsObjectInContext
||Action name|IsObjectInContext|
||Class name|{{com.cdrator.workflow.context.action.IsObjectInContext}}|
||Available from core version|8.7|
||Description|Checks if the object is in the context|
||Return value|{{boolean}}: true if the object is in the context|
||Properties|# objectKey: The key of the object to check in the context
|
||Parameters|# {{Map}}: context
|
h3.Workflow - Hookpointresult
h4.AddHookpointResultObjects
||Action name|AddHookpointResultObjects|
||Class name|{{com.cdrator.workflow.hookpointresult.action.AddHookpointResultObjects}}|
||Available from core version|8.7|
||Description|Adds key/value to hookpoint result. Allows having objects in HOOKPOINT_RESULT|
||Return value|{{void}}: No return value|
||Properties|# key1: Key 1
# key2: Key 2
# key3: Key 3
# key4: Key 4
# key5: Key 5
|
||Parameters|# {{HookpointResult}}: result
# {{Object}}: value1
# {{Object}}: value2
# {{Object}}: value3
# {{Object}}: value4
# {{Object}}: value5
|
h4.CheckHookpointResult
||Action name|CheckHookpointResult|
||Class name|{{com.cdrator.workflow.hookpointresult.action.CheckHookpointResult}}|
||Available from core version|8.7|
||Description|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.|
||Return value|{{boolean}}: True if result is success, False otherwise.|
||Properties|# errorCodesToIgnore: List of error codes to ignore. Use semicolon (;) to separate the values of the list.
|
||Parameters|# {{HookpointResult}}: hookpointResult
|

  • No labels