Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 39 Next »

Activities



Connect to Office365

This activity connects to the specified Office365 account and outputs a Office365 client connection.

Activity Parameters

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

Parameters:

  • Office365 User (text box control) (type: string): here should be given a valid Office365 account. For example, "Tester@FlowsterSolutions.onmicrosoft.com".
  • Password (password editor type) (type: string): the password for the Office365 username provided.
  • Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the Office365. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Studio Portal).

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

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






Create Account and Mailbox

This activity create a new Office365 account to an existing license subscription. Licensing user accounts in Office 365 is an important step, because users can't use any Office 365 services until their account has been licensed.


In order to use this activity there are some requirements that needs to be checked on the machine where it will be executed:

  • installation of Microsoft Online Services Sign-In Assistant for IT Professional
  • installation of Azure Active Directory Module for Windows Powershell


NOTE: if necessary, copy the folders called MSOnline and MSOnline Extended from the source C:\Windows\System32\WindowsPowerShell\v1.0\Modules\ to the folder C:\Windows\SysWOW64\WindowsPowerShell\v1.0\Modules\

Activity Parameters

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

Parameters:

  • Connection (text box editor type) (type: object): this parameter is the Output from the Connect To Office365 activity.
  • First Name (text box control) (type: string): the First Name for the new Office365 account. For example, "Flowster".
  • Last Name (text editor type) (type: string): the Last Name for the new Office365 account. For example, "DemoUser".
  • License Subscription (text editor type) (type: string): the type of the License Subscription at which the new account will be added. The license selected should accept the creation of a new mailbox, or else the activity will not be executed. As an example, "FlowsterSolutions:O365_BUSINESS_PREMIUM". For a list with all valid licenses use the Connect-MsolService and the Get-MsolAccountSku commands from PowerShell. The Get-MsolAccountSku returns all the available licensing plans and the number of available licenses in each plan in your organization:



  • Password (password editor type) (type: string): the password for the new Office365 account. The password must be between 8 - 16 characters long, using characters and a number or a symbol (for example Welcome2016!).
  • Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the new Office365 account. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Studio Portal).
  • Usage Location (text editor type) (type: string): the new Office365 account's usage location and must be set to a valid ISO 3166-1 alpha-2 country code. For example, US for the United States, and DE for Germany. For more details regarding the country codes, you can consult the table at https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Current_codes.
  • User Display Name (text editor type) (type: string): the Display Name for the new Office365 account.
  • User Principal Name (text editor type) (type: string): the User Principal Name (UPN) for the new Office365 account. The User Principal Name (UPN) is the name of a system user in an e-mail address format. The user name (or "username") is followed by the "@" followed by the name of the Internet domain with which the user is associated.


Execution: the activity will check if the license inserted is a valid one and if it allows creating an user account with a mailbox. If yes, it will create the account with the provided information. If the license is not a valid one, the activity will mention that the access is denied.







Create Calendar 

This activity creates a calendar for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Name (text box editor type) (type: string): the Calendar name that will be created for the connected Office365 account.


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

  • Output Calendar (type: CalendarValue): outputs the new created calendar..
 


Execution: the activity will create a new calendar with the given name and will output its ID:


The calendar can be seen on the Office365 logged in account:







Create Calendar Group

This activity creates a calendar group for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Name (text box control) (type: string): the Calendar Group name that will be created for the connected Office365 account.

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

  • Output Calendar Group (type: CalendarGroupValue): outputs the new created calendar Group.
 


Execution: the activity will create a new calendar group with the given name and will output its ID:


The calendar group can be seen on the Office365 logged in account:







Create Contact

This activity creates a contact for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Business Phone (text box control) (type: string): the Contact Business Phone for the new contact.
  • Company Name (text box control) (type: string): the Contact Company Name for the new contact.
  • Department (text box control) (type: string): the Contact Department for the new contact.
  • Email Address (text box control) (type: string): the Contact Email Address for the new contact.
  • Given Name (text box control) (type: string): the Contact Given Name for the new contact.
  • Job Title (text box control) (type: string): the Contact Job Title for the new contact.
  • Middle Name (text box control) (type: string): the Contact Middle Name for the new contact.
  • Nickname (text box control) (type: string): the Contact Nick Name for the new contact.
  • Office Location (text box control) (type: string): the Contact Office Location for the new contact.
  • Surname (text box control) (type: string): the Contact surname for the new contact.


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

  • Output Contact (type: ContactRequest): outputs the new created contact.
 


Execution: the activity will create a new contact with the given properties:


The new contact can be seen on the Office365 logged in account:








Create Event

This activity creates an event for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Content (text box control) (type: string): the content of the new event. This content will be also the body of the email that will be sent to the organizer's address. 
  • Email Address (text box control) (type: string): the Event Organizer Email Address, where the event information will be sent to.
  • End (text box control) (type: string): the Event End DateTime. Manually insert the date (in the "DD/MM/YYYY hh:mm:ss" format) or select it by clicking the  button.
  • Organizer Name (text box control) (type: string): the Event Organizer Name.
  • Start (text box control) (type: string): the Event Start DateTime. Manually insert the date (in the "DD/MM/YYYY hh:mm:ss" format) or select it by clicking the  button.
  • Subject (text box control) (type: string): the Event Subject. This will be also the subject of the email that will be sent to the organizer's address. 


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

  • Output Event (type: Events): outputs the created event.
 


Execution: the activity will create the event with the given information:








Delete Calendar

This activity deletes a calendar from a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Input Calendar (text box control) (type: CalendarValue): the Input Calendar. This field can be bound to the output variable of the Find Calendar activity.

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

  • Output Status (type: boolean): outputs the operation status.
 






Delete Calendar Group

This activity deletes a calendar from a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Input Calendar (text box control) (type: CalendarValue): the Input Calendar Group. This field can be bound to the output variable of the Find Calendar Group activity.

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

  • Output Status (type: boolean): outputs the operation status.





 



Delete Contact

This activity delete a contact from a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Input Contact (text box control) (type: Contact): the Input Contact. This field can be bound to the output variable of the Find Contact activity.

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

  • Output Status (type: boolean): outputs the operation status.





 


Delete Event

This activity deletes an event from a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Input Event (text box control) (type: Events): the Input Event. This field can be bound to the output variable of the Find Event activity.

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

  • Output Status (type: boolean): outputs the operation status.





 


Delete Message

This activity deletes a message from a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Input Message (text box control) (type: Message): the Input Message. This field can be bound to the output variable of the Find Message activity.

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

  • Output Status (type: boolean): outputs the operation status.
 





Find Calendar

This activity finds calendar by name for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Name (text box control) (type: string): the name of the Calendar that needs to be retrieved.

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

  • Output Calendar (type: CalendarValue): outputs the Calendar found. This output can be used as an Input value for the Delete Calendar activity.
 


Execution: the activity will search after the given Calendar name. If found, will output the calendar's name and ID:







Find Calendar Group

This activity finds calendar by name for a specified Office365 Account.

Activity Parameters

The Find Calendar Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Name (text box control) (type: string): the name of the Calendar Group that needs to be retrieved.

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

  • Output Calendar Group (type: CalendarGroupValue): outputs the Calendar Group found. This output can be used as an Input value for the Delete Calendar Group activity.
 


Execution: the activity will search after the given Calendar Group name. If found, will output the calendar group's name and ID:







Find Contact

This activity finds Contact by Email Address.

Activity Parameters

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

Parameters:

  • Contact Email Address (text box control) (type: string): the Contact Email address for the contact that needs to be retrieved.

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

  • Output Contact (type: Contact): outputs the Contact found. This output can be used as an Input value for the Delete Contact activity.
 


Execution: the activity will search for a contact that has assigned the given Email Address. If found, will output the contact's information:









Find Event

This activity finds event by date for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Selected Date (text box control) (type: string): the Event's selected date.

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

  • Output Event (type: Events): outputs the Event found. This output can be used as an Input value for the Delete Event activity.
 







Find Message

This activity finds last message by Email Address, ordered by date time.

Activity Parameters

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

Parameters:

  • Email Address (text box control) (type: string): the Last Message by a specified Email Address.

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

  • Output Message (type: Message): outputs the Message found. This output can be used as an Input value for the Delete Message activity.
 


Execution: the activity will search for messages for the given account and if found, will output them with their properties:








Get Calendar Groups

This activity get calendar groups for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Connection (text box control) (type: object): the Offce365 connection.

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

  • Output Calendar Groups (type: List<CalendarGroupValue>): outputs a list of all found Calendar Groups.
 


Execution: the activity will search all the calendar groups for the connected Office365 account. If any found, their name and ID will be outputted (for example, the My Calendars, Other Calendars and FlowsterGroup calendar groups):







Get Calendars

This activity gets calendars for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Connection (text box control) (type: object): the Offce365 connection.

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

  • Output Calendars (type: List<CalendarValue>): outputs a list of all found Calendars.
 


