Difference between revisions of "Draft: PEC-Hybrid/Current/Admin/About"

From Genesys Documentation
Jump to: navigation, search
Line 21: Line 21:
 
|Type=Unstructured
 
|Type=Unstructured
 
|anchor=TransactionObjHybrid
 
|anchor=TransactionObjHybrid
|freetext=xx
+
|freetext=A transaction object is needed for Genesys components to authenticate with Genesys Cloud.
 +
 
 +
# Create a transaction object (and alias) of type '''list''' named '''hybrid_integration''' in the '''Script''' folder of the '''Environment''' tenant.
 +
#* Usage characteristics: the transaction object should be acquired at start-up and used until the component gets an error from a given API call. If an error occurs, your component should retrieve the hybrid_integration object from config server and try again. If the component still has problems, your component should end the associated processing with an error.
 +
#* Tenant characteristics: the transaction object should be cretaed at the Environment level so it can be shared by multiple tenants. The transaction object allows for support of both single tenant and multi-tenant Configuration Servers. This can be overridden by putting the object in under a specific tenant level.
 +
# Create the following Object options in the '''general''' section:
 +
#* '''organization_sname''': The PureCloud organization short name for this tenant.
 +
#* '''organization_id''': The PureCloud organization id for this tenant.
 +
#* '''default_agent_role_name''': The default PureCloud agent role name.
 +
#* '''default_supervisor_role_name''': The default PureCloud supervisor role name.
 +
#* '''default_admin_role_name''': The default PureCloud admin role name.
 +
#* '''base_auth_url''': The base auth URL that can be used for any PureCloud service; for example: '''base_auth_url'' should be <nowiki>https://[region_host]/oauth/token</nowiki>. <nowiki>[region_host]</nowiki> is the authentication-based FQDN for the region; the regions are listed on [https://developer.mypurecloud.com/api/rest/ this page].
 +
#* '''base_service_url''': The base URL that can be used for any PureCloud service; for example: '''base_service_url''' should be <nowiki>https://[region_host]/api/</nowiki>. <nowiki>[region_host]</nowiki> should be the API-based FQDN for the region; the regions are listed on [https://developer.mypurecloud.com/api/rest/ this page]. The rest of the url is PureCloud service and version specific; for example: '''...v2/conversations'''. The '''base_service_url''' and the service specific portion is combined in your componment code.
 +
# Create the following Object options in the '''saml''' section:
 +
#* '''issuer''': The SAML IDP URL.
 +
#* '''certificate''': The SAML related certificate.
 +
#* '''pkey''': The encrypted SAML related certificate private key.
 +
#* '''password''': The password to decrypt the private key.
 +
#* '''expire_time''': The expiration time for the access token.
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 17:47, May 15, 2019

This is a draft page; the published version of this page can be found at PEC-Hybrid/Current/Admin/About.

Manually provision PureCloud (by creating an Organization) and PureEngage Premise (using Genesys Administrator Extension).

About Provisioning

Transaction object for hybrid integrations