The following table lists the Operations defined in "ApplicationService":

This operation adds or updates an AppUser. If aParameter.AppUser.Id = 0, then the user will be added.

Change the username and password for the given user. The user must be identified by either UserId or Username (OldUsername).

Get values for defined parameters for the Application

Log in a user identified by username and password.

This operation will reset and create a new password, and send it by e-mail. On next login the password has to be changed.

Executes the SQL and returns the data and column definitions as XML

Executes the SQL and returns the column definitions and data. The data is returned as JSON

Method AddOrUpdateAppUser

This operation adds or updates an AppUser. If aParameter.AppUser.Id = 0, then the user will be added.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ChangeUsernameAndPassword

Change the username and password for the given user. The user must be identified by either UserId or Username (OldUsername).

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetAppParameters

Get values for defined parameters for the Application

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method LoginUser

Log in a user identified by username and password.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SendNewPassword

This operation will reset and create a new password, and send it by e-mail. On next login the password has to be changed.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ExecuteSQL

Executes the SQL and returns the data and column definitions as XML

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ExecuteSQLV2

Executes the SQL and returns the column definitions and data. The data is returned as JSON

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "BusinessObjectsService":

Method Update

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Save

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method InsertChild

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Delete

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Dispose

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Refetch

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "CheckpointService":

Returns information about a specific checkpoint signing.

Returns a list of WorkLogStruct for a given Workid

Returns a list of WorkStructs for a given salesline and checkpoint

Signs a checkpoint. The checkpoint id has to be retrived using GetWorkStruct or other functions returning a valid workid.  The return value is the worklog id.
PS! This operation is atomic

Returns links to all relevant documents for the given workid and checkpoint profile

Method GetWorklogInformation

Returns information about a specific checkpoint signing.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetWorklogList

Returns a list of WorkLogStruct for a given Workid

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetWorkStructList

Returns a list of WorkStructs for a given salesline and checkpoint

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SignCheckpoint

Signs a checkpoint. The checkpoint id has to be retrived using GetWorkStruct or other functions returning a valid workid.  The return value is the worklog id.
PS! This operation is atomic

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetCheckpointprofileDocumentLinks

Returns links to all relevant documents for the given workid and checkpoint profile

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetCheckpointprofileInfo

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ExecuteSQLforCheckpointprofile

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "ConsignmentService":

Method NewEmpty

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method NewFromSales

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method NewFromCustomer

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method NewFromDelivery

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Open

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method FindSimilar

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "ConsignmentUtilService":

Confirms a group of consignment as dispatched. If the carrier supports EDI, the message will be created and sent according to the configuration on the carrier.

Sends notification about dispatch of consignments to the recipients. The recipients has to be obtained from ConsignmentUtilService.GetNotificationRecipients.

Method FindSimilarFromAddress

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method FindSimilarFromConsignment

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Merge

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetDispatched

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetNotDispatched

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ConfirmDispatched

Confirms a group of consignment as dispatched. If the carrier supports EDI, the message will be created and sent according to the configuration on the carrier.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetNotificationRecipients

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SendNotification

Sends notification about dispatch of consignments to the recipients. The recipients has to be obtained from ConsignmentUtilService.GetNotificationRecipients.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "DeviationService":

Will create a deviation based on a template.

Method CreateFromTemplate

Will create a deviation based on a template.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "LoginService":

Login to the appliation. If successfully, a session i created.

Login to the appliation application identified by ApplicationId. If successfully, a session i created.

Logs out the client and releases the session.

Method Login

Login to the appliation. If successfully, a session i created.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ApiLogin

Login to the appliation application identified by ApplicationId. If successfully, a session i created.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Logout

Logs out the client and releases the session.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "LogisticsService":

Goods dispatch/deliver (order) or goods receipt (purchase)

Cancel goods dispatch/deliver (order) or goods receipt (purchase)

Create a draft for either inventory, correction or transfer kind of item adjustments

Book a draft. That mean all items in the draft are applied.

Add items to an Inventory draft.

Add items to an correction draft.

Add items to an correction draft.

Method GoodsDeliver

Goods dispatch/deliver (order) or goods receipt (purchase)

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GoodsCancel

Cancel goods dispatch/deliver (order) or goods receipt (purchase)

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method CreateDraft

