Outbound Operations - Enterprise Integration Server - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - Standard - external - Standard - Premier

Update

Updates data in an AutoFill Keyword Set directly from the line-of-business application.

Before configuring this operation, you must configure an AutoFill Keyword Processor. The AutoFill Keyword Processor is used to update data in OnBase with the data obtained by this operation. For information on configuring an AutoFill Keyword Processor, see the AutoFill Keyword Sets module reference guide.

When using this operation:

• Only AutoFill Keyword Sets configured to use an AutoFill Keyword Processor are available for selection.

• If the processor's configured path does not include wildcards (for example, C:\Autofilldata\keyset.txt), Keyword Values are written to the file specified. If this file does not exist, a new one is created.

• If the processor's configured path does include wildcards (for example, C:\Autofilldata\*.txt), Keyword Values are written to a new file each time the operation is sent to the Hyland Adapter. Each file is assigned a randomly generated alphanumeric file name. Wildcards included in the file name's extension are replaced with txt(for example, keyset.* becomes keyset.txt).

• If the primary Keyword Value coming from the line-of-business application does not already exist in OnBase, a new AutoFill Keyword Set entry is created containing the primary and secondary Keyword Values.

• If the primary Keyword Value coming from the line-of-business application already exists in an AutoFill Keyword Set, the primary Keyword Value and corresponding secondary Keyword Values are saved to the processor's configured path.

ExecuteSimpleQuery

Performs a Custom Query in OnBase directly from the line-of-business application.

When using this operation:

• By Document Type, By Document Type Group, and By Keyword are the only Custom Query types that are supported.

  Note:

  To execute a By Keyword Custom Query, a Keyword Value or Date must be provided.

• All Custom Queries are executed as binary and value equals.

When using this operation, the following are not supported:

• Binary Operators

• Value Operators

ExecuteDisplayColumnQuery

Performs a Custom Query in OnBase directly from the line-of-business application. When this operation is executed, results will be displayed using any configured Display Columns for that Custom Query. See the System Administration documentation for more information on configuring Custom Queries.

When using this operation:

• By Document Type, By Document Type Group, and By Keyword are the only Custom Query types that are supported.

  Note:

  To execute a By Keyword Custom Query, a Keyword Value or Date must be provided.

• All Custom Queries are executed as binary and value equals.

When using this operation, the following are not supported:

• Binary Operators

• Value Operators

Archive

Archives a document in the selected OnBase Document Type, directly from the line-of-business application.

When using this operation:

• The file must be converted into a Base64 string before it can be archived in OnBase.

• If the Document Type is configured for revisions and there is already an existing document with the same Keyword Values in OnBase, the newly archived document is stored as a revision.

• If the Document Type is configured for renditions, there is already an existing document with the same Keyword Values in OnBase, and the newly archived document's File Type is different than the existing document's File Type, the newly archived document is stored as a rendition.

• If the Document Type is configured for both revisions and renditions, the following is the order of precedence in which the Enterprise Integration Server stores the newly archived document:

  1. As a rendition, if the newly archived document's File Type is different than the existing document's File Type.
  2. As a revision, if the newly archived document's File Type is the same as the existing document's File Type.
  3. As a new document, if there is not already an existing document with the same Keyword Values in OnBase.

DocumentBytes

Requests a specific document from OnBase. The document will be sent to the Enterprise Integration Server within a byte stream.

When using this operation:

• The documents will be received in the response message in Base64 string format along with the file extension.

• The latest revision of the selected document will be sent.

• If the selected document's Document Type allows renditions, the rendition of the lowest numbered (1 being the lowest) file format ID for the latest revision will be sent.

• Image documents will be sent as .tiff files.

• Image documents that are comprised of multiple files will be sent as a single .tiff file, regardless of whether or not the original file type was .tiff.

• Documents will be sent as .tiff files if the EIS request contains a value of true for the overlay node, or if no value is passed in the request for the overlay. This applies even if the document type is not configured to use overlays.

• Documents will be sent using the default file extension of the document if the EIS request contains a value of false for the overlay node.

DocumentURL

