Dynamics CRM - Create session
Declaration
<AMDYNAMICSCRM ACTIVITY="create_session" 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)" />
Description
Creates a unique session which can be used to associate subsequent Dynamics CRM steps allowing a single task the ability to execute numerous Dynamics CRM operations simultaneously.
Practical usage
Commonly used as a means of organizing and encapsulating a collection of related activities required to accomplish a particular task or process. The use of sessions can ensure consistency and eliminate redundancy.
Parameters
Connection
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Server (protocol) | Text (options) | Yes | HTTPS |
|
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:
|
Server | Text | Yes | (Empty) |
|
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) |
|
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. |
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'. |
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 URI 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 URI 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 URI 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 |
|
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:
|
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 |
|
The
type of proxy in which to connect to. The available options are:
|
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. |
Example
- 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 task creates an entity example that begins with a Dynamics CRM - Create Session activity and ends with an Dynamics CRM - End Session activity.
<AMDYNAMICSCRM ACTIVITY="create_entity" SESSION="DynamicsCrmSession1" ENTITY="account" RESULTVARIABLE="theVar"><ATTRIBUTE LOGICALNAME="the_name_sample" TYPE="String" VALUE="the_value_sample" /></AMDYNAMICSCRM>
<AMDYNAMICSCRM ACTIVITY="create_session" PROTOCOL="http" SERVER="209.223.157.138" USERNAME="administrator" PASSWORD="AM4/Q7bbHbt9QhISwlRVy6FfQHONLtbjckKaME" DOMAIN="netautoinc" ORGANIZATION="netautodyn" DISCOVERYURI="http://209.223.157.106/XRMServices/2011/Discovery.svc" ORGANIZATIONURI="http://dynamicscrm2011/netautodyn/XRMServices/2011/Organization.svc" AUTHTYPE="ActiveDirectory" SESSION="DynamicsCrmSession1" />
<AMDYNAMICSCRM ACTIVITY="end_session" SESSION="DynamicsCrmSession1" />