Create a draft for either inventory, correction or transfer kind of item adjustments

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method BookDraft

Book a draft. That mean all items in the draft are applied.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method AddToInventoryDraft

Add items to an Inventory draft.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method AddToCorrectionDraft

Add items to an correction draft.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method AddToTransferDraft

Add items to an correction draft.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "MachineLinkService":

Will execute a MachineLink project, and return one or more files.

Will execute a MachineLink project and store the generated files to a database tabler

Method ExecuteProject

Will execute a MachineLink project, and return one or more files.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ExecuteProjectAndStore

Will execute a MachineLink project and store the generated files to a database tabler

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "MediaService":

Returns a product drawing for an item line

Returns a product drawing for standard product

Returns a product drawing for an item

Returns all list of document infromation for an item line

Returns all list of document information for a checkpoint profile and workid

Returns a product drawing for standard product

Method GetItemLineImage

Returns a product drawing for an item line

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetStdProductImage

Returns a product drawing for standard product

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetStockItemImage

Returns a product drawing for an item

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetItemLineDocuments

Returns all list of document infromation for an item line

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetCheckpointDocuments

Returns all list of document information for a checkpoint profile and workid

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetProductImage

Returns a product drawing for standard product

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "MessageService":

Send message to CalWin user that will show up in the CalWin desktop application.

Send Email message. The message will be added to the outbound email queue, so there will be no immediate feedback on success or eventual errors

Method SendMessage

Send message to CalWin user that will show up in the CalWin desktop application.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SendSMS

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SendEMail

Send Email message. The message will be added to the outbound email queue, so there will be no immediate feedback on success or eventual errors

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "MiscService":

Installs or ugrades an CalWin App by uploading the APPX file.

Checks if the given session id exists.

Method InstallAPPX

Installs or ugrades an CalWin App by uploading the APPX file.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method CheckSession

Checks if the given session id exists.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetRGBFromNCS

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "MiscServiceSession":

With AddOrUpdateDiary you can either create a new diary event (aParameter.Id = 0) or update an existing (aParemeterId = 0).

Delete the diary event given by aParameter.EventId.

Gets a DiaryEvent from the database gived by aParameter.Id

Get a arbitrary list of parameters by name and context.
This operation is intended for storing application parameters in global,
application (name of application), user or customer context, or any combination.

Returns information about a given Standard Product for every allowed sizes.
Pricelist prices will also be returned if the a pricelist is given, or there is a
default pricelist defined on the location.

Adds or updates a Contactperson. If aContact.Id is 0 the contact will be added.  PS! It's very important to call Commit or Rollback in conjuction with this operation. See Session service.

Method AddOrUpdateActivity

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method AddOrUpdateDiaryEvent

With AddOrUpdateDiary you can either create a new diary event (aParameter.Id = 0) or update an existing (aParemeterId = 0).

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method DeleteActivity

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method DeleteDiaryEvent

Delete the diary event given by aParameter.EventId.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetActivity

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetDiaryEvent

Gets a DiaryEvent from the database gived by aParameter.Id

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetParameters

Get a arbitrary list of parameters by name and context.
This operation is intended for storing application parameters in global,
application (name of application), user or customer context, or any combination.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetStdProductInfo

Returns information about a given Standard Product for every allowed sizes.
Pricelist prices will also be returned if the a pricelist is given, or there is a
default pricelist defined on the location.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SaveParameters

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method AddOrUpdateContact

Adds or updates a Contactperson. If aContact.Id is 0 the contact will be added.  PS! It's very important to call Commit or Rollback in conjuction with this operation. See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "NotificationService":

Returns the next DB change notification from the queue.
PS! A commit must be done before the item or items are permanently dequed. Eventually
a rollback can be executed to let the items stay in the queue.

Method GetNextDbChange

Returns the next DB change notification from the queue.
PS! A commit must be done before the item or items are permanently dequed. Eventually
a rollback can be executed to let the items stay in the queue.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method PollQueue

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method CheckQueue

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method PushQueue

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "OrderService":

Creates a new quote for a given customer account.

Sets the currency mode for the order session. Must be called before shNew or shOpen.

Opens a existing quote or order from database.

Updates the server side salesheader object with values from the aSalesHeader parameter.

Saves the current quote or order to DB and returns and updated SalesHeaderStruct. Any unsaved orderlines
will also be saved.

