/
IBM Notes

IBM Notes

Owned by wiki
Last updated: Dec 23, 2020

Activities

Prequisites:

  • install Flowster Studio Execution Agent on Lotus Domino server
  • start Domino server on Lotus Domino machine
  • use a Certifier ID File and Password with privileges to create accounts and persons on Domino Admin application


NOTE: These activities cannot be executed from Designer locally, only if the Designer(or Flowster Studio) is installed on a Domino Server machine.  

Add User Mail Account

This activity creates a new user mail account. This activity can be executed only if Lotus Domino is installed on machine. 

Activity Parameters

The Add User Mail Account activity parameters can be provided by manual inserted values or via IN arguments or variables:


Parameters:

  • Alternate Name (text box editor control) (type: string): enter an alternate user name.
  • Alternate Name Language (text box editor control) (type: string): enter an alternate language for the user name . E.g. 'de-DE'.
  • Certifier ID File (text box editor control) (type: string): enter the certifier ID File Path . E.g. 'C:\Program File\IBM\Notes\Data\cert.id'.
  • Certifier Password (password box editor control) (type: string): enter the password for the IBM Notes certifier provided.
  • Certifier Password Binding (text box editor control) (type: string): bind to a variable containing the encrypted password for the IBM Notes certifier provided. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Studio Portal). 
  • Comment (text box editor control) (type: string): enter the value for the comment field in the Domino Directory record.
  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Create Mail DB (combobox editor type) (type: string): choose if the user will have a new mail database. 
  • First Name (text box editor type) (type: string): enter the first name.
  • Forward (text box editor control) (type: string): enter the forwarding domain for the user's mail file. 
  • Last Name (text box editor type) (type: string): enter the last name of the user.
  • Location (text box editor type) (type: string): enter the value for the location field in the Domino Directory record. 
  • Mail DB Path (text box editor type) (type: string): enter the path of the user's mail file to the mail directory. E.g. 'C:\mail\jones.nsf'.
  • Mail Server (text box editor type) (type: string): enter the middle initial of the new user. E.g. J.D. 
  • Middle Initial (text box editor type) (type: string): enter the mail server. M
  • Organisation Unit (text box editor type) (type: string):  enter the name of the organisation unit. E.g. 'Flowster'.
  • Registration Log (text box editor type) (type: string): enter the registration log. E.g. 'log.nsf'.
  • Registration Server (text box editor type) (type: string): enter the registration server name. 
  • User File Path (text box editor type) (type: string): enter the user file path where will be created. E.g. 'C:\Lotus Notes\FilePath.id'. 
  • User Password (password box editor control) (type: string): enter the password for the IBM Notes user ID file provided. 
  • User Password Binding (text box editor control) (type: string): bind to a variable containing the encrypted password for the IBM Notes user ID file provided. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Studio Portal). 

The Read Only Output variables are the possible output values that the activity will provide:

  • Result (type: string): outputs the operation result: true or false. 

Connect to IBM Notes

This activity connects to the specified IBM Notes account and outputs an IBM Notes client connection. 

Activity Parameters

The Connect to IBM Notes activity parameters can be provided by manual inserted values or via IN arguments or variables:

Authentication:

  • Password (password box editor type) (type: string): the mailbox username's password.
  • Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
  • Server Name (text box editor type) (type: string): the IBM Notes server name to connect to. 
  • Username (text box editor type) (type: string): the username for IBM Notes authentication.

The Read Only Output variable are the possible output values that the activity will provide:

  • Connection  (type: object): outputs a IBM Notes connection. The Output of this activity should be used as Input for all Connection parameters used for all activities placed under IBM Notes category..
 

Execution:

  • the activity will create a connection to the given server, using the provided credentials.


Create Document

This activity creates a new IBM Notes document. 

Activity Parameters

The Create Document activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • City (text box editor control) (type: string): the city of the person that the document will represent.
  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Content (text box editor type) (type: string): the actual content of the newly created Notes document. 
  • Database (text box editor type) (type: string): the IBM Notes database that the document will be related to.
  • EMail (text box editor control) (type: string): the document user email.
  • FirstName (text box editor type) (type: string): the First Name of the person that the document will represent.
  • LastName (text box editor type) (type: string): the Last Name of the person that the document will represent.

