Troubleshooting
Common Issues
Requesting support for failed WorkItems
Please provide the following information when requesting support for failed WorkItems:
- WorkItem IDs for WorkItems created less than 30 days ago.
- Report(s) for WorkItems.
If the issue cannot be identified from the above information, further diagnosis will require the following:
- AppBundle zip file: minimal code that reproduces the issue is preferred.
- Payloads for Activity and WorkItem.
- The inputs, including JSON strings passed in the WorkItem payload. For example:
"countItParams": { "url": "data:application/json,{'walls': true, 'floors': true, 'doors': true, 'windows': true}" }
“Cannot parse ID” error on alias creation for AppBundle/Activity
There are the following limitations on alias names:
- Maximum alias length is 40 characters.
- Only alphanumeric characters and _ (underscore) are allowed.
- You need to use unqualified or fully qualified IDs depending on the context.
Note that there is a limit on the number of aliases. For more details, check the Rate Limits and Quotas page. For more details on unqualified/fully qualified IDs, check the Aliases and IDs page.
“Failed to prepare app package(s)” error when executing a WorkItem
If you encounter this error, it might be caused by an issue that occurred when uploading the AppBundle zip file.
Check the following:
- Ensure the file structure in your AppBundle zip file is correct (e.g., PackageContents.xml must be at the same level as the Contents directory).
- If the AppBundle zip file is correct, ensure it was uploaded correctly (e.g., when making requests in Postman, the ‘file’ key must be of type ‘File’, not ‘Text’).
Non-English filenames in ZIP files
By default, most ZIP archivers do not use UTF-8 encoding to store filenames, and ZIP archives created from them do not store a code page for filenames. As a result, the Automation Service needs a hint to extract filenames from the archive correctly. Use one of the following workarounds if filenames in your ZIP archive are not in the ASCII code page:
- Force UTF-8 usage in your archiver. For example, 7-Zip accepts the “cu” parameter to use UTF-8 for filenames.
- Add a hint file to the ZIP. A hint file is an empty “XYZ.codepage” file, where “XYZ” is either a code page name or a code page number. For example, for Cyrillic it can be “CP866.codepage” or “866.codepage”.
504 gateway timeout issue
If you encounter a “504 gateway timeout” error, it is often sufficient to retry the request to resolve it.
413 payload too large error
If you encounter a “413 Payload too large” error when posting a WorkItem, it may be due to one of the following reasons:
- Check how many presigned URLs you are using to specify a WorkItem’s downloads. Some presigned URLs tend to be quite lengthy. If this is the case, pack the inputs into a single zip file and specify only one presigned URL for the zip file in the WorkItem’s payload.
- Check your input arguments. If you have a long section of inputs for a single argument in the payload, consider saving this as a single downloadable JSON file and provide only a presigned URL to that file in the WorkItem’s payload.
For the permitted size of JSON payload, check the Rate Limits and Quotas page.
Revit-specific issues
RevitServerUnauthenticatedUserException error when executing on a published RCW file or incorrect execution on a central or local model
If you encounter this error, your file is most likely not opening with the correct options.
To open the file properly, you must specify the correct behavior by opening the file within your add-in.
Implement the following:
- Ensure the /i command line option is not set. This will prevent the Automation Service from opening the file and throwing an exception.
- Verify that you have hardcoded a localName within your activity - this will allow you to open the file with the same relative/path/to/file regardless of the name of the file downloaded.
- Open the file with the correct options and filepath:
Application rvtApp = data.RevitApp; OpenOptions openOptions = new OpenOptions(); FilePath modelFilePath = new FilePath("relative/path/to/file"); openOptions.DetachFromCentralOption = DetachFromCentralOption.DetachAndPreserveWorksets; Document doc = rvtApp.OpenDocumentFile(modelFilePath, openOptions);
To access and modify both Revit workshared cloud models and non-workshared cloud models, please refer to the Revit Cloud Models Integration page.
Inventor-specific issues
“FailedExecution” error when executing an Inventor WorkItem
If you encounter this error, it might be due to problems opening IPT/IAM files, iLogic errors, etc.
Check the following:
- Ensure the IPT/IAM file can be opened in Inventor with the same version as defined in the Activity.
- Ensure the iLogic rule can run in Inventor.
Error when trying to save an Inventor IDW document to Inventor DWG format using Document.SaveAs()
This is a known issue in Inventor engines. It is recommended that you use the function DrawingDocument.SaveAsInventorDWG() instead:
DrawingDocument.SaveAsInventorDWG(sPath + "xxx.dwg", true)
Error when trying to export an Inventor document to Revit family file (RFA) and Industry Foundation Classes file (IFC)
This is a known issue in Inventor engines when using functions ExportBuildingComponent and ExportBuildingComponentWithOptions. The error “Unspecified error (Exception from HRESULT: 0x80004005 (E_FAIL))” appears when trying to export building components using Inventor engines.
It is recommended that you use Revit together with Inventor to convert the RFA and IFC files. Please check the inventor2revit sample for reference.
Inventor functions requiring installed Excel
On the Automation Service, some functions that work with Excel formats are not supported.
This includes:
- Weld Bead Report
- Import Points
- Export BOM
- Insert Object
- Positional Representation
- Exporting tables in drawings
Starting from the sample plugin
It is recommended that you start with the sample plugin to build your own plugin bundle and upload the bundle to the Automation Service.
Error when trying to save an Inventor document through an iLogic rule
If you need to save your document, we recommend that you do so in your plug-in instead of your iLogic rule. Do not use the ThisDoc.Save() command in iLogic rules.