PS! It's very important to call Commit or Rollback in conjuction with this operation,
or use the AutoDBCommit parameter.
See Session service.

Adds a new Salesline object.

Saves the current Salesline to DB.  PS! It's very important to call Commit or Rollback in conjuction with this operation, or use the AutoDBCommit parameter. See Session service.

Set the current row that all subsequent Salesline operations will apply to.

Returns a drawing of the product in JPG, EMG or Bitmap format.

Return a list of valid product and items.

Converts a quote to an order.  PS! It's very important to call Commit/Rollback in conjuction with this operation, or use the AutoDBCommit parameter. See Session service.

Deletes the current SalesHeader from DB.  PS! It's very important to call Commit or Rollback in conjuction with this operation, or use the AutoDBCommit parameter. See Session service.

Returns the possible production, delivery and customer date for the quote or order.

Initialize a new purchase header

Opens an existing purchase.

Returns the complete Salesheader and Salesline array in the orderservice object.
New lines (for example automatically created lines) will be added to the Salesline object array.
Optionally the salesheader and saleslines can be refreshed from the database by setting
the RereadSalesheader and/or RereadSaleslines.

Returns the complete Salesheader and Salesline array in the orderservice object.
New lines (for example automatically created lines) will be added to the Salesline object array.
Optionally the salesheader and saleslines can be refreshed from the database by setting
the RereadSalesheader and/or RereadSaleslines.

Saves the current purchase DB and returns and updated PurchaseHeaderStruct. Any unsaved orderlines
will also be saved.

PS! It's very important to call Commit or Rollback in conjuction with this operation,
or use the AutoDBCommit parameter.
See Session service.

Updates the server side purchase header object.

Recalculates the volumediscount based on the given discountpercent. The discount will be applied to the
individual itemlines or as a seperate item line based on a CalWin system parameter.
PS 1! All item lines in the OrderService has to be saved before calling this operation.
PS 2! A shSave will be performed automatically afterwards.
This method is marked as obsolete.

Adds a new product from an existing item line stored in the database and set it as current.

Adds information to the current Salesline

Delete current salesline object, and if the salesline is stored in the DB, from the
DB also.

PS! It's very important to call Commit or Rollback in conjuction with this operation,
or use the AutoDBCommit parameter.
See Session service.

Duplicates current salesline and returns it. It can optionally be saved to the database.

Returns the current orderline object.

The operation returns a 2D drawing of the current item line in XAML format.

Returns alternatives for property identified by aIndex.

Rollbacks changes done to current salesline object, since loading, last save or slSetCurrent. PS! Not to be confused with Session.Rollback which is a database rollback.

With this operation several properties can be updated in one call.

Returns links to all related document for this line. Currently only for lines that are saved to db.

Returns links to all related document for this sale

Method shNew

Creates a new quote for a given customer account.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shSetCurrencyMode

Sets the currency mode for the order session. Must be called before shNew or shOpen.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shOpen

Opens a existing quote or order from database.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shUpdate

Updates the server side salesheader object with values from the aSalesHeader parameter.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shSave

Saves the current quote or order to DB and returns and updated SalesHeaderStruct. Any unsaved orderlines
will also be saved.

PS! It's very important to call Commit or Rollback in conjuction with this operation,
or use the AutoDBCommit parameter.
See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slAdd

Adds a new Salesline object.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slSaveCurrent

Saves the current Salesline to DB.  PS! It's very important to call Commit or Rollback in conjuction with this operation, or use the AutoDBCommit parameter. See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slSetCurrent

Set the current row that all subsequent Salesline operations will apply to.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slGetImage

Returns a drawing of the product in JPG, EMG or Bitmap format.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetListOfCodes

Return a list of valid product and items.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shConvertToOrder

Converts a quote to an order.  PS! It's very important to call Commit/Rollback in conjuction with this operation, or use the AutoDBCommit parameter. See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shDelete

Deletes the current SalesHeader from DB.  PS! It's very important to call Commit or Rollback in conjuction with this operation, or use the AutoDBCommit parameter. See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shGetCalcualtedDeliveryTime

Returns the possible production, delivery and customer date for the quote or order.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shNewPurchase

Initialize a new purchase header

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shOpenPurchase

Opens an existing purchase.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shRefresh

