Dynamics CRM - Enable/Disable audit

Declaration

<AMDYNAMICSCRM ACTIVITY="enable_disable_audit" SESSION="text" SERVER="text" OFFICE365="YES/NO" USERNAME="text" PASSWORD="text (encrypted)" DOMAIN="text" ORGANIZATION="text" AUTODISCOVER="YES/NO" DISCOVERYURI="text" ORGANIZATIONURI="text" HOMEREALMURI="text" AUTHTYPE="text (options)" TIMEOUT="number" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" ACTION="text (options)" AUDITORGANIZATION="YES/NO" AUDITENTITY="YES/NO" ENTITY="text" />

Related Topics   

Description

Enables or disables Dynamics CRM auditing for the specified organization or entity.

NOTE: To function properly, this activity requires a Microsoft Dynamics CRM System Administrator or System Customizer security role or equivalent permissions.

Practical usage

Dynamics CRM supports an auditing capability where entity and attribute data changes within an organization can be recorded over time for use in analysis and reporting purposes. A System Administrator may want to stop auditing for maintenance purposes or when the database is limited in space. Disabling auditing at the organization level stops the tracking of changes for the entities and attribute data within that organization. When organization level auditing is re-enabled, the same entities and attribute data for which tracking stopped will automatically restart.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- Host --- Indicates where Dynamics CRM user credentials, connection properties and other preferences should originate from. The available options are:
  • Host (default) - Specifies that user credentials and preferences are configured individually for this activity. This option is normally selected if only a single activity is required to complete an operation.
  • Session - Specifies that user credentials and preferences are obtained from a pre-configured session created in an earlier step with the use of the Dynamics CRM - Create session activity. This option is normally selected if a combination of related activities are required to complete an operation. Consolidating several activities to a single session can make the task more manageable and eliminate redundancy. Moreover, a single task supports simultaneous execution of multiple sessions which can improve efficiency and speed up production.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.

Connect - Session

Property Type Required Default Markup Description
Session Text Yes, if Connection is set to Session DynamicsCrmSession1 SESSION="DynamicsCrmSession1" The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. The default session name is 'DynamicsCrmSession1'.

Connection - Host > Credentials

Property Type Required Default Markup Description
Server (protocol) Text (options) Yes HTTPS
  • PROTOCOL="HTTPS"
  • PROTOCOL="HTTP"
 Specifies the protocol used to connect to the Dynamics CRM server. The URL can be HTTP or HTTPS and the port is optional if it is HTTP over port 80 or HTTPS over port 443. The available options are:
  • HTTPS (default) - Hypertext Transfer Protocol Secure, which adds security capabilities of SSL/TLS to standard HTTP communications.

  • HTTP - Hypertext Transfer Protocol.
Server Text Yes (Empty)
  • SERVER="crm.dynamics.com"
  • SERVER="209.223.157.106"
 The URL or IP address of the Dynamics CRM server to establish a connection with. If entering a URL, the port is optional if it is http over port 80 or https over port 443. (for example, crm-server:port). The server URL is typically in the format of:

http://crm-server:port/organization-name

Or for Microsoft Dynamics CRM Online:

https://organization-name.crm.dynamics.com
Username or Windows Live ID Text Yes (Empty)
  • USERNAME="bubbagump
  • USERNAME="bubbagump@shrimps.com
 The username of the service account that is used to connect using AD, SPLA, or Passport authentication types. The format for this is specific to the authentication type: domain\username for AD and SPLA authentication types and a Windows Live ID for Passport authentication.
Password Text Yes (Empty) PASSWORD="encrypted" The password of the service account that is used to connect using AD, SPLA, or Passport authentication.
Domain name (optional) Text No (Empty) DOMAIN="fortra.com" The name of the domain that will verify user credentials (optional).
Organization name Text Yes (Empty) ORGANIZATION="Fortra" The name of the organization associated with the account. To query organization names and Dynamics CRM server URIs that exist on the system, select Discover.

Connection - Host > Advanced

Property Type Required Default Markup Description
Microsoft Office 365 Yes/No No No OFFICE365="YES" If selected, connection will be established by way of Office365 account. Set this option to YES if using  Microsoft Dynamics CRM Online through Microsoft Outlook. Disabled by default.
Auto discover Yes/No No No AUTODISCOVER="YES"

Auto-discovery helps you detect where the Dynamics CRM components are installed, whether locally or remotely. If selected, Automate Desktop will use CrmDiscoveryService to obtain a name and URL endpoint for a target organization (disabled by default). The CrmDiscoveryService Web service is accessed through a global URL of an on-premise Microsoft Dynamics CRM server. Each Microsoft Dynamics CRM server hosts the CrmDiscoveryService Web service, which is located here: http://<server:port>/MSCRMServices/2007/AD/CrmDiscoveryService.asm.

NOTE: Setting this parameter to YES deactivates various settings.
Discovery URI Text No (Empty)
DISCOVERYURI="crm.disco.com"
 The Discovery URL used by your site if you are connecting to a Microsoft Dynamics CRM Online organization. To connect to Microsoft Dynamics CRM Online, the discovery service is first hit to retrieve a passport authentication ticket. This ticket indicates that a Live ID user is, in fact, authenticated to use the Microsoft Dynamics CRM Online instance.
