Setting Up the Integration Pack
The following sections describe how to configure the integration pack to meet the requirements for the integration.
To configure the integration you must complete the following:
Configuration Properties
Various configurations that apply to the entire integration and specific processes for the integration services are stored in the OUCCBOUNMSConfigurationProperties.xml file located under the apps/CCB-NMS/AIAMetaData/config directory.
These configurations hold several configurable values that are picked up by the integration at runtime to:
• Set Default values to be used in the integration.
• Activate custom implemented extension points available inside the processes. By default these properties are set to false, not to invoke any of the extension points.
• Activate error handling.
Note: Whenever the OUCCBOUNMSConfigurationProperties.xml file is updated, the file must be reloaded for updates to be reflected in the applications or services that use the updated properties. You can perform the reload by restarting the SOA server.
Refer to Appendix B for more information on the Configuration Properties File setup.
Domain Value Maps
Domain value maps (DVMs) are a standard feature of the Oracle SOA Suite which maps codes and other static values across applications. For example: “FOOT” and “FT” or “US” and “USA”.
The DVMs are static in nature, though administrators can add additional maps as needed. The transactional business processes never update DVMs. They only read from them. They are stored in XML files and cached in memory at runtime.
Refer to Appendix C - Domain Value Maps (DVMs) for a listing of the DVMs included for the integration.
To add DVMs:
1. Open a browser and access the SOA Composer Application.
2. On the SOA composer click on the “Open” drop-down and select “Open DVM”. This displays a list of all the DVM files in MDS.
3. Search and Select the relevant DVM you want to maintain.
4. The Edit button in the top navigation bar enables editing the DVM.
5. Once the DVM has been edited click on the “Save” button in the top navigation bar. This saves the DVM data for that session.
6. Click on “Commit” after updating each DVM. This saves the DVM data in MDS.
Updating MDS
If new artifacts are created, if extensions or customizations are made on the artifacts, or if changes are made to the DVM /or the OUCCBOUNMSConfigurationProperties.xml, you must upload the artifacts to the Oracle Metadata Services (MDS).
The Oracle Metadata Services (MDS) repository contains all the metadata and the contents are stored under <PRODUCT_HOME>/MDS-Artifacts. These are uploaded to <SOA-MDS >/apps/CCB-NMS. This includes specific schemas, WSDLS, DVMs and OUCCBOUNMSConfigurationProperties.xml.
For more information about updating MDS, see the “Deployment of MDS Artifacts” section in the Oracle Utilities Customer Care and Billing Integration to Oracle Utilities Network Management System Installation Guide.
Error Handling
To enable Email notification for CCB-NMS Error Handling module:
1. Login to the Enterprise Manager console.
2. Click and expand SOA. Right-click on Soa-infra > SOA Administration > Workflow Notification Properties.
3. Select EMAIL from the drop-down.
4. Provide the email ID for the From address.
Error Handling Module Configuration
Error handling module configuration is governed by the Integration_err_lookup table. This table contains processing instructions for each composite. The Error_Processing_Parent composite picks data for one composite and calls error_Processing_Detail for processing.
INTEGRATION_ERR_LOOKUP
S. No.
Column Name
Description
Default / Suggested Values
1
LookUp_ID
Sequence ID of entry in this table. This is auto generated.
Auto generated
2
IP_Name
The name of the composite that is processed.
 
Example: OUCCBOUNMSCustomerSyncEBF
This column is pre populated with the individual enterprise business process name.
 
Do not modify: Modifying this value will break the code.
3
Processing_Status
Current status of processing it has to be one of the following.
 
HALTED (waiting for manual intervention),
 
NOT REQUIRED
 
ALIVE
NOT REQUIRED
4
Run_Flag
Processing flag status, Y or N. Unread value = N, read value =Y
N
5
Next_Runtime
Next runtime when the error record should be processed for this composite.
SYSDATE+200
6
Halt_For_Error
Allowed values ‘Y’ or ‘N’.
 
When set to ‘Y’ manual intervention is required after one successful error record processing.
 
When set to ‘N’ processing continues without halting.
N
7
RunTime_Interval
Runtime in minutes after which the next error processing should be done.
 
Example: P10Y0M0DT0H0M0S
 
Next processing is done after 10 years 0 months 0 days 0 hours 0 minutes and 0 seconds.
 
This value must be updated based on the business requirement. Setting fewer intervals may have impact on performance.
Default: P10Y0M0DT0H0M0S
8
Email_ID
Email-ID where error notifications are sent.
 
