Opties in $Index veld in weergave ontwerp

Niet zo spannend maar wellicht toch handig om te weten is dat het veld $Index in een weergave ontwerp, als je deze bekijkt via de Designer of door middel van script, de opties voor de index van de weergave bevat.

Elke optie heeft een eigen letter met een notatie als /O enz.

Vernieuwen van de index (Refresh):

Als er geen /M, /O, of / R in het veld $Index staat, dan is de instelling “Auto, after first use”. Dit is de standaard waarde.

/O wil zeggen dat de Index “Automatic” dus automatisch wordt bijgewerkt wanneer dat nodig is.

/M staat voor de keuze “Manual” dus handmatig indexeren.

/R=3600 Dit staat voor “Auto, at most every x hours”, automatisch maar niet meer dan 1 keer per x uren waarbij de uren in ms opgegeven worden. In dit geval dus 1 keer per uur.

Verwijderen van de index na (Discard):

Wanneer er geen /P of /T in het veld $Index staat betekend dit de index na 45 dagen van inactiviteit wordt verwijderd, “If inactive for 45 days”. Dit is de standaard instelling.

/T wil zeggen dat de index na elk gebruik weer verwijderd wordt, “After each use”.

/P=24 De /P= is de parameter om de index te verwijderen (purge) in uren. /P=24 is dus na een dag van inactiviteit, instelling “If inactive for x days”.

Alleen een ontwerper of beheerder mag de index aanmaken:

/B zal in het veld staan wanneer “Restrict initial index build to designer or manager” is aangevinkt.

Deze opties samen in het veld $Index van een view object maken de Index opties. Zo kan het veld $Index bijvoorbeeld de waarde “/T/O/B” hebben of “/P=168/R=43200/B” enzovoort.

Ja en?

Ik had deze gegevens nodig om te bepalen of een onderhoudstaak geschreven in Visual Basic bepaalde weergaven moest vernieuwen of niet.

Met de NotesNoteCollection Class kun je eenvoudig de weergaven in een database krijgen en de eigenschappen uitlezen.

Dim nc As NotesNoteCollection
Set nc = db.CreateNoteCollection(False)
nc.SelectViews = True
Call nc.BuildCollection

 

 

 

 

notesDatabase.SetOption

Hoewel de functie notesDatabase.SetOption wel beschreven wordt in de Designer Help staan enkele waarden voor versie 8.5.1 er nog niet bij, daarom even in dit onderwerp.

Om de geavanceerde database eigenschappen met Lotusscript aan te passen bestaat de volgende  functie:

Call notesDatabase.SetOption( optionName% , flag )
Waarbij optionName% een waarde van het type Integer is.

Voor flag gebruik je True om de eigenschap aan te vinken, en False om het uit te zetten.

De volgende waarden zijn toegestaan:

12 = Geen idee wat dit doet?
36 = Vrije ruimte niet overschrijven (Don’t overwrite free space)
37 = Leesmarkeringen niet behouden (Don’t maintain unread marks)
38 = Speciale antwoordhierarchie niet ondersteunen ( Don’t support specialized response hierarchy)
41 = Documententabel optimaliseren (Optimize document table map)
44 = Eigenschap LastAccessed behouden (Maintain LastAccessed property)
45 = Transactielog uitschakelen (Disable transaction logging)
46 = Controleren op nieuws niet toestaan (Don’t allow headline monitoring)
49 = Voorlopig verwijderen toestaan (Allow soft deletions)
54 = Meer velden in database toestaan (Allow more fields in database)
65 = LZ1-compressie gebruiken voor bijlagen (Use LZ1 compression for attachments)
70 = Leesmarkeringen repliceren: Alleen clusterservers (Replicates unread marks: Clustered servers only)
71 =  Leesmarkeringen repliceren: Alle servers (Replicates unread marks: All servers)
74 =  Markeer de database als niet beschikbaar. (Out of service enabled)
75 = Threadhistorie ondersteunen (Support Response Thread History)
76 = Eenvoudig zoeken niet toestaan (Don’t allow simple search)
81 = Domino service voor bijlagen en objecten gebruiken (Use Domino Attachment and Object Service)
82 = Documentgegevens comprimeren (Compress document data)
85 = Export van viewgegevens uitschakelen (Disable export of view data)

