com.highdeal.admin.hci

Class SwitchDBFileDirectoriesOp

java.lang.Object

com.highdeal.admin.hci.SwitchDBFileDirectoriesOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SwitchDBFileDirectoriesOp
extends java.lang.Object
implements MessageOperation

This operation allows releasing all the output data files resulting from the business processes and to trigger the bulk loading process.

It forces:

• The release of all the output data files managed by the rater instances of the connected SAP CC system
• The triggering of the output data file bulk loading process when this function is enabled in the SAP CC system; See the note below.

Refer the SAP CC Application Help for more information about the Output Data Persistency function and the Data Files Bulk Loading process.

Note

In an integrated SAP Solution scenario with SAP Convergent Invoicing (SAP CI) in SAP ERP/FI-CA, the data files bulk loading process converts data into billable items and consumption items and transfer this data to the relevant SAP ERP and SAP CRM systems.

Implementation in Your Client Application

This operation is for test, demo, or training purposes to manually trigger the release and processing of data files without waiting for the internal schedulers to wake up and automatically process these files.

Recommendation

Use the SAP CC Message Client user interface with the bl command to manually request this operation from the SAP CC system.

Note

In an integrated SAP Solution scenario, you can specify the customer management area to restrict the scope of the operation: The SAP CC system processes the data files that relate to the SAP ERP/FI-CA system defined in the customer management area. Consult the SAP CC Application Help for more information about the Output Data Persistency function and the Data Files Bulk Loading process.

Additional Information

Consult the SAP CC Application Help for more information about the Output Data Persistency function and the Data Files Bulk Loading process.

Operation Result

SwitchDBFileDirectoriesResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="switchDBFileDirectories">
   <xs:complexType>
     <xs:attribute name="checkFiles" type="xs:boolean" default="false" />
     <xs:attribute name="customerManagementAreaName" type="xs:string" use="optional" />
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	No	No	No	No	Yes

Audit Domain

This operation is audited by the system as part of the audit domain: ADMINISTRATION. Consult the IT administrator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML name of the operation request: "switchDBFileDirectories"

Constructor Summary

Constructors

Constructor and Description
SwitchDBFileDirectoriesOp() Builds an empty SwitchDBFileDirectoriesOp.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String data) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
boolean	getCheckFiles() Retrieves whether the operation must check if all files have been loaded properly.
java.lang.String	getCustomerManagementAreaName() Gets the name of the customer management area to switch the files of subscriber accounts with this specific customer management area.
java.lang.String	getName() Gets the XML name of the service operation.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCheckFiles(boolean checkFiles) Specifies whether the operation must check if all files have been loaded properly.
void	setCustomerManagementAreaName(java.lang.String customerManagementAreaName) Sets the name of the customer area to switch the files of subscriber accounts with this specific customer management area.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML name of the operation request: "switchDBFileDirectories"

See Also:

Constant Field Values

Constructor Detail

SwitchDBFileDirectoriesOp

public SwitchDBFileDirectoriesOp()

Builds an empty SwitchDBFileDirectoriesOp.

Method Detail

getCheckFiles

public boolean getCheckFiles()

Retrieves whether the operation must check if all files have been loaded properly.

Returns:

true if the loading of the files must be checked, false otherwise

setCheckFiles

public void setCheckFiles(boolean checkFiles)

Specifies whether the operation must check if all files have been loaded properly.

Parameters:

checkFiles - true if the operation must check the loading of the files, false otherwise

getCustomerManagementAreaName

public java.lang.String getCustomerManagementAreaName()

Gets the name of the customer management area to switch the files of subscriber accounts with this specific customer management area.

Returns:

The identification name of the customer management area

setCustomerManagementAreaName

public void setCustomerManagementAreaName(java.lang.String customerManagementAreaName)

Sets the name of the customer area to switch the files of subscriber accounts with this specific customer management area.

Parameters:

customerManagementAreaName - The specific customer management area

getName

public java.lang.String getName()

Description copied from interface: MessageOperation

Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

Example

• activateAll
• ping

Specified by:

getName in interface MessageOperation

Returns:

The technical name of the HCI operation

addCharacterData

public void addCharacterData(java.lang.String data)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

data - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element