This value can be different or same for all the composites.
Default: email@email.com
9
Email_Content_Type
• GENERIC: One email is sent for all errors. No detail information is included.
• SINGLE: One email is sent for all errors with all details included in the attachment.
• MULTIPLE: Multiple emails are sent & each email has information equal to the value specified in the Error_Count_Per_Notification column.
Values are case sensitive and must always be given in upper case.
Default: GENERIC
10
Email_XSL
XSL to be applied for creating email.
 
Content which includes subject/body and attachment. Look and feel can be modified here.
Default file is provided for all the composites and present under the xsl folder of composite.
 
Example: xsl/Transformation_Create_Email.xsl
 
Copy this to the MDS folder and enter the MDS path in this column for additional configuration.
11
Error_Count_Per_Processing
A notification is sent after the number of records set here is processed.
 
Example: If this is set to 50 then an email notification containing 50 records is sent after 50 records are created in the error store.
Default: 100
12
Email_Attachment_Location
Location where the email attachment is created on the server.
 
This value should point to the location / folder where the attachment should be stored. It is used to create the attachment file in the following format:
 
INTEGRATION_ERR_LOOKUP.Email_Attachment_Location + IP_Name + Date (in YYYYMMDDHH24MMSS)
 
13
Email_Attachment_Flag
• Y: Send email with attachment. In this case it is not mandatory to have Email_Attachment_Location specified.
• N: Send email without attachment but send the attachment location. In this case Email_Attachment_Location has to be specified.
ServerName
+INTEGRATION_ERR_LOOKUP.Email_Attachment_Location + IntegrationPoint_Name + Date in YYYYMMDDHH24MMSS.
N
14
Publish_Human_Task_Flag
• Y: Publish human task
• N: Do not publish human task
If Halt_For_Error value is set to Y and Publish_Human_Task_Flag is also Y then human task is published and the user can take action from worklist application.
N
15
ID_Human_Task
User/Group ID to which human task should be published in case Halt_For_Error is set to Y.
 
This ID must be present in the weblogic realm pointed by fusion middleware.
WebLogic
16
Last_Updated_Date
Last updated date time
SYSDATE
17
Purge_Error_Store_Flag
• Y: Purge data
• N: No purge require
 
The process PurgeIntegrationErrorStore is only deployed when following flag purge.process.deploy=true in deploy.properties file is set to true during installation.
 
If flag.purge.process = false then value of this column Purge_Error_Store_Flag will always be N.
Default: N
18
Purge_Processing_Status_Flag
• Y: Purge Processing in process
• N: Purge processing not happening
 
The process PurgeIntegrationErrorStore is only deployed when following flag purge.process.deploy=true in deploy.properties file is set to true during installation.
 
If flag.purge.process = false then value of this column Purge_Error_Store_Flag will always be N.
Default: N
19
Purge_Frequency
Number of days after which data should be purged. This will be in picture format.
 
Example: P10Y0M0DT0H0M0S
 
Next processing will be done after 10 years 0 months 0 days 0 hours 0 minutes and 0 seconds. This value has to be updated based on the business requirement. Setting fewer intervals may have impact on performance.
 
Need to set this value appropriately.
 
Applicable only when flag.purge.process = true in deploy.properties file during installation and the process PurgeIntegrationErrorStore ID deployed.
Default: P10Y0M0DT0H0M0S
20
Next_Purge_Date
Next purge date. Format: Next_Purge_date + Purge_Frequency
 
Applicable only when flag.purge.process = true in deploy.properties file during installation and the process PurgeIntegrationErrorStore ID deployed.
SYSDATE+100
21
Purge_File_Name
Directory Name where purge file should be stored.
 
Applicable only when flag.purge.process = true in deploy.properties file during installation and the process PurgeIntegrationErrorStore ID deployed.
'location on server where purge record should be persisted'
Primary Key - LookUp _ID, IP_Name
To customize error email notifications for individual the integration points:
1. Use the composite: UpdateIntegrationErrorLookupTable
2. In a browser, enter the following URL and then enter the options to update the contents of the table.
http://<hostname>:<soa server port>/soa-infra/services/CCB-NMS/ UpdateIntegrationErrorLookupTable/updatethe integrationerrorlookuptablebpel_client_ep?
3. Expand WS-Security and provide authentication information. This username and password will be the same as those used to login to the WebLogic Enterprise Manager console.
4. Expand the payload section. Several editable text fields are displayed.
Only the ipName field is mandatory and should be entered as one of the values from INTEGRATION_ERR_LOOKUP.IP_NAME field.
By default, all the checkboxes appearing next to the text fields are selected.
5. Enter the required values in the text fields. If you do not want to update the value, do not select the box.