Skip to content

Commit f7018a0

Browse files
authored
Merge pull request #912 from ritza-co/1075-freshservice
1075: use business service term; freshservice integration
2 parents ab7047a + a573b47 commit f7018a0

4 files changed

Lines changed: 30 additions & 30 deletions

File tree

docs/integration/external-integrations/freshservice-integration/customize-freshservice.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Let's take a closer look at the attributes and elements of the `<task>` elements
7272
<task enable="false" name="Products" type="product" description="Copy Product info from Device42 to Freshservice" d42_min_version="16.19.00">
7373
```
7474

75-
Note that if you turn off a task that has `asset` or `asset_relationship` as its corresponding Freshservice type (for example, devices, business apps, and resources in Device42), you'll need to find and remove its corresponding query snippet in the `Delete` cleanup tasks. For an example, see [this answer in the FAQ section](#how-do-i-prevent-a-relationship-between-two-device42-asset-types-from-syncing-to-freshservice).
75+
Note that if you turn off a task that has `asset` or `asset_relationship` as its corresponding Freshservice type (for example, devices, business services, and resources in Device42), you'll need to find and remove its corresponding query snippet in the `Delete` cleanup tasks. For an example, see [this answer in the FAQ section](#how-do-i-prevent-a-relationship-between-two-device42-asset-types-from-syncing-to-freshservice).
7676

7777
- `name`: You can edit the task name. Task names appear in the [integration app's **Data Mapping Chart**](#data-mapping-between-device42-and-freshservice).
7878
- `type`: Holds the [Freshservice classification](https://api.freshservice.com/) of the data. The valid types are:
@@ -112,15 +112,15 @@ Typically, the first `<field>` represents the Device42 data returned from the qu
112112
- `resource`: The same as the `target` value.
113113
- `source-type`: Not functionally critical; this provides the data type displayed on the [integration app's **Data Mapping Chart**](#data-mapping-between-device42-and-freshservice).
114114
- `target`: The Device42 field to be mapped to Freshservice. The Freshservice convention is to use the display name in snake case, occasionally with the ID of the asset type as a suffix. For example, `memory_max_usage` and `memory_reservation_used`. The sync process determines the ID. Please look up which target field names to use in the [Freshservice API documentation](https://api.freshservice.com/).
115-
- `escape`: This is used on field elements where `target="name"`. Some characters used in Device42 names aren't supported in Freshservice and need to be substituted. When creating a new task, you can set this to `true` but disable it if mismatching issues occur.
115+
- `escape`: This is used on field elements where `target="name"`. Some characters used in Device42 names aren't supported in Freshservice and need to be substituted. When creating a new task, you can set this to `true`, but disable it if mismatching issues occur.
116116

117117
:::tip
118118
Use our InsightsAI chat under **Analytics > InsightsAI** to interpret DOQL query snippets quickly in the context of the Device42 data tables.
119119
:::
120120

121121
### Additional Matching Criteria for Updating Existing Items
122122

123-
Some `<task>` elements in `mapping.xml` have a helper `<matching>` element for updating synched data that currently exists in Freshservice but may have slightly different name formats. For example, asset-type syncing tasks include the `<matching>` element to determine which query fields are used to match which asset attributes when trying to find a match. For example:
123+
Some `<task>` elements in `mapping.xml` have a helper `<matching>` element for updating synced data that currently exists in Freshservice but may have slightly different name formats. For example, asset-type syncing tasks include the `<matching>` element to determine which query fields are used to match which asset attributes when trying to find a match. For example:
124124

125125
<details>
126126
<summary>Click to expand the code block</summary>
@@ -190,7 +190,7 @@ For a quick look at all the valid Freshservice `types`, see the [The `<task>` El
190190
| Copy AWS EBS from Device42 to Freshservice | asset | 19.04.00 | |
191191
| Copy AWS Key Pair from Device42 to Freshservice | asset | 19.04.00 | |
192192
| Copy AWS S3 from Device42 to Freshservice | asset | 19.04.00 | |
193-
| Copy AWS Public IP from Device42 to FreshService | asset | 19.04.10 | |
193+
| Copy AWS Public IP from Device42 to Freshservice | asset | 19.04.10 | |
194194
| Copy Azure VPC from Device42 to Freshservice | asset | 19.04.00 | |
195195
| Copy GCP Subnet from Device42 to Freshservice | asset | 19.04.00 | |
196196
| Copy GCP VPC from Device42 to Freshservice | asset | 19.04.00 | |
@@ -213,23 +213,23 @@ For a quick look at all the valid Freshservice `types`, see the [The `<task>` El
213213
| Copy GCP Network Interface from Device42 to Freshservice | asset | 19.04.00 | |
214214
| Copy Azure Resource Group from Device42 to Freshservice | asset | 19.04.00 | |
215215
| Copy AWS Image from Device42 to Freshservice | asset | 19.04.00 | |
216-
| Copy Azure Public IP from Device42 to FreshService | asset | 19.04.10 | 19.04.99 |
217-
| Copy Azure Public IP from Device42 to FreshService | asset | 19.05.00 | |
216+
| Copy Azure Public IP from Device42 to Freshservice | asset | 19.04.10 | 19.04.99 |
217+
| Copy Azure Public IP from Device42 to Freshservice | asset | 19.05.00 | |
218218
| Copy GCP Image from Device42 to Freshservice | asset | 19.04.00 | |
219-
| Copy GCP BigQuery Table from Device42 to FreshService | asset | 19.04.10 | |
219+
| Copy GCP BigQuery Table from Device42 to Freshservice | asset | 19.04.10 | |
220220
| Copy Azure Key Vault from Device42 to Freshservice | asset | 19.04.00 | |
221221
| Copy VMware VCenter Resource Pool from Device42 to Freshservice | asset | 19.04.10 | |
222222
| Copy VMware VCenter Network from Device42 to Freshservice | asset | 19.04.10 | |
223223
| Copy VMware VCenter Disk from Device42 to Freshservice | asset | 19.04.10 | |
224224
| Copy VMware VCenter Datastore from Device42 to Freshservice | asset | 19.04.10 | |
225225
| Copy VMware VCenter Datacenter from Device42 to Freshservice | asset | 19.04.10 | |
226-
| Copy AWS K8 Pod from Device42 to FreshService | asset | 19.04.10 | |
226+
| Copy AWS K8 Pod from Device42 to Freshservice | asset | 19.04.10 | |
227227
| Copy AWS K8s Namespace from Device42 to Freshservice | asset | 19.04.10 | |
228228
| Copy AWS K8s Deployment from Device42 to Deployment | asset | 19.04.10 | |
229229
| Copy AWS K8s Service from Device42 to Service | asset | 19.04.10 | |
230230
| Copy AWS K8s Daemon Set from Device42 to Daemon Set | asset | 19.04.10 | |
231-
| Copy AWS K8s Replica Set from Device42 to FreshService | asset | 19.04.10 | |
232-
| Copy AWS K8s Cron Job from Device42 to FreshService | asset | 19.04.10 | |
231+
| Copy AWS K8s Replica Set from Device42 to Freshservice | asset | 19.04.10 | |
232+
| Copy AWS K8s Cron Job from Device42 to Freshservice | asset | 19.04.10 | |
233233
| Copy GCP Public IP from Device42 to Freshservice | asset | 19.04.10 | |
234234
| Copy AWS K8s Config Map from Device42 to Config Map | asset | 19.04.10 | |
235235
| Copy AWS K8s Stateful Set from Device42 to Stateful Set | asset | 19.04.10 | |
@@ -315,7 +315,7 @@ Use the following steps to verify that the field name is correct:
315315
3. Search the returned JSON for the field label you are interested in to verify the field name.
316316

317317
<ThemedImage
318-
alt="Business Application in Device42"
318+
alt="JSON search example"
319319
sources={{
320320
light: useBaseUrl('/assets/images/freshservice-integration/verify-field-name-light.png'),
321321
dark: useBaseUrl('/assets/images/freshservice-integration/verify-field-name-dark.png'),
@@ -509,7 +509,7 @@ Set the `enable` attribute to `false` on those `<task>` elements:
509509
<task enable="false" name="Device Contract Associations" type="contract_asset" description="Create association between asset and contract">
510510
```
511511

