AVEVA™ Process Simulation

Understanding Excel functions

Save PDF

Understanding Excel functions

Save PDF

Last UpdatedJul 08, 2025
4 minute read

You can embed AVEVA Process Simulation-specific functions in a cell to display information about your simulation and its data. This section includes information on the AVEVA Process Simulation functions and arguments you can use when you create an AVEVA Process Simulation Excel report.

Excel Function	Arguments	Output
SCDefSim	None	Returns of name of the default simulation.
SCDefSnap	None	Returns the default snapshot.
SCDefUOMSlate	None	Retrieves the default unit of measure (UOM) Slate selected on the ribbon.
SCDynValue	Time, Model, Var/Par, UOM, Sim, Snap	Returns dynamic results from a snapshot at a given time for variables in the History. To add a variable to the History, make it a favorite in AVEVA Process Simulation. If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software uses the default snapshot.
SCMode	Sim, Snap	Returns the simulation mode of the specified simulation and snapshot. If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software returns the current mode of the simulation.
SCModelDesc	Model, Sim	Returns the description of a model. You can modify the description for a model on the model's Property Inspector, in the General area, in the Description box. If you set the Model argument to "Main", the function returns the description of the Main flowsheet in the simulation. You can modify the description for the Main flowsheet on its Property Inspector, in the General area, in the Description box. You can open the Property Inspector for the Main flowsheet by right-clicking the Main branch in the Simulation Manager and then selecting Full Properties. If the simulation name is blank, the software uses the default simulation. This function returns the model description as a single line of text. If the model description extends beyond the width of the cell, part of the model description may be hidden. You may want to format the cell so that the text wraps and you can see the full description of the model.
SCModelList	ModelType, Index, Sim	Returns the name of a model instance from a list of model instances for the specified Model Type. The Index argument must be an integer value. This value determines the name of the model instance that the function returns. For example, if you set the Index argument to 4, the function returns the name of the fourth model instance in the list of model instances of the specified Model Type. If you leave the ModelType argument blank, the software returns the indicated model instance from the list of all model instances in the simulation. You can set the ModelType argument to a generic search string, such as Pipe or HX. The list of model instances includes all the model instances that are based on Model Types that include the search sting in their name. For example, if you set the ModelType argument to Pipe, the list includes all model instances in the simulation that are based on the following Model Types: CWLib.Pipe FlareLib.Pipe FlareLib.PipeRig Process.Pipe Process.PipeRig SteamLib.Pipe SteamLib.PipeRig You can include the library name in the search string to limit the list of model instances to only those model instances that are based on Model Types in the specified library. For example, if you set the ModelType argument to FlareLib.Pipe, the list includes all model instances in the simulation that are based on FlareLib.Pipe and FlareLib.PipeRig. If the simulation name is blank, the software uses the default simulation. The list of model instances is always in alphabetical order.
SCModelState	Model, Sim	Returns the solved status of the model. If the simulation name is blank, the software uses the default simulation.
SCSetValue	Value, Model, Var/Par, UOM, Sim	Sets the value of a specified variable or parameter. If the simulation name is blank, the software uses the default simulation.
SCSnapDesc	Sim, Snap	Returns the description of a specified snapshot. If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software returns the description of the default snapshot.
SCSolState	Sim, Snap	Returns the simulation solved status. If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software returns the solved status of the simulation.
SCUOM	Model, Var/Par, UOM Slate, Sim	Returns the UOM associated with the variable or parameter. If the UOM Slate is blank, the software uses the default UOM Slate.
SCValue	Model, Var/Par, UOM, Sim, Snap	Returns the value of a variable or parameter. If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software uses the default snapshot.

Excel Function

Arguments

Output

SCDefSim

None

Returns of name of the default simulation.

SCDefSnap

None

Returns the default snapshot.

SCDefUOMSlate

None

Retrieves the default unit of measure (UOM) Slate selected on the ribbon.

SCDynValue

Time, Model, Var/Par, UOM, Sim, Snap

Returns dynamic results from a snapshot at a given time for variables in the History. To add a variable to the History, make it a favorite in AVEVA Process Simulation.

If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software uses the default snapshot.

SCMode

Sim, Snap

Returns the simulation mode of the specified simulation and snapshot.

If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software returns the current mode of the simulation.

SCModelDesc

Model, Sim

Returns the description of a model. You can modify the description for a model on the model's Property Inspector, in the General area, in the Description box.

If you set the Model argument to "Main", the function returns the description of the Main flowsheet in the simulation. You can modify the description for the Main flowsheet on its Property Inspector, in the General area, in the Description box. You can open the Property Inspector for the Main flowsheet by right-clicking the Main branch in the Simulation Manager and then selecting Full Properties.

If the simulation name is blank, the software uses the default simulation.

This function returns the model description as a single line of text. If the model description extends beyond the width of the cell, part of the model description may be hidden. You may want to format the cell so that the text wraps and you can see the full description of the model.

SCModelList

ModelType, Index, Sim

Returns the name of a model instance from a list of model instances for the specified Model Type.

The Index argument must be an integer value. This value determines the name of the model instance that the function returns. For example, if you set the Index argument to 4, the function returns the name of the fourth model instance in the list of model instances of the specified Model Type.

If you leave the ModelType argument blank, the software returns the indicated model instance from the list of all model instances in the simulation.

You can set the ModelType argument to a generic search string, such as Pipe or HX. The list of model instances includes all the model instances that are based on Model Types that include the search sting in their name. For example, if you set the ModelType argument to Pipe, the list includes all model instances in the simulation that are based on the following Model Types:

CWLib.Pipe
FlareLib.Pipe
FlareLib.PipeRig
Process.Pipe
Process.PipeRig
SteamLib.Pipe
SteamLib.PipeRig

You can include the library name in the search string to limit the list of model instances to only those model instances that are based on Model Types in the specified library. For example, if you set the ModelType argument to FlareLib.Pipe, the list includes all model instances in the simulation that are based on FlareLib.Pipe and FlareLib.PipeRig.

If the simulation name is blank, the software uses the default simulation.

The list of model instances is always in alphabetical order.

SCModelState

Model, Sim

Returns the solved status of the model.

If the simulation name is blank, the software uses the default simulation.

SCSetValue

Value, Model, Var/Par, UOM, Sim

Sets the value of a specified variable or parameter.

If the simulation name is blank, the software uses the default simulation.

SCSnapDesc

Sim, Snap

Returns the description of a specified snapshot.

If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software returns the description of the default snapshot.

SCSolState

Sim, Snap

Returns the simulation solved status.

If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software returns the solved status of the simulation.

SCUOM

Model, Var/Par, UOM Slate, Sim

Returns the UOM associated with the variable or parameter.

If the UOM Slate is blank, the software uses the default UOM Slate.

SCValue

Model, Var/Par, UOM, Sim, Snap

Returns the value of a variable or parameter.

If the simulation name is blank, the software uses the default simulation. If the snapshot name is blank, the software uses the default snapshot.

Example: Drag a formula to populate an Excel range

Enter the names of the models that you want as column headings.
Enter the names of variables as row headings.
Enter your formula in the parent cell, for example, =SCVALUE(C$4,$A5,$B5,$C$1).
Select the border of the cell and drag either horizontally or vertically to the cells to which you want to apply the formula.

The formula in the parent cell will be applied to the cells included in the range.

AVEVA™ Process Simulation

Understanding Excel functions

Table of Contents

Understanding Excel functions

Related Links