Engine Help Category: NotesAdmin
Filtered overview of the Engine Help documentation.
@CopyACL
Copies the ACL of the database with the DBHANDLE DBHANDLE1 to the database with the DBHANDLE DBHANDLE2. If the @function was executed successfully, the @function result has the data type PV. The executing server must hav …
@CopyTemplateACL
Copies the template ACL of the database with the DBHANDLE DBHANDLE1 as the ACL into the database with the DBHANDLE DBHANDLE2. Template ACL entries are specified in the ACL in square brackets. This @function converts thes …
@DeleteDBARConnection
Deletes a specific Advanced Replication Settings connection between the target server TEXT DESTINATIONSERVER and the source server TEXT SOURCESERVER. The entry for Anyserver (wildcard "-") as source server cannot are del …
@DeleteEnvironment
Deletes the environment variable TEXT TEXT1 physically from NOTES.INI. Returnvalue: 1 = variable could are deleted. 0 = variable not present. @Errro... = An error occurred; the variable was not deleted.
@Environment
Returns the value of the environment variable TEXT/TEXTLIST TEXT1/TEXTLIST1.
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1, all specified group names are replaced by their members. Unknown group names are retained, and the resulting list is returned as the @Function result. TEXTLIST TEXTLIST2 additionally ret …
@GetACL
Retrieves the ACL of the database with the OSPATH OSPATH1 or DBHANDLE DBHANDLE1 and returns it split into TEXTLIST USERNAMES2, NUMBERLIST USERLEVEL3, TEXTLIST USERPRIVS4 and TEXTLIST PRIVNAMES5. USERNAMES2: The ACL name …
@GetACLHistory
The ACL change history of the DB with the DBHANDLE DBHANDLE1 as TEXTLIST is returned. Example @GetACLHistory(DBHANDLE1): DBHANDLE1:=@OpenDB("TEST.NSF"); @LogReport(@GetACLHistory(DBHANDLE1)); DBHANDLE1:=@CloseDB(DBHANDLE …
@GetACLMaxINetAccess
Returns the maximum Internet access of the DB with the DBHANDLE DBHANDLE1. LEVEL: 6=Manager 5=Developer 4=Editor 3=Author 2=Depositor 1=Reader 0=No Access Return: FN -> Success @Error -> Error @ERROR ACL NOT …
@GetDBARConnection
For the DB with the DBHANDLE DBHANDLE1 returns the settings of the Advanced Replication Connection from the source server TEXT SOURCESERVER to the destination server TEXT DESTINATIONSERVER if a definition exists for this …
@GetDBARConnections
The list is returned in TEXTLIST TLRETDESTINATIONSERVERS the list of destination servers is returned for which Advanced Replication Settings are defined in the DB with the DBHANDLE DBHANDLE1. Optionally, the parameter TE …
@GetDBDocumentCount
The number of data documents in the DB with the DBHANDLE DBHANDLE1 is returned. Optionally, the number of deleted documents FLOAT FLOATDELETEDCOUNT and the number of design documents FLOAT FLOATDESIGNCOUNT can be queried …
@GetDBID
The ID of the DB with the DBHANDLE DBHANDLE1 is returned. The ID is a TD value that indicates when the DB was created.
@GetDBReplicaHistory
Retrieves the replication history of the database with the DBHANDLE DBHANDLE1. A TEXTLIST with the names of the servers/users is returned directly. In RETTD1 a TDLIST with the respective last replication date, correspond …
@GetDBReplicaInfo
Retrieves the replication information: replica ID TD REPLICAID2, replication flags NUMBER FLAGS3, replication deletion interval NUMBER CUTOFFINTERVAL4 and replication deletion time TD CUTOFFTD5 of the database with the D …
@GetDBSpaceUsage
The size of the DB with the DBHANDLE DBHANDLE1 is returned in bytes, rounded up to full MB. Optionally, the number of used bytes (FLOAT FLOATALLOC) or free bytes (FLOAT FLOATFREE) and the percentage usage (FLOAT FLOATUSE …
@GetDBTitle
Returns the database title and the database categories of the database with the DBHANDLE DBHANDLE1. The return value is of type TEXTLIST where the first element contains the title and one additional element follows for e …
@GetDocPrivileges
Returns a FLOATLIST of the document with the NOTEHANDLE NOTEHANDLE1 associated privileges. If the document has no privileges, the list has 0 elements.
@GetMailAddress
Returns the mail address or, wenn eingetragen, the mail address to forwasding to User TEXT USER1 (from the address book).
@GetMailLocation
Returns the Mail relevanten Informationen to User TEXT (from the Adressbuch). Als Return value is the MailServer (TEXT) returned. In P2 is the Mailfilename (TEXT) returned.
@GetOSPath
Returns the physical/local path (OSPATH) for the relative NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1. Directory and database links are taken into account. If a NOTESPATHLIST is passed as the input parameter, error …
@GetRemoteDBPathByRID
On the server with the server name TEXT TEXTSERVERNAME the first DB with the replica ID RID DBRID is searched for and the Notes path (TEXT) to it is returned. The found DB can be opened with this Notes path. If no matchi …
@GetSchedListEntry
Returns the data for a specific entry FN POSITION2 of the SCHEDLIST SCHEDLIST1 is returned. In UID UID3 the UID of the document to which this entry refers is returned. In TDLIST TDLRANGE4 the time span of this entry is r …
@NotesIDFileCloseCertifierCtx
The @Funktion closes the Certifier NotesID Context-Handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 and returns VSPECPOTVAR. Return value: On success VSPECPOTVAR is returned; otherwise @ERROR.
@NotesIDFileEncodePassword
The @Funktion encodes the plain-text password TEXT TEXTPASSWORD1 and returns the encoded password as VSPECENCPASSWORD. In case of an error, @ERROR is returned.
@NotesIDFileGetInfo
This @Funktion returns various information about the Notes ID file with the OSPATH OSPATH1. If the ID file is password-protected, @NotesIDFileGetInfo should not be used. In that case, the password is requested on the ser …
@NotesIDFileNewCertifier
Creates a new Notes certifier ID. Optionally, an entry can also be created in the Name and Address Book, and a mail file can be created for the new user. The process is controlled primarily by FN IDTYPE and FN FLAGS. All …
@NotesIDFileNewServer
Creates a new Notes server ID. Optionally, an entry can also be created in the Name and Address Book. The process is controlled primarily by FN IDTYPE and FN FLAGS. All other parameters are largely optional TEXT paramete …
@NotesIDFileNewWorkstation
Creates a new Notes ID. Optionally, an entry can also be created in the Name and Address Book, and a mail file can be created for the new user. The process is controlled primarily by FN IDTYPE, FN MAILSYSTEM and FN FLAGS …
@NotesIDFileOpenCertifierCtx
This @Funktion öffnet the Cdertifier Context (Certifier Notes ID) with the OSPATH OSPATH1. In parameter VSPECENCPASSWORD VSPECENCPASSWORD2 the encoded password must (see @NotesIDFileEncodePassword) be passed, if the Note …
@NotesIDFileReCertifyID
This @Funktion recertifies the Notes ID with the OSPATH OSPATH4 of the certifier Notes ID that is assigned to the certifier context handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 has been assigned (see @NotesIDF …
@NotesIDFileSetCtxExpirationTD
With this @Funktion the certifier context handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 an expiration date (TD TDEXPIRE2) for newly created Notes IDs. All IDs subsequently created with this certifier context ha …
@PushAndReplace
Replicates the database with the DBHANDLE FROMDBHANDLE1 with the database with the DBHANDLE TODBHANDLE2 in the direction from FROMDBHANDLE1 to TODBHANDLE2, replicating only the documents that match the Notes-compatible s …
@PushWithFormula
Replicates the database with the DBHANDLE FROMDBHANDLE1 with the database with the DBHANDLE TODBHANDLE2 in the direction from FROMDBHANDLE1 to TODBHANDLE2, replicating only the documents that match the Notes-compatible s …
@ReorgACLPrivileges
The empty elements of TEXTLIST PRIVNAMES2 are removed and returned in the parameter RETUSERPRIVS3 is returned. The corresponding privilege references in TEXTLIST USERPRIVS1 are adjusted and returned in the parameter RETP …
@Replicate
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2. FNLIST FNLIST3 is a list of rights where the first element specifies the replication rights in the first database and the second …
@ReplicateWithFormula
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2, replicating only the documents thas match the Notes-compatible selection formula TEXT/TEXTLIST FORMULA3. If FORMULA3 a TEXTLIST i …
@ReplicateWithFormulaWithFieldException
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2, replicating only the documents thas match the Notes-compatible selection formula TEXT FORMULA3 entsprechen. FNLIST FNLIST4 is a l …
@ReplicateWithServer
The databases of the local Notes server are replicated with the remote Notes server TEXT SERVERNAME2 over the port TEXT PORTNAME1 by the Notes replicator, not by the Engine replicator. Using FN OPTIONS3, options can be s …
@ServerPing
This @Funktion can be used to check the reachability or availability of the server named TEXT TEXT1 . Return value: If the server responds, the workload index (FN) of the server is returned; otherwise an @ERROR-Wert.
@SetACL
Writes the ACL described by PARAMETERS2-5 to the database identified by DBHANDLE DBHANDLE. This ACL must always contain at least one entry with ACL-LEVEL=6. The APIEngine server that writes the ACL must have Manager acce …
@SetACLMaxINetAccess
Sets the Maximum Internet Access level of the database identified by DBHANDLE DBHANDLE1 to the level FN FNLEVEL2. FNLEVEL2: 6=Manager 5=Developer 4=Editor 3=Author 2=Depositor 1=Reader 0=No Access Return: FN -> S …
@SetDBARConnection
Sets the Advanced Replication Connection settings in the database identified by DBHANDLE DBHANDLE1 from the source server TEXT SOURCESERVER to the destination server TEXT DESTINATIONSERVER. If a definition for this desti …
@SetDBReplicaInfo
Sets in the database identified by DBHANDLE DBHANDLE1 the replication information: replica ID TD REPLICAID2, replication flags FN FLAGS3, replication purge interval FN CUTOFFINTERVAL4 and replication cutoff time TD CUTOF …
@SetDBTitle
Sets the title and categories of the database identified by DBHANDLE DBHANDLE1. With TEXT TEXT2 it is interpreted as the title and the categories are deleted; with TEXTLIST TEXTLIST2 the first element of the list is inte …
@SetDocPrivileges
Sets in the document identified by NOTEHANDLE NOTEHANDLE1 the privileges specified in FLOATLIST PRIVILEGES2.
@SetEnvironment
Sets the environment variable TEXT TEXT1 to the value TEXT TEXT2.
@SetSchedListEntry
Sets the data for a specific entry FN POSITION2 of the SCHEDLIST SCHEDLIST1. In UID UID3 receives the UID of the document to which this entry refers. In TDLIST TDLRANGE4 specifies the time range of this entry. 1st ele …
@VerifyNoteSignature
Checks whether the document identified by NOTEHANDLE NOTEHANDLE1 is signed and whether the signature is still valid. If a signature could be positively confirmed (certified key in the address book), TRUE returned, otherw …