OpenText Content Manager (.NET SDK)

Workgroup Server URL

The primary workgroup server URL. Protocol and port components are optional and will default to TCP and 1137.

For example,

• tcp://trim81.demo.ezescan.com.au:1137/

• http://trim81.demo.ezescan.com.au:8080/

• https://trim81.demo.ezescan.com.au:8443/

Refer to Content Manager Enterprise Studio for configured protocols and ports.

Database ID

Enter the ID of the Database you want to login to (e.g. 45, TD, PD).

Click the browse button ... to display the available Content Manager datasets.

The list of available databases can only be browsed when using a TCP connection and authentication is Integration Windows Authentication (all other options do not work).

Authentication Method

The authentication method:

• ADFS

• Explicit Windows Authentication

• Google Apps

• Integrated Windows Authentication

• OpenID Connect

Default is Integrated Windows Authentication.

Client ID

The Client ID of the confidential client configured in Content Manager Enterprise Studio to be used for non-interactive OpenID Connect authentication.

Client Secret

The Client Secret of the confidential client configured in Content Manager Enterprise Studio to be used for non-interactive OpenID Connect authentication.

UserName

The UserName to use for Explicit Windows Authentication, or leave blank to prompt.

Password

The Password to use for Explicit Windows Authentication, or leave blank to prompt.

Trusted User

Connect using the supplied user name instead of the user name of the currently logged in process. Required for non-interactive OAuth authentication.

Impersonate User

Enter the login name to impersonate when connecting to the database, or leave blank if impersonation is not required.

This is used mainly in server environments. The operator may require to use another username to impersonate when searching and uploading records.

The username will need to be configured with impersonate access in the Content Manager Enterprise Studio.

CLASSIFICATION

The Classification function allows an operator to browse and select a Classification from the list of available Content Manager Classifications.

The function also includes the option of a Record Type for when the Classification is directly defined to a particular Record Type. The Record Type value can be hardcoded (chosen via a browse button), or can be the contents of a previous field’s value.

The below example pic shows the Record Type as being defined in KFI field 1, alternatively a Record Type can be hardcoded via selecting using the Browse button on the right.

LOOKUP CLASSIFICATION

The Classification function also has an Action Type of “Lookup Classification” where a query can be built to return a particular Classification value.

Supported output property placeholder values are:

IdNumber - The code for the Classification e.g. 122/600/

Name - The name of a Classification node e.g. Accounting

Title - The full title of the Classification e.g. Accounting - Accounting Stores in Transit

URI - The OTCM Uri number assigned to the found item. e.g. 94

Supported search property placeholders:

title  - The full title of the Classification

name - The names of a Classification node

number - The Classification number

The Example query as shown below will search for the Classification Title value where there is a required Record Type attached to the Classification.

Search Query: title="<<F2>>" and recordType[name="<<F1>>"]

Display Value Format: {Title}

The “First” option will return the first returned result where there are multiple results.

The “Single Only” option requires the search return exactly one result only, where there is more than a single result a null value will be returned.

The Classification below as it exists in OTCM (no Record Type assigned).

The above Classification Lookup example results in EzeScan.

The fields examples are populated based on a lookup of a Classification title with each field returning a different value. Search Query: title="<<F2>>" Display Value Format: {Title} Search Query: title="<<F2>>" Display Value Format: {Name} Search Query: title="<<F2>>" Display Value Format: {IdNumber}

Searches can also be joined with the and/or operators.

The Classification lookup functionality also includes the option of an “Output Field Value” as show by the Green arrow.

The default is not populated, however if populated with one of the standard output property placeholders, the following will occur.

A special hidden and linked field will be automatically created as the following field suffixed with “ID”.

The auto created field will populate with the output value of the Placeholder in the “Output Value Format” of the preceding field.

The functionality is to provide additional data return options, for example to lookup and display a Classification Title while also returning the Classification’s number, or vice versa.

Once created the two fields are forever linked and deleting one will automatically delete the other.

CONTAINER RECORD UI

This will allow the KFI operator to choose which OTCM Container to attach the document to.

During profiling, when the KFI browse button ... is clicked by the operator, the Select From Records - My Containers screen is displayed.

The operator can then select the item from the list, or search for a container (and with the correct upload mapping) which will apply the Container value to the saved document.

CONTAINERS

This will allow the KFI operator choose which container to attach the document to. During profiling, when the KFI browse button ... is clicked by the operator, the Select From Records - My Containers screen is displayed.

The operator can then select the item from the list, or search for a container (and with the correct upload mapping) which will apply the Container value to the saved document.

This method provides the operator with the ability to search for a container if it’s not in the list; whereas the Container Record UI function does not.

CONTAINERS BY CLASSIFICATION

This will allow the KFI operator choose which container to attach the document to.

During profiling, when the KFI browse button ... is clicked by the operator, the Select From Records - My Containers screen is displayed.

The operator can then select the item from the list, or search for a container via classification (and with the correct upload mapping) which will apply the Container value to the saved document.

CONTAINERS BY QUERY

This will allow the KFI operator choose which container to attach the document to. The operator can use the search methods required to find the respective container.

The operator can then search for a Container and select the item from the list (and with the correct upload mapping) which will apply the Container value to the saved document.

EXECUTE QUERY

This option will allow returning of data from a Record or Location type object.

There are four settings in this option:

1. Object Lookup Query: The query to be run e.g. Record/Title/Containswords/Test

   • Field placeholders can be used to insert a value into the query e.g.

     TEXT

     Record/Number/Equals/<<F1>>

   • Query is split into components before replacing placeholders.

   • Raw query values containing slashes (/) can be escaped using tilde (~) e.g.

     TEXT

     Record/Number/Equals/2022~/1234