Receives an OnBase Document Handle and returns a DocPop URL for that document.

When using this operation:

• This operation will only accept a valid document handle. Keywords and other criteria supported by the DocPop URL Creator are not supported for use with this operation.

• This functionality can be used with checksums (i.e., when the EnableChecksum option in the Application Server web.config file is set to true).

• The AppNet Directory and EnableChecksum options in the Application Server web.config file control the behavior of the DocPop URL generated. See Application Server Web.config Settings for more information on these options.

Read

This operation accepts an OnBase document handle and returns the document properties and keyword metadata for that document.

When using this operation:

• This operation does not return non-keyword E-Form field data.

• This operation does not include an action property.

Update

Updates OnBase Keyword Values directly from the line-of-business application for the selected document.

When using this operation:

• When a value is received from the line-of-business application, all existing values for that Keyword Type on the document are deleted. The newly received values are then added to the document.

• If no value or an empty value is received from the line-of-business application, all instances of that Keyword Type on the document are deleted.

• If Keyword Values are being updated at the same time Keyword Values are updated with this operation, all keyword updates are retained. If the same Keyword Value is being updated, multiple instances of the Keyword Type are created.

• Multiple instances of a Keyword Type are supported.

When using this operation, the following are not supported:

• Keyword Types that are part of a Multi-Instance Keyword Type Group or a Keyword Type Group.

  Note:

  If you configure this operation with a Document Type that contains a Keyword Type Group or Multi-Instance Keyword Type Group, schema nodes for the Keyword Type Group or Multi-Instance Keyword Type Group are not displayed.

• Keyword Types that are part of an AutoFill Keyword Set.

• Updating Document Dates.

• Updating Keyword Values on documents that have been re-indexed into a different Document Type.

• Updating Keyword Values on specific revisions of documents.

Compose | Compose Document

Compose a document based on an existing Document Composition template.

When using this operation:

• If a default Document Type ID is configured and no Document Type ID is supplied by this operation, the default Document Type ID will be used.

• File format(s) (word, image, tiff) flagged by the Document Composition template are created as long as the Document Type for the document is renditionable.

• You must be licensed for Document Composition.

Get | Get Templates

Returns information on all Document Composition templates stored in the Template Group for the provided Document Type ID number.

When using this operation:

• If input parameters are invalid or missing, or no Document Composition templates exist within the provided Template Group, an error will be logged in the Diagnostics Console.

• You must be licensed for Document Composition.

Create

Creates an E-Form or Virtual E-Form in OnBase directly from the line-of-business application. E-Forms with non-keyword fields can also be created.

When using this operation:

• Ensure that you are familiar with the E-Form design considerations outlined in Enterprise Integration Server E-Form Design Overview.

• E-Forms created with this operation are always saved as new documents, regardless of the Document Type's revision configuration.

• AutoFill Keyword Sets containing unique primary Keyword Values will populate secondary Keyword Values on the E-Form only if an AutoFill Keyword Set button is configured on the E-Form.

  CAUTION:

  Ensure that you have thoroughly tested the configuration of E-Form OBKey fields before deploying a configuration that uses this operation. E-Forms with incorrectly configured OBKey fields will cause errors and substantially affect Enterprise Integration Server performance.

• You must be licensed for E-Forms.

When using this operation:

• Entities have a cascading effect, such that if a parent/child relation has dependent fields, these fields are created, updated, read, or deleted automatically.

• When creating an entity where a child is made up of two parent entities, all parent entities are required to create a child entity.

• When reading an entity, only attributes that contain values are sent from the Hyland Adapter. Null values are not sent.

• When updating an entity, each update results in new instance IDs for each child entity. The parent entity retains the same instance ID following the update.

• Multiple instances of child entities are supported for reading, creating, and updating.

  CAUTION:

  This operation uses two methods to update entities. For the parent entity, an update to the field values is performed, and the instance of the entity is retained. For any child entities, all instances are deleted. New instances are then created based on the data provided. Because of this method of updating, any unmapped field within a child entity will not have any existing value retained. If updates are going to be performed on entities where associative relationships exist, these relationships must be recreated.