Execution: the activity will search all the calendars for the connected Office365 account. If any found, their name and ID will be outputted (for example, the CalendarUnited States HolidaysBirthdays and Flowster_February calendars):







Get Contacts

This activity gets contacts for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Connection (text box control) (type: object): the Offce365 connection.

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

  • Connection (type: List<Contact>): outputs a list of all found Contacts.
 


Execution: the activity will search all the contacts for the connected Office365 account. If any found, they will be outputted with all their information (for example, the FlowsterUser contact):







Get Events

This activity get events for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Connection (text box control) (type: object): the Offce365 connection.

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

  • Output Events (type: List<Events>): outputs a list of all found Events.
 


Execution: the activity will search all the events for the connected Office365 account. If any found, they will be outputted with all their information:






Get Messages

This activity gets messages for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Connection (text box control) (type: object): the Office365 connection.

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

  • Output Messages (type: List<Messages>): outputs a list of all found Messages.
 


Execution: the activity will search all the messages for the connected Office365 account. If any found, they will be outputted with all their information:









Reply To Message

This activity replies to a message received.

Activity Parameters

The Reply to Message activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Input Message (text box control) (type: Message): the Input message. For a much easier usage, this field can be bound to an output variable from the Find Message activity or to an Iterator from the collection outputted by the Get Messages activity.
  • Reply Message (text box control) (type: string): the Reply message.

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

  • Output Status of Reply (type: boolean): outputs the reply status.







Send Email

This activity sends an Office365 Email.

Activity Parameters

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

Parameters:

  • Message (text box control) (type: string): the E-mail body.
  • Recipients (text box control) (type: string): the email Recipients, with ';' separator. For example, "demo@fmrp.intern" for single recipient or "demo@fmrp.intern;flowster@flowster.de" for multiple recipients,
  • Subject (text box control) (type: string): the Email subject.

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

  • Output Status (type: boolean): outputs the Send Email status.

Execution: the activity will send an e-mail with the given body (Message field) and subject (Subject field) to the provided recipient(s):





 


Update Calendar

This activity updates a calendar for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Calendar Name (text box control) (type: string): the Calendar new name.
  • Input Calendar (text box control) (type: string or CalendarValue): the Input Calendar. For a much easier usage, this variable can be bound to an output variable from the Find Calendar activity.

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

  • Output Calendar (type: CalendarValue): outputs the updated Calendar.
 


Execution: the activity will send an e-mail with the given body (Message field) and subject (Subject field) to the provided recipient(s):


The updated calendar can be seen on the Office365 logged in account:








Update Contact

This activity updates a contact for a specified Office365 Account. There can be updated only one information, or multiple information, but it is not mandatory to update all information.

Activity Parameters

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

Parameters:

  • Business Phone (text box control) (type: string): the new Business Phone.
  • Company Name (text box control) (type: string): the new Company Name.
  • Department (text box control) (type: string): the new Department name.
  • Email Address (text box control) (type: string): the new Email Address.
  • Given Name (text box control) (type: string): the new Given Name.
  • Input Contact (text box control) (type: string): the Input Contact that will be updated. For a much easier usage, this field can be bound to the output variable of the Find Contact activity. If multiple contacts are need to be updated, the field can be bound to an Iterator from the output collection of the Get Contacts activity.
  • Job Title (text box control) (type: string): the new Job Title.
  • Middle Name (text box control) (type: string): the new Middle Name.
  • Office Location (text box control) (type: string): the new Office Location.
  • Surname (text box control) (type: string): the new Surname.

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

  • Output Contact (type: ContactRequest): outputs the updated Contact.
 


Execution: the activity will update the given contact's information according to the new provided values. Except Office365 Connection and Input Contact, all other parameters are optional. There can be modified a single information, multiple information or all information. In our example there will be updated only the Department, Job Title and Surname attributes.







Update Message

This activity updates a message for a specified Office365 Account.

Activity Parameters

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

Parameters:

  • Input Message (text box control) (type: Message): the input message. For a much easier usage, this field can be bound to the output variable of the Find Message activity or to an iterator from the collection output from the Get Messages activity.
  • Is Read (combo box control) (type: string): sets if the message is Read or not. Flowster Studio provides Yes and No as options.
  • Message Category (text box editor type) (type: string): the Message category, if this is set from the Office365 account. These categories can be set from Office365 account. For example, some of the default categories provided by Office365 are:

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

  • Output Message (type: Message): outputs the updated message.
  • No labels