2. Query Result Format: What data to return e.g. {number}

3. Query Result Return:

   • First: Will always use the first result from the search.

   • Definitive: Will return the first result if only one result, if multiple then no result is returned. This is because EzeScan will not know which result to choose.

   • List: If there is more than one result this will return a pull down list of values into the KFI field. If one result then it will be displayed as the value.

4. Max Results: This is used with the list option. It will allow how many results to be displayed.

The query field needs to be run after the field it is looking up e.g. If the Record/Location is Field 3 then this execute query field would have to be from either Field 4 or onwards.

Examples are provided in section Execute Query statements

LOCATIONS

This will allow the KFI operator to choose which location to apply to a location type attribute applied to the document.

The operator can also filter the location types to only display active or inactive locations and internal or external locations (or the default of both).

When they click on the browse button ... in the KFI they should see this screen…

The operator can then select the item from the list, or search for a location (and with the correct upload mapping) which will apply the location value to the saved document.

LOOKUP SET

Follow these steps…

• Select Lookup Set from pulldown list

• Click the browse button ... on Lookup Set field

You may have to run a search (using the Search button) to locate the Lookup Sets.

• Select the required Lookup Set from the OTCM window

When the operator clicks on the browse ... button in the KFI they should see this screen; based on the Lookup Set selected in the settings (above)…

The operator can then select the item from the list (and with the correct upload mapping) which will apply the item value to the saved document.

RECORD ACTIONS

This will allow the KFI operator to choose an existing OTCM Record Action to apply to the document. During profiling, when the KFI browse button ... is clicked by the operator, the EzeScan - Insert Action screen is displayed…

1. The operator can then click the Browse button ... to display the available actions.

   

2. Once the Action is selected click on the long browse button to choose the Responsible Location/s (assignee/s).

3. When the operator has selected the Action and Location/s, they can click Save.

The Action (with the correct upload mapping) will be applied to the saved document.

The selected Action must have the “Action can be attached to a Record” box ticked on the Action in OTCM and the “Responsible Location” have the appropriate security access to process the action; otherwise the upload process may fail.

RECORD TYPES

This will allow the KFI operator to select a record type for the document. When they click on the browse button ... in the KFI they should see this screen…

The operator can then select the item from the list (and with the correct upload mapping) will apply the record type to the saved document.

RECORDS

This will allow the KFI operator to choose an existing Record to attach the document to. This option is commonly used to apply a new revision or relate a record with the scanned document.

This will display “document” type records not Containers.

During profiling, when the KFI browse button ... is clicked by the operator, the Select From Records - Recent Documents (myDocuments) screen is displayed.

The operator can then select the item from the list (and with the correct upload mapping) which will apply the record revision or relationship to the saved document.

RECORDS BY QUERY

The operator can use the search methods required to find the respective record. When they click on the browse button ... in the KFI they should see this screen…

The operator can then search for a Record and select the item from the list (and with the correct upload mapping) which will apply the Record value to the saved document.

RETENTION SCHEDULES

This will allow the KFI operator to select a Retention Schedule for the document.

You may have to run a search (using the Search button) to locate the schedules.

When they click on the browse button ... in the KFI they should see this screen…

The operator can then select the item from the list (and with the correct upload mapping) which will apply the schedule to the saved document.

SECURITY CAVEATS

This will allow the KFI operator to select a Security Caveat for the document. When they click on the browse ... button in the KFI they should see this screen…

The operator can then select the item from the list (and with the correct upload mapping) which will apply the security caveat value to the saved document.

SECURITY LEVELS

This will allow the KFI operator to select a Security Level for the document. When they click on the browse ... button in the KFI they should see this screen…

The operator can then select the item from the list (and with the correct upload mapping) which will apply the security level value to the saved document.

WORKFLOW TEMPLATE

This will allow the KFI operator to select a Workflow for the document.

On the OTCM Content Manager tab…

1. Tick the Enable OpenText Content Manager (.NET SDK) Browse Button

2. Select Workflow Templates browse mode

3. You can add a default Workflow name if required; especially if the KFI always generates the same workflow template. Otherwise leave the field blank.

4. You can add the KFI Title field (e.g. <<F3>>) to be used as the Workflow Title; as long as it is above the Workflow field (e.g. <<F4>> or greater)

   1. Workflow names must be unique so this may cause a problem

   2. You may add other fields if needed (e.g. <<F3>> <<F4>>) to create a combined title but the field must not be more that 50 characters.

5. You can add a Default Next Assignee if required or leave it blank

When the operator clicks on the browse button in the KFI they should see this screen…

The operator can then select the workflow item from the list (and with the correct upload mapping) which will apply the workflow to the saved document.

Name ID

Search Name

3

||

Last Name

Search Name

1

||

1st Names

Search Name

2

||

Full Name

This is a Custom Extract - see details below

Name Type

Search Name

4

||

Name DOB

Search Name

5

||

Name Address 1

Search Name

6

||

Name Address 2

Search Name

7

||

Name Address Suburb

Search Name

8

||

Name Address State

Search Name

9

||

Name Address Postcode

Search Name

10

||

Name Street Address

This is a Custom Extract of the 5 fields above - see details below

Name Mobile

Search Name

11

||

Name Email

Search Name

12

||

Job Title

Search Name

13

||

Contact Type

This is a “List” of contact types - see details below

OTCM Contact Details

