openForm (Référence API JavaScript) pour l’environnement d’intégration du canal de Dynamics 365 1.0
Ouvre un formulaire d’entité ou un formulaire de création rapide.
Syntaxe
Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);
Paramètres
| Nom | Type | Requise | Description |
|---|---|---|---|
| entityFormOptions | Objet JSON | Oui | Options de formulaire d’entité pour ouvrir le formulaire. L’objet contient les attributs suivants : - cmdbar - createFromEntity - entityId - entityName - formId - height - navBar - openInNewWindow - windowPosition - processId - processInstanceId - relationship - selectStageId - useQuickCreateForm - width Consultez l’objet de table entityFormOptions pour en savoir plus sur les attributs. |
| formParameters | Object | No | Objet de dictionnaire qui transmet des paramètres supplémentaires au formulaire. Des paramètres non valides provoquent une erreur. Pour plus d’informations sur le passage des paramètres à un formulaire, voir Définir les valeurs de champ utilisant les paramètres transmis à un formulaire et Configurer un formulaire pour accepter les paramètres de chaîne de requête personnalisés. |
| successCallback | Function | No | Une fonction à exécuter lorsque l’opération aboutit. |
| errorCallback | Function | No | Fonction à exécuter lorsque l’opération échoue. |
Attributs d’objets entityFormOptions
Le tableau suivant décrit les attributs du paramètre entityFormOptions.
Note
Les attributs sont facultatifs.
| Nom de l’attribut | Type | Description |
|---|---|---|
| cmdBar | Valeur booléenne | Indique si afficher la barre de commandes. Si vous ne spécifiez pas de valeur pour ce paramètre, la barre de commandes est affichée par défaut. |
| createFromEntity | Lookup | Indique un enregistrement qui fournira des valeurs par défaut en fonction des valeurs d’attribut mappées. L’objet de recherche contient les propriétés de type Chaîne suivantes : entityType, id, et name (facultatif). |
| entityId | String | Identificateur de l’enregistrement d’entité pour lequel afficher le formulaire. |
| entityName | String | Nom logique de l’entité pour laquelle afficher le formulaire. |
| formId | String | Identificateur de l’instance de formulaire à afficher. |
| hauteur | Chiffre | Hauteur de la fenêtre du formulaire à afficher, en pixels. |
| navBar | String | Contrôle si la barre de navigation est affichée et si la navigation dans l’application est disponible dans les zones et les sous-zones définies dans le plan de site. Les valeurs valides sont : on : la barre de navigation s’affiche. Il s’agit du comportement par défaut si le paramètre navBar n’est pas utilisé. off : la barre de navigation ne s’affiche pas. L’utilisateur peut accéder à d’autres éléments de l’interface utilisateur ou aux boutons Précédent et Suivant. entity : dans un formulaire d’entité, seules les options de navigation pour les entités associées sont disponibles. Après la navigation vers une entité associée, un bouton Précédent s’affiche dans la barre de navigation pour permettre le renvoi vers l’enregistrement d’origine. |
| openInNewWindow | Valeur booléenne | Indique si afficher le formulaire dans une nouvelle fenêtre. |
| windowPosition | Chiffre | Indique la position du formulaire sur la fenêtre. Les valeurs valides sont : 1 pour la position centrale et 2 pour la position latérale. |
| processId | String | ID du processus d’entreprise à afficher dans le formulaire. |
| processInstanceId | String | ID de l’instance du processus d’entreprise à afficher dans le formulaire. |
| relationship | Objet JSON | Indique un objet de relation pour afficher les enregistrements associés dans le formulaire. Consultez l’objet de table relationship pour en savoir plus sur les attributs. |
| selectStageId | String | ID de la phase sélectionnée dans l’instance de processus d’entreprise. |
| useQuickCreateForm | Chiffre | Largeur de la fenêtre du formulaire à afficher, en pixels. |
Attributs d’objets relationship
Le tableau suivant décrit les attributs de l’attribut d’objet relationship du paramètre entityFormOptions.
Note
Les attributs sont facultatifs.
| Nom de l’attribut | Type | Description |
|---|---|---|
| attributeName | String | Nom de l’attribut utilisé pour la relation. |
| nom | String | Nom de la relation. |
| navigationProperty | String | Nom de la propriété de navigation pour cette relation. |
| relationshipType | Chiffre | Type de relation. Les valeurs valides sont : 0 pour une relation un-à-plusieurs et 1 pour une relation plusieurs-à-plusieurs. |
| roleType | Chiffre | Type de rôle dans la relation. Les valeurs valides sont : 1 pour le référencement et 2 pour AssociationEntity. |
Valeur renvoyée
En cas de succès, retourne un objet promesse contenant une chaîne.
Exemple
L’exemple de code suivant ouvre un nouveau formulaire d’incident avec des valeurs préremplies pour certains champs comme l’ID de contact et la description.
var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
var title = "Sample Case Form"
var entityFormOptions = {};
entityFormOptions["entityName"] = "incident";
var formParameters = {};
//pre-populate some fields based on the context
formParameters["title"] = title;
formParameters["customerid"] = id;
formParameters["customeridtype"] = "contact";
formParameters["caseorigincode"] = 1;
formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";
//Open the form
Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
function (success) {
console.log(success);
},
function (error) {
console.log(error);
}
);