Claris FileMaker Upgrade Tool Guide

https://help.claris.com/en/app-upgrade-tool-guide/
Admin
Command-line tool documentation for applying schema, layout, and script changes to FileMaker Pro...
Tokens:6,116
Snippets:56
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Generate GUIDs

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/example-command-usage.html

Command to generate GUIDs in a FileMaker application.

```bash
./FMUpgradeTool --generateGUIDs -src_path ./MyApp-v1.fmp12 -src_account Admin -src_pwd admin
```

--------------------------------

### Example Usage of FMUpgradeTool for Updating a FileMaker Pro File

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/command-line-parameters.html

This example demonstrates how to use the `FMUpgradeTool` with the `--update` subcommand to update a FileMaker Pro file. It specifies the source file path, encryption key, account credentials, plugin folder, patch file path, and the destination path for the upgraded file.

```bash
FMUpgradeTool --update  \
    -src_path ./MySourceApp.fmp12 \
    -src_key MyEncryptionPassword \
    -src_account Admin \
    -src_pwd MyAdminPassword \
    -plugin_folder ./plugin/ \
    -patch_path ./MyPatch.xml \
    -dest_path ./MyPatchedApp.fmp12
```

--------------------------------

### Generate GUIDs Subcommand

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/workflow.html

Example of using the `--generateGUIDs` subcommand with the upgrade tool to add GUIDs to objects in the original version of an app.

```bash
upgrade_tool --generateGUIDs
```

--------------------------------

### Update Application with Patch

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/example-command-usage.html

Command to test and apply a patch file to update a FileMaker application.

```bash
./FMUpgradeTool --update -src_path ./MyApp-v1.fmp12 -src_account Admin -src_pwd admin -patch_path ./v1-v2-patch.xml -dest_path ./MyApp-v1-patched-to-v2.fmp12 -v
```

--------------------------------

### DeleteAction Example (Catalog)

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/patch-file.html

Example of using DeleteAction to delete a catalog using CatalogReference.

```xml
<DeleteAction>
  <CatalogReference
    catalogName="AccountsCatalog"
    uuid="4E2F65F4-D97B-4604-...">
  </CatalogReference>
<DeleteAction>
```

--------------------------------

### AddAction Patch File Example

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/add-action-example.html

This XML code demonstrates the structure of a patch file designed to add a new field to a table in a FileMaker database.

```xml
<?xml version="1.0"?>  
<FMUpgradeToolPatch version="2.2.3.0">  
	<Structure>  
		<AddAction>  
			<FieldsForTables membercount="1">  
				<FieldCatalog>  
					<UUID>A434D930-F3BE-4833-A8CF-D8BE9A5A8D31</UUID>  
					<TagList></TagList>  
					<BaseTableReference id="129" name="Table" UUID="9B93EC91-B53E-407B-AF5B-F1961A8CD109">  
					</BaseTableReference>  
					<ObjectList membercount="6">  
						<Field DefaultStyle="" id="6" name="Note" fieldtype="Normal" datatype="Text" comment="">  
							<UUID>9ADC7007-D176-4872-8982-B33CD51FAA61</UUID>  
							<TagList></TagList>  
						</Field>  
					</ObjectList>  
				</FieldCatalog>  
			</FieldsForTables>  
		</AddAction>  
	</Structure>  
</FMUpgradeToolPatch>
```

--------------------------------

### Validate Patch File

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/example-command-usage.html

Command to validate a patch file for a FileMaker application.

```bash
./FMUpgradeTool --validatePatch -src_path ./MyApp-v1.fmp12 -patch_path ./v1-v2-patch.xml -src_account Admin -src_pwd admin
```

--------------------------------

### AddAction Example

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/patch-file.html

Example of using AddAction to add a new object, specifying catalog and object UUIDs.

```xml
<AddAction>
  <LayoutCatalog>
    <UUID>Z3D7AF30-4E47-...</UUID>
    <TagList></TagList>
    <Layout>
      <PartsList>
        <Part>
          <ObjectList>
            <LayoutObject>
              <UUID>5D660197-8995...</UUID>
      ...
    </Layout>
  </LayoutCatalog>
<AddAction>
```

--------------------------------

### DeleteAction Example (Object)

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/patch-file.html

Example of using DeleteAction to delete an object in a catalog using ItemReference.

```xml
<DeleteAction>
  <ItemReference
    UUID="E2A7AF30-4E47-..."
    type="ExtendedPrivilegeReference">
  </ItemReference>
<DeleteAction>
```

--------------------------------

### ReplaceAction Patch File Example

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/replace-action-example.html

This XML snippet demonstrates how to create a plaintext patch file (v1-v2-patch.xml) to apply changes to a LayoutObject, specifically a rectangle, using the ReplaceAction element. It includes references to the layout and the object itself, along with its modified properties like name, bounds, and tooltip.