Onbekende opties

Ik mis nog een aantal opties zoals de optie om “Weergaven automatisch bijwerken uitschakelen” (Disable automatic updating of views) en “Database-ontwerp comprimeren” (Compress database design) aan of uit te zetten.

Nieuw in 8.5: ResetUserPassword

Voor ontwikkelaars is er in Notes 8.5 een nieuwe functie bijgekomen om wachtwoorden via een applicatie te kunnen resetten: ResetUserPassword.

In LotusScript:
Call notesSession.ResetUserPassword( servername, username, password[, downloadcount ] )

In Java:
public void resetUserPassword(String servername, String username, String password[, Int downloadcount]) throws NotesException

ResetUserPassword kan alleen worden gebruikt als ID Vault is ingesteld.

Nieuw in 8.5: StampAllMulti – een voorbeeld hoe te gebruiken…

De nieuwe methode StampAllMulti voor de NotesDocumentCollection en NotesViewEntryCollection classes is een waardevolle aanvulling!
Nu kunnen we zeer snel meerdere velden in een documentenreeks van een nieuwe waarde voorzien.

Omdat er in de Lotus 8.5 Designer Help geen voorbeeld staat voor het gebruik post ik het even hier.
In dit geval maken we een document collectie door alle documenten in een view te selecteren, maken een nieuw (tijdelijk) document, vullen het document met een paar velden en roepen
de methode StampAllMulti aan om de velden uit het tijdelijke document te kopieren naar alle documenten in de collectie. Snel en effectief!

Voorbeeld:

Sub Initialize
Dim session As New NotesSession
Dim db As NotesDatabase
Dim view As NotesView
Dim vc As NotesViewEntryCollection
Dim doc As NotesDocument

Set db = session.CurrentDatabase
Set view = db.GetView(“StampMulti”)
Set vc = view.AllEntries

Set Doc = db.CreateDocument
Doc.ReplaceItemValue(“Company”,”INECO”).IsSummary = True
Doc.ReplaceItemValue(“Address”,”Hoge Riem 27″).IsSummary = True
Doc.ReplaceItemValue(“Zipcode”,”6666JA”).IsSummary = True
Doc.ReplaceItemValue(“City”,”Heteren”).IsSummary = True
Doc.ReplaceItemValue(“Country”,”The Netherlands”).IsSummary = True
Doc.ReplaceItemValue(“Phone”,”+31653353140″).IsSummary = True
Call vc.StampAllMulti( Doc )

End Sub

Uit de Help:

Replaces the values of specified items in all documents associated with the entries in a view collection.

Note
This method is new with Release 8.5.
Defined in

NotesViewEntryCollection
Syntax

Call notesViewEntryCollection.StampAllMulti( document )

EN

Parameters:

document
NotesDocument. The document contains multiple items, each with values appropriate for the item type.

Usage
If an item does not exist, it is created. If the item is of a different data type, the existing item will be deleted and a new item of the new data type created.

The item values are immediately written to the documents on the server. You do not have to use the Save method of NotesDocument after StampAllMulti. However, any documents modified by your script must be saved before calling StampAllMulti.

This method does not modify existing NotesDocument objects. Documents must be retrieved again to see the changes.

If you do not have the proper access to modify one or more of the documents in the view entry collection, this method will return ERR_NOTES_STAMP_FAILED. Only those documents you are able to modify will be stamped.

PDFCreator aansturen met LotusScript

