1. To-Increase Dynamics 365 for Finance & Operations
  2. Connectivity studio
  3. Deployment

Clean up configuration

You can use this process to clean up your environment. To clean up your environment, you can delete your no-longer-used:

  • Projects
  • Messages
  • Web service actions
  • Documents
  • Outbound queue
  • Staging journals
You can also clean up the history tables and files.
Usually, you do not clean up your environment frequently.
Beware: Cleaning up your environment results in a hard delete of the applicable elements. So, be very careful when you use the clean-up functionality.


Application Consultant Application Consultant Start Start What do you want  to clean up? What do you want  to clean up? Delete project Delete project On the Project page, you cannot delete a project if it is used as a sub project or if it has children, like tasks. However, if such a project is no longer desired, to clean up your environment, you can still delete it. On delete, everything that belongs to the project is deleted.Usually, you do not clean up your projects frequently.Beware: Cleaning up your projects results in a hard delete of the applicable projects. So, be very careful when you use the clean-up functionality. Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Delete project. 2. In the list, find and select the desired project. 3. Click Delete. 4. Click Yes. 5. Close the page. Delete message Delete message On the Message page, you cannot delete a message if it is used or if it has field mappings. A message can be used on, for example, a task, a web service action, or an EDI document flow. However, if such a message is no longer desired, to clean up your environment, you can still delete it. On delete, only the message is deleted.Usually, you do not clean up your messages frequently.Beware: Cleaning up your messages results in a hard delete of the applicable messages. Note that deleting a message has a consequence for the entities where it was used. For example, a web service action cannot run properly until another message is linked. So, be very careful when you use the clean-up functionality. Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Delete message. 2. In the list, find and select the desired message. 3. Click Delete. 4. Click Yes. 5. Close the page. Delete web service action Delete web service action On the Web service action page, you cannot delete a web service action if it is used or if it has attributes or arguments. A web service action can be used on, for example, a task or an EDI document flow. However, if such a web service action is no longer desired, to clean up your environment, you can still delete it. On delete, only the web service action is deleted.Usually, you do not clean up your web service actions frequently.Beware: Cleaning up your web service actions results in a hard delete of the applicable web service actions. Note that deleting a web service action has a consequence for the entities where it was used. For example, an EDI document flow cannot run properly until another web service action is linked. So, be very careful when you use the clean-up functionality. Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Delete web service. 2. In the list, find and select the desired web service action. 3. Click Delete. 4. Click Yes. 5. Close the page. Delete document Delete document On the Document page, you cannot delete a document if it is used on a message or if it has records and fields. However, if such a document is no longer desired, to clean up your environment, you can still delete it. On delete, only the document is deleted.Usually, you do not clean up your documents frequently.Beware: Cleaning up your documents results in a hard delete of the applicable documents. Note that the messages in which the document is used cannot run until another document is linked to the message. So, be very careful when you use the clean-up functionality. Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Delete document. 2. In the list, find and select the desired document. 3. Click Delete. 4. Click Yes. 5. Close the page. Remove connections Remove connections For an Azure file storage connector, you can connect to an Azure file share. To access the Azure file share, you can mount the Azure file share. For most connectors, when a message is run, a connection is made only for the run. After the run the connection ends. However, for an Azure file storage connection with a mounted Azure file share, the connection stays, independent of messages run. When a related message is run or the connection is tested, a check is done, and an error can occur if something has changed. For example, the connector username or password is changed. In this case, the mounted connection to the Azure file share is no longer valid. To reset the mounting, first remove the connection (see steps). The next time, a related message is run, or the connection is tested, the mounting is restored, for example with the proper username or password. Usually, messages are run in batch. If you run a message in batch, you can use a batch group to direct a batch task to another server. If a message runs on another server, the connection also stays on the other server. In case of an error or change, this connection is no longer valid. So also, the connection on the other servers must be removed. For more information, refer to: Use an Azure files share with Windows Batch processing overview Batch processing and batch servers Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Remove connections. 2. In the Connector field, enter or select the connector for which you want to remove the connection. 3. Sub-task: Define batch settings. 4. Expand the Run in the background section. 5. Select Yes in the Batch processing field. 6. In the Batch group field, enter or select the batch group that is used to direct batch tasks to other servers. Note: Make sure to remove the connection from each of the available other servers to which batch tasks are directed. 7. Click OK. Notes You can only use one username and password combination to connect to an Azure Storage account. So, on all connectors that connect to the same Azure Storage account, the same username and password must be used. You can also remove the connection for a specific connector from the Connector page. To do so, on the Action Pane, on the Development tab, click Remove connections. Be careful, removing the connection. Only do so when a connection error occurs. Removing a connection can disrupt running processes in batch jobs. Another way to restore the mounting to the Azure file share is to restart the D365 FO environment. However, usually, this is not acceptable in a production environment. Clean up history tables Clean up history tables Each integration run results in history records. History records can be logged for: Projects Tasks Web service actions Messages Service Bus queues Test cases You can clean up the logged history manually or in recurring mode. For example, you want to keep history records for six months. Each week, you can do a cleanup, deleting history records older than six months. These tables are cleaned up: BisBufferTable BisConHistoryChangeLogTable BisConnectorFileHistoryTable BisConSBReceivedData BisConSBSendData BisFlowActionHistory BisHistory BisHistoryCalculation BisHistoryEntity BisMessageDebugger BisProjectHistory BisTaskHistory BisTestCaseRunResultTable BisTestCaseRunTable BisWsAttributeHistory BisWsHistory BisWsWebRequestHistory BisWsWebRequestHistory Procedure 1. Click Connectivity studio Integration operations. 2. Click Clean up Connectivity studio history tables. 3. In the Project field, enter or select a value. 4. In the Number of days field, select an option. 5. Sub-task: Set up batch processing. 6. Expand the Run in the background section. 7. Select Yes in the Batch processing field and fill in the fields as desired. 8. Click Recurrence and fill in the fields as desired. 9. Click OK. 10. Click OK. 11. Close the page. Clean up outbound queue Clean up outbound queue On processing the outbound queue, for each record, the related message or web service action is run to export the applicable data. A successfully processed outbound queue record gets the status Processed. You can clean up the outbound queue by deleting the records with the status Processed. Procedure 1. Click Connectivity studio Integration operations. 2. Click Outbound message queue. 3. Click Clean up. 4. You can clean up the outbound queue for a specific message. In the Message field, enter or select a value. Note: If you do not define a message or web service action, all outbound queue records (with status Processed) within the defined period are deleted. 5. You can clean up the outbound queue for a specific web service action. In the Web service action field, enter or select a value. Note: If you do not define a message or web service action, all outbound queue records (with status Processed) within the defined period are deleted. 6. In the Number of days field, enter a number. 7. Sub-task: Set up batch processing. 8. Expand the Run in the background section. 9. Select Yes in the Batch processing field and fill in the fields as desired. 10. Click Recurrence and fill in the fields as desired. 11. Click OK. 12. Click OK. Clean up generic staging journal table Clean up generic staging journal table In Connectivity studio, you can use the staging concept to validate data in an intermediate area before it is further processed.One predefined generic staging journal table is available for Connectivity studio: 'BisStagingBufferOrderJournal'.This topic explains how to clean up the 'BisStagingBufferOrderJournal' table.You can clean up the staging journals manually or in recurring mode.For example, you want to keep staging journals for six months. Each week, you can do a cleanup, deleting staging journals older than six months. Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Clean up Connectivity studio staging buffer tables. 2. In the Number of days field, select an option. 3. Expand the Run in the background section. 4. Select Yes in the Batch processing field and fill in the fields as desired. 5. Click Recurrence and fill in the fields as desired. 6. Click OK. 7. Click OK. Clean up data changes log Clean up data changes log On a message header, in the Log changes field, you can indicate if data changed are logged. If set to 'Yes', on import, the D365 FO data that is changed during import, is logged. Changes are logged by field. Only the latest change is stored for each field. The data changes are logged in the History change log (BisConHistoryChangeLog) table. To view the logged data changes for a message, on the Message page, on the Action Pane, on the Operations tab, click Show changes. You can clean up the logged data changes manually or in recurring mode. Procedure 1. Go to Connectivity studio > Periodic > Cleanup > Clean up retain local value log. 2. Sub-task: Set up batch processing. 3. Expand the Run in the background section. 4. Select Yes in the Batch processing field and fill in the fields as desired. 5. Click Recurrence and fill in the fields as desired. 6. Click OK. 7. Click OK. End End