• Child entities that have multiple parent entities are supported.

• Only Public fields are available. Related fields and key fields are only available for cross-referenced entity types.

Delete

Deletes deficiency data in OnBase directly from the line-of-business application.

Update

Updates deficiency data in OnBase directly from the line-of-business application.

Create

Creates a Unity Form in OnBase directly from the line-of-business application.

When using this operation:

• Default values are supported. If an empty value is sent for a field, or if the field is unmapped, the Hyland Adapter sets the default value of the Unity Form field.

• Required fields are supported. If the field is marked as required, the Unity Form cannot be created unless all the required fields are mapped and sent a non-empty value.

• Nested tables are supported.

• Values must follow any configured keyword masking. When values do not follow the configured keyword masking, the Unity Form will not be created.

• AutoFill Keyword Set expansion is not supported.

• Auto increment Keyword Types are not supported.

• The Hyland Adapter attempts to create Unity Form repeater instances if at least one instance of a Unity Form repeater is sent.

Delete

Deletes a Unity Form in OnBase directly from the line-of-business application.

Read

Reads a Unity Form in OnBase directly from the line-of-business application.

Update

Updates a Unity Form in OnBase directly from the line-of-business application.

When using this operation:

• Values must follow any configured keyword masking. When values do not follow the configured keyword masking, the Unity Form will not be updated.

• If a NULL value is received from the line-of-business application, the value of that Unity Form field on the Unity Form is deleted.

• If a Document Type is configured for revisions, a new revision is created each time this operation runs. If a Document Type is not configured for revisions, the latest revision is updated.

• Unity Form fields configured as signature fields should not be used. This is because the Enterprise Integration Server performs this operation by deleting all existing instances of mapped fields, and then creating new instances, which invalidates Unity Form fields configured as signature fields.

• Auto increment Keyword Types are not supported.

Execute

Executes a Unity Script in OnBase directly from the line-of-business application.

When creating the Unity Script, ensure that you select the IEISScript Unity Script type in the Unity Project Creation Wizard.

BatchScanning

If you are using the ScanQueue inbound operation, this operation allows you to mark a batch of OnBase documents as processed directly from the line-of-business application.

These operations are only available if UseCanonicalSchema is set to true. See 12 for more information on this setting.

The operations within this category are canonical versions of standard operations. The following operations are available:

• archivedoc: canonical version of Document | Archive. See fxq1646179342898.html#fxq1646179342898__p_nnw_qkh_dtb .

• AutoFillUpdateCanonical: canonical version of AutoFill | Update. See fxq1646179342898.html#fxq1646179342898__p_lzv_hmh_dtb .

• composeTemplate: canonical version of DocumentComposition | Compose. See fxq1646179342898.html#fxq1646179342898__p_vmw_pmh_dtb.

• createeform: canonical version of EForm | Create. See fxq1646179342898.html#fxq1646179342898__p_jzx_smh_dtb.

• createunityform: canonical version of UnityForm | Create. See fxq1646179342898.html#fxq1646179342898__p_pmk_vmh_dtb.

• Delete_Deficiency: canonical version of Medical Records | Delete. See fxq1646179342898.html#fxq1646179342898__p_eps_ymh_dtb.

• deleteunityform: canonical version of UnityForm | Delete. See fxq1646179342898.html#fxq1646179342898__p_pmk_vmh_dtb.

• downloaddocumentbytes: canonical version of Document | DocumentBytes. See fxq1646179342898.html#fxq1646179342898__p_nnw_qkh_dtb.

• executeadhoc: canonical version of Workflow. See fxq1646179342898.html#fxq1646179342898__p_k3f_gnh_dtb.

• executeQuery: canonical version of CustomQuery | ExecuteSimpleQuery. See fxq1646179342898.html#fxq1646179342898__p_bmn_3nh_dtb.

• Execute_unity_script: canonical version of UnityScript | Execute. See fxq1646179342898.html#fxq1646179342898__p_tjl_lnh_dtb.

• getdocpopurl: canonical version of Document | DocumentURL. See fxq1646179342898.html#fxq1646179342898__p_nnw_qkh_dtb.