This is a Custom Extract - see details below

The Full Name field is not actually used in the Location creation. It is there for use in the document

Title (if required)

Custom Extract: <<1st Names>> <<Last Name>>

The Name Street Address field is a concatenation of the 5 fields above and will used for the

Location’s address.

Custom Extract: <<Name Address 1>> <<Name Address 2>>,<<Name Address Suburb>>,<<Name Address State>>,<<Name Address Postcode>>

The Contact Type field is simply a list (created on the Format tab) and generally contains these values - Author; Addressee; Client; Other.

It is used in the final process (below). The operator would select one of these values when processing the document.

The OTCM Contact Details field is a concatenation of the fields required to create the Location in OTCM. The Name ID is the key.

• This is the field which may be used in the Upload process. As it contains the Contact type you can use the AutoLoc target field.

• If the value exists on a Location then the new record will be linked to it.

• If the value does not exist then a new location will be created.

Custom Extract:

IdNumber||<<Name ID>>||Surname||<<Last Name>>||GivenNames||<<1st Names>>||Type||<<Name Type>>||DOB||<<Name DOB>>||STREETADDRESS||<<Name Street Address>>||MOBILE||<<Name Mobile>>||EMAILADDRESS||<<Name Email>>||Job Title||<<Job Title>>||ContactType||<<Contact Type>>

The resulting field would look like this:

IdNumber||912211||Surname||Flintstone||GivenNames||Fred||Type||Person||DOB||||STREETADDRESS||66 Rubble Way,BEDROCK,NSW,2442||MOBILE||||EMAILADDRESS||||Job Title||||ContactType||Author

NOTE

In the above example some of the fields did not return a value which caused multiple pipes (||||). This will not affect the upload process.

Upload Type

Should be displaying DocuShare

Change it to OpenText Content Manager (.NET SDK)

Use Global Connections Settings

This option is off by default (unticked box). Tick this option to use the default EDRMS settings from the Workstation options. See /wiki/spaces/EDS2/pages/98042224

Database ID

If Global Settings are ticked , the default database id appears in grey e.g. 45

If Global Settings are not ticked (unticked box), you then must select the appropriate OTCM dataset using the browse ... button.

• This is quite often handy if you are testing a new EzeScan job & you want to save the processed documents into a Test/Development dataset instead of Production

SDK Bitness

If Global Settings are ticked , this option is disabled.

If Global Settings are not ticked , you can then select from the list.

Impersonate Login

If Global Settings are ticked , this option is disabled.

If Global Settings are not ticked , you can then enter the log-in name to impersonate when connecting to the database, or leave blank if impersonation is not required.

Container Record Type Name

Set to Folder by default

If the operator is using the Container Barcode / Record Barcode Upload mapping, they will be required to enter the Record Type name for the Container.

This is so EzeScan can determine whether the barcode value belongs to a Record or a Container.

Create Missing Containers

Ticked by default .

If the operator is using the Container New Upload mapping to search by metadata to store the document into it, this option can be used to not create the container for if the search returns 0 results.

The operator will be displayed an error message notifying them that there is no container with those results.

Setting to Yes will create the container and store the document into it.

Bypass Document Upload

Off by default (unticked box).

This option will bypass uploading the document and create a container only.

This option is designed only for jobs that are creating containers.

This feature would usually be used with the upload option “Pass to Upload” where a second upload would run to upload the document.

Attach Document To Record

Ticked by default . The document will be attached to the newly created record.

If this is turned off (untick box), the record is created without attaching a document to it.

This would be used if no documents are required to be uploaded or if a record needs to be created to obtain the record number and then a secondary upload is called (using Pass to Upload - e.g. Burn Doc ID) to upload the document with the Record Number marked up on the image.

Use latest file part when part closed

Ticked by default . The record will be uploaded into the latest file/container part.

If this is turned off (untick box), the record will be uploaded to the defined file/container part.

Use this upload function to pass a defined file/container and part value. If enabled and a file/container has parts and no part value has been defined, the default will save to the first returned value, typically part 1 (e.g. 19/1234-001), therefore a part value should always be defined where using files/containers with parts.

ALTERNATIVE CONTAINER

This is the Alternative Container field.

• This is generally used for alternate containers such as “Day Box”

• The field can support multiple alternative container values being passed into it.

AUTHORLOC

This is the Author contact type Location field.

• This can be set from the KFI field (if used)

OR

• Set the Upload Source field to Static Value and a browse button ... will appear

• • The operator can then apply a static location for the job

  • This will contain the respective Location Name and URI - e.g. Abbott, Peter (Mr) -lu 17

• The field can support multiple Addressee values being passed into it - Abbott, Peter (Mr) -lu 17||Smithers, Betty -lu1234

Instead of supplying a Name and URI (as shown above), this field can be configured to search and create a location.

The search can be done by searching by…

1. Location ID Number

2. Surname and First Name

Refer to the following examples

OPTION 1

Option (1) The operator can use the below specific search fields for the search.

IDNUMBER, SURNAME, GIVENNAMES, INITIALS, HONORIFIC, INTERNAL, and TYPE

An example search would be like the following…

IdNumber||1282075||Surname||Smith||GivenNames||Barbara||Initials||B|| Type||Person

The 2 pipes “||” are used as a delimiter.

OPTION 2

Option (2) The operator can use the below specific search fields for the search.

SURNAME, GIVENNAMES, INITIALS, HONORIFIC, INTERNAL, and TYPE

An example search would be like the following…

Surname||Smith||GivenNames||Barbara||Initials||B||Type||Person||Internal||N

