API

Functions

Functions of the VPS

reloadData

With this function, you can trigger an update of the simulation. This can also be done via the menu item „Reload “.

procedure reloadData(pClientGuid: Guid) rRetVal: Boolean

 

 

Data type

Description

Parameter:

pClientGuid


Guid


This value is used for the global identification of VPS Control-AddIn on a page.

rRetVal

Boolean

Return status

resetProdOrderRoutingLineCustomColors

This function can be used to remove all individual color settings that were set by the setProdOrderRoutingLineCustomColor function.

procedure resetProdOrderRoutingLineCustomColors(pClientGuid: Guid)

 

 

Data type

Description

Parameter:

pClientGuid


Guid


This value is used for the global identification of VPS Control-AddIn on a page.

scrollToDateTime

This function allows you to scroll to a specific point in time in the time scale.

procedure scrollToDateTime(pClientGuid: Guid; pDateTime: DateTime)

 

 

Data type

Explanation

Parameter:

pClientGuid


Guid


This value is used for the global identification of VPS Control-AddIn on a page.

 

pDateTime

DateTime

Time to be scrolled to

 

Example:

//scroll to any date (businesslogic)

_date := DMY2Date(19, 1, 2022);

_integrationMngt.scrollToDateTime(gVpsClientGuid, CreateDateTime(_date, 0T));

setProdOrderRoutingLineCustomColor

This function can be used to set the color and text color of production order routing lines individually. These settings get not changed by Load/Reload and can only be reset to the default color or to the color having been set via the OnProvideProdOrderRoutingLineColor event using the resetProdOrderRoutingLineColors function.

procedure setProdOrderRoutingLineCustomColor(pClientGuid: Guid;

 pProdOrderRoutingLinePositions: List of [Text]; pBarColor: Text; pTextColor: Text)

 

Parameter

Data type

Description

pClientGuid

Guid

This value is used for the global identification of VPS Control-AddIn on a page.

pProdOrderRoutingLinePositions

List of [Text]

List of selected production order routing lines. By default, there is one production order routing line. In the future, in case of multi-selection, several Production Order Routing Lines will be selected.

pBarColor

Text

Specify the bar color.

pTextColor

Text

Specify the text color.

setProdOrderRoutingLineSelection

With this function you can select the production order routing lines. Currently, without having enabled multiselect, the first element in the list gets selected.

procedure setProdOrderRoutingLineSelection(pClientGuid: Guid; 

pProdOrderRoutingLinePositions: List of [Text])


 

 

Data type

Description

Parameter

pClientGuid


Guid


This value is used for the global identification of VPS Control-AddIn on a page.

 

pProdOrderRoutingLinePositions

List of [Text]

 

List of selected production order routing lines. By default, there is one production order routing line. In the future, in case of multi-selection, several Production Order Routing Lines will be selected