Activities

Name Responsible Description

Delete project

Application Consultant

 		On the Project page, you cannot delete a project if it is used as a sub project or if it has children, like tasks. However, if such a project is no longer desired, to clean up your environment, you can still delete it. On delete, everything that belongs to the project is deleted.
Usually, you do not clean up your projects frequently.
Beware: Cleaning up your projects results in a hard delete of the applicable projects. So, be very careful when you use the clean-up functionality.

Delete message

Application Consultant

 		On the Message page, you cannot delete a message if it is used or if it has field mappings. A message can be used on, for example, a task, a web service action, or an EDI document flow. However, if such a message is no longer desired, to clean up your environment, you can still delete it. On delete, only the message is deleted.
Usually, you do not clean up your messages frequently.
Beware: Cleaning up your messages results in a hard delete of the applicable messages. Note that deleting a message has a consequence for the entities where it was used. For example, a web service action cannot run properly until another message is linked. So, be very careful when you use the clean-up functionality.

Delete web service action

Application Consultant

 		On the Web service action page, you cannot delete a web service action if it is used or if it has attributes or arguments. A web service action can be used on, for example, a task or an EDI document flow. However, if such a web service action is no longer desired, to clean up your environment, you can still delete it. On delete, only the web service action is deleted.
Usually, you do not clean up your web service actions frequently.
Beware: Cleaning up your web service actions results in a hard delete of the applicable web service actions. Note that deleting a web service action has a consequence for the entities where it was used. For example, an EDI document flow cannot run properly until another web service action is linked. So, be very careful when you use the clean-up functionality.