The 2 pipes “||” are used as a delimiter.

The following custom fields can also be applied.

EMAILADDRESS

BUSINESSPHONE

MOBILE

HOMEPHONE

FAX

STREETADDRESS

CITY

STATE

REGION

POSTCODE

COUNTRY

P_STREETADDRESS

P_CITY

P_STATE

P_REGION

P_POSTCODE

P_COUNTRY

The search string could be built up using the KFI Custom Extract option (please refer to the KFI User Guide for more information) or as a static value using <<IF>> placeholders.

Type should be populated with either Company or Person and… Internal should be populated with either Y or N

AUTOLOC

This mapping is used if Locations are selected with different Contact Types in the Location field details being uploaded; as covered here.

Some of the Property Systems which use the EzeScan API (e.g. Infor - Pathway) browse function “Chose NAR Link for HP TRIM” allows the operator to choose the Contact Type.

e.g. Select Author, Addressee, Client or Other before they browse the NAR.

ADDRESSEELOC

This is the Addressee contact type Location field.

• This can be set from the KFI field (if used)

OR

• Set the Upload Source field to Static Value and a browse button ... will appear

• • The operator can then apply a static location for the job.

  • This will contain the respective Location Name and URI.

e.g. Abbott, Peter (Mr) -lu 17

• The field can support multiple Addressee values being passed into it.

e.g. Abbott, Peter (Mr) -lu 17||Smithers, Betty -lu1234

CLIENTLOC

This is the Client contact type Location field.

• This can be set from the KFI field (if used)

OR

• Set the Upload Source field to Static Value and a browse button ... will appear

• • the operator can then apply a static location for the job

  • this will contain the respective Location Name and URI.

e.g. Abbott, Peter (Mr) -lu 17

• The field can support multiple Addressee values being passed into it.

e.g. Abbott, Peter (Mr) -lu 17| |Smithers, Betty -lu1234

OTHERLOC

This is the Other contact type Location field.

• This can be set from the KFI field (if used)

OR

• Set the Upload Source field to Static Value and a browse button ... will appear

• • the operator can then apply a static location for the job

  • this will contain the respective Location Name and URI.

e.g. Abbott, Peter (Mr) -lu 17

• The field can support multiple Addressee values being passed into it.

e.g. Abbott, Peter (Mr) -lu 17| |Smithers, Betty -lu1234

CLASSIFICATION

This is the Classification field.

• This can be set from the KFI field (if used)

OR

• Set the Upload Source field to Static Value and a browse button ... will appear

CONTAINER

This is the Container field.

• This can be set from the KFI field (if used)

OR

• Set the Upload Source field to Static Value and a browse button will appear

The container upload field can accept either of the following values.

1. The Container Record Number, e.g. WG21/1234

2. The Container URI (Unique Identifier) value, e.g. 123456789

 If using the URI the value must be passed to the Container upload field with the prefix of “uri=” i.e. uri=123456789

The prefix can be added via multiple methods in EzeScan KFI where the simplest would be via the “Output / Add Prefix To Output Value”.

Alternately the upload field can be direct set as static with uri=<<IF9>> where <<IF9>> contains the URI value from the KFI index field number.

Container Record Number or URI value?

As to whether the Container Record Number or URI would be the more ideal to pass to Upload, the URI being the Unique Identifier value would be the more accurate, whereas the use of a Container Record Number would be less accurate due to Content Manager potentially allowing duplicated numbering.

CONTAINER BARCODE

This is the Container Barcode field.

The Container Barcode fields are derived from the OTCM client under File, Print Report

CONTAINER BARCODE / RECORD BARCODE

This is the Barcode value for a Container or a Record.

• If a container barcode is supplied a new record will be saved into the container.

• If a record barcode is supplied a new revision of the record will be saved. 

The operator is required to enter the “Container Record Type Name” in the Upload properties. This is so EzeScan will know what Container Record type to look for.

CONTAINER NEW

For this feature to work the option in the OTCM Record Type / Numbering tab “Confirm Each Generated Number” must be ticked OFF.

This option will create a new container. In the UPLOAD field value the Name of the container must be specified and then the Container Record Number value.

There are multiple ways to search for a container before EzeScan will attempt to create it.

• By default EzeScan will perform a search for a container before creating the new container.

  • If a container with a result is found, EzeScan will save the document into this container.

  • If two or more containers are returned from the search EzeScan will store the document into the first container in the results.

• If the operator does not want EzeScan to create the container…

  • Set the Upload property Create Missing Containers to No as defined in the Create Missing Containers section (refer to the list of links to the right).

Use one of the following 3 options to set-up the “Container New” option

CONTAINER NEW - SEARCH OPTION 1 - USE A TITLE SEARCH

This option will use a Title search to find a container with the value supplied. If not found it will create a new one.

It must be configured as follows.

Container Type||Container Field Value

Example in UPLOAD:

• <<IF6>> is the index file field value.

  • <<IF6>> is usually the first KFI field (<<F1>>)

  • <<IF7>> is usually the second KFI field (<<F2>>) and so on.

CONTAINER NEW - SEARCH OPTION 2 - USING A CUSTOM FIELDCONTAINER NEW - SEARCH OPTION 2 - USING A CUSTOM FIELD

If the operator would like to search on a Container custom field instead of the Container title.

It is recommended searching on a custom field rather than a title search

It must be configured as follows.

Container Type||New Container Title||Container Field||Container Field Value

Example in UPLOAD:

• <<IF6>> is the index file field value.

  • <<IF6>> is usually the first KFI field (<<F1>>)

  • <<IF7>> is usually the second KFI field (<<F2>>) and so on.

In the example above we are searching for a File Folder object and by the Student Number field which must be what is defined in the index file field value. If a container is found EzeScan will save the document into this Container.

If not a new Container will be created and then the document will saved into it.

CONTAINER NEW - SEARCH OPTION 3 - USING THE “G” NUMBER PATTERN

If the Numbering Pattern of your Folder Record type is set to “GGGGGGGGG” EzeScan can create the Container with the supplied record number for you.

This is particularly useful means of creating a container which has a specific number to be used; such as a property number, supplier code, person’s ID number etc

There are two ways the search can be performed; shown below…

1 - Search by the Container Record Number

This will use the KFI value supplied to search if the record number exists. It must be configured as follows;

Container Type||New Container Title||SBRN(New Container N°)

Example in UPLOAD:

• You need to add SBRN in front of the new container number so that the upload will search for an existing container before creating a new one - also include brackets around the field number…

e.g.   Property Folder||88 Mandella Street Templestowe||SBRN(260638)

2 - Search Custom Container field

To search on a container custom field. It must be configured as follows;

Container Type||New Container Title||Container N°||Container Field||Container Field Value

Example in UPLOAD

• <<IF6>> is the index file field value.

  • <<IF6>> is usually the first KFI field (<<F1>>)

  • <<IF7>> is usually the second KFI field (<<F2>>) and so on.

CONTAINER NEW - INSIDE AN EXISTING CONTAINER WITH SYSTEM GENERATED CONTAINER NUMBER

If a Container needs to be created inside an existing (parent) container and there is no requirement for a pre-determined container number then structure the upload string like this…

New Child Container Type||Parent Container N°\New Container Title

Notes:

• Ensure that there is a “backslash” between the Parent Container Number & New Container Title (e.g. <<IF7>>\<<IF10>>)

• In this example …

  • the child container type is the 1^st value in the string

  • the parent’s record number has a value taken from a KFI placeholder <<IF7>>

  • the child container title value taken from a KFI placeholder <<IF10>>

  • the child is “auto numbered” with the next available number for that record type

• the KFI fields look like this…

• the resulting OTCM records look like this…

The parent’s “container level” must be higher in value than the child’s e.g. Parent is set to 4 and child is set to 3

CONTAINER NEW - INSIDE AN EXISTING CONTAINER WITH PRE-DETERMINED CONTAINER NUMBER

This will require the new container record type to have a Numbering Pattern set to “GGGGGGGGG” before EzeScan can create the Container with the supplied record number for you.

If a Container needs to be created inside an existing (parent) container and there is a requirement for a pre-determined container number (unlike the previous example, which used a system generated number) then structure the upload string like this…

New Child Container Type||Parent Container N°\New Container Title||SBRN(New Container N°)

Notes:

• Ensure that there is a “backslash” between the Parent Container Number & New Container Title (e.g. <<IF7>>\<<IF10>>)

• In this example …

  • the child container type is the 1^st value in the string

  • the parent’s record number has a value taken from a KFI placeholder <<IF7>>

  • the child container title value taken from a KFI placeholder <<IF10>>

  • the child number has been created using the parent number + a KFI field number SBRN(<<IF7>> - <<IF9>>)

    • in this example it is the month for the selected month (e.g. 05 for May)

    • The SBRN component checks if folder already exists and creates a new container if it does not already exist; otherwise it uses the existing container

• the KFI fields look like this…

• the resulting OTCM records look like this…

The parent’s “container level” must be higher in value than the child’s e.g. Parent is set to 4 and child is set to 3

CONTAINER NEW - INSIDE ANOTHER WITH PRE-DETERMINED NUMBER FOR BOTH

If a new container needs to be created in another container then use 3 pipes ||| to separate the creation methods…

Container Type||New Container Title||SBRN(New Container N°)|||Container Type||New Container Title||SBRN(New Container N°)

Notes:

• The first container is the “parent” container

  • The SBRN component checks if folder already exists and creates a new container if it does not already exist; otherwise it uses the existing container

• The 2^nd container is the child which has the processed document added

  • The SBRN component checks if folder already exists and creates a new container if it does not already exist; otherwise it uses the existing container

• You can use a KFI placeholder e.g. <<IF7>> or straight text e.g. Title for the container title in both

• In this example the parent’s record number has a value taken from a KFI placeholder <<IF8>> and the child uses the same number with -01 appended

  • the KFI fields look like this…

• • the resulting OTCM records look like this…

The parent’s “container level” must be higher in value than the child’s e.g. Parent is set to 4 and child is set to 3

CONTAINER NEW - ACCESS CONTROLS

This option will apply access controls to the new container that will be created.
The access controls can be applied in three different ways.

1. AccessType||AccessSetting

2. AccessType||AccessSetting||Optional Location

3. AccessType||AccessSetting||Optional Location1|+ Additional Location

Example:

ViewDocument||Private||Abbey, Rhoda (Ms) -lu 48|Abbott, Peter (Mr) -lu 17

Further locations can be added to the specified access type via the format of,

<Single Pipe>Additional Location<Single Pipe>Additional Location

e.g. |Additional Location|Additional Location|Additional Location

• The Access Type can be…

  • ViewDocument, ViewRecord, UpdateDocument, UpdateMetadata, ModifyAccess, AddContents OR DeleteRecord

• The Access Setting can be…

  • Public, Inherited OR Private

