Guida SDK › Integration › API Reference List › Translation Script Objects › Tools › Exception Methods › AddException

AddException

Description

This method adds a new exception and returns a map with the following entries:

• ExceptionName
• ExceptionJustification
• ExceptionDescription
• ExceptionEffectiveFrom
• ExceptionEffectiveTo
• ExceptionTimeSlot
• ContractParties: Map of contract parties and/or contracts. The map can be empty.
• Contracts: (key ContractPartyNameContractName, Value ContractName)
• Services: Map of services. The map can be empty.
• DomainCategories: Map of domain categories. The map can be empty.

Note: The Tools.AddException parameter "ExceptionTimeSlot" should refer to the name of an existing "Timeslot Template"
(see Framework > Template Library > Timeslot Templates).

Note: This is different than the the GUI, which requires a timeslot type (Weekly/Yearly) (with an "Edit Timeslot" button), a timeslot range and a time zone.

Syntax

AddException (pDetails)

Parameters

Remarks

None.

Example:

Option Explicit

Sub OnLoad()
  'Tools.log "Translation Script : In OnLoad procedure", "I"
End Sub

Sub OnTranslationEvent(EntryDetails)
  'Tools.log "Translation Script : In OnTranslationEvent function", "I"
End Sub

Sub Main()
  'Tools.log "Translation Script : In Main procedure", "I"
  
  Dim map2
  Set map2=Tools.CreateMap
  
  map2("Exception1")="Exception2"    
  map2("ExceptionName")="Exception2"    
  map2("ExceptionJustification")="Exception2"
  map2("ExceptionDescription")=""
  map2("ExceptionEffectiveFrom")="01/12/2009"
  map2("ExceptionEffectiveTo")="05/12/2009"
  map2("ExceptionTimeSlot")="Always"
  map2("ContractParties") = Tools.CreateMap
  'Uncomment this line to assign the exception to contract party: contractParty1
  'map2("ContractParties")("contractPartyName")="contractParty1"
  map2("Contracts")= Tools.CreateMap
  'Comment out this line if only assigning the exception to a contract party, and not a contract
  'The following key is in the format: ContractPartyNameContractName
  map2("Contracts")("contractParty1contract1")= "contract1"
  map2("Services")=Empty  
  map2("DomainCategories")=Empty  
  
Tools.AddException(map2)

Tools.Commit
  
End Sub

Function Result
  'Tools.log "Translation Script : In Result function", "I"
  'Result =
End Function