# On-premise (6.3) Install - inRiver Data Model Configuration

## Install - inRiver Data Model Configuration

### **inRiver 6.3**

There are a number of things that needs to be configured in the inRiver Model Tool(6.3).

* Start the inRiver Model Tool and log in to the PIM server.

### CVL - Source Language

Languages in your PIM and translation languages are not necessary the same thing. That's why they need to be defined separately. In both language CVLs the following logic is applied; KEY=A unique key eg. "engb" VALUE=Language description eg. "English (UK)"

The `sourceLanguages` are the possible language to translate from. Even if there only is one possible source language, a CVL with this language must be created.

* create a CVL called `sourceLanguages` with a list of the possible source languages to select from. Make sure to set the key as specified in the language configuration.

**(sample sourceLanguages CVL)**

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvL7DP5Z5nPgI6v6V%2Fsourcelanguages6.3.png?generation=1523890179296404\&alt=media)

| Key  | Sort Order | Value        |
| ---- | ---------- | ------------ |
| engb | 10         | English (UK) |

### CVL - Target Languages

The `targetLanguages` are the possible languages to translate to. As with the sourceLanguages check these language lists with your Freeway set up.

* create a CVL called `targetLanguages` with a list of the possible target languages to select.

**(sample targetLanguages CVL)**

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvLAlU2j2uTEFs6dt%2FtargetLanguages6.3.png?generation=1523890179274244\&alt=media)

| Key  | Sort Order | Value              |
| ---- | ---------- | ------------------ |
| noNO | 10         | Norwegian (Bokmål) |
| svSE | 20         | Swedish            |
| fiFI | 30         | Finnish            |

### CVL - Job Status

A translation job can have a number of status steps. They have to be defined in a CVL, this makes it easier for a user if the like to search for Jobs in a specific status.

* create a CVL called `trJobStatus`

| Key                | Sort Order | Value                         |
| ------------------ | ---------- | ----------------------------- |
| Draft              | 10         | Draft                         |
| Sending            | 20         | Sending job                   |
| SendFailed         | 25         | Error sending job             |
| Sent               | 30         | Job sent                      |
| InEvaluation       | 40         | Job in evaluation             |
| Cancelled          | 50         | Job is cancelled              |
| InProduction       | 60         | Work in progress              |
| ReadyForImport     | 70         | Job ready for import          |
| Imported           | 80         | Imported                      |
| ImportedWithErrors | 85         | Imported but some with errors |
| Closed             | 90         | Job done and closed           |

### CVL - Job Actions

This CVL includes the actions that the user can make on Translation Jobs.

* create a CVL called trJobAction.

| Key    | Sort Order | Value                |
| ------ | ---------- | -------------------- |
| Send   | 10         | Send for translation |
| Cancel | 30         | Request cancelation  |
| Import | 40         | Import translation   |

### CVL - Task Status

All translation tasks have a status. Create a CVL called `trTaskStatus`.

| Key                | Sort Order | Value                |
| ------------------ | ---------- | -------------------- |
| NotFound           | 10         | Not translated       |
| Ready              | 20         | Ready for download   |
| Imported           | 30         | Imported             |
| ImportedWithErrors | 40         | Imported with errors |

### CVL - Task Action

This CVL includes the actions that the connector can take on Translation Tasks.

* create a CVL called `trTaskAction`.

| Key    | Sort Order | Value           |
| ------ | ---------- | --------------- |
| Import | 10         | Import language |

### Entity - Translation Job

Create a new entity called `TranslationJob`, add the following required fields. (Find other fields in the Customization section). Source and Target languages are recommended to have default values if you run a automated work flow.

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvLoGxXWGqPmyLKbi%2FTranslationJobFields.png?generation=1523890179301941\&alt=media)

1. `trJobId`: The FreewayID of the Job
2. `trJobName`: Your name of the Job
3. `trSpecialInstructions`: Special instructions for translation
4. `trPOReference` : Your P.O reference
5. `trExpectedDeliveryDate` : When you expect delivery
6. `trSourceLanguage`: CVL, sourceLanguages. For automated jobs, a default value must be entered (Use the key value of CVL sourceLanguage)
7. `trTargetLanguages`: CVL, TargetLanguages. For automated jobs, a default value must be entered (Use the key value of CVL targetLanguages)
8. `trAutomated`: boolean : If the Job process is automated (suggest giving this a Name in PIM noting that this should not be set manually)
9. `trJobStatus`: CVL, trJobStatus : PIM and Freeway status of the Job
10. `trJobAction`: CVL, trJobActions Actions to take on the Job (If manual)