Organization URI Text No (Empty) ORGANIZATIONURI="crm.org.com" The URL of the organization service. If the Auto discover parameter is selected, this parameter becomes inactive.
Home realm URI Text No (Empty) HOMEREALMURI="crm.home.com" The URL of the home realm. This is the address of the identity provider. If the Auto discover parameter is selected, this parameter becomes inactive.
Authentication type Text (options) No LiveID
  • AUTHTYPE="ActiveDirectory"
  • AUTHTYPE="Federation"
  • AUTHTYPE="LiveId"
  • AUTHTYPE="OnlineFederation"
 The type of authentication used to connect to the Dynamics CRM server. If the Auto discover parameter is selected, this parameter becomes inactive. The available options are:
  • None - Authenticates with Dynamics CRM using the current Windows credentials of the application. This is typically used in development environments and only works with on-premises deployments in the same Active Directory domain (or trusted domain) as the Microsoft Dynamics CRM server.
  • Active Directory - Authenticates using Active Directory credentials of a specific service account. This is mainly used for on-premises deployments.
  • Federation - Establishes an authentication gateway using a combination of IAG and Active Directory Federation Services (ADFS) in order to provide external users with access to the sensitive information that is stored in the CRM system without having to create Active Directory trusts.
  • Live ID - Authenticates using the Windows Live ID authentication mechanism (previously known as Passport authentication). Mainly used for Microsoft Dynamics CRM Online deployments.
  • Online Federation - Contains the available identity providers for the Microsoft Dynamics CRM Online service.
Timeout (seconds) Number No 120 TIMEOUT="120" The total amount of time (in seconds) to allow for a synchronous connection request to the CRM server to complete. If this value is surpassed, a timeout error will occur. The default value is 120 seconds (3 minutes).
Proxy type Text (options) No System default
  • PROXYTYPE="none"
  • PROXYTYPE="http"
 The type of proxy in which to connect to. The available options are:
  • System default (default) - Points to the default proxy used by the system.
  • None - No proxy authentication required.
  • HTTP - Proxy type is HTTP.

Use authentication

 --- No --- --- If enabled, specifies proxy authentication is required, enabling authentication-based parameters (disabled by default). It is active only if the Proxy type parameter is set to HTTP.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Proxy server Text Yes, if Proxy type is set to HTTP (Empty) PROXYSERVER="proxy.host.com" The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP.
Proxy port Number No 808 PROXYUSERNAME="username" The port number to use to connect to the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 808.
Proxy username Text No (Empty) PROXYPORT="8080" If enabled, specifies proxy authentication is required, enabling authentication-based parameters (disabled by default). It is active only if the Proxy type parameter is set to HTTP.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Proxy password Text No (Empty) PROXYPASSWORD="encrypted" The proxy password to authenticate with.   This parameter is available only if Use authentication is enabled.

Audit

Property Type Required Default Markup Description
Action Text (options) Yes Enable
  • ACTION="enable"
  • ACTION="disable"
 The audit related action to perform. The available options are:
  • Enable (default) - Enables auditing capability where entity and attribute data changes within an organization can be recorded for analysis and reporting.
  • Disable - Disables auditing capability, at which point, recording of data changes stops.
Auditing for organization Yes/No No No AUDITORGANIZATION="yes" If selected, the auditing operation selected in the Action parameter will be performed at the organization level. If disabled, auditing will not be performed at the organization level (disabled by default).
NOTE: You can enable or disable auditing at the organization and entity levels. If auditing is not enabled at the organization level, auditing of entities and attributes, even if it is enabled, does not occur. By default, auditing is enabled on all auditable entity attributes but is disabled at the entity and organization level.
Auditing for entity Yes/No No No AUDITENTITY="yes" If selected, the auditing operation selected in the Action parameter will be performed at the entity level. If disabled, auditing will not be performed.
NOTE: You can enable or disable auditing at the organization and entity levels. If auditing is not enabled at the organization level, auditing of entities and attributes, even if it is enabled, does not occur. By default, auditing is enabled on all auditable entity attributes but is disabled at the entity and organization level.
Entity logical name (for example, account) Text Yes if Auditing for entity is selected (Empty) ENTITY="account" The logical name of the entity in which to enable/disable auditing. The logical name is an all lowercase version of the original name assigned during creation of the entity. For instance, if an entity named Production was created, its logical name would be production. This parameter is active only if the Auditing for entity parameter is selected.

Description

Error Causes

On Error

Examples

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample session-based task uses the Dynarmics CRM - Enable/Disable audit activity to enable auditing.

Copy 
<AMDYNAMICSCRM ACTIVITY="create_session" PROTOCOL="http" SERVER="209.223.157.106" USERNAME="administrator" PASSWORD="AM2gvUWJwwypS+Z9QcnFzL2L9z1QydMMsQpaME" DOMAIN="netautoinc" ORGANIZATION="netautodyn" AUTODISCOVER="no" DISCOVERYURI="http://209.223.157.106/XRMServices/2011/Discovery.svc" ORGANIZATIONURI="http://dynamicscrm2011/netautodyn/XRMServices/2011/Organization.svc" AUTHTYPE="ActiveDirectory" SESSION="DynamicsCrmSession1" />
<AMDYNAMICSCRM ACTIVITY="enable_disable_audit" SESSION="DynamicsCrmSession1" AUDITORGANIZATION="YES" AUDITENTITY="YES" ENTITY="account" />
<AMDYNAMICSCRM ACTIVITY="end_session" SESSION="DynamicsCrmSession1" />