• The Optional Location is the name of a location

  • You can use the name without the URI

    • g. Abbott, Peter (Mr)

    • BUT if there are more than one name (spelt the same) it may fail as MF  Content Manager may not be able to cope or select the wrong location

  • It is recommended that you include the URI in the string

    • e.g. Abbott, Peter (Mr) -lu 17

    • where -lu 17 is the URI code

To apply an access control

• Set Source Field to “static value”

• Select the “Container New Access Controls” Target field

• Then in the Field Value type in your respective Access Control.

Example 1

1 - To set an Access Type and Access Setting (e.g. View Document, Private)

Example 2

2 - To set an Access Type, Access Setting and a Location

Use the location URI (-lu + Unique ID) in the location e.g. -lu 17 This removes any issues where there may be multiple locations with exactly the same name.

Example 3

3 To define two or more different Access Types use the following syntax (example).

Access Type||Access Setting||Location URI|||Access Type||Access Setting||Location URI

ViewDocument||Private||Abbey, Rhoda (Ms) -lu 48|||UpdateMetadata||Private||Abbey, Rhoda (Ms) -lu 48

In the below additional example two Access Types have been defined using two locations on each Access Type, with the distinct Access Types separated by three pipes.

Three pipes (|||) are used to separate each of the Access Controls used.

Use the location URI (-lu + Unique ID) in the location e.g. -lu 17 This removes any issues where there may be multiple locations with exactly the same name.

TAKE NOTE: If setting access controls at the Container level, please check to see if the respective Document Type (That EzeScan is saving the document as) is inheriting from it as a default. Otherwise please specify to inherit the access controls using the “Record Access Controls” Upload mapping.

CONTAINER NEW - CLASSIFICATION

This will apply a Classification to the new container being created.

The Classification can be passed through from the KFI module OR …

• set the Upload Source field to Static Value,

  • a browse button ... will appear and

  • the operator can then apply a static container value for the job.

CONTAINER NEW - FIELD

If the container being created has field/s to be populated then this option can be used. In the UPLOAD Field value the name of the field, the type of field and then the value

It must be configured as follows;

Field Name||Field Type||Field Value

Example in UPLOAD

<<IF7>> is the index file field value for the 2^nd KFI field You may need to change this to suit the KFI field you will be using.

e.g.   Student Number||String||00001

If a second custom property needs to be populated then the operator can specify it after the first.

e.g. Student Number||String||00001||Student Active||String||Yes

The following container properties are supported in addition to user defined fields:

• AddresseeLoc

• AuthorLoc

• ClientLoc

• HomeLoc

• OwnerLoc

• OtherLoc

• CurrentLoc **

• Custom1Loc

• Custom2Loc

• Custom3Loc

• Custom4Loc

• Custom5Loc

• Custom6Loc

• Custom7Loc

• Custom8Loc

• Custom9Loc

• Custom10Loc

• PrimaryContactLoc

• Classification

• External ID

• Notes

• Record Action

• Record Is Attached To

• Record Is Related To

• Record Is Redaction Of

• Security Caveat

• Security Level

** Property is applied after container creation.

CONTAINER NEW - RETENTION SCHEDULE

This will apply a Retention Schedule to the newly created container.

The Retention Schedule can be passed through by the KFI module or set in the Upload Source field to Static Value, a browse button ... will appear and the operator can then apply a static Retention value for the job.

Container New Record Action

This will assign a Record Action to the container when created using Container New functionality.

This can be set from the KFI Record Action browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static Record Action for the job.

The record action will not be applied when Container New functionality finds an existing container.

CURRENTLOC

This is the Current Location Field (also can be known as the Assignee field).

This can be set from the KFI Location browse feature and a browse button ... will appear which the operator can then apply a static location for the job.

An alternative is to set the Upload Source field to Static Value.

This will contain the respective location Name and URI.

e.g. Abbott, Peter (Mr) -lu 17

If the operator wishes to use the current user’s login as the Current Location then set this mapping to static with a value of <<TRIMUSER>>

CUSTOM1LOC 
(TO CUSTOM10LOC)

These are the Custom contact type location fields that can be assigned to a record.

The custom fields will be different to names displayed.

The administrator will need to check in the OTCM client for the correct name.
In OTCM this can be done in the Administration -> Edit Captions -> Objects -> Record -> Child Object -> Contact -> Enumerated List -> Contact Type

DATE CREATED

This is the Date Created field.

OTCM requires the date to be in DD/MM/YYYY Format. If the time needs to be passed the operator will need to use the KFI Suffix option for this field. The following suffix must be applied.

e.g.   “ <<(Time Processed)(HH:MM:SS)>>”

This needs to be set-up in the KFI field being used for the “Date Created” value and there is a space in the start of this suffix…
_space<<(Time Processed)(HH:MM:SS)>>

In the KFI:

This is how it will carry through in UPLOAD:

DATE DUE

This is the Date Due field.

OTCM requires the date to be in DD/MM/YYYY Format. If the time needs to be passed the operator will need to use the KFI Suffix option for this field.

e.g.   “ <<(Time Processed)(HH:MM:SS)>>”

This needs to be set-up in the KFI field being used for the “Due Date” value and there is a space in the start of this suffix…
_space<<(Time Processed)(HH:MM:SS)>>

In the KFI:

This is how it will carry through in UPLOAD:

EXTERNAL ID

This is the External ID Field.

FINALISE RECORD

This is the Declare as Final After Saving field. It can be passed with a…

• Y or N

• Yes or No

• 1 or 0

This can be set from a KFI field OR set in the Upload Source field to Static Value