Delete document

Application Consultant

 		On the Document page, you cannot delete a document if it is used on a message or if it has records and fields. However, if such a document is no longer desired, to clean up your environment, you can still delete it. On delete, only the document is deleted.
Usually, you do not clean up your documents frequently.
Beware: Cleaning up your documents results in a hard delete of the applicable documents. Note that the messages in which the document is used cannot run until another document is linked to the message. So, be very careful when you use the clean-up functionality.

Remove connections

Application Consultant

For an Azure file storage connector, you can connect to an Azure file share. To access the Azure file share, you can mount the Azure file share.

For most connectors, when a message is run, a connection is made only for the run. After the run the connection ends. However, for an Azure file storage connection with a mounted Azure file share, the connection stays, independent of messages run.
When a related message is run or the connection is tested, a check is done, and an error can occur if something has changed. For example, the connector username or password is changed. In this case, the mounted connection to the Azure file share is no longer valid. To reset the mounting, first remove the connection (see steps). The next time, a related message is run, or the connection is tested, the mounting is restored, for example with the proper username or password.
Usually, messages are run in batch. If you run a message in batch, you can use a batch group to direct a batch task to another server. If a message runs on another server, the connection also stays on the other server. In case of an error or change, this connection is no longer valid. So also, the connection on the other servers must be removed.

Clean up history tables

Application Consultant

Each integration run results in history records. History records can be logged for:

  • Projects
  • Tasks
  • Web service actions
  • Messages
  • Service Bus queues
  • Test cases
You can clean up the logged history manually or in recurring mode.
For example, you want to keep history records for six months. Each week, you can do a cleanup, deleting history records older than six months.
These tables are cleaned up:
  • BisBufferTable
  • BisConHistoryChangeLogTable
  • BisConnectorFileHistoryTable
  • BisConSBReceivedData
  • BisConSBSendData
  • BisFlowActionHistory
  • BisHistory
  • BisHistoryCalculation
  • BisHistoryEntity
  • BisMessageDebugger
  • BisProjectHistory
  • BisTaskHistory
  • BisTestCaseRunResultTable
  • BisTestCaseRunTable
  • BisWsAttributeHistory
  • BisWsHistory
  • BisWsWebRequestHistory
  • BisWsWebRequestHistory

Clean up outbound queue

Application Consultant

On processing the outbound queue, for each record, the related message or web service action is run to export the applicable data. A successfully processed outbound queue record gets the status Processed. 

You can clean up the outbound queue by deleting the records with the status Processed.

Clean up generic staging journal table

Application Consultant

 		In Connectivity studio, you can use the staging concept to validate data in an intermediate area before it is further processed.
One predefined generic staging journal table is available for Connectivity studio: 'BisStagingBufferOrderJournal'.
This topic explains how to clean up the 'BisStagingBufferOrderJournal' table.
You can clean up the staging journals manually or in recurring mode.
For example, you want to keep staging journals for six months. Each week, you can do a cleanup, deleting staging journals older than six months.

Clean up data changes log

Application Consultant

On a message header, in the Log changes field, you can indicate if data changed are logged. If set to 'Yes', on import, the D365 FO data that is changed during import, is logged. Changes are logged by field. Only the latest change is stored for each field.

The data changes are logged in the History change log (BisConHistoryChangeLog) table. To view the logged data changes for a message, on the Message page, on the Action Pane, on the Operations tab, click Show changes.

You can clean up the logged data changes manually or in recurring mode.

Provide feedback