Voor een klant moest er een export gemaakt worden van alle Notes documenten in een database.
Dit moest gebeuren door deze als PDF af te drukken.
Als PDF printer heb ik gekozen voor de open source applicatie PDFCreator, dat makkelijk aan te sturen is en erg nette afdrukken maakt.
Omdat er geen tijd was om te onderzoeken of dit op de achtergrond kon gebeuren heb ik gekozen om een eenvoudig script te maken dat via de Notes cliënt door een weergave loopt, elk document opent, de bestandsnaam aan PDFCreator doorgeeft via COM, afdrukt naar de default (PDF) printer, en het document sluit.

Code

Sub Initialize
On Error GoTo ErrorHandler
'....... Declare And Set items.....

sPDFPath$ = "C:\"
If Dir(sPDFPath$,16) = "" Then
MsgBox sPDFPath$ & " kan niet worden geopend",16,"Export"
End If

Set PDFCreator = CreateObject("PDFCreator.clsPDFCreator")
If Not PDFCreator.cStart("",True) Then
MsgBox "PDF printer kan niet worden gestart",16,"Export"
GoTo TheEnd
End If

Set Doc = View.GetFirstDocument
Do Until Doc Is Nothing

sPDFName$ = doc.NoteID & ".pdf"
FileName$ = sPDFPath$ & sPDFName$
If Not Dir(FileName$) = "" Then
Kill FileName$
End If

With PDFCreator
.cOption("UseAutosave") = 1
.cOption("UseAutosaveDirectory") = 1
.cOption("AutosaveDirectory") = sPDFPath$
.cOption("AutosaveFilename") = sPDFName$
.cOption("AutosaveFormat") = 0
.cClearCache
End With

Set uiDoc = ws.EditDocument(False,Doc,True,"",True,True)
Call uiDoc.Print(1)
Call uiDoc.Close(True)
Set uiDoc = Nothing

If Not isFileCreated(FileName$) Then
'Foutafhandeling
End If
Set Doc = View.GetNextDocument(Doc)
Loop

TheEnd:
On Error Resume Next
PDFCreator.cClose
Set PDFCreator = Nothing
Exit Sub

ErrorHandler:
MsgBox GetThreadInfo(1) & " " & Error & " (" & Err & ") op regel " & Erl & "."
Resume TheEnd
End Sub

Function isFileCreated ( filePath As String ) As Boolean
On Error GoTo errorHandler
Dim counter As Integer
Dim fSize As Long

isFileCreated = False
Do While Dir$(filePath$, 0) = ""
If counter > 30 Then
Exit Function
End If
Sleep 1
counter = counter + 1
Loop

fSize = FileLen(filePath$)
Counter = 0
Do While (FileLen(filePath$) = 0 Or FileLen(filePath$) > fSize)
fSize = FileLen(filePath$)
If counter > 30 Then
Exit Function
End If
Sleep 1
counter = counter + 1
Loop

isFileCreated = True

Exit Function
ErrorHandler:
MsgBox GetThreadInfo(1) & " " & Error & " (" & Err & ") op regel " & Erl & "."
Exit Function
Resume Next
End Function

Aantal dagen in een bepaalde periode met LotusScript

Voor een applicatie moest herhaaldelijk uitgerekend worden hoeveel dagen er in een bepaalde periode zitten.
De volgende functie voldeed hier goed:

Input: getDaysBetween(“31-12-2007″,”01-01-2007”, “1,7” ,”25/12/07 – 26/12/07,05-12-2007″,Doc)  

Output: 258

Function getDaysBetween(strStart As String, strEnd As String,daysToExclude As String , datesToExclude As String ,Doc As NotesDocument) As Long
On Error GoTo ErrorHandler
Dim Formula As Variant
Dim dLow As String
Dim dHigh As String

If strStart = “” Or strEnd = “” Then GoTo ErrorHandler

strStart = {@TextToTime(“} & strStart & {“)}
strEnd= {@TextToTime(“} & strEnd & {“)}

If daysToExclude = “” Then
dLow = {;0}
Else
dLow = {;@TextToNumber(@Explode(“} & daysToExclude & {“;”,”))}
End If