```xml
<?xml version="1.0"?>  
<FMUpgradeToolPatch version="2.2.3.0">  
  <Structure>  
    <ReplaceAction>   
      <!-- Layout object's UUID -->  
      <Replace type="LayoutObject" UUID="5D660197-8995-4AE1-9C53-989AD6394604">  
        <!-- Layout's UUID -->  
        <LayoutReference id="1" name="Table" width="1024" UUID="B5470113-1D0F-4787-99B0-00BD19AF6600">  
        </LayoutReference>  
        <LayoutObject id="1" type="Rectangle" name="MyRectangleObjectName" kind="5">  
          <!-- Layout object's UUID -->  
          <UUID>5D660197-8995-4AE1-9C53-989AD6394604</UUID>  
          <Bounds top="88" left="29" bottom="140" right="86"></Bounds>  
          <Options>805322752</Options>  
          <Rectangle></Rectangle>  
          <Tooltip>  
            <Text><![CDATA["My rectangle tooltip."]]></Text>  
          </Tooltip>  
        </LayoutObject>  
      </Replace>  
    </ReplaceAction>  
  </Structure>  
</FMUpgradeToolPatch>
```

--------------------------------

### ReplaceAction Example

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/patch-file.html

Example of using ReplaceAction to modify an existing object, specifying its type and UUID.

```xml
<ReplaceAction>
  <Replace
    type="LayoutObject"
    UUID="EBF21276-CE7C-...">
    ...
  </Replace>
<ReplaceAction>
```

--------------------------------

### Patch file for changing supported settings

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/patch-file.html

An XML patch file demonstrating how to change various settings using the Metadata element, including client sharing, login, password saving, toolbars, spelling, and text data entry.

```xml
<?xml version="1.0"?>  
<FMUpgradeToolPatch version="2.2.3.0">  
  <Metadata> <!-- Required tag -->  
    <AddAction> <!-- Required tag -->  
      <HideClientSharing enable="True"></HideClientSharing> <!-- FileMaker Network clients, enable: Don't display in host's file list -->  
      <HideWebDirectSharing enable="True"></HideWebDirectSharing> <!-- FileMaker WebDirect clients, enable: Don't display in host's file list -->  
      <Login type="1"> <!-- type: Automatic log-in ON ("1"), OFF ("-1") -->  
        <AccountName>Admin</AccountName>  
        <Password></Password>  
      </Login>  
      <SavePassword keychain="True" requireMobile="True"></SavePassword> <!-- keychain: Allow stored credentials for authentication; requireMobile: Require iOS and iPadOS passcode -->  
      <ShowSignInFields enable="True"></ShowSignInFields> <!-- enable: Show sign-in fields even when OAuth or AD FS is enabled -->  
      <HideToolbars enable="True"></HideToolbars> <!-- enable: Hide all toolbars -->  
      <Spelling whileTyping="Beep" underline="True"></Spelling> <!-- whileTyping: Check spelling as you type ("Beep"/"Off"); underline: Indicate questionable words with special underline -->  
      <Text>  
        <Handle smartQuotes="True" asian="True" roman="True"></Handle> <!-- smartQuotes: Use smart quotes; asian: Use Asian language line-breaking; roman: Use Roman language line-breaking -->  
        <DataEntry type="512"></DataEntry> <!-- type: Ask whenever settings are different ("512"); Always use current system settings ("1024"); Always use file's saved settings ("0") -->  
      </Text>  
    </AddAction>  
  </Metadata>  
</FMUpgradeToolPatch>
```

--------------------------------

### Encrypting a patch file

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/encrypted-patch-file.html

This command encrypts a patch file using the upgrade tool, requiring a patch path, a passkey, and a destination path for the encrypted file.

```bash
FMUpgradeTool --encryptPatch 
    -patch_path ./plaintext-patch.xml 
    -patch_key k4EuhSEG 
    -dest_path ./encrypted-patch.fmpatch
```

--------------------------------

### Patch File Structure

Source: https://help.claris.com/en/app-upgrade-tool-guide/content/patch-file.html

The top-level structure of a patch file for the Claris FileMaker Upgrade Tool.

```xml
<?xml version="1.0"?>  
<FMUpgradeToolPatch version="2.2.3.0">  
		<Structure>  
				<!-- One or more *Action elements -->  
				<AddAction> ... </AddAction>  
				<DeleteAction> ... </DeleteAction>  
				<ReplaceAction> ... </ReplaceAction>  
		</Structure>  
		<Metadata>  
				<AddAction> ... </AddAction>  
		</Metadata>  
</FMUpgradeToolPatch>
```
Tokens:
Raw