From the KFI field…

From the Upload Static Value setting…

HOMELOC

This is the Home Location field.

This can be set from the KFI Location browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static location for the job.

From the KFI setting…

From the Upload Static Value setting…

NOTES

This is the Notes field

This is generally set from a KFI field but may also be set via an Upload “Static Value”

Use the Notes with User Stamp (see below) as it will also add the user stamp.

NOTES WITH USER STAMP

This is the Notes Field with a User Stamp.

This is generally set from a KFI field but may also be set via an Upload “Static Value”

If the operator fills out a note in the KFI field the User Stamp will also be placed before the note.

e.g. If the note was “Hello World” the note in the Record property will appear as… ''Tuesday, 5 May 2016 at 3:16:36 PM (GMT+10:00) Surname, First Name:'' Hello World

OWNERLOC

This is the Owner Location field.

This can be set from the KFI Location browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static location for the job.

From the KFI setting…

From the Upload Static Value setting…

PRIMARYCONTACTLOCPRIMARYCONTACTLOC

This is the Primary Contact Location field

This can be set from the KFI Location browse feature or manually set in the Upload Source field to Static Value and the operator can then apply a static location for the job.

RECORD

This is the Record field.

This would be used if selecting a Record from a KFI browse or getting the record number by data extraction as a KFI zone value.

• If the operator is supplying the record Foreign Barcode value the operator will need to prefix BARCODE: in front of the value. This is done in the respective KFI Field Output Tab.

• • This will tell EzeScan UPLOAD to look for the record by its foreign barcode value.

  • When the value is submitted, EzeScan UPLOAD will upload the image as a new revision of this Record.

RECORD NUMBER PATTERN

This option will allow the operator to specify the Record Number of the document to be saved into OTCM.

When the number is passed through to UPLOAD, EzeScan will save the record as this specific number.

If the Record number already exists EzeScan will display an error.

For this option to work the Record Type must be set to a pattern like ANNNNNNZ where…
A = An alphabetic character that must be typed in at the time of creating a record
N = A numeric digit that must be typed in at the time of creating a record (maximum of 9 digits)
Z = Any alphabetic or numeric character that must be typed in at the time of creating a record

RECORD ACCESS CONTROLS

This option will apply access controls to the new record that will be created. The access controls can be applied in three different ways.

1. AccessType||AccessSetting

Multiple locations can be separated using 1-pipe delimiter…

2. AccessType||AccessSetting||Location1|Location2|etc

Multiple access controls can be separated with 3-pipe delimiter (with multiple locations separated by single pipes)…

3. AccessType||AccessSetting||Locations|||AccessType||AccessSetting||Locations

• The Access Type can be…

  • ViewDocument, ViewRecord, UpdateDocument, UpdateMetadata, ModifyAccess, AddContents OR DeleteRecord

• The Access Setting can be…

  • Public, Inherited OR Private

• The Optional Location is the name of a location

  • You can use the name without the URI

    • eg. Abbott, Peter (Mr)

    • BUT if there are more than one name (spelt the same) it may fail as MF  Content Manager may not be able to cope or select the wrong location

  • It is recommended that you include the URI in the string

    • e.g. Abbott, Peter (Mr) -lu 17

    • where -lu 17 is the URI code

To apply a Record Access Control

• Set Source Field to “static value”

• Select the “Record Access Controls” Target field

• Then in the Field Value type in your respective Access Control

Example 1

1 - To set an Access Type and Access Setting (e.g. View Document, Private)

Example 2

2 - To set an Access Type, Access Setting and a Location

• Use the location URI (-lu + Unique ID) in the location e.g. -lu 17
  This removes any issues where there may be multiple locations with exactly the same name.

Single pipes (|) are used to separate each location used.

Example 3

3 - If the operator needs to specify two or more Access Types then use the following syntax.

Three pipes (|||) are used to separate each of the Access Controls used.

Use the location URI (-lu + Unique ID) in the location e.g. -lu 17
This removes any issues where there may be multiple locations with exactly the same name.

RECORD ACTION

This will assign a Record Action to the uploaded document.

This can be set from the KFI Record Action browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static Record Action for the job.

RECORD BARCODE

This is the Barcode value of a record.

If supplied, UPLOAD will upload the document as a new version of this Record

RECORD BARCODE - TO APPEND TO

This is the Barcode value of a record.

If supplied, UPLOAD will append the pages of the scanned document to the record that is already in OTCM.

The MIME type must be the same for this to work. E.g. a PDF document in OTCM being appended by a PDF scanned Document.

RECORD BARCODE - TO PREPEND TO

This is the Barcode value of a record.

If supplied, UPLOAD will append the pages of the scanned document to the record that is already in OTCM.

The MIME type must be the same for this to work. E.g. a PDF document in OTCM being prepended by a PDF scanned Document.

RECORD BARCODE - IS REDACTION OF

This will use the Record Barcode supplied (during the KFI indexing) and update this respective OTCM record with a “Was Redacted To” relationship to the new document uploaded which will have a “Redaction Of” relationship.

RECORD BARCODE - IS RELATED TO

This will use the Record Barcode supplied (during the KFI indexing) and update this respective OTCM record with a “Related To” relationship to the new document uploaded which will also have a “Related To” relationship.

RECORD BARCODE - TO REPLACE

This will use the Record Barcode supplied (during the scan) and replace the record in OTCM.

RECORD - REDACTION OF

This will use the Record Number supplied (during the KFI indexing) and update this respective OTCM record with a “Was Redacted To” relationship to the new document uploaded which will have a “Redaction Of” relationship.