If Not datesToExclude = “” Then
dLow = dLow & {;@TextToTime(@Explode(@TextToTime(@Explode(“} & datesToExclude & {“;”,”))))}
End If

dHigh$ = {@BusinessDays(} & strStart$ & {;} & strEnd$ & dLow & {)}
dLow$ = {-@BusinessDays(} & strEnd$ & {;} & strStart$ & dLow & {)}

Formula = Evaluate({@If(} & strStart & {>} & strEnd & {;} & dLow$ & {;} & dHigh$ & {)} ,Doc)

getDaysBetween = CLng(Formula(0))

Exit Function
ErrorHandler:
MsgBox GetThreadInfo(1) & ” ” & Error & ” (” & Err & “) op regel ” & Erl & “.”
getDaysBetween = 0
Exit Function
Resume Next
End Function

AddLinkByIds

Met AddLinkByIds kun je een Weergave of Document koppeling in een RichText veld aanmaken door gebruik te maken van het Replica ID van de doel database en het UNID van de weergave of het document.
De wel gedocumenteerde AppendDocLink methode heeft echt een Database, Weergave of Document object nodig, deze methode gebruikt dus alleen tekst als parameters.

AddLinkByIds

Gedefinieerd in

NotesRichTextItem

Syntax

Call notesRichTextItem.AddLinkByIds( dbReplicaID$, serverHint$, viewUNID$, documentUNID$, comment$ [, HotSpotText$ ])

Parameters

serverHint$

String. Servernaam in Canonical or Common formaat.

viewUNID$

String. UniversalID van de weergave. Gebruik een lege string (“”) om een database link te maken of om de “default view” te gebruiken wanneer een document koppeling wordt gebruikt.

documentUNID$

String. UniversalID van het document dat je wilt koppelen. Gebruik een lege string (“”) om een weergave of database koppeling te maken.

comment$

String. De tekst die verschijnt als de gebruiker de koppeling met de muis selecteert en vast houd (titel of help tekst).

HotSpotText$

Optioneel. String. Wanneer opgegeven zal de HotSpotText verschijnen als een informatie blokje met tekst als koppeling, anders wordt de betreffende pictogram afgebeeld (weergave, document of database).

Tip: het UniversalID van een document is snel te halen uit het Informatievenster van een document.

Kleurfuncties zoals RGB en Webkleuren

Soms is het nodig om kleuren te vertalen naar andere formaten.
Excel wil bijvoorbeeld graag een RGB kleur als type Long zien, in style sheets e.d. gebruik je de Webkleuren in Hex formaat e.d.
Meestal gebruik ik het kleurenpallet van Notes om een kleur te bepalen, en gebruik de RGB waarden om verder te werken.

Een aantal LotusScript functies die ik dan gebruik zijn de volgende:

Van RGB waarden naar Long (gelijk aan VBA functie, bijv. voor export naar Excel) :

Function RGB(Byval lRed As Long, Byval lGreen As Long, Byval lBlue As Long) As Long
‘input 255,255,255
Dim tmpLong As Long
tmpLong = lRed
tmpLong = tmpLong + (lGreen*256)
tmpLong = tmpLong + (lBlue*Clng(65536))
RGB = tmpLong
‘Output 16777215
End Function

Van HEX naar RGB String (met kleine aanapssing voor bijv. weergavekolommen e.d.) :