The Read Only Output variables are the possible output values that the activity will provide:

  • ModifiedDate (type: string): outputs the date of the current document change.
  • New UNID (type: string): outputs the Universal ID of the document, which can later be used as input (document reference) to other activities.
  • Status (type: boolean): outputs the success state of the request.

Execution:

  • the activity will create a new IBM Notes document


Delete Document by UNID

This activity deletes the IBM Notes document with a specified Universal ID.

Activity Parameters

The Delete Document by UNID activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database that the document is related to.
  • UNID (text box editor type) (type: string): the Universal ID of the document to be deleted.

The Read Only Output variables are the possible output values that the activity will provide:

  • Status (type: boolean): outputs the success state of the request.

Execution:

  • the activity will delete the IBM Notes document that has the specified UNID.


Disconnect from IBM Notes

This activity disconnects from IBM notes account.

Activity Parameters

The Disconnect from IBM Notes activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.



Get Contacts By UNID

This activity gets all contacts from entry using UID. 

Activity Parameters

The Get Contacts By UNID activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database to return contacts from. 
  • UNID (text box editor type) (type: string): the UNID to return contacts from. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Company Names (type: list<string>): outputs a list of company names.
  • Hrefs (type: list<string>): outputs a list of hrefs for the specified entry.
  • Servers (type: list<string>): outputs a list of servers.
  • Status (type: boolean): outputs the status for the IBM Notes request.  
  • UNIDs (type: list<string>): outputs a list of UNIDs for the specified contact.
  • Users (type: list<string>): outputs a list of users.
 


In order to extract the values from the output collections (in our case the output is a List(Of String) ), For Each activity should be used to iterate through the entire list and extract all elements OR Get Element From Collection activity to extract a specific element using index: OR   


Execution:

  • the activity will return a list of contacts and extra information using the provided input.


Get Document By UNID

This activity gets a document by UNID. 

Activity Parameters

The Get Document By UNID activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM notes database to return the document info from. 
  • UNID (text box editor type) (type: string): the UNID. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Created (type: string): outputs the IBM notes document created date.
  • Machine (type: string): outputs the IBM notes document machine.
  • MailServer (type: string): outputs the IBM notes document mailserver.
  • Modified (type: string): outputs the IBM notes document modified date.
  • Owner (type: string): outputs the IBM notes document owner.
  • Platform (type: string): outputs the IBM notes document platform.
  • Status (type: boolean): outputs the status for the IBM notes request.
 


Execution:

  • the activity will return a list of information about a specified IBM Notes document.



Get Documents By UNID

This activity gets all documents from the IBM notes database. 

Activity Parameters

The Get Documents activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database to return documents from. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Changes (type: list<string>): outputs a list of date changes for the entry. 
  • Status (type: boolean): outputs the status for the IBM notes request.
  • UNIDS (type: list<string>): outputs a list of UNIDs for each document. 

In order to extract the values from the output collections (in our case the output is a List(Of String) ), For Each activity should be used to iterate through the entire list and extract all elements OR Get Element From Collection activity to extract a specific element using index: OR   

 


Execution:

  • the activity will return a list of all documents found in the specified IBM Notes database.

 

Get Entries

This activity gets all entries from the database. 

Activity Parameters

The Get Entries activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database to return entries from. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Changes (type: list<string>): outputs a list of date changes for entry.
  • Hrefs (type: list<string>): outputs a list of hrefs for the specified entry.
  • Status (type: boolean): outputs the status for the IBM Notes request.  
  • UNIDs (type: list<string>): outputs a list of UNIDs for entry.
  • Titles (type: list<string>): outputs a list of every title.
 


In order to extract the values from the output collections (in our case the output is a List(Of String) ), For Each activity should be used to iterate through the entire list and extract all elements OR Get Element From Collection activity to extract a specific element using index: OR   


Execution:



Get Mail Content By UNID

This activity gets mail content by UNID from the specified database. 

Activity Parameters

The Get Mail Content By UNID activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database to return mail info from. 
  • UNID (text box editor type) (type: string): the Universal D. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Content Type (type: list<string>): outputs the email content type list.
  • Data (type: list<string>): outputs the email content.
  • From (type: string): outputs the from email.
  • Received Date (type: string): outputs the received date.
  • Status (type: boolean): outputs the status for the IBM Notes request.  
  • Subject (type: string): outputs the mail subject.
 


