Show TOC

Function documentationCustom VBA Functions Locate this document in the navigation structure

 

Planning and Consolidation provides several custom functions that allow you to automate some of the tasks required for your business processes. You can use these custom functions when you build Visual Basic for Applications (VBA) macros in Planning and Consolidation.

Prerequisites

You know how to build VBA macros.

Features

Interface for Excel provides the following custom VBA functions:

BEFORE_CHANGECVW

You use this function to execute a custom operation before changing the current view.

Syntax Syntax

  1. 1.	Option Explicit 
2.	BEFORE_CHANGECVW(Argument As String) 
3.	Process content 
4.	MsgBox Argument 
5.	BEFORE_CHANGECVW = True 
6.	End Function
End of the code.

AFTER_CHANGECVW

You use this function to execute a custom operation after changing the current view.

Syntax Syntax

  1. 1.	Function AFTER_CHANGECVW(Argument As String) 
2.	MsgBox Argument 
3.	AFTER_CHANGECVW = True 
4.	End Function
End of the code.

BEFORE_REFRESH

You use this function to execute a custom operation before the system refreshes the data.

Syntax Syntax

  1. 1.	BEFORE_REFRESH(Argument As String)
2.	MsgBox Argument 
3.	BEFORE_REFRESH = True 
4.	End Function
End of the code.

AFTER_REFRESH

You use this function to execute a custom operation after the system refreshes the data.

Syntax Syntax

  1. 1.	AFTER_REFRESH(Argument As String) 
2.	MsgBox Argument 
3.	AFTER_REFRESH = True 
4.	End Function
End of the code.

BEFORE_SEND

You use this function to execute a custom operation before the system sends data.

Syntax Syntax

  1. 1.	BEFORE_SEND(Argument As String)
2.	MsgBox Argument
3.	BEFORE_SEND = True
4.	End Function
End of the code.

AFTER_SEND

You use this function to execute a custom operation after the system sends data.

Syntax Syntax

  1. 1.	AFTER_SEND(Argument As String)
2.	MsgBox Argument
3.	AFTER_SEND = True
4.	End Function
End of the code.

BEFORE_EXPAND

In addition to using this function in online reporting, you can use it to execute custom code at the beginning of a batch process, such as offline distribution.

Syntax Syntax

  1. 1.	BEFORE_EXPAND(Argument As String) 
2.	MsgBox Argument 
3.	BEFORE_EXPAND = True 
4.	End Function
End of the code.

AFTER_EXPAND

In addition to using this function in online reporting, you can use it to execute custom code at the end of a batch process, such as offline distribution.

Syntax Syntax

  1. 1.	AFTER_EXPAND(Argument As String) 
2.	MsgBox Argument 
3.	AFTER_EXPAND = True 
4.	End Function
End of the code.