• readunityform: canonical version of UnityForm | Read. See fxq1646179342898.html#fxq1646179342898__p_pmk_vmh_dtb.

• WorkViewCreateData: canonical version of WorkView | Create. See fxq1646179342898.html#fxq1646179342898__p_ud2_qnh_dtb.

• WorkViewReadData: canonical version of WorkView | Read. See fxq1646179342898.html#fxq1646179342898__p_ud2_qnh_dtb.

• WorkViewDeleteData: canonical version of WorkView | Delete. See fxq1646179342898.html#fxq1646179342898__p_ud2_qnh_dtb.

• WorkViewUpdateData: canonical version of WorkView | Update. See fxq1646179342898.html#fxq1646179342898__p_ud2_qnh_dtb.

• Update_Deficiency: canonical version of Medical Records | Update. See fxq1646179342898.html#fxq1646179342898__p_eps_ymh_dtb.

• updatedoc: canonical version of Document | Update. See fxq1646179342898.html#fxq1646179342898__p_nnw_qkh_dtb.

• updateunityform: canonical version of UnityForm | Update. See fxq1646179342898.html#fxq1646179342898__p_pmk_vmh_dtb.

Enables the Enterprise Integration Server to execute an ad-hoc task from the selected Workflow queue on a document.

When using this operation:

• All Workflow life cycles, queues, and tasks are available for selection.

• A Workflow license is not consumed during task execution.

• Ad hoc tasks that require user interaction are not supported.

Create

Creates a WorkView object in the selected application and class, directly from the line-of-business application.

When using this operation:

• If you send an alphanumeric value that is longer than the maximum length for that attribute in WorkView, the WorkView object is created. However, any characters that are greater than the maximum are not included. For example, if the maximum length for that attribute in WorkView is 5 and abcdefg is sent, only abcde will be included for the value.

• You must be licensed for WorkView.

• External classes are not available for use.

Delete

Deletes a WorkView object from the selected application and class, directly from the line-of-business application.

When using this operation:

• If you attempt to delete a WorkView object that is being viewed or edited, the object is deleted. However, if the user viewing or editing the object saves their changes, the object is restored.

• You must be licensed for WorkView.

• External classes are not available for use.

Execute Filter

Executes a WorkView filter from the selected application and class, directly from the line-of-business application.

When using this operation:

• You must be licensed for WorkView.

• External classes are not available for use.

• The following numeric values correspond to the available search operators:

  • Equal = 0

  • LessThan = 1

  • GreaterThan = 2

  • LessThanEqual = 3

  • GreaterThanEqual = 4

  • NotEqual = 5

  • Soundex = 6

  • Like = 7

  • NotLike = 8

  • Null = 9

  • NotNull = 10

  • In = 11

• The list of values that can go into Connector are: And, Or.

Read

Reads a WorkView object in the selected application and class, directly from the line-of-business application.

When using this operation:

• Only WorkView attributes that contain values are sent from the Hyland Adapter. Null values are not sent.

• You must be licensed for WorkView.

• External classes are not available for use.

Update

Updates a WorkView object in the selected application and class, directly from the line-of-business application.

When using this operation:

• If you send an alphanumeric value that is longer than the maximum length for that attribute in WorkView, the WorkView object is updated. However, any characters that are greater than the maximum are not included. For example, if the maximum length for that attribute in WorkView is 5 and abcdefg is sent, only abcde will be included for the value.

• If an element that is mapped within a BizTalk orchestration is excluded from the data submitted to the Enterprise Integration Server, the behavior is dependent upon on the values specified for the Max Occurs and Min Occurs properties.

  When Max Occurs and Min Occurs are both 1, previous values for that element are deleted. This is because the element is included in the outgoing message with value of NULL.

  When Min Occurs is 0, values for that element are not modified. This is because the element is excluded from the outgoing message.

  Note:

  Because multiple instances of a single attribute are not supported, Max Occurs and Min Occurs should not be configured as values greater than 1.

• You must be licensed for WorkView.

• External classes are not available for use.