In order to extract the values from the output collection (in our case the output is a List(Of String) ), For Each activity should be used to iterate through the entire list and extract all elements OR Get Element From Collection activity to extract a specific element using index: OR   


Execution:


Get Mails

This activity gets all mails from database. 

Activity Parameters

The Get Mails activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database to return mails from. 

The Read Only Output variable are the possible output values that the activity will provide:

  • From (type: list<string>): outputs a list of mails FROM.
  • Received Date (type: list<string>): outputs a list of mail dates.
  • Status (type: boolean): outputs the status for the IBM Notes request.  
  • Subject (type: list<string>): outputs a list of mail subjects.
  • UNIDs (type: list<string>): outputs a list of unids for each email.
 


In order to extract the values from the output collection (in our case the output is a List(Of String) ), For Each activity should be used to iterate through the entire list and extract all elements OR Get Element From Collection activity to extract a specific element using index: OR   


Execution:


Get View

This activity gets information about IBM Notes view. 

Activity Parameters

The Get View activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): the IBM Notes database.
  • View (text box editor type) (type: string): the IBM Notes view. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Status (type: boolean): outputs the status for the IBM Notes request.  
  • Users (type: list<string>): outputs a list of users for the specified account and view.
 


In order to extract the values from the output collection (in our case the output is a List(Of String) ), For Each activity should be used to iterate through the entire list and extract all elements OR Get Element From Collection activity to extract a specific element using index: 


Execution:


Set Database Rights 

This activity sets database rights for a user. 

Activity Parameters

The Set Database Rights activity parameters can be provided by manual inserted values or via IN arguments or variables:


Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Database (text box editor type) (type: string): enter the IBM Lotus Notes database name. E.g. 'notes.nsf'.
  • Remove User (text box editor type) (type: string): enter the user name which you want to delete. The hierarchical name of the user in canonical or abbreviated form. The username might be composed by: First name, Middle Name, Last Name / Organisation / ValutID Name. E.g. 'Joe John Doe / Flowster/ORG'. 
  • User Password (password box editor control) (type: string): enter the password for the IBM Notes user provided. 
  • User Password Binding (text box editor control) (type: string): bind to a variable containing the encrypted password for the IBM Notes user Server provided. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Studio Portal). 
  • User Privilege (combobox editor control) (type: string): set user privilege type: Author, Depositor, Designer, Editor, Manager , No Access, Reader.
  • Username (text box editor control) (type: string): enter the user which you want to set privileges . E.g. 'demouser'. 

The Read Only Output variables are the possible output values that the activity will provide:

  • Result (type: string): outputs the operation result: true or false. 


Remove Mailbox

This activity removes user mailbox and deletes the person from Domino Administrator. This activity can be executed only if Lotus Domino is installed on machine. 

Activity Parameters

The Remove Mailbox activity parameters can be provided by manual inserted values or via IN arguments or variables:


Parameters:

  • Connection (text box editor control) (type: object): the IBM Notes connection object. It can only be obtained as output from the Connect to IBM Notes activity.
  • Deny Group (text box editor type) (type: string): enter the name of the deny group. The name of an existing group of type 'Deny List Only' to which the name of the deleted user is added. The empty string means do not add the user name to any group but delete instead.  
  • Remove User (text box editor type) (type: string): enter the user name which you want to delete. The hierarchical name of the user in canonical or abbreviated form. The username might be composed by: First name, Middle Name, Last Name / Organisation / ValutID Name. E.g. 'Joe John Doe / Flowster/ORG'. 
  • Server Password (password box editor control) (type: string): enter the password for the IBM Server provided. 
  • Server Password Binding (text box editor control) (type: string): bind to a variable containing the encrypted password for the IBM Server provided. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Studio Portal). 

The Read Only Output variables are the possible output values that the activity will provide:

  • Result (type: string): outputs the operation result: true or false. 

Related content

Exchange
Exchange
Flowster Studio Activity Library
More like this
AutoKAS
AutoKAS
Flowster Studio Activity Library
More like this
Administration
Administration
Flowster Studio Activity Library
More like this
SMTP
SMTP
Flowster Studio Activity Library
More like this
SalesForce
SalesForce
Flowster Studio Activity Library
More like this
Certificate Management
Certificate Management
Flowster Studio Activity Library
More like this