512-
3. If you want to disable Software Licensing from being synced, find the `Copy Software Licensing info from Device42 to Freshservice` task (around line `2437`):
512+
3. If you want to prevent software licensing from being synced, find the `Copy Software Licensing info from Device42 to Freshservice` task (around line `2437`):
513513

514514
![Line 2437](/assets/images/freshservice-integration/example-vscode-6.png)
515515

@@ -563,7 +563,7 @@ Set the `enable` attribute to `false` on those `<task>` elements:
563563
<task enable="false" name="Software In Use" type="software_installation" description="Create Software Install from Software In Use" d42_max_version="16.18.02">
564564
```
565565

566-
3. Software Licensing from Device42 syncs to `contract` in Freshservice. Find and disable the `Copy Software Licensing info from Device42 to Freshservice` task (around line `2437`):
566+
3. Software licensing from Device42 syncs to `contract` in Freshservice. Find and disable the `Copy Software Licensing info from Device42 to Freshservice` task (around line `2437`):
567567

568568
![Line 2437](/assets/images/freshservice-integration/example-vscode-6.png)
569569

@@ -644,4 +644,4 @@ If you want Device42 to update `asset_state` values, set `skip-update` to `"fals
644644
</value-mapping>
645645
</field>
646646
```
647-
</details>
647+
</details>

docs/integration/external-integrations/freshservice-integration/use-freshservice-integration.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Make your way to the **Settings** tab, located on the configuration page of the
3030

3131
Data synchronization (sync) imports new CIs and updates the existing ones within Freshservice. Locate the synced data under **Assets > Inventory** in Freshservice.
3232

33-
You can schedule a daily sync and run the sync immediately. We recommend that you run a full sync after installing the integration app.
33+
You can schedule a daily sync and run the sync immediately. We recommend running a full sync after installing the integration app.
3434

3535
[From the **Settings** tab](#find-the-settings-tab), scroll down to the **Schedule Synchronization** section.
3636

@@ -171,7 +171,7 @@ The **Contract Type** dropdown in Freshservice displays the available contract t
171171

172172
### Sync Purchase Line Items Types to Contracts
173173

174-
In Device42, a Purchase Line Item is an individual entry associated with a larger Purchase (located under **Infrastructure > Purchases**). Contract Purchase Line Item sub-types include **Lease**, **Warranty**, **Subscription**, **Service**, and **In-Service**. The sub-type **(None)** is used for unspecified types:
174+
In Device42, a **Purchase Line Item** is an individual entry associated with a larger purchase (located under **Infrastructure > Purchases**). Contract purchase line item sub-types include **Lease**, **Warranty**, **Subscription**, **Service**, and **In-Service**. The sub-type **(None)** is used for unspecified types:
175175

176176
<ThemedImage
177177
alt="PO Line Item Types in Device42"
@@ -181,13 +181,13 @@ In Device42, a Purchase Line Item is an individual entry associated with a large
181181
}}
182182
/>
183183

184-
The Purchase Line Item **Lease** and **Warranty** contract types map to the Freshservice **Lease** and **Warranty** types. The other Purchase Line Item contract types (**Service**, **In-Service**, **Subscription**, and **(None)**) are assigned to the Freshservice **Maintenance** type.
184+
The purchase line item **Lease** and **Warranty** contract types map to the Freshservice **Lease** and **Warranty** types. The other purchase line item contract types (**Service**, **In-Service**, **Subscription**, and **(None)**) are assigned to the Freshservice **Maintenance** type.
185185

186186
![Synced Maintenance Contract Type in Freshservice](/assets/images/freshservice-integration/maintenance-type-contracts.png)
187187

188-
For example, this Purchase Line Item with an unspecified contract type in Device42 is synced to Freshservice as a **Maintenance** contract:
188+
For example, this purchase line item with an unspecified contract type in Device42 is synced to Freshservice as a **Maintenance** contract:
189189

190-
- Purchase Line Item in Device42:
190+
- A purchase line item in Device42:
191191
<ThemedImage
192192
alt="Unspecified Contract Type in Device42"
193193
sources={{
@@ -196,7 +196,7 @@ For example, this Purchase Line Item with an unspecified contract type in Device
196196
}}
197197
/>
198198

199-
- Synced Maintenance Contract in Freshservice:
199+
- The synced maintenance contract in Freshservice:
200200

201201
![Maintenance Contract Type in Freshservice](/assets/images/freshservice-integration/line-item-example-fs.png)
202202

@@ -219,36 +219,36 @@ Warranty information from Device42 is brought into Freshservice, with **Warranty
219219

220220
### Software Licensing Syncs to Contracts
221221

222-
**Software Licensing** contracts in Device42 are synced to Freshservice as **Software License** contracts when a Software Component has an associated Purchase Line Item or License Count that is not null (empty).
222+
**Software Licensing** contracts in Device42 are synced to Freshservice as **Software License** contracts when a software component has an associated purchase line item or license count that is not null (empty).
223223

224224
![Software Licensing in Freshservice](/assets/images/freshservice-integration/fs-software-license.png)
225225

226-
## Syncing Business Applications to Freshservice
226+
## Syncing Business Services to Freshservice
227227

228-
Using the default mapping, **Business Applications** in Device42 are synced to Freshservice as the **Business Service** asset type. The Business Application relationships are also synced.
228+
Using the default mapping, **Business Services** in Device42 are synced to Freshservice as the **Business Service** asset type. The business service relationships are also synced.
229229

230-
- In Freshservice, navigate to **Assets > Inventory** (1) and select **Business Service** as the **Asset Type** (2) to view the synced Business Applications. Click on an item to view its details.
230+
- In Freshservice, navigate to **Assets > Inventory** (1) and select **Business Service** as the **Asset Type** (2) to view the synced business services. Click on an item to view its details.
231231

232232
![Business Services in Freshservice](/assets/images/freshservice-integration/fs-business-service.png)
233233

234-
- Click **Relationships** to see a **Mini map** of the selected Business Service.
234+
- Click **Relationships** to see a **Mini map** of the selected business service.
235235

236236
![Business Service Relationships in Freshservice](/assets/images/freshservice-integration/fs-business-app-mini-map.png)
237237

238238
- When viewing the full map, you can select the **Level of Relationships** to display.
239239

240240
![Business Service Full Map in Freshservice](/assets/images/freshservice-integration/fs-business-app-full-map.png)
241241

242-
The example Business Service in Freshservice above looks like this as a Business Application in Device42:
242+
The example business service in Freshservice above looks like this in Device42:
243243

244244
<ThemedImage
245-
alt="Business Application in Device42"
245+
alt="Business Service in Device42"
246246
sources={{
247-
light: useBaseUrl('/assets/images/freshservice-integration/business-app-d42-light.png'),
248-
dark: useBaseUrl('/assets/images/freshservice-integration/business-app-d42-dark.png'),
247+
light: useBaseUrl('/assets/images/freshservice-integration/business-service-d42-light.png'),
248+
dark: useBaseUrl('/assets/images/freshservice-integration/business-service-d42-dark.png'),
249249
}}
250250
/>
251251

252252
## Deleting the Freshservice External Integration
253253

254-
Before deleting the Freshservice external integration in Device42 or making changes to your Cloud Services configuration, first uncheck the **Enable Freshworks SSO** option in the Appliance Manager, under **Global Settings > SAML/SSO Settings**.
254+
Before deleting the Freshservice external integration in Device42 or making changes to your Cloud Services configuration, first uncheck the **Enable Freshworks SSO** option in the Appliance Manager, under **Global Settings > SAML/SSO Settings**.
85 KB
Loading
79.3 KB
Loading

0 commit comments

Comments
 (0)