Configure Tag Synchronizer
The behavior of Tag Synchronizer can be configured on the Edit Configuration and Meridian Cloud tabs.
After import, the import date and results are recorded in a text file and will be used in the next import. The name of the text file is Lastimport-<ConfigurationFileName>.log. The file will be located in the same folder as the application. If a mapped property is a part of the Field-Path definition, invalid characters \ / : * ? " < > | appearing in the value are replaced by an underscore character _.
The options that are saved in the configuration file are summarized in the following sections.
If you encounter SQL authentication errors when using this tool, you may need to install the Microsoft OLE DB Driver version 18 or 19 for SQL.
Config section
Setting | Description | Default | Remarks |
---|---|---|---|
AddressSMTPServer | Address of an SMTP server for sending email messages. | None | Optional |
LogDirectory | Folder for storing the log files. | None | Optional |
LogErrorDirectory |
Folder for storing the error log files. |
None | Optional |
LogErrorEmail | Email address for reporting errors. | None | Optional |
ImportDB section
Setting |
Description |
Default |
Remarks |
---|---|---|---|
ActionAdd |
Semicolon separated list of strings that trigger an import action. | None | |
ActionField |
Column in the intermediate file that specifies the action to be taken. If no action is specified, then the application will import tags instead of retire them. | None | Optional |
ActionRetire |
Semicolon separated list of strings that trigger a retire action. | None | |
ConnectionString |
Connection string to the maintenance management system database from which to import tags. This setting may contain %1 as a placeholder for the intermediate filename. If so, then the user interface dialog will provide the option to specify the name manually. Do not use this feature when running in unattended mode. |
None | Required |
DatabasePath |
Path to the exported intermediate file. | None | Required |
ImportDBFieldName |
Column in the intermediate file that specifies the name of the imported tag. | None | Required |
ImportPathField |
Path to a content file to import for a new tag. Not applicable to existing tags. | None | Optional |
ResultFail |
Message to insert in the column specified by ResultField if the import or retire action fails. | None | |
ResultField |
Column in the intermediate file for displaying the result of the action. | None | Optional |
ResultOK |
Message to insert in the column specified by ResultField if the import or retire action succeeds. | None | |
SelectionCommand |
SQL SELECT statement for the intermediate file. The value can contain a placeholder {0} for the modification date time. See also SkipModifiedArgument. | None | Required |
SkipExisting |
Imports only new records. | 0 | Optional |
SkipHeaderRecords | Integer value specifying the number of header records in the result set to be ignored. | 0 | Optional |
SkipModifiedArgument |
If True, the statement in SelectionCommand is expected to not contain a placeholder for the modification date and time, and the application expects a query that needs a modification date as an input parameter. This date should have the format YYYY/MM/DD HH:MM:SS. For example: Select * FROM <ImportDatabase> Where <ModificationDate> =%1 Where <ImportDatabase> is the name of the import database and <ModificationDate> is the date of the modification. |
False | Optional |
SkipNonExisting |
Only synchronizes existing tags. | 0 | Optional |
SubFolderField |
Column that contains a subfolder path where to import tags. Invalid characters \ / : * ? " < > | appearing in the value are replaced by an underscore character _ |
None | Optional |
SubFolderFieldIsParent |
Boolean value that specifies how to interpret the SubFolderField setting. Set to True if SubFolderField specifies the parent folder of the imported tag. Set to False if SubFolderField specifies the path to the tag (including the tag name). In that case the tag name is stripped from the value. | True | Optional |
VersionField |
None | Optional |
Meridian Cloud
Setting |
Description |
Default |
Remarks |
---|---|---|---|
ApiUrl |
Enter the Meridian Cloud Partner API endpoint to use for importing data. |
https://api.meridiancloud.net/meridianasset/api/assets/(globalId) |
|
ApiSubscriptionKey |
Enter the subscription key (either primary or secondary) from your Meridian Cloud Partner API subscription. To find your subscription keys, in the Meridian Cloud API Developer Portal, open the Profile tab. The Subscription details table shows your primary and secondary keys. |
None |
|
Field<X> |
A column in the intermediate file to map to the corresponding Meridian Cloud property specified in Property<X>. Possible formats include: Field<X>=<ColumnName>, <Size> Field<X>=//<Value> Where <ColumnName> is the name of a column in the intermediate file, <Value> is a fixed value to use and <Size> is an optional integer to restrict to a number of characters. |
None | |
NumFields |
Number of properties to map. |
6 | |
Property<X> |
Meridian Cloud property to map to the corresponding intermediate file column Field<X>. | None |
Configure Meridian Cloud for Tag Synchronizer Tool
To configure Tag Synchronizer to import tags to your Meridian Cloud tenancy, set options on the Meridian Cloud page using the descriptions in the following table.
Option | Description |
---|---|
Meridian Cloud API URL |
URL of the Create Asset endpoint as provided by the Accruent API Developer Portal. This allows the you to import into specific environments (Stage or Production, for example) as required. |
Subscription Key |
API subscription key as provided by the Accruent API Developer Portal. You must have already signed up for access and already subscribed to the Meridian Asset product. |
Asset Property Mapping |
The import destination properties. For each destination property described below, enter in the matching field in the intermediate file:
|
Import Tags into a Meridian Cloud Tenancy Using the Meridian Cloud API
To import tags into a Meridian Cloud tenancy using the Meridian Cloud API, which is part of Meridian Cloud:
-
Download the AMMTagSynchronizerSampleAmended.zip file in this link.
Download the AMMTagSynchronizerSampleAmended.zip file in this link.
Download the AMMTagSynchronizerSampleAmended.zip file in this link.
-
Extract the file.
-
Open the Tag Synchronizer Tool.
The Tag Synchronizer window opens. There are three tabs along the top of the window.
-
In the Configuration File tab, click Browse.
-
Navigate to the extracted folder of the AMMTagSynchronizerSampleAmended.zip file.
-
Select the 2doctag.ini file.
You can update and save the configuration file.
-
On the Tag Synchronizer window, open the Meridian Cloud tab.
To find the Meridian Cloud API URL to use for importing assets:
-
Log into the Meridian Cloud API Developer Portal.
Use the appropriate URL:
-
For US-hosted tenants: https://api-developer.meridiancloud.net/.
-
For EU-hosted tenants: https://api-developer.meridiancloud.eu/.
-
-
View the Asset endpoint of the Meridian Asset API.
This endpoint depends on the data being imported (Asset/Tags or Asset Relationships/Tag links).
The following is an example of an endpoint:
https://api.meridiancloud.net/meridianasset/api/assets/{globalId}
-
-
In Meridian Cloud API URL, enter the Meridian Cloud Partner API endpoint to use for importing data.
-
In Subscription Key, enter the subscription key (either primary or secondary) from your Meridian Cloud Partner API subscription.
To find your subscription keys, in the Meridian Cloud API Developer Portal, open the Profile tab. The Subscription details table shows your primary and secondary keys.
-
For each destination property described below, enter the matching field in the intermediate file:
-
GlobalId: Unique identifier of the asset
-
TagNumber: Asset number
-
TagType: Asset type (Work-Order, Equipment, or Location)
-
TagStatus: Asset status
-
TagDescription: Description of the asset
-
FunctionalLocation: Location of the asset
The tool automatically shows each Destination Property that needs to be mapped to a column from your source.
-
-
In the Source Field column, type the spreadsheet column name that maps to the destination field.
Large Import Considerations
Importing over 50K assets via the Cloud API can cause issues because of the large number of requests received by the Meridian Cloud VM. We recommend splitting large imports into batches of 50K per import, per six hours.