RECORD IS RELATED TO

This will use the Record Number supplied (during the KFI indexing) and update this respective OTCM record with a “Related To” relationship to the new document uploaded which will also have a “Related To” relationship.

RECORD TO APPEND TO

This is the Record Number a record. If supplied, UPLOAD will append the pages of the scanned document to the record that is already in OTCM.

The MIME type must be the same for this to work. E.g. a PDF document being appended by a PDF scanned Document.

RECORD TO PREPEND TO

This is the Record Number a record. If supplied, UPLOAD will append the pages of the scanned document to the record that is already in OTCM.

The MIME type must be the same for this to work. E.g. a PDF document in OTCM being prepended by a PDF scanned Document.

RECORD TO REPLACE

This will replace the specified Record on the OTCM server with the current scanned image.

Please use this option with caution, it does not update the document as a revision, it will replace the record.

If the document needs to be updated as a revision, please refer to the “Record” upload mapping.

RETENTION SCHEDULE

This will populate the Record with a Retention Schedule value.

This can be set from the KFI Retention Schedule browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static Retention for the job.

RECORD TYPE

This is the Record Type that the document will be saved as.

This can be set from the KFI browse feature or set in the Upload Source field to Static Value.

Setting the Record Type in the Upload:

• Set this value to “Static”

• Click inside the field value and a browse button ... will appear

• The available record types can then be selected from the pop-up window

• Select a record Type and then click OK.

SECURITY CAVEAT

This will set a Security Caveat on the document that is being uploaded.

This can be set from the KFI Security Caveat browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static Security Caveat for the document.

SECURITY LEVEL

This will set a Security Level on the document that is being uploaded.

This can be set from the KFI Security Level browse feature or set in the Upload Source field to Static Value and a browse button ... will appear and the operator can then apply a static Security Level for the document.

TR5 FILE NAME

If the operator would like to create a .TR5 file then the name of the TR5 file is configured in here.

The TR5 File Path setting must also be configured to tell EzeScan where to save the file (see below)

TR5 FILE PATH

This is the path of where the .TR5 file will be created.

WORKFLOW TEMPLATE

This will assign a Workflow to the uploaded document.

This can be set from the KFI Workflow browse feature or set in the Upload Source field to a Static Value.

Please refer to the /wiki/spaces/EDS2/pages/98042224 in the table under section Configuring Browse Parameters for details of setting the Workflow Template in the KFI.

Setting the Workflow Template in the Upload:

• Set this value to “Static”

• Click inside the field value and a browse button will appear

• Set a Workflow for the job

The operator can also apply a custom Name to the workflow, e.g. a KFI field value. To do this use the following syntax:

Workflow Name||Title Of Workflow

In Upload you can also pass index field value.

If using a default KFI CSV output

• <<IF6>> is KFI Field No.1

• <<IF7>> is KFI Field No.2

  • and so on.

If passing the workflow name only it will appear in OTCM with the name and the date and time. For example…

<<DOCID>>

This is the Record Number of the previously saved record by EzeScan

• This is used with the “Burn Doc ID “ upload 

<<DOCURI>>

This is the URI of the previously saved record by EzeScan

• These placeholders can used if doing a chained upload into another system after the MF Content Manager upload has been completed.

• Please refer to the EzeScan UPLOAD user guide on how to configure a chained upload

<<TRIMUSER>>

This is the OTCM User that is logged into the PC

• This placeholder could be used as a static value in UPLOAD to pass through into location type fields

Object Lookup Query

Record/Title/Contains/<<F1>>

Query Result Format

{Number}

Object Lookup Query

Record/Title/ContainsWords/118 Road

Query Result Format

{Number}

Object Lookup Query

Record/Title/Contains/<<F1>>

Query Result Format

{Number}

Object Lookup Query

Container Type/User Defined Field name/<<F1>>

Query Result Format

{Number}

Object Lookup Query

Record/Number/<<F1>>

Query Result Format

{Title}

Object Lookup Query

Student Folder/Student Number/<<F1>>

Query Result Format

1.Value for Student Name use................. {Title}

2.Value for Container use.................. {Number}

Object Lookup Query

Record Type/Number/Container Number

<<F9>>/Number/<<F5>>

Facilities/Number/WG21/1234

Query Result Format

{Content Manager Barcode}

R4500004A0

Object Lookup Query

Record Type/Number/Container Number

<<F9>>/Number/<<F5>>

Facilities/Number/WG21/1234

Query Result Format

{URI}

123456789

Object Lookup Query

Location/IdNumber/<<F1>>

Query Result Format

{FormattedID}

Object Lookup Query

Location/URI/<<F1>>

Query Result Format

{FormattedID}

Object Lookup Query

Location/EmailAddress/<<F1>>

Query Result Format

{FormattedID}

Required Format

REGEX

Result

1^st Name then Last Name

"-(lu [0-9]+)",""," *([(][^()]*[)])","","([^,]+),([^,]+)","$2$1","^ *",""

Neil Alexander

Last Name then 1^st Name

"-(lu [0-9]+)",""," *([(][^()]*[)])","","([^,]+),([^,]+)","$1$2","^ *",""

Alexander Neil

Last Name only

" -(lu [0-9]+)",""," *([(][^()]*[)])","","([^,]+),([^,]+)","$1","^ * ",""

Alexander

1^st Name only

" -(lu [0-9]+)",""," *([(][^()]*[)])","","([^,]+),([^,]+)","$2","^ * ",""

Neil