Returns the complete Salesheader and Salesline array in the orderservice object.
New lines (for example automatically created lines) will be added to the Salesline object array.
Optionally the salesheader and saleslines can be refreshed from the database by setting
the RereadSalesheader and/or RereadSaleslines.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shRefreshPurchase

Returns the complete Salesheader and Salesline array in the orderservice object.
New lines (for example automatically created lines) will be added to the Salesline object array.
Optionally the salesheader and saleslines can be refreshed from the database by setting
the RereadSalesheader and/or RereadSaleslines.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shSavePurchase

Saves the current purchase DB and returns and updated PurchaseHeaderStruct. Any unsaved orderlines
will also be saved.

PS! It's very important to call Commit or Rollback in conjuction with this operation,
or use the AutoDBCommit parameter.
See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shUpdatePurchase

Updates the server side purchase header object.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shUpdatevolumeDiscount

Recalculates the volumediscount based on the given discountpercent. The discount will be applied to the
individual itemlines or as a seperate item line based on a CalWin system parameter.
PS 1! All item lines in the OrderService has to be saved before calling this operation.
PS 2! A shSave will be performed automatically afterwards.
This method is marked as obsolete.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slAddFrom

Adds a new product from an existing item line stored in the database and set it as current.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slAddInformation

Adds information to the current Salesline

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slDeleteCurrent

Delete current salesline object, and if the salesline is stored in the DB, from the
DB also.

PS! It's very important to call Commit or Rollback in conjuction with this operation,
or use the AutoDBCommit parameter.
See Session service.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slDuplicateCurrent

Duplicates current salesline and returns it. It can optionally be saved to the database.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slGetCurrent

Returns the current orderline object.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slGetDrawing2D

The operation returns a 2D drawing of the current item line in XAML format.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slGetPropertyAlternatives

Returns alternatives for property identified by aIndex.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slModifySelectedAreas

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slRollback

Rollbacks changes done to current salesline object, since loading, last save or slSetCurrent. PS! Not to be confused with Session.Rollback which is a database rollback.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slUpdateProperties

With this operation several properties can be updated in one call.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method slGetDocumentLinks

Returns links to all related document for this line. Currently only for lines that are saved to db.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method shGetDocumentLinks

Returns links to all related document for this sale

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "ReportService":

Returns a list of defined reports in the system.

Executes one or more CalWin report and returns files (or list of URL) in the specified format.

Returns information like variables and parameters defined on the given report.

Method GetReportTemplateList

Returns a list of defined reports in the system.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ExecuteReports

Executes one or more CalWin report and returns files (or list of URL) in the specified format.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetReportInformation

Returns information like variables and parameters defined on the given report.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "Session":

Kills the given by aSessionId.

Executes a rollback command on the Oracle database. All transactions since last Commit or Rollback will be discarded.

Performs a commit in the Oracle database.

Method KillSession

Kills the given by aSessionId.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Rollback

Executes a rollback command on the Oracle database. All transactions since last Commit or Rollback will be discarded.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method Commit

Performs a commit in the Oracle database.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Operations defined in "SystemService":

Returns information about the CalWin Server instance

Returns detail about server instance status.

Method GetServerInfo

Returns information about the CalWin Server instance

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method ProbeServer

Returns detail about server instance status.

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method GetConfig

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

Method SetConfig

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the Events defined in "SystemEventSink":

This event happens every time the configuration of an App is modified.

Event OnAppChanged

Parameters:

Return Value:

Oxygene Syntax:

C# Syntax:

The following table lists the fields defined in "ActivityLinkStruct":

Link to a quote, order, purchase etc. Ref. Salestype field.

Reference to an other party record (PARTOTHER table)

Link to a contact.

Link to a creditor account (CREDTABLE).

Link to a customer (DEBTABLE).

Link to a project (PROJECT table).

Link to an Invoice Journal (INVOICEJOURNAL table)

Link to a customer Invoice (INVOICE table)

Link to a creditor invoice journal (CREDINVOICEJOURNAL table)

Link to a creditor invoice (CREDINVOICE table).

Link to a deviation (DEVIATION table)

The following table lists the fields defined in "ActivityStruct":

The other entities this activity links to.

E-Mail address.

Should this note activity be shown during creation of quote, order or purchase.

Note valid from date.

Note valid to date.

