| Step Details | |
| Introduced in Version | 4.0.0 |
| Last Modified in Version | 7.12.0 |
| Location | Integration > Exchange Web Services |
The Search Exchange Contacts step retrieves all contact data that matches the search string specified.
Prerequisites
- This Step requires the Exchange Web Services module to be installed before it will be available in the toolbox.
- A dependency must be created after installing the module in order for the Steps to be properly used.
Properties
Inputs
| Property | Description | Data Type |
|---|---|---|
| Exchange Server | Server and authentication to use. | ExchangeServerDefinition |
| Offset | The number of results to skip. Use 0 to retrieve results from the start of the results. This parameter is used to allow pages of results to be retrieved. | Int32 |
| Page Size | The maximum number of results to return. | Int32 |
| Search String | Text to search for in the Contacts list. | String |
Outputs
| Property | Description | Data Type |
|---|---|---|
| Output | List of the Exchange Contacts that match the input criteria. | List of ExchangeContact |
Example Inputs and Outputs
| Exchange Server | Offset | Page Size | Output |
|---|---|---|---|
| [Exchange Server] | 0 | 5 | 0: Contact 1 1: Contact 2 2: Contact 3 3: Contact 4 4: Contact 5 |
| [Exchange Server] | 3 | 3 | 0: Contact 4 1: Contact 5 2: Contact 6 |
Common Errors
The Parameter QueryString is Only Valid for Exchange Server Version Exchange2010 or Later.
If the inputted exchange server version is earlier than Exchange2010, the step will cause an error.
To correct this, update the desired exchange server to version Exchange2010 or later or use a preexisting exchange server already running Exchange2010 or later.
Exception Message:
DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Search Exchange Contacts 1[SearchExchangeContacts] in flow [Step Library Flow]: Exception invoking method SearchExchangeContacts on class ContactSteps ---> DecisionsFramework.LoggedException: Exception invoking method SearchExchangeContacts on class ContactSteps ---> System.Exception: Search Exchange Contacts error. SearchString: person. ---> System.AggregateException: One or more errors occurred. (The parameter queryString is only valid for Exchange Server version Exchange2010 or a later version.) ---> Microsoft.Exchange.WebServices.Data.ServiceVersionException: The parameter queryString is only valid for Exchange Server version Exchange2010 or a later version.
at Microsoft.Exchange.WebServices.Data.FindRequest`1.Validate()
at Microsoft.Exchange.WebServices.Data.ServiceRequestBase.ValidateAndEmitRequest()
at Microsoft.Exchange.WebServices.Data.SimpleServiceRequestBase.InternalExecuteAsync()
at Microsoft.Exchange.WebServices.Data.MultiResponseServiceRequest`1.ExecuteAsync()
at Microsoft.Exchange.WebServices.Data.ExchangeService.FindItems(FolderId parentFolderId, String queryString, ViewBase view)
--- End of inner exception stack trace ---
at System.Threading.Tasks.Task.ThrowIfExceptional(Boolean includeTaskCanceledExceptions)
at System.Threading.Tasks.Task`1.get_Result()
at Decisions.Exchange.ContactSteps.SearchExchangeContacts(ExchangeServerDefinition ExchangeServer, String SearchString, Int32 PageSize, Int32 Offset)
--- End of inner exception stack trace ---
at Decisions.Exchange.ContactSteps.SearchExchangeContacts(ExchangeServerDefinition ExchangeServer, String SearchString, Int32 PageSize, Int32 Offset)
at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
at System.Reflection.MethodBaseInvoker.InvokeDirectByRefWithFewArgs(Object obj, Span`1 copyOfArgs, BindingFlags invokeAttr)
--- End of inner exception stack trace ---
at DecisionsFramework.Design.Flow.StepImplementations.InvokeMethodStep.Run(StepStartData data)
at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData)
at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
--- End of inner exception stack trace ---Related Information