Exchange/Graph - Revision history

Jkuehlthau at 22:17, 30 April 2026

2026-04-30T22:17:09Z

← Older revision		Revision as of 22:17, 30 April 2026
Line 1:		Line 1:
	=Overview=		=Overview=
	The "Exchange/Graph" connector is based on a driver from https://www.cdata.com/ and uses Microsoft's newer Graph REST API, https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/office-365-rest-apis-for-mail-calendars-and-contacts. Helpful documentation for using the "Exchange/Graph" connector can be found here: ~~http~~://cdn.cdata.com/help/~~CEC~~/ado/~~pg_alltables~~.htm.		The "Exchange/Graph" connector is based on a driver from https://www.cdata.com/ and uses Microsoft's newer Graph REST API, https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/office-365-rest-apis-for-mail-calendars-and-contacts. Helpful documentation for using the "Exchange/Graph" connector can be found here: https://cdn.cdata.com/help/CEM/ado/default.htm.

	When connecting Starfish to your Exchange server, if the Exchange Server requires approval from an administrator, Starfish will NOT handle this well. You will fill out a form with information about why you are requesting access, then click the Request Access button. Exchange will then give you a confirmation screen with a button to Return to the App. When you click Return to App, Starfish will show an error. Surf back to https://cartographer.cloud/. Once an admin approves the request, you can try to authenticate again. Note that once it took several days after the admin approved the request before I could successfully authenticate. I do not know why this happened.		When connecting Starfish to your Exchange server, if the Exchange Server requires approval from an administrator, Starfish will NOT handle this well. You will fill out a form with information about why you are requesting access, then click the Request Access button. Exchange will then give you a confirmation screen with a button to Return to the App. When you click Return to App, Starfish will show an error. Surf back to https://cartographer.cloud/. Once an admin approves the request, you can try to authenticate again. Note that once it took several days after the admin approved the request before I could successfully authenticate. I do not know why this happened.

Jkuehlthau: /* Overview */

2024-07-05T16:57:45Z

Overview

← Older revision		Revision as of 16:57, 5 July 2024
Line 1:		Line 1:
	=Overview=		=Overview=
	The "Exchange/Graph" connector is based on a driver from https://www.cdata.com/ and uses Microsoft's newer Graph REST API, https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/office-365-rest-apis-for-mail-calendars-and-contacts. Helpful documentation for using the "Exchange/Graph" connector can be found here: http://cdn.cdata.com/help/CEC/ado/pg_alltables.htm.		The "Exchange/Graph" connector is based on a driver from https://www.cdata.com/ and uses Microsoft's newer Graph REST API, https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/office-365-rest-apis-for-mail-calendars-and-contacts. Helpful documentation for using the "Exchange/Graph" connector can be found here: http://cdn.cdata.com/help/CEC/ado/pg_alltables.htm.

			When connecting Starfish to your Exchange server, if the Exchange Server requires approval from an administrator, Starfish will NOT handle this well. You will fill out a form with information about why you are requesting access, then click the Request Access button. Exchange will then give you a confirmation screen with a button to Return to the App. When you click Return to App, Starfish will show an error. Surf back to https://cartographer.cloud/. Once an admin approves the request, you can try to authenticate again. Note that once it took several days after the admin approved the request before I could successfully authenticate. I do not know why this happened.

	=Origin=		=Origin=

Jkuehlthau: /* Retrieving Attachments */

2024-06-12T23:48:09Z

Retrieving Attachments

← Older revision		Revision as of 23:48, 12 June 2024
Line 67:		Line 67:
	To retrieve attachments from an email, you must perform a SmartLookupDT to the DownloadAttachments "table". This code will give you an example of retrieving the attachments and then using the data returned.		To retrieve attachments from an email, you must perform a SmartLookupDT to the DownloadAttachments "table". This code will give you an example of retrieving the attachments and then using the data returned.

	Note that the Connector returns a field called "hasAttachments". This field is ~~broken~~ and ~~should be ignored. It~~ only shows as True when there is one or more attachment(s) attached. If there are only embedded images, hasAttachment shows as False. So, we need to query for attachments and then check to see if any were returned.		Note that the Connector returns a field called "hasAttachments". This field is provided as is from Exchange and only shows as True when there is one or more attachment(s) attached. If there are only embedded images, hasAttachment shows as False. So, we need to query for attachments and then check to see if any were returned.
	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
	dtAttachments = Starfish.SmartQueryDT("DownloadAttachments", "AttachmentSource='Message' AND SourceId='" + Starfish.OriginData["ID"].ToString() + "' AND userId='bb8f5190-bcd2-4a9a-a1b2-e7a9c7512865'", "", "ORIGIN");		dtAttachments = Starfish.SmartQueryDT("DownloadAttachments", "AttachmentSource='Message' AND SourceId='" + Starfish.OriginData["ID"].ToString() + "' AND userId='bb8f5190-bcd2-4a9a-a1b2-e7a9c7512865'", "", "ORIGIN");