### Entity - Translation Task

Create a new entity called `TranslationTask`, add the following required fields.

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvM6Ly4gx6wOE_J4f%2FTranslationTask6.3.png?generation=1523890179220032\&alt=media)

1. `trTaskId`: FreewayID of the task
2. `trTaskName`: Language Source-Target
3. `trTaskSourceLanguage`: String
4. `trTaskTargetLanguages`: String
5. `trTaskStatus`: CVL, trTaskStatus : Status of the Task
6. `trTaskAction`: CVL, trTaskActions : Action to take on the Task

### Modify Existing Entities

On the entities that you will translate you need to add three new fields.

Add the following fields, where **\[EntityType]** is the Entity type id.

| Field Type Id                                | Data Type | CVL             | Multivalue | ReadOnly | Hidden |
| -------------------------------------------- | --------- | --------------- | ---------- | -------- | ------ |
| tr**\[EntityType]**InTranslation   | CVL       | targetLanguages | Yes        | Yes      | No     |
| tr**\[EntityType]**Translated      | CVL       | targetLanguages | Yes        | Yes      | No     |
| tr**\[EntityType]**TranslationInfo | Xml       |                 | No         | Yes      | Yes    |

#### Example: We want to translate Product and Item.

#### Product

* trProductInTranslation
* trProductTranslated
* trProductTranslationInfo

#### Item

* trItemInTranslation
* trItemTranslated
* trItemTranslationInfo

**(Example of Product status)**

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvMo093cs9zo7ZtYV%2FTranslatableEntityFields.png?generation=1523890179219497\&alt=media)

### Add links

All the entities that you should translate need a link to the Job.

* Add links between Translation Job and the entities you like to translate. E.g. Translation Job -> Product
* And all other Entities that you like to be able to add to a Translation job
* Add the following required links

  | Link type id                  | Source entity type | Target entity type | Suggested inbound name | Suggested outbound name |
  | ----------------------------- | ------------------ | ------------------ | ---------------------- | ----------------------- |
  | TranslationJobTranslationTask | TranslationJob     | TranslationTask    | Translation Tasks      | Translation Job         |
  | TranslationJobTranslationJob  | TranslationJob     | TranslationJob     | Translation Job Batch  | Translation Job Batch   |
  | TranslationTaskResource       | TranslationTask    | Resource           | Files to translate     | Translation Task        |

### Server Configuration

If you like the users, to be able to create translation Jobs you must add that entity to the list of entities.

* Add `TranslationJob` to the "Default Create Entities" in ServerSettings.

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvN8QsQQAfFMna_Ue%2Fsettingsaddtranslationjob.png?generation=1523890179392713\&alt=media)

Note - this can also be added in the web UI under System Settings.

| Setting                   | Value              |
| ------------------------- | ------------------ |
| DEFAULT\_CREATE\_ENTITIES | ... TranslationJob |

### **ICONS**

To have customised icons displayed for connector Translation Jobs(

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvNLM3fWvxSlveXBR%2FTranslationJobIcon2.png?generation=1523890179981639\&alt=media)

) and Translation Tasks(

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvNLN_nzdG2rwJAie%2FTranslationTaskicon3.png?generation=1523890179317313\&alt=media)

) you can copy the icons provided in the deployment package and place them into your inRiver Icons folder of your installation.

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvNQNSmi1LbvJAX1Z%2Ficons1.png?generation=1523890179318018\&alt=media)

Translation Jobs will display like this:

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvNTsGVcG4Xcc0E7R%2FTranslationJobIcon.png?generation=1523890179219066\&alt=media)

Translation Tasks will diplay like this:

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvNYWO6XtTAfKX2cX%2FTranslationTaskIcons.png?generation=1523890179310221\&alt=media)

* Restart: You will need to restart the InRiver Server process.

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvUAOdIVTtbTaGGJJ%2FTranslationTaskIcons.png?generation=1523890179302260\&alt=media)