# PMC install - inRiver Data Model Configuration

## Install - inRiver Data Model Configuration

### **inRiver PMC**

There are a number of things that needs to be configured in the Control Center(PMC).

* Go to the [inRiver Control Center](https://controlcenter.productmarketingcloud.com)
* Log in using your credentials
* Select a customer and an environment
* Navigate to
  * Model

### 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 (Great Britain)"

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.

(sourceLanguages example)

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

### 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.

(targetLanguages example)

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

### 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`

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

| Key                | Index | 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.

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

| Key    | Index | 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.`

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

| 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`.

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

| 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 required 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-LBfhAMLTGOaJQF_pYFt%2F-LBfk2FQSVAUW4a76h_N%2FTranslationJob_PMC.png?alt=media\&token=cc5ef2a1-ace5-4d81-8ec5-0867d792ae42)

(Note that the image above shows the Display Name of the field type in the `Name` column, and not the Id)<br>

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LBflgvoglwVHjyF5Adk%2F-LBflljqh7DDf7F3LLvO%2FTranslationJob_PMC.png?alt=media\&token=b360b66d-8a07-48e6-a016-2b230a87ad2f)

1. `trJobId`: The FreewayID of the Job, Read Only
2. `trJobName`: Your name of the Job, Mandatory
3. `trSpecialInstructions`: Special instructions for translation
4. `trPOReference` : Your P.O reference
5. `trExpectedDeliveryDate` : When you expect delivery, Mandatory
6. `trAutomated`: boolean : If the Job process is automated (Not to be set manually)
7. `trSourceLanguage`: CVL, sourceLanguages : Translate from, Mandatory
8. `trTargetLanguages`: CVL, targetLanguages: Translate to, Manatory, Multivalue
9. `trJobStatus`: CVL, trJobStatus : PIM and Freeway status of the Job, Read Only, Default value `Draft`
10. `trJobAction`: CVL, trJobAction 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-LADvRYiSJg4KvYsdKEJ%2Ftranslationtask.png?generation=1523890179270659\&alt=media)

(Note that the image above shows the Display Name of the field type in the `Name` column, and not the Id)<br>

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LZ44iK-ME7Pqe4czLi_%2F-LZ451PF9bHPLzY573An%2FTranslationTask.png?alt=media\&token=30292221-275d-4c09-9668-c65fbde52e45)

1. `trTaskId`: FreewayID of the task, Read Only.
2. `trTaskName`: Language Source-Target, Display Name, Read Only.
3. `trTaskSourceLanguage`: String, Read Only.
4. `trTaskTargetLanguage`: String, Read Only.
5. `trTaskStatus`: CVL, trTaskStatus : Status of the Task, Display Description, Read Only, Default value `NotFound`.
6. `trTaskAction`: CVL, trTaskAction : Action to take on the Task

### Modify Existing Entities

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

| Field Type Id                     | Data Type | CVL             | Multivalue | Read Only | Hidden | Track Changes |
| --------------------------------- | --------- | --------------- | ---------- | --------- | ------ | ------------- |
| `tr[EntityType]InTranslation`     | CVL       | targetLanguages | Yes        | Yes       | No     | Yes           |
| `tr[EntityType]Translated`        | CVL       | targetLanguages | Yes        | Yes       | No     | Yes           |
| `tr[EntityType]TranslationStatus` | Xml       |                 | No         | Yes       | Yes    | Yes           |

### 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        |

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

### Server Configuration

For users to be able to create Translation Jobs you must add that entity to the list of creatable entities.

* Add `TranslationJob` to the "DEFAULT\_CREATE\_ENTITIES" setting in System Settings.
* **Don't forget the comma separator!**

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

### **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-LADvTh5O_NuDrR6HBDs%2FTranslationJobIcon2.png?generation=1523890179269908\&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-LADvTh68ZEizLuuEGDl%2FTranslationTaskicon3.png?generation=1523890179203547\&alt=media)

) select these enity types in the Model section and click the Upload icon button.

![](https://2421145388-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LADvF7aT_Jidr9PmkkA%2F-LADvJna_CsAhXGu_PJn%2F-LADvTuVxl0n6WcEBAD0%2FTranslationJobIconPMC.png?generation=1523890179302352\&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-LADvU1KZ4NdWDfFUKMa%2FTranslationJobIcon.png?generation=1523890179288793\&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-LADvUAOdIVTtbTaGGJJ%2FTranslationTaskIcons.png?generation=1523890179302260\&alt=media)