Jkuehlthau: /* Retrieving Attachments */

2024-06-12T20:29:04Z

Retrieving Attachments

← Older revision		Revision as of 20:29, 12 June 2024
Line 65:		Line 65:

	==Retrieving Attachments==		==Retrieving Attachments==
	To retrieve attachments from an email, you must perform a ~~SmartLookup~~ and ~~pass in~~ the ~~attachment's ID~~. Note that the ~~origin~~ field, ~~@@ORG:AttachmentId@@~~, ~~will sometimes contain an array of IDs~~, ~~so you must always do a Split on the Attachment Id~~ (~~comma~~-~~seperated list~~) ~~and~~ loop through for ~~each id~~. ~~The SmartLookup will return the attachment as a Base64 string~~.		To retrieve attachments from an email, you must perform a SmartLookupDT to the DownloadAttachments "table". This code will give you an example of retrieving the attachments and then using the data returned.
	~~<syntaxhighlight lang=~~"vb">
	~~Sub VBScriptProcedure~~		Note that the Connector returns a field called "hasAttachments". This field is broken and should be ignored. It only shows as True when there is one or more attachment(s) attached. If there are only embedded images, hasAttachment shows as False. So, we need to query for attachments and then check to see if any were returned.
	~~Logmessage SmartLookup~~("~~GetAttachment~~", "~~Content~~", "~~@@ORG:AttachmentId@@~~")		<syntaxhighlight lang="csharp">
	~~End Sub~~		dtAttachments = Starfish.SmartQueryDT("DownloadAttachments", "AttachmentSource='Message' AND SourceId='" + Starfish.OriginData["ID"].ToString() + "' AND userId='bb8f5190-bcd2-4a9a-a1b2-e7a9c7512865'", "", "ORIGIN");

			//Check if any attachments exist. If yes, go to Insert Temp File stage.
			if (dtAttachments.Rows.Count>0)
			{
			//If desired, loop through and log all attachments for testing purposes.
			/*for (int index = 0; index < dtAttachments.Rows.Count; index++)
			{
			foreach (DataColumn column in dtAttachments.Columns)
			{
			Starfish.LogMessage(ConvertObj2String(dtAttachments.Rows.Count) + "; " + column.ColumnName + ": " + ConvertObj2String(dtAttachments.Rows[index][column.ColumnName]));
			}
			}*/
			//Starfish.LogMessage("Att Cnt: " + dtAttachments.Rows.Count.ToString());

			//If an attachment was found, go to the stage that will process the first attachment. If no attachment was found, do nothing as the job will automatically end if we have previously used the GotoStage function.
			Starfish.GotoStage("Insert Temp File");
			//OR if I want to do something with the attachment right here, I would use something like this code. In my case, I use this in my "Insert Temp File" stage.
			//var res = dtAttachments.Rows[ca]["ContentBytes"].ToString();
			//return Starfish.ConvertBase64ToBytes(res);
			}
	</syntaxhighlight>		</syntaxhighlight>
	~~Attachment Names are also stored in an array: @@ORG:AttachmentName@@. You will need to process this array to get the attachment names.~~
	==Update/Insert Stages==		==Update/Insert Stages==
	In order to run Update/Insert Stages you MUST do a few things.		In order to run Update/Insert Stages you MUST do a few things.

Jkuehlthau: /* Overview */

2024-06-12T20:21:04Z

Overview

← Older revision		Revision as of 20:21, 12 June 2024
Line 1:		Line 1:
	=Overview=		=Overview=
	The "Exchange ~~(NEW)~~" connector is based on a driver from https://www.cdata.com/. Helpful documentation for using the "Exchange ~~(v2)~~" connector can be found here: http://cdn.cdata.com/help/CEC/ado/pg_alltables.htm.		The "Exchange/Graph" connector is based on a driver from https://www.cdata.com/ and uses Microsoft's newer Graph REST API, https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/office-365-rest-apis-for-mail-calendars-and-contacts. Helpful documentation for using the "Exchange/Graph" connector can be found here: http://cdn.cdata.com/help/CEC/ado/pg_alltables.htm.

	=Origin=		=Origin=

Jkuehlthau: Jkuehlthau moved page Exchange (v2) to Exchange/Graph

2024-06-12T20:19:33Z

Jkuehlthau moved page Exchange (v2) to Exchange/Graph

← Older revision	Revision as of 20:19, 12 June 2024
(No difference)

Jkuehlthau: /* Move Email To A Different Folder */

2019-11-07T22:25:30Z

Move Email To A Different Folder

