...
- Create a new data object class extending com.crm.dataobject.ViewObject class.
- Create five new summary pages.
- Create a new data entry page.
- Create a new user interface class extending com.crm.process.processrun.CRMUIProcessRunDefinitionBean class.
- Create a new XML utility class extending com.crm.businessobject.processrun.ProcessRunDefinitionXMLUtilBean class, to save and load any criteria, action inputs and/or scheduling settings.
- Create the process class needed to execute the process run definition.
- Define the process in modules metadata file.
...
| Ui expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
4. Create User Interface Class
The new user interface class must extend com.crm.process.processrun.CRMUIProcessRunDefinitionBean class.
Note that:
- When creating a new process run definition, the process and module attributes to set on the new data objects must be the same as the ones defined in modules metadata file.
- setMandatoryFields() method calculates the associated objects' mandatory fields and along with the ones defined in getViewMandatoryFields() method it constructs the new data object's defaultMandatoryFields linked hash map.
- To submit the process run definition to the scheduler for execution, use submit(CRMDOProcessRunLog processRunLog) method of com.crm.process.processrun.CRMUIProcessRunDefinitionBean class. This method uses process run definition's module and process attributes to retrieve the EJB and method name to call, from modules metadata file.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
@Stateless
@LocalBean
public class CRMUIRewardSettlementRunDefinitionBean extends CRMUIProcessRunDefinitionBean {
/**
*
*/
private static final long serialVersionUID = 1L;
private static final String PROCESS_RUN_LOG_ENTRIES_EXIST = "PROCESS_RUN_LOG_ENTRIES_EXIST";
private static final String IS_PROCESS_RUN_DEF_LATEST_VERSION = "IS_PROCESS_RUN_DEF_LATEST_VERSION";
private static final String LATEST_PROCESS_RUN_DEF_ID = "LATEST_PROCESS_RUN_DEF_ID";
private static final String PROCESS ="REWARD_SETTLEMENT_PROCESSING";
private static final String MODULE ="REWARDS";
@EJB private CRMBOProcessRunDefinitionBean processRunDefinitionBean;
@EJB private RewardSettlementProcessRunDefinitionXMLUtilBean rewardSettlementProcessRunDefinitionXMLUtilBean;
@EJB private CRMBOProcessRunLogBean processRunLogBean;
@EJB private CRMBORewardSchemeBean rewardSchemeBean;
@EJB private CRMValidatorBean validatorBean;
@EJB private CRMBORewardDefinitionBean rewardDefinitionBean;
@EJB private RewardDefinitionXMLUtilBean rewardDefinitionXMLUtilBean;
/**
* @see CRMUIProcessRunDefinitionBean#CRMUIProcessRunDefinitionBean()
*/
public CRMUIRewardSettlementRunDefinitionBean() {
//do nothing
}
/**
* Loads a reward settlement run definition form.
*
* @param id - the reward settlement run definition id to load
* @return the loaded form
* @throws Exception
*/
public RewardSettlementRunDefinition loadForm(String id) throws Exception {
//Load the process run definition from db
CRMDOProcessRunDefinition definition = (CRMDOProcessRunDefinition)processRunDefinitionBean.load(id);
//Set process run definition additional information
definition = processRunDefinitionBean.loadAdditionalInformation(definition);
//Create new RewardSettlementRunDefinition instance and set process run definition object
RewardSettlementRunDefinition rewardSettlementRunDefinition = new RewardSettlementRunDefinition();
rewardSettlementRunDefinition.setProcessRunDefinition(definition);
//Load criteria input and scheduling settings from XML
rewardSettlementRunDefinition = rewardSettlementProcessRunDefinitionXMLUtilBean.loadFromXML(rewardSettlementRunDefinition);
//Initialise criteria
rewardSettlementRunDefinition = rewardSettlementProcessRunDefinitionXMLUtilBean.initialize(rewardSettlementRunDefinition);
//Set aliases
if (processRunLogBean.exists(rewardSettlementRunDefinition.getProcessRunDefinition()))
{
rewardSettlementRunDefinition.setAlias(PROCESS_RUN_LOG_ENTRIES_EXIST, "1");
}
else
{
rewardSettlementRunDefinition.setAlias(PROCESS_RUN_LOG_ENTRIES_EXIST, "0");
}
String latestVersionID = getLatestVersionID(rewardSettlementRunDefinition.getProcessRunDefinition());
if (latestVersionID==null || ( latestVersionID!=null && latestVersionID.equals(id)))
{
rewardSettlementRunDefinition.setAlias(IS_PROCESS_RUN_DEF_LATEST_VERSION, "1");
rewardSettlementRunDefinition.setAlias(LATEST_PROCESS_RUN_DEF_ID, latestVersionID);
}
else
{
rewardSettlementRunDefinition.setAlias(IS_PROCESS_RUN_DEF_LATEST_VERSION, "0");
rewardSettlementRunDefinition.setAlias(LATEST_PROCESS_RUN_DEF_ID, latestVersionID);
}
//Set mandatory fields
rewardSettlementRunDefinition.setMandatoryFields();
return rewardSettlementRunDefinition;
}
/**
* Creates a notification run definition.
*
* @return a notification run definition
* @throws Exception
*/
public RewardSettlementRunDefinition createButton() throws Exception {
RewardSettlementRunDefinition rewardSettlementRunDefinition = new RewardSettlementRunDefinition();
//Initialise attributes
rewardSettlementRunDefinition.setProcessRunDefinition((CRMDOProcessRunDefinition)processRunDefinitionBean.construct());
rewardSettlementRunDefinition.setSchedulerTask(new SchedulerTask());
rewardSettlementRunDefinition.setSchemeCriteria(constructRewardSchemeCriterion());
//Set process = process id as defined in modules metadata file
rewardSettlementRunDefinition.getProcessRunDefinition().setProcess(PROCESS);
//Set module = module id as defined in modules metadata file
rewardSettlementRunDefinition.getProcessRunDefinition().setModule(MODULE);
//Set type default value
rewardSettlementRunDefinition.setRewardSettlementType(RewardSettlementType.BOTH);
//Set the definition's mandatory fields
rewardSettlementRunDefinition.setMandatoryFields();
return rewardSettlementRunDefinition;
}
private Set<RewardSchemeCriterion> constructRewardSchemeCriterion() throws Exception {
Set<RewardSchemeCriterion> schemeCriteria = new HashSet<RewardSchemeCriterion>();
//schemeCriteria.add(new RewardSchemeCriterion());
return schemeCriteria;
}
/**
* Saves a reward run definition.
* @param rewardSettlementRunDefinition - the reward run definition to save
* @return the saved reward run definition
* @throws Exception
*/
public RewardSettlementRunDefinition saveButton(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception {
//Set and validate the definition's mandatory fields
rewardSettlementRunDefinition.setMandatoryFields();
validateMandatoryFields(rewardSettlementRunDefinition);
//Convert criteria, input settings and scheduling settings to XML and set them to process run definition data object.
rewardSettlementRunDefinition = rewardSettlementProcessRunDefinitionXMLUtilBean.constructXML(rewardSettlementRunDefinition);
CRMDOProcessRunDefinition processRunDefinition = rewardSettlementRunDefinition.getProcessRunDefinition();
//Validate process run definition
if(processRunDefinition.getCode()==null)
{
processRunDefinition.setCode(processRunDefinitionBean.getNextSequenceNumber(SequenceNumber.PROCESSRUNDEFINITIONCODES));
}
validateCriteria(rewardSettlementRunDefinition);
validateActionInput(rewardSettlementRunDefinition);
validateSchedulingSettings(rewardSettlementRunDefinition);
CRMDORewardDefinition rewardDefinition= (CRMDORewardDefinition)rewardDefinitionBean.loadActiveDefinition();
rewardDefinition = rewardDefinitionXMLUtilBean.initialize(rewardDefinition);
if(rewardDefinition.getSettlementAutomation()==null || rewardDefinition.getSettlementAutomation().getInvoiceType()==null || rewardDefinition.getSettlementAutomation().getInvoiceProduct() == null)
{
throw new CannotExecuteSettlementNoConfigurationInRewardDefinitionException(getCRMSession());
}
processRunDefinitionBean.validateAndSave( rewardSettlementRunDefinition.getProcessRunDefinition() );
String latestVersionID = getLatestVersionID(rewardSettlementRunDefinition.getProcessRunDefinition());
//if process run definition is modified
if (latestVersionID==null || ( latestVersionID!=null && latestVersionID.equals(rewardSettlementRunDefinition.getProcessRunDefinition().getId())))
{
rewardSettlementRunDefinition.setAlias(IS_PROCESS_RUN_DEF_LATEST_VERSION, "1");
}
else
{
rewardSettlementRunDefinition.setAlias(IS_PROCESS_RUN_DEF_LATEST_VERSION, "0");
}
return rewardSettlementRunDefinition;
}
/**
* Validate the criteria of the notification run definition
*
* @param notificationRunDefinition - the notification run definition to validate the criteria of
* @throws Exception
*/
protected void validateCriteria(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception{
if (ServiceUtil.isInitialized(rewardSettlementRunDefinition.getSchemeCriteria()) )
{
validatorBean.validateUniqueRecord(
"Scheme",
new ArrayList<CRMDO>(rewardSettlementRunDefinition.getSchemeCriteria()),
new String[]{"scheme.name"},
new String[]{"Name"});
}
}
/**
* Validate the scheduling settings of the notification run definition
*
* @param notificationRunDefinition - the notification run definition to validate the scheduling settings of
* @throws Exception
*/
protected void validateSchedulingSettings(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception{
}
/**
* Loads a reward run definition form.
*
* @param rewardSettlementRunDefinition - the reward run definition to load
* @return the loaded form
* @throws Exception
* @throws CannotModifyException
*/
public RewardSettlementRunDefinition editButton(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception, CannotModifyException {
CRMDOProcessRunDefinition definition = (CRMDOProcessRunDefinition)processRunDefinitionBean.load(rewardSettlementRunDefinition.getProcessRunDefinition().getId());
if(definition==null)
{
definition = processRunDefinitionBean.loadLatest(rewardSettlementRunDefinition.getProcessRunDefinition().getCode());
}
rewardSettlementRunDefinition = loadForm(definition.getId());
if(rewardSettlementRunDefinition.getAlias(PROCESS_RUN_LOG_ENTRIES_EXIST).equals("1"))
{
rewardSettlementRunDefinition = amendButton(rewardSettlementRunDefinition);
}
return rewardSettlementRunDefinition;
}
/**
* Amend a reward run definition.
*
* @param rewardSettlementRunDefinition - the reward run definition to amend
* @return the amended reward run definition
* @throws Exception
* @throws CannotModifyException
*/
public RewardSettlementRunDefinition amendButton(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception {
CRMDOProcessRunDefinition processRunDefinition = rewardSettlementRunDefinition.getProcessRunDefinition();
CRMDOProcessRunDefinition newProcessRunDefinition = (CRMDOProcessRunDefinition) processRunDefinition.clone();
newProcessRunDefinition.setVersion(new Integer(processRunDefinition.getVersion().intValue()+1));
rewardSettlementRunDefinition.setProcessRunDefinition(newProcessRunDefinition);
rewardSettlementRunDefinition.setAlias(PROCESS_RUN_LOG_ENTRIES_EXIST, "0" );
rewardSettlementRunDefinition.setAlias(IS_PROCESS_RUN_DEF_LATEST_VERSION, "1");
return rewardSettlementRunDefinition;
}
/**
* Submit a reward run definition.
*
* @param rewardSettlementRunDefinition - the reward run definition to submit
* @return the submitted form
* @throws Exception
* @throws CannotModifyException
*/
public RewardSettlementRunDefinition submitButton(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception {
CRMDORewardDefinition rewardDefinition= (CRMDORewardDefinition)rewardDefinitionBean.loadActiveDefinition();
rewardDefinition = rewardDefinitionXMLUtilBean.initialize(rewardDefinition);
if(rewardDefinition.getSettlementAutomation()==null || rewardDefinition.getSettlementAutomation().getInvoiceType()==null || rewardDefinition.getSettlementAutomation().getInvoiceProduct() == null)
{
throw new CannotExecuteSettlementNoConfigurationInRewardDefinitionException(getCRMSession());
}
//Create a process run log object and set the process run definition
CRMDOProcessRunLog processRunLog = (CRMDOProcessRunLog) processRunLogBean.construct(rewardSettlementRunDefinition.getProcessRunDefinition());
//submit the process run log for execution
submit(processRunLog);
return rewardSettlementRunDefinition;
}
/**
* Validate the action input of the reward settlement run definition
*
* @param definition - the reward settlement run definition to validate the action input of
* @throws Exception
*/
protected void validateActionInput(RewardSettlementRunDefinition definition) throws Exception{
if (definition.getRewardSettlementType()==null)
{
throw new MandatoryFieldException(getCRMSession(),"key_reward_settlement_type");
}
}
/**
* Delete a reward run definition.
*
* @param rewardSettlementRunDefinition - the reward run definition to delete
* @return the deleted form
* @throws Exception
* @throws CannotModifyException
*/
public RewardSettlementRunDefinition deleteButton(RewardSettlementRunDefinition rewardSettlementRunDefinition) throws Exception {
processRunDefinitionBean.validateAndDelete(rewardSettlementRunDefinition.getProcessRunDefinition());
return rewardSettlementRunDefinition;
}
/**
* Adds a list of reward schemes to the reward definition run.
*
* @param entityIDs - the ids of the reward schemes
* @return the list of reward schemes
* @throws Exception
*/
public ArrayList<CRMDO> addRewardSchemeCriterionButton(ArrayList<String> entityIDs) throws Exception {
ArrayList<CRMDO> dtos = new ArrayList<CRMDO>();
if (entityIDs!=null && entityIDs.size() > 0)
{
for (int i=0; i<entityIDs.size(); i++)
{
CRMDORewardScheme scheme = (CRMDORewardScheme)rewardSchemeBean.load(entityIDs.get(i));
RewardSchemeCriterion schemeCriterion=new RewardSchemeCriterion();
schemeCriterion.setScheme(scheme);
dtos.add(schemeCriterion);
}
}
return dtos;
}
/**
* Removes a list of reward scheme criteria from a reward run definition.
*
* @param dtoList - a list of reward scheme criteria to delete
* @return the updated list
* @throws Exception
*/
public ArrayList<CRMDO> removeRewardSchemeCriterionButton(ArrayList<CRMDO> dtoList) throws Exception {
return setDeleted(dtoList);
}
/**
* Loads the reward settlement type options.
*
* @return the reward settlement type options
* @throws Exception
*/
public LookupBuilder getRewardSettlementTypeOptions() throws Exception {
return getRewardSettlementTypeOptions(null);
}
/**
* Loads the reward settlement type options.
*
* @param emptyValue - an empty value for a reward settlement type
* @return the reward settlement type options
* @throws Exception
*/
public LookupBuilder getRewardSettlementTypeOptions(String emptyValue) throws Exception {
LookupBuilder builder = new LookupBuilder();
if (emptyValue!=null)
{
builder.build("", emptyValue);
}
RewardSettlementType[] rewardSettlementTypes = RewardSettlementType.values();
for (int i=0; i<rewardSettlementTypes.length; i++)
{
RewardSettlementType rewardSettlementType = rewardSettlementTypes[i];
builder.build(rewardSettlementType.toString(), rewardSettlementType.getLabel());
}
return builder;
}
}
|
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/**
* Session Bean implementation class RewardSettlementProcessRunDefinitionXMLUtilBean
*/
@Stateless
@LocalBean
public class RewardSettlementProcessRunDefinitionXMLUtilBean extends ProcessRunDefinitionXMLUtilBean {
/**
*
*/
private static final long serialVersionUID = 1L;
private final String XML_CRITERIA_NODE = "criteria";
private final String XML_INPUT_SETTINGS_NODE = "inputsettings";
private final String XML_SCHEME_CRITERIA_NODE = "schemes";
private final String XML_SCHEME_NODE = "scheme";
private final String XML_SCHEMEID_NODE = "schemeid";
private final String XML_DAYS_AGO_NODE = "daysago";
private final String XML_SETTLEMENT_TYPE_NODE = "settlementtype";
@EJB private CRMBORewardSchemeBean schemeBean;
@EJB private CRMBOProductBean productBean;
@EJB private CRMBOFinancialTransactionTypeBean financialTransactionTypeBean;
/**
* @see ProcessRunDefinitionXMLUtilBean#ProcessRunDefinitionXMLUtilBean()
*/
public RewardSettlementProcessRunDefinitionXMLUtilBean() {
}
public RewardSettlementRunDefinition initialize(RewardSettlementRunDefinition definition) throws Exception {
// Initialises the rewards schemes criteria
definition.setSchemeCriteria(initializeSchemeCriteria(definition.getSchemeCriteria()));
return definition;
}
public Set<RewardSchemeCriterion> initializeSchemeCriteria(Set<RewardSchemeCriterion> schemeCriteria) throws ParserConfigurationException, SAXException, IOException,Exception {
//Create a set of rewards scheme criteria
Set<RewardSchemeCriterion> schemes = new HashSet<RewardSchemeCriterion>();
if(schemeCriteria!=null && schemeCriteria.size() > 0)
{
Iterator<RewardSchemeCriterion> iter = schemeCriteria.iterator();
while (iter.hasNext())
{
RewardSchemeCriterion schemeCriterion = iter.next();
if (schemeCriterion.getSchemeID()!=null && schemeCriterion.getScheme() == null)
{
//Given its ID, load the rewards scheme for the db and set it to the scheme criterion
schemeCriterion.setScheme((CRMDORewardScheme)schemeBean.load(schemeCriterion.getSchemeID()));
}
//Add the initialised scheme criterion to the scheme criteria set
schemes.add(schemeCriterion);
}
}
return schemes;
}
public RewardSettlementRunDefinition loadFromXML(RewardSettlementRunDefinition definition) throws Exception {
definition = loadCriteriaFromXML(definition);
definition = loadInputSettingsFromXML(definition);
definition = loadSchedulingSettingsFromXML(definition);
return definition;
}
protected RewardSettlementRunDefinition loadInputSettingsFromXML(RewardSettlementRunDefinition definition) throws Exception {
//load the rewards settlement type from an XML formatted string field
definition.setRewardSettlementType(loadRewardSettlementTypeFromXML(definition.getProcessRunDefinition().getActionInputXML()));
return definition;
}
protected RewardSettlementRunDefinition loadCriteriaFromXML(RewardSettlementRunDefinition definition) throws Exception {
//load the rewards scheme criteria set from an XML formatted string field
definition.setSchemeCriteria(loadSchemeCriteria(definition.getProcessRunDefinition().getCriteriaXML()));
//load the days ago integer field from an XML formatted string field
definition.setDaysAgo(loadNumberFromXML(definition.getProcessRunDefinition().getCriteriaXML()));
return definition;
}
public Integer loadNumberFromXML(String xmlString) throws Exception {
Integer number = null;
if (xmlString!=null)
{
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
InputSource is = new InputSource(new StringReader(xmlString));
Document doc = (Document) builder.parse(is);
Element parent = (Element)doc.getFirstChild();
for (Node child = parent.getFirstChild(); child != null; child = child.getNextSibling())
{
if (child.getTextContent().length()>0)
{
if (child instanceof Element && child.getNodeName().equals(XML_DAYS_AGO_NODE))
{
if (child.getTextContent()!=null && child.getTextContent().length()>0)
{
number = new Integer(Integer.parseInt(child.getTextContent()));
}
}
}
}
}
return number;
}
public RewardSettlementType loadRewardSettlementTypeFromXML(String xmlString) throws Exception {
RewardSettlementType type = null;
if (xmlString!=null)
{
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
InputSource is = new InputSource(new StringReader(xmlString));
Document doc = (Document) builder.parse(is);
Element parent = (Element)doc.getFirstChild();
for (Node child = parent.getFirstChild(); child != null; child = child.getNextSibling())
{
if (child.getTextContent().length()>0)
{
if (child instanceof Element && child.getNodeName().equals(XML_SETTLEMENT_TYPE_NODE))
{
if (child.getTextContent()!=null && child.getTextContent().length()>0)
{
type=UnitOfTime.valueOf(RewardSettlementType.class,child.getTextContent());
break;
}
}
}
}
}
return type;
}
public Set<RewardSchemeCriterion> loadSchemeCriteria(String xmlString) throws ParserConfigurationException, SAXException, IOException {
Set<RewardSchemeCriterion> schemeCriteria =new HashSet<RewardSchemeCriterion>();
if(xmlString!=null)
{
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
InputSource is = new InputSource(new StringReader(xmlString));
Document doc = (Document) builder.parse(is);
Element parent = (Element)doc.getFirstChild();
for(Node child = parent.getFirstChild(); child != null; child = child.getNextSibling())
{
if(child.getTextContent().length()>0)
{
if(child instanceof Element && child.getNodeName().equals(XML_SCHEME_CRITERIA_NODE))
{
NodeList schemes = child.getChildNodes();
if (schemes!=null && schemes.getLength() > 0)
{
for (int i=0;i<schemes.getLength();i++)
{
Node schemeNode = schemes.item(i);
if(schemeNode instanceof Element && schemeNode.getNodeName().equals(XML_SCHEME_NODE))
{
NodeList schemeValueNodes = schemeNode.getChildNodes();
RewardSchemeCriterion rewardSchemeCriterion = new RewardSchemeCriterion();
if (schemeValueNodes!=null && schemeValueNodes.getLength() > 0)
{
for (int j=0;j<schemeValueNodes.getLength();j++)
{
Node schemeValueNode = schemeValueNodes.item(j);
if(schemeValueNode instanceof Element && schemeValueNode.getNodeName().equals(XML_SCHEMEID_NODE))
{
rewardSchemeCriterion.setSchemeID(schemeValueNode.getTextContent());
}
}
}
schemeCriteria.add(rewardSchemeCriterion);
}
}
}
}
}
}
}
return schemeCriteria;
}
protected RewardSettlementRunDefinition loadSchedulingSettingsFromXML(RewardSettlementRunDefinition definition) throws ParserConfigurationException, SAXException, IOException, ParseException {
CRMDOProcessRunDefinition processRunDefinition = definition.getProcessRunDefinition();
if (processRunDefinition!=null)
{
//Use an XML formatted string field to load the scheduling settings object and set it to the process run definition
String xmlString = processRunDefinition.getSchSettingXML();
SchedulerTask schedulerTask = loadScheduleSettings(xmlString);
definition.setSchedulerTask(schedulerTask);
}
return definition;
}
public RewardSettlementRunDefinition constructXML(RewardSettlementRunDefinition definition) throws Exception {
definition = constructCriteriaXML(definition);
definition = constructInputSettingsXML(definition);
definition = constructSchedulingSettingsXML(definition);
return definition;
}
protected RewardSettlementRunDefinition constructInputSettingsXML(RewardSettlementRunDefinition definition) {
//Create input settings node
DOMElement inputSettingsNode = new DOMElement(XML_INPUT_SETTINGS_NODE);
//construct the rewards settlement type XML
DOMElement rewardSettlementTypeElement = constructRewardSettlementTypeXML(definition.getRewardSettlementType());
//add the rewards settlement type XML to the input settings node
inputSettingsNode.add(rewardSettlementTypeElement);
CRMDOProcessRunDefinition processRunDefinition = definition.getProcessRunDefinition();
processRunDefinition.setActionInputXML(inputSettingsNode.asXML());
return definition;
}
public DOMElement constructRewardSettlementTypeXML(RewardSettlementType type) {
//Create a new settlement type node and add the rewards settlement type to it
DOMElement typeElement = new DOMElement(XML_SETTLEMENT_TYPE_NODE);
if (type!=null)
{
typeElement.setText(type.toString());
}
return typeElement;
}
protected RewardSettlementRunDefinition constructCriteriaXML(RewardSettlementRunDefinition definition) {
//Create a new criteria node
DOMElement criteriaNode = new DOMElement(XML_CRITERIA_NODE);
//Construct the rewards scheme criteria XML
DOMElement schemeCriteriaElement = constructSchemeCriteriaXML(definition.getSchemeCriteria());
//Construct the days ago XML
DOMElement daysAgoElement = constructNumber(definition.getDaysAgo());
//Add the two XMLs to the criteria node
criteriaNode.add(schemeCriteriaElement);
criteriaNode.add(daysAgoElement);
CRMDOProcessRunDefinition processRunDefinition = definition.getProcessRunDefinition();
processRunDefinition.setCriteriaXML(criteriaNode.asXML() );
return definition;
}
public DOMElement constructNumber(Integer number) {
DOMElement daysAgoElement = new DOMElement(XML_DAYS_AGO_NODE);
if (number!=null)
{
daysAgoElement.setText(number.toString());
}
return daysAgoElement;
}
public DOMElement constructSchemeCriteriaXML(Set<RewardSchemeCriterion> schemeCriteria) {
DOMElement schemeCriteriaElement = new DOMElement(XML_SCHEME_CRITERIA_NODE);
if (schemeCriteria!=null && schemeCriteria.size() > 0)
{
Iterator<RewardSchemeCriterion> iter = schemeCriteria.iterator();
while (iter.hasNext())
{
RewardSchemeCriterion schemeCriterion = iter.next();
DOMElement schemeElement = new DOMElement(XML_SCHEME_NODE);
DOMElement schemeValueElement = new DOMElement(XML_SCHEMEID_NODE);
if (schemeCriterion.getScheme()!=null)
{
schemeValueElement.setText(schemeCriterion.getScheme().getId());
}
else if(schemeCriterion.getSchemeID()!=null)
{
schemeValueElement.setText(schemeCriterion.getSchemeID());
}
schemeElement.add(schemeValueElement);
schemeCriteriaElement.add(schemeElement);
}
}
return schemeCriteriaElement;
}
protected RewardSettlementRunDefinition constructSchedulingSettingsXML(RewardSettlementRunDefinition definition) {
DOMElement schedulerTaskNode = constructSchedulingSettingsXML(definition.getSchedulerTask() );
definition.getProcessRunDefinition().setSchSettingXML(schedulerTaskNode.asXML());
return definition;
}
}
|
On the last step, the CRMProcessRunBean mentioned in the module.xml as additional process need to be implemented whilst the method executeMessageProcess which executes the process runs via threats mechanism like in Implement a Multithreaded Process section. Firstly, process run method saves the action inputs. Then each process run request processed from a thread and if procedure works correctly, the next process run prepares to been processed and the current one saved as completed. On the other hand, if something goes wrong, the current process run is saved as failed and moves to process the next request. This procedure continues until all the process run requests pass from the multi-threading mechanism. As a result, all the successful and failed process runs are illustrated in the summary page image above. Also, below is illustrated the example of the multi-threaded method implemented:
...
| theme | Eclipse |
|---|---|
| language | java |
| title | executeMessageProcess method |
| collapse | true |
...
6. Create Process Class
The new process class must extend com.crm.process.CRMProcessRunBean class.
Note that:
- A method having only one input parameter, the process run log ID, must be created. This method will be used to implement any business functionality required after the process run definition submission.
- If a multithreaded process is needed, please follow the instructions on how to Implement a multithreaded process.
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
/** * Session Bean implementation class CRMProcessRewardSettlementBean */ @Stateless @LocalBean public class CRMProcessRewardSettlementBean extends CRMProcessRunBean { /** * */ private static final long serialVersionUID = 1L; @EJB private RewardSettlementProcessRunDefinitionXMLUtilBean rewardSettlementProcessRunDefinitionXMLUtilBean; @EJB private RewardDefinitionXMLUtilBean rewardDefinitionXMLUtilBean; @EJB private CRMBOInvoiceBean invoiceBean; @EJB private CRMBOCreditNoteBean creditNoteBean; @EJB private CRMBOAccountReceivableBean accountReceivableBean; @EJB private CRMBOUnitBean unitBean; @EJB private CRMBORewardAwardTransactionBean rewardAwardTransactionBean; @EJB private CRMBORewardSpendTransactionBean rewardSpendTransactionBean; @EJB private CRMProcessFinTransactionBean processFinTransactionBean; @EJB private CRMBORewardsParticipatingMerchantBean rewardsParticipatingMerchantBean; @EJB private CRMBOAwardEventBean awardEventBean; @EJB private CRMBORewardsParticipatingMerchantGroupBean rewardsParticipatingMerchantGroupBean; @EJB private CRMBOUnitGroupBean unitGroupBean; @EJB private CRMBORewardDefinitionBean rewardDefinitionBean; /** * @see CRMProcessRunBean#CRMProcessRunBean() */ public CRMProcessRewardSettlementBean() { //do nothing } public void execute(String processRunLogID) throws Exception { CRMDOProcessRunLog processRun = (CRMDOProcessRunLog)processRunLogBean.load(processRunLogID); execute(processRun); } public void execute(CRMDOProcessRunLog processRun) throws Exception { CRMDOProcessRunDefinition processRunDefinition = processRun.getProcessRunDefinition(); RewardSettlementRunDefinition rewardSettlementRunDefinition = new RewardSettlementRunDefinition(); rewardSettlementRunDefinition.setProcessRunDefinition(processRunDefinition); rewardSettlementRunDefinition = rewardSettlementProcessRunDefinitionXMLUtilBean.loadFromXML(rewardSettlementRunDefinition); rewardSettlementRunDefinition = rewardSettlementProcessRunDefinitionXMLUtilBean.initialize(rewardSettlementRunDefinition); CRMDORewardDefinition rewardDefinition=(CRMDORewardDefinition)rewardDefinitionBean.loadActiveDefinition(); rewardDefinition=rewardDefinitionXMLUtilBean.initialize(rewardDefinition); processRun.setStatus(ProcessRunLogStatus.IN_PROGRESS); processRun.setStartDate(getCurrentDate()); processRunLogBean.save(processRun); Boolean processComplete = new Boolean(false); try { if(rewardSettlementRunDefinition!=null && rewardSettlementRunDefinition.getRewardSettlementType()!=null && !rewardSettlementRunDefinition.getRewardSettlementType().equals(RewardSettlementType.CREDIT) ) { createInvoices(processRun, rewardSettlementRunDefinition,rewardDefinition); createCreditNotesForPurchaseCustEvent(processRun, rewardSettlementRunDefinition,rewardDefinition); processComplete = new Boolean(true); } if(rewardSettlementRunDefinition!=null && rewardSettlementRunDefinition.getRewardSettlementType()!=null && !rewardSettlementRunDefinition.getRewardSettlementType().equals(RewardSettlementType.DEBIT) ) { createCreditNotes(processRun, rewardSettlementRunDefinition,rewardDefinition); createInvoicesForSpendCustEvent(processRun, rewardSettlementRunDefinition,rewardDefinition); processComplete = new Boolean(true); } } catch(Exception e) { saveEntityLogRecord(processRun,"", "",ProcessRunLogEntityStatus.FAILED,e.getClass().getSimpleName(),ExceptionUtil.getStackTrace(e)); processRun.setStatus(ProcessRunLogStatus.FAILED); processRunLogBean.save(processRun); processRun = saveNextProcessRun(processRun); } if (processComplete) { processRun.setStatus(ProcessRunLogStatus.COMPLETED); processRun.setEndDate(getCurrentDate()); processRun = saveNextProcessRun(processRun); processRunLogBean.save(processRun); } } ... } |
CRMProcessSmsRunBean must be also bind to the server by specifying the EJB in the ibm-ejb-jar-bnd.xml binding file.This xml found in CRMEJB > ejbModule > METADATA-INF
...