Function HEX2RGB(Byval HexColor As String) As String
‘Input #FFFFFF
HexColor = Replace(HexColor, “#”, “”)
HEX2RGB = Val(“&H” & Mid(HexColor, 1, 2))  & “,” & Val(“&H” & Mid(HexColor, 3, 2)) & “,” & Val(“&H” & Mid(HexColor, 5, 2))
‘Output 255,255,255
End Function

Van RGB waarden naar Hex (voor Web, css e.d.):

Function RGB2HEX(Byval lRed As Long, Byval lGreen As Long, Byval lBlue As Long) As String
‘ input 255,255,255
RGB2HEX = Right(Cstr(Hex(lBlue + 256*(lGreen+256*lRed))),6)
‘ Output FFFFFF
End Function

RGB kleur naar Notes kleuren (Richtext item e.d.):

Function RGB2NOTES(Byval lRed As Long, Byval lGreen As Long, Byval lBlue As Long) As Integer
Dim session As New NotesSession
Dim color As NotesColorObject
Set color = session.CreateColorObject
RGB2NOTES = color.SetRGB(lRed,lGreen,lBlue)
End Function

@LocationGetInfo

Om informatie uit het huidige locatie document van de Notes Client op te halen kun je de formule @LocationGetInfo gebruiken.
Als parameter geef je de veldnaam op die je wilt uitlezen.

Enkele voorbeelden:

@LocationGetInfo([FullName]) : Locatienaam
@LocationGetInfo([MailServer]) : Homeserver
@LocationGetInfo([InternetMailAddress]) : e-mail adres
@LocationGetInfo([NamePreference]) : 0 voor standaard naam, 1 voor alternatieve naam
@LocationGetInfo([BookmarksFilename]) : standaard bookmark.nsf
@LocationGetInfo([SametimeServer]) : Sametime Server
enz…

Weeknummer in Lotusscript

Voor een applicatie had ik een weeknummer functie nodig. Format(Now,”ww”) werkt niet goed voor jaren waar een week 53 bestaat.
Een iets aangepaste script van de MSDN site werkt echter prima.
Invoer Is een datum, uitvoer Is een tekst met het jaar en het weeknummer waarin de invoerdatum valt.

Function getWeekNumber(InDate As NotesDateTime) As String
On Error GoTo ErrorHandler
Dim DayNo As Integer
Dim StartDays As Integer
Dim StopDays As Integer
Dim StartDay As Integer
Dim StopDay As Integer
Dim VNumber As Integer
Dim ThurFlag As Boolean
Dim tmpDate As NotesDateTime
Dim tmpWeek As Integer
Set tmpDate = New NotesDateTime(DateSerial(Year(inDate.LSLocalTime), 1, 0))
DayNo = InDate.TimeDifference(tmpDate)/60/60/24
StartDay = Weekday(DateSerial(Year(InDate.LSLocalTime), 1, 1)) – 1
StopDay = Weekday(DateSerial(Year(InDate.LSLocalTime ), 12, 31)) – 1
StartDays = 7 – (StartDay – 1) ‘Number of days for the first calendar week
StopDays = 7 – (StopDay – 1) ‘Number of days for last calendar week
If StartDay = 4 Or StopDay = 4 Then ThurFlag = True Else ThurFlag = False ‘Test to see if the year has 53 weeks
VNumber = (DayNo – StartDays – 4) / 7 ‘If first week has 4 or more days, it will be calendar week 1 otherwise it will belong to last year’s last calendar week
If StartDays >= 4 Then
tmpWeek = Fix(VNumber) + 2
Else
tmpWeek = Fix(VNumber) + 1
End If
If tmpWeek > 52 And ThurFlag = False Then tmpWeek = 1 ‘Handle years whose last days will belong to coming year’s first calendar week
If tmpWeek = 0 Then ‘Handle years whose first days will belong to the last year’s last calendar week
Set tmpDate = New NotesDateTime(DateSerial(Year(InDate.LSLocalTime ) – 1, 12, 31))
getWeekNumber = getWeekNumber(tmpDate) ‘Recursive loop
Else
getWeekNumber = Format(inDate.LSLocalTime,”yyyy”) & ” week ” & CStr(tmpWeek)
End If
Exit Function
ErrorHandler:
MsgBox GetThreadInfo(1) & ” ” & Error & ” (” & Err & “) op regel ” & Erl & “.”
Exit Function
Resume Next
End Function