← Older revision		Revision as of 22:25, 7 November 2019
Line 60:		Line 60:
	#ItemChangeKey - Note that if Exchange is your Origin and you "Use Origin Connector" for your stage, you will have this values in your origin. If not: [[Exchange_(v2)#Example_Function_to_retrieve_the_ItemChangeKey\|ItemChangeKey]]		#ItemChangeKey - Note that if Exchange is your Origin and you "Use Origin Connector" for your stage, you will have this values in your origin. If not: [[Exchange_(v2)#Example_Function_to_retrieve_the_ItemChangeKey\|ItemChangeKey]]
	#FolderDisplayName - The name of the folder to move the email to.		#FolderDisplayName - The name of the folder to move the email to.

			==Delete Email==
			Create a stage that DELETES to the folder you want to delete from. Match on the ItemId and ItemChangeId.

	==Retrieving Attachments==		==Retrieving Attachments==

Jkuehlthau: /* Calendar_RequiredAttendees */

2018-03-20T17:21:54Z

Calendar_RequiredAttendees

← Older revision		Revision as of 17:21, 20 March 2018
Line 53:		Line 53:
	You can only INSERT into this "table". Simply supply the Email (Address) and (Display) Name of the Calendar Invitee and the Exchange Calendar's ItemId.		You can only INSERT into this "table". Simply supply the Email (Address) and (Display) Name of the Calendar Invitee and the Exchange Calendar's ItemId.

	Optionally, you can populate the SendMeetingInvitations "field". The allowed values are SendToNone, SendOnlyToAll, and SendToAllAndSaveCopy. The default is SendToNone. NOTE: You can either send no one OR send to every person invited to the meeting. We have to add people one at a time, so if a meeting has four attendees, it invites the first person 4 times, the second person 3 times, the third person 2 times and the last person 1 time. If you want to send invites, you're going to have to somehow set the SendMeetingInvitations "field" on the LAST invitee for that meeting. If anyone is added to the Calendar item at a later date, all attendees will get an update. There is no way to send only to the ~~currently~~ added Attendee.		Optionally, you can populate the SendMeetingInvitations "field". The allowed values are SendToNone, SendOnlyToAll, and SendToAllAndSaveCopy. The default is SendToNone. NOTE: You can either send no one OR send to every person invited to the meeting. We have to add people one at a time, so if a meeting has four attendees, it invites the first person 4 times, the second person 3 times, the third person 2 times and the last person 1 time. If you want to send invites, you're going to have to somehow set the SendMeetingInvitations "field" on the LAST invitee for that meeting. If anyone is added to the Calendar item at a later date, all attendees will get an update. There is no way to send only to the newly added Attendee.

	==Move Email To A Different Folder==		==Move Email To A Different Folder==

Jkuehlthau: /* Mapping */

2018-03-20T17:21:44Z

Mapping

← Older revision		Revision as of 17:21, 20 March 2018
Line 50:		Line 50:

	=Mapping=		=Mapping=
			==Calendar_RequiredAttendees==
			You can only INSERT into this "table". Simply supply the Email (Address) and (Display) Name of the Calendar Invitee and the Exchange Calendar's ItemId.

			Optionally, you can populate the SendMeetingInvitations "field". The allowed values are SendToNone, SendOnlyToAll, and SendToAllAndSaveCopy. The default is SendToNone. NOTE: You can either send no one OR send to every person invited to the meeting. We have to add people one at a time, so if a meeting has four attendees, it invites the first person 4 times, the second person 3 times, the third person 2 times and the last person 1 time. If you want to send invites, you're going to have to somehow set the SendMeetingInvitations "field" on the LAST invitee for that meeting. If anyone is added to the Calendar item at a later date, all attendees will get an update. There is no way to send only to the currently added Attendee.

	==Move Email To A Different Folder==		==Move Email To A Different Folder==
	Create a stage that INSERTS to the sp_MoveItem "table" (this is really calling a Stored Procedure inside the connector). The table expects 3 things:		Create a stage that INSERTS to the sp_MoveItem "table" (this is really calling a Stored Procedure inside the connector). The table expects 3 things:

Jkuehlthau: /* Additional Connection String Parameters */

2018-03-20T17:16:59Z

Additional Connection String Parameters

← Older revision		Revision as of 17:16, 20 March 2018
Line 47:		Line 47:
	\|Verbosity=x;		\|Verbosity=x;
	\|x=1-5. The verbosity level that determines the amount of detail included in the log file. See http://cdn.cdata.com/help/CEC/ado/RSBExchange_p_Verbosity.htm for what each option logs.		\|x=1-5. The verbosity level that determines the amount of detail included in the log file. See http://cdn.cdata.com/help/CEC/ado/RSBExchange_p_Verbosity.htm for what each option logs.
	\|-
	~~\|SendMeetingInvitations~~
	~~\|The allowed values are SendToNone, SendOnlyToAll, and SendToAllAndSaveCopy. The default is SendToNone. Ex: SendMeetingInvitations=SentOnlyToAll;~~
	\|}		\|}