Pucrhase confirmed date (Kind=ekPurchaseConfirmation)

Name of the printer if this activty was an ekPrintOut

Reference to a diary event

Refrence to the session that created the activity

E-Mail from

Reference to a CalWin activity category

The CalWin user id. If 0 the user id of the CwServer will be used. Eventually the logged in user id.

A list of CalWin user ids that have access to this activity.

List of attached documents represented by their Id's.

Reference to an Exchange object.

The following table lists the fields defined in "AddressDebtableStruct":

The following table lists the fields defined in "AddressEnduserStruct":

The following table lists the fields defined in "AddressStruct":

The following table lists the fields defined in "AppGetAppParameterRequest":

The meaning of this parameter depends on parameter level:
plSystem: No effect
plLocation: Location ID. If null all locations are returned
plUser: User Id. If null - the currently logged in user. If null and user not logged on an
exception will be raised.
plUserParent (customer, supplier etc.): No effect.

The following table lists the fields defined in "AppParameter":

The Parameter GUID

Records of parameter values. If the parameter is an Array it may contain several records. Otherwise only one.

The value depends on the level of the parameter. plSystem: Always null plLocation: The locationId plUser: User id plUserParent: The id of the parent of the user (customer, supplier, etc.)

The following table lists the fields defined in "AppParameterRecord":

The following table lists the fields defined in "AppParameterValue":

If the parameter is a reference to another structure, Complex contains the sub parameter structure.

If the parameter value is a refrence to a CalWin report (the name of the report is in StringValue), ReportParameters contains report parameters that should be passed to ReportService.ExecuteReport.

If the parameter value is a refrence to a CalWin report (the name of the report is in StringValue),
ReportVariables contains report variables (user input) that should be passed to ReportService.ExecuteReport
in the paraExecuteReport.Variables.

The following table lists the fields defined in "AppUserRightStruct":

The GUID representing the user right.

The following table lists the fields defined in "AppUserStruct":

The unique id for the App user.

Username used when logging in to the App.

E-mail address

True if the password has expired and has to reset.

The ISO 639 language code

False if the user is not enabled/active anymore.

Reference to the user profile ID (configurator).

If this App user represented a CalWin contact (belonging to customer, creditor, project or party), this sub structure will be contain data.

If this App user represented a CalWin user, this sub structure will be contain data.

The assigned user Rights for the user.

The application id the user belongs to

The following table lists the fields defined in "AutolineInfoStruct":

Should this line be visible for the enduser?

The following table lists the fields defined in "BinaryFile":

The following table lists the fields defined in "CheckpointStruct":

The following table lists the fields defined in "ChildStruct":

The following table lists the fields defined in "ConfigStruct":

The following table lists the fields defined in "ContactStruct":

The unique ID of the contact.

True if the contact is no longer employeed by the parent (Customer, supplier etc.)?

Reference to the user profile that will be used by CalWin Web configurator.

The username used for login.

The customer number if this contact belongs to a customer.

The supplier number if this contact belongs to a supplier.

The project id if this contact belongs to a project.

The id of the other party if this contact belongs to a other party.

Reference to a role (PersonRole table)

Name, address etc. for the customer this user/contact belongs to.

The following table lists the fields defined in "CurrencyInfoStruct":

Which currency mode is active for the returned prices.

The current display currency internal exchange code ID.

Exchange rate used for conversion from installation currency. 1.0 if no conversion.

ISO currency code for the returned prices (e.g., "NOK", "EUR", "USD").

Currency symbol for display (e.g., "kr", "€", "$").

Number of decimal places typically used for this currency.

The installation currency internal exchange code ID.

The installation base currency ISO code (e.g., "NOK").

The following table lists the fields defined in "CustomSalesHeaderStruct":

Reference to external system

Is the element locked?

Status on salesheader (0=New, 5=Quote printed, 10=Confirmation printed, 15=Changed after confirmation, 20=Delivery note, 25=Changed after delivery note, 30=Remainders, 40=remainder completed, 50=Fully delivered)

Total UValue for all lines on the the quote/order.

Total area in square meters for lines that is part in the U-Value caluclation for the quote/order.

The following table lists the fields defined in "DebtableStruct":

The following table lists the fields defined in "DiaryEventStruct":

The unique id of the event.

CalWin Employee ID

Specifies the caption of the event