Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

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

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

Parameters

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

Unknown package

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

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

Parameters

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

Billing - Financial - Payments

...

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

  1. AccountPayment: accountPayment

...

AccountPaymentSetCaptureInfo

 

Action name

AccountPaymentSetDoCaptureAccountPaymentSetCaptureInfo

Class name

com.cdrator.billing.payment.action.AccountPaymentSetDoCaptureAccountPaymentSetCaptureInfo

Available from core version

8.7

Description

Calls setDoCapture on a given account payment and saves it.Set capture info on AccountPayment

Return value

void: No return value.

Properties

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

Parameters

  1. AccountPayment: accountPaymentap

...

AccountPaymentSetDoCapture

Action name

AccountPaymentTypeReaderAccountPaymentSetDoCapture

Class name

com.cdrator.billing.payment.action.AccountPaymentTypeReaderAccountPaymentSetDoCapture

Available from core version

8.7

Description

Retrieves an account payment based on configurable parametersCalls setDoCapture on a given account payment and saves it.

Return value

PersistentObject: Retrieves void: No return value.

Properties

 

Parameters

  1. AccountPayment: accountPayment

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

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

Parameters

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

...

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

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

Parameters

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

Correspondence - Archive

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

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

Parameters

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

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

  1. filePath: FilePath

Parameters

  1. DocArchive: archive
  2. String: filePathParameter

...

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

  1. Account: account
  2. WfWorkflow: wfWorkflow

Main

...

CheckIfAccountInState

Action name

ProductMakeSubscriptionCheckIfAccountInState

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

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

Parameters

  1. Account: account

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

  1. Account: account

Main

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

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

...

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

  1. Subscription: subscription

...

GetActiveBillingGroupOfSubscription

Action name

GetAllActiveWorkflowsForSubscriptionGetActiveBillingGroupOfSubscription

Class name

com.cdrator.main.subscription.action.GetAllActiveWorkflowsForSubscriptionGetActiveBillingGroupOfSubscription

Available from core version

8.7

Description

This action returns all active Retrieves the active billing group of the subscription

Return value

BillingGroup: The active billing group of the subscription

Properties

 

Parameters

  1. Subscription: subscription

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

  1. Subscription: subscription

...

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

  1. Subscription: subscription
  2. Date: endDate

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

  1. serviceCode: The service code to check for.

Parameters

  1. Subscription: subscription

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

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

Parameters

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

...

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

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

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

Parameters

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

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

Properties

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

Parameters

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

Main - User - Login

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

  1. Users: user
  2. String: password

Misc

CreateLongDescriptionElementList

...

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

  1. PersistentObject: object
  2. String: name
  3. Object: value

Unknown package

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

  1. columnName: The column name of the persistent object, from where to read the value from

Parameters

  1. PersistentObject: persistentObject

Util - String

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

  1. delimiter: The delimiter used in the text

Parameters

  1. String: delimitedText

Workflow

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

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

Parameters

